Workday Integration Workday Settlement Services API — Settlement Services

naftiko: 1.0.0-alpha2
info:
  label: Workday Integration Workday Settlement Services API — Settlement Services
  description: 'Workday Integration Workday Settlement Services API — Settlement Services. 2 operations. Lead operation: Workday
    Integration Retrieve a collection of settlements. Self-contained Naftiko capability covering one Workday Integration business
    surface.'
  tags:
  - Workday Integration
  - Settlement Services
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WORKDAY_INTEGRATION_API_KEY: WORKDAY_INTEGRATION_API_KEY
capability:
  consumes:
  - type: http
    namespace: settlement-services-settlement-services
    baseUri: https://{baseUrl}/ccx/api/settlementServices/v1/{tenant}
    description: Workday Integration Workday Settlement Services API — Settlement Services business capability. Self-contained,
      no shared references.
    resources:
    - name: settlements
      path: /settlements
      operations:
      - name: getsettlements
        method: GET
        description: Workday Integration Retrieve a collection of settlements
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: settlements-ID
      path: /settlements/{ID}
      operations:
      - name: getsettlementbyid
        method: GET
        description: Workday Integration Retrieve a specific Settlement
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.WORKDAY_INTEGRATION_API_KEY}}'
  exposes:
  - type: rest
    namespace: settlement-services-settlement-services-rest
    port: 8080
    description: REST adapter for Workday Integration Workday Settlement Services API — Settlement Services. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/settlements
      name: settlements
      description: REST surface for settlements.
      operations:
      - method: GET
        name: getsettlements
        description: Workday Integration Retrieve a collection of settlements
        call: settlement-services-settlement-services.getsettlements
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settlements/{id}
      name: settlements-id
      description: REST surface for settlements-ID.
      operations:
      - method: GET
        name: getsettlementbyid
        description: Workday Integration Retrieve a specific Settlement
        call: settlement-services-settlement-services.getsettlementbyid
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: settlement-services-settlement-services-mcp
    port: 9090
    transport: http
    description: MCP adapter for Workday Integration Workday Settlement Services API — Settlement Services. One tool per consumed
      operation, routed inline through this capability's consumes block.
    tools:
    - name: workday-integration-retrieve-collection-settlements
      description: Workday Integration Retrieve a collection of settlements
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: settlement-services-settlement-services.getsettlements
      outputParameters:
      - type: object
        mapping: $.
    - name: workday-integration-retrieve-specific-settlement
      description: Workday Integration Retrieve a specific Settlement
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: settlement-services-settlement-services.getsettlementbyid
      outputParameters:
      - type: object
        mapping: $.