CSG Forte REST API — Settlements

naftiko: 1.0.0-alpha2
info:
  label: CSG Forte REST API — Settlements
  description: 'CSG Forte REST API — Settlements. 1 operations. Lead operation: List settlements. Self-contained Naftiko capability
    covering one Csg business surface.'
  tags:
  - Csg
  - Settlements
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CSG_API_KEY: CSG_API_KEY
capability:
  consumes:
  - type: http
    namespace: forte-rest-settlements
    baseUri: https://api.forte.net/v3
    description: CSG Forte REST API — Settlements business capability. Self-contained, no shared references.
    resources:
    - name: organizations-organizationId-locations-locationId-settlements
      path: /organizations/{organizationId}/locations/{locationId}/settlements
      operations:
      - name: listsettlements
        method: GET
        description: List settlements
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: locationId
          in: path
          type: string
          required: true
        - name: start_settle_date
          in: query
          type: string
        - name: end_settle_date
          in: query
          type: string
    authentication:
      type: basic
      username: '{{env.CSG_USER}}'
      password: '{{env.CSG_PASS}}'
  exposes:
  - type: rest
    namespace: forte-rest-settlements-rest
    port: 8080
    description: REST adapter for CSG Forte REST API — Settlements. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/locations/{locationid}/settlements
      name: organizations-organizationid-locations-locationid-settlements
      description: REST surface for organizations-organizationId-locations-locationId-settlements.
      operations:
      - method: GET
        name: listsettlements
        description: List settlements
        call: forte-rest-settlements.listsettlements
        with:
          organizationId: rest.organizationId
          locationId: rest.locationId
          start_settle_date: rest.start_settle_date
          end_settle_date: rest.end_settle_date
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: forte-rest-settlements-mcp
    port: 9090
    transport: http
    description: MCP adapter for CSG Forte REST API — Settlements. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-settlements
      description: List settlements
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: forte-rest-settlements.listsettlements
      with:
        organizationId: tools.organizationId
        locationId: tools.locationId
        start_settle_date: tools.start_settle_date
        end_settle_date: tools.end_settle_date
      outputParameters:
      - type: object
        mapping: $.