Endpoints — subpackage_listCycles

naftiko: 1.0.0-alpha2
info:
  label: Endpoints — subpackage_listCycles
  description: 'Endpoints — subpackage_listCycles. 1 operations. Lead operation: List payroll cycles. Self-contained Naftiko
    capability covering one Deel business surface.'
  tags:
  - Deel
  - subpackage_listCycles
  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-listcycles
    baseUri: https://api.letsdeel.com/rest/v2
    description: Endpoints — subpackage_listCycles business capability. Self-contained, no shared references.
    resources:
    - name: legal-entities-legal_entity_id-payroll-events
      path: /legal-entities/{legal_entity_id}/payroll-events
      operations:
      - name: listpayrollcyclesv20260101
        method: GET
        description: List payroll cycles
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: legal_entity_id
          in: path
          type: string
          description: The unique identifier (public ID) for the legal entity.
          required: true
        - name: date_start
          in: query
          type: string
          description: Start date in the format 'YYYY-MM-DD'. Must not be earlier than 5 years ago.
        - name: date_end
          in: query
          type: string
          description: End date in the format 'YYYY-MM-DD'. Must not exceed 5 years in the future.
        - name: limit
          in: query
          type: integer
          description: Maximum number of items to return.
        - name: cursor
          in: query
          type: string
          description: Pagination cursor, CUID or UUID format.
        - 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-listcycles-rest
    port: 8080
    description: REST adapter for Endpoints — subpackage_listCycles. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/legal-entities/{legal-entity-id}/payroll-events
      name: legal-entities-legal-entity-id-payroll-events
      description: REST surface for legal-entities-legal_entity_id-payroll-events.
      operations:
      - method: GET
        name: listpayrollcyclesv20260101
        description: List payroll cycles
        call: platform-endpoints-subpackage-listcycles.listpayrollcyclesv20260101
        with:
          legal_entity_id: rest.legal_entity_id
          date_start: rest.date_start
          date_end: rest.date_end
          limit: rest.limit
          cursor: rest.cursor
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: platform-endpoints-subpackage-listcycles-mcp
    port: 9090
    transport: http
    description: MCP adapter for Endpoints — subpackage_listCycles. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-payroll-cycles
      description: List payroll cycles
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-endpoints-subpackage-listcycles.listpayrollcyclesv20260101
      with:
        legal_entity_id: tools.legal_entity_id
        date_start: tools.date_start
        date_end: tools.date_end
        limit: tools.limit
        cursor: tools.cursor
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.