Synctera API — PaymentSchedules

naftiko: 1.0.0-alpha2
info:
  label: Synctera API — PaymentSchedules
  description: 'Synctera API — PaymentSchedules. 4 operations. Lead operation: List payment schedules. Self-contained Naftiko
    capability covering one Synctera business surface.'
  tags:
  - Synctera
  - PaymentSchedules
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SYNCTERA_API_KEY: SYNCTERA_API_KEY
capability:
  consumes:
  - type: http
    namespace: synctera-paymentschedules
    baseUri: https://api.synctera.com/v0
    description: Synctera API — PaymentSchedules business capability. Self-contained, no shared references.
    resources:
    - name: payment_schedules
      path: /payment_schedules
      operations:
      - name: listpaymentschedules
        method: GET
        description: List payment schedules
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createpaymentschedule
        method: POST
        description: Create a payment schedule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: payment_schedules-payments
      path: /payment_schedules/payments
      operations:
      - name: listpayments
        method: GET
        description: List payments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: payment_schedules-payment_schedule_id
      path: /payment_schedules/{payment_schedule_id}
      operations:
      - name: patchpaymentschedule
        method: PATCH
        description: Update a payment schedule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.SYNCTERA_API_KEY}}'
  exposes:
  - type: rest
    namespace: synctera-paymentschedules-rest
    port: 8080
    description: REST adapter for Synctera API — PaymentSchedules. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/payment-schedules
      name: payment-schedules
      description: REST surface for payment_schedules.
      operations:
      - method: GET
        name: listpaymentschedules
        description: List payment schedules
        call: synctera-paymentschedules.listpaymentschedules
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createpaymentschedule
        description: Create a payment schedule
        call: synctera-paymentschedules.createpaymentschedule
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/payment-schedules/payments
      name: payment-schedules-payments
      description: REST surface for payment_schedules-payments.
      operations:
      - method: GET
        name: listpayments
        description: List payments
        call: synctera-paymentschedules.listpayments
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/payment-schedules/{payment-schedule-id}
      name: payment-schedules-payment-schedule-id
      description: REST surface for payment_schedules-payment_schedule_id.
      operations:
      - method: PATCH
        name: patchpaymentschedule
        description: Update a payment schedule
        call: synctera-paymentschedules.patchpaymentschedule
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: synctera-paymentschedules-mcp
    port: 9090
    transport: http
    description: MCP adapter for Synctera API — PaymentSchedules. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-payment-schedules
      description: List payment schedules
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: synctera-paymentschedules.listpaymentschedules
      outputParameters:
      - type: object
        mapping: $.
    - name: create-payment-schedule
      description: Create a payment schedule
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: synctera-paymentschedules.createpaymentschedule
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-payments
      description: List payments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: synctera-paymentschedules.listpayments
      outputParameters:
      - type: object
        mapping: $.
    - name: update-payment-schedule
      description: Update a payment schedule
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: synctera-paymentschedules.patchpaymentschedule
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.