naftiko: 1.0.0-alpha2
info:
  label: Endpoints — subpackage_reports
  description: 'Endpoints — subpackage_reports. 4 operations. Lead operation: List payroll events by legal entity. Self-contained
    Naftiko capability covering one Deel business surface.'
  tags:
  - Deel
  - subpackage_reports
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    DEEL_API_KEY: DEEL_API_KEY
capability:
  consumes:
  - type: http
    namespace: platform-endpoints-subpackage-reports
    baseUri: https://api.letsdeel.com/rest/v2
    description: Endpoints — subpackage_reports business capability. Self-contained, no shared references.
    resources:
    - name: gp-legal-entities-legal_entity_id-reports
      path: /gp/legal-entities/{legal_entity_id}/reports
      operations:
      - name: getgplegalentityreports
        method: GET
        description: List payroll events by legal entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: legal_entity_id
          in: path
          type: string
          description: Unique identifier for the legal entity.
          required: true
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
    - name: gp-reports-id-gross_to_net
      path: /gp/reports/{id}/gross_to_net
      operations:
      - name: getgpreportgrosstonet
        method: GET
        description: List gross-to-net report.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Id of the gp payroll report.
          required: true
        - name: currency
          in: query
          type: string
          description: Currency to be used in the report calculation.
        - name: limit
          in: query
          type: number
          description: Maximum number of records to return.
        - name: offset
          in: query
          type: number
          description: Offset/index of record for the next page of records to return.
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
    - name: gp-reports-id-gross_to_net-csv
      path: /gp/reports/{id}/gross_to_net/csv
      operations:
      - name: getgpreportgrosstonetcsv
        method: GET
        description: Download gross to net report
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Id of the gp payroll report.
          required: true
        - name: currency
          in: query
          type: string
          description: Currency to be used in the report calculation.
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
    - name: reports-payroll-cycles-cycle_id-gross-to-net
      path: /reports/payroll/cycles/{cycle_id}/gross-to-net
      operations:
      - name: getsg2nreportdataforagivenpayrollcyclebyitsidv20260101
        method: GET
        description: Gets G2N report data for a given payroll cycle by it's ID.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: cycle_id
          in: path
          type: string
          description: The unique identifier for the payroll event.
          required: true
        - name: limit
          in: query
          type: integer
          description: Maximum number of items to return. Defaults to 20.
        - name: cursor
          in: query
          type: string
          description: Cursor for pagination of results.
        - name: Authorization
          in: header
          type: string
          description: '## Authentication'
          required: true
    authentication:
      type: bearer
      token: '{{env.DEEL_API_KEY}}'
  exposes:
  - type: rest
    namespace: platform-endpoints-subpackage-reports-rest
    port: 8080
    description: REST adapter for Endpoints — subpackage_reports. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/gp/legal-entities/{legal-entity-id}/reports
      name: gp-legal-entities-legal-entity-id-reports
      description: REST surface for gp-legal-entities-legal_entity_id-reports.
      operations:
      - method: GET
        name: getgplegalentityreports
        description: List payroll events by legal entity
        call: platform-endpoints-subpackage-reports.getgplegalentityreports
        with:
          legal_entity_id: rest.legal_entity_id
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/gp/reports/{id}/gross-to-net
      name: gp-reports-id-gross-to-net
      description: REST surface for gp-reports-id-gross_to_net.
      operations:
      - method: GET
        name: getgpreportgrosstonet
        description: List gross-to-net report.
        call: platform-endpoints-subpackage-reports.getgpreportgrosstonet
        with:
          id: rest.id
          currency: rest.currency
          limit: rest.limit
          offset: rest.offset
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/gp/reports/{id}/gross-to-net/csv
      name: gp-reports-id-gross-to-net-csv
      description: REST surface for gp-reports-id-gross_to_net-csv.
      operations:
      - method: GET
        name: getgpreportgrosstonetcsv
        description: Download gross to net report
        call: platform-endpoints-subpackage-reports.getgpreportgrosstonetcsv
        with:
          id: rest.id
          currency: rest.currency
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/reports/payroll/cycles/{cycle-id}/gross-to-net
      name: reports-payroll-cycles-cycle-id-gross-to-net
      description: REST surface for reports-payroll-cycles-cycle_id-gross-to-net.
      operations:
      - method: GET
        name: getsg2nreportdataforagivenpayrollcyclebyitsidv20260101
        description: Gets G2N report data for a given payroll cycle by it's ID.
        call: platform-endpoints-subpackage-reports.getsg2nreportdataforagivenpayrollcyclebyitsidv20260101
        with:
          cycle_id: rest.cycle_id
          limit: rest.limit
          cursor: rest.cursor
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: platform-endpoints-subpackage-reports-mcp
    port: 9090
    transport: http
    description: MCP adapter for Endpoints — subpackage_reports. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-payroll-events-legal-entity
      description: List payroll events by legal entity
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-endpoints-subpackage-reports.getgplegalentityreports
      with:
        legal_entity_id: tools.legal_entity_id
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: list-gross-net-report
      description: List gross-to-net report.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-endpoints-subpackage-reports.getgpreportgrosstonet
      with:
        id: tools.id
        currency: tools.currency
        limit: tools.limit
        offset: tools.offset
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: download-gross-net-report
      description: Download gross to net report
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-endpoints-subpackage-reports.getgpreportgrosstonetcsv
      with:
        id: tools.id
        currency: tools.currency
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: gets-g2n-report-data-given
      description: Gets G2N report data for a given payroll cycle by it's ID.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-endpoints-subpackage-reports.getsg2nreportdataforagivenpayrollcyclebyitsidv20260101
      with:
        cycle_id: tools.cycle_id
        limit: tools.limit
        cursor: tools.cursor
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.