Sage Accounting API — Bank Accounts

naftiko: 1.0.0-alpha2
info:
  label: Sage Accounting API — Bank Accounts
  description: 'Sage Accounting API — Bank Accounts. 3 operations. Lead operation: List Bank Accounts. Self-contained Naftiko
    capability covering one Sage business surface.'
  tags:
  - Sage
  - Bank Accounts
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SAGE_API_KEY: SAGE_API_KEY
capability:
  consumes:
  - type: http
    namespace: accounting-bank-accounts
    baseUri: https://api.accounting.sage.com/v3.1
    description: Sage Accounting API — Bank Accounts business capability. Self-contained, no shared references.
    resources:
    - name: bank_accounts
      path: /bank_accounts
      operations:
      - name: listbankaccounts
        method: GET
        description: List Bank Accounts
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createbankaccount
        method: POST
        description: Create Bank Account
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: bank_accounts-key
      path: /bank_accounts/{key}
      operations:
      - name: getbankaccount
        method: GET
        description: Get Bank Account
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: key
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.SAGE_API_KEY}}'
  exposes:
  - type: rest
    namespace: accounting-bank-accounts-rest
    port: 8080
    description: REST adapter for Sage Accounting API — Bank Accounts. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/bank-accounts
      name: bank-accounts
      description: REST surface for bank_accounts.
      operations:
      - method: GET
        name: listbankaccounts
        description: List Bank Accounts
        call: accounting-bank-accounts.listbankaccounts
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createbankaccount
        description: Create Bank Account
        call: accounting-bank-accounts.createbankaccount
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/bank-accounts/{key}
      name: bank-accounts-key
      description: REST surface for bank_accounts-key.
      operations:
      - method: GET
        name: getbankaccount
        description: Get Bank Account
        call: accounting-bank-accounts.getbankaccount
        with:
          key: rest.key
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: accounting-bank-accounts-mcp
    port: 9090
    transport: http
    description: MCP adapter for Sage Accounting API — Bank Accounts. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-bank-accounts
      description: List Bank Accounts
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: accounting-bank-accounts.listbankaccounts
      outputParameters:
      - type: object
        mapping: $.
    - name: create-bank-account
      description: Create Bank Account
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: accounting-bank-accounts.createbankaccount
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-bank-account
      description: Get Bank Account
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: accounting-bank-accounts.getbankaccount
      with:
        key: tools.key
      outputParameters:
      - type: object
        mapping: $.