Sage Accounting API — Sales Invoices

naftiko: 1.0.0-alpha2
info:
  label: Sage Accounting API — Sales Invoices
  description: 'Sage Accounting API — Sales Invoices. 5 operations. Lead operation: List Sales Invoices. Self-contained Naftiko
    capability covering one Sage business surface.'
  tags:
  - Sage
  - Sales Invoices
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SAGE_API_KEY: SAGE_API_KEY
capability:
  consumes:
  - type: http
    namespace: accounting-sales-invoices
    baseUri: https://api.accounting.sage.com/v3.1
    description: Sage Accounting API — Sales Invoices business capability. Self-contained, no shared references.
    resources:
    - name: sales_invoices
      path: /sales_invoices
      operations:
      - name: listsalesinvoices
        method: GET
        description: List Sales Invoices
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: contact_id
          in: query
          type: string
          description: Filter by customer contact ID
        - name: status_id
          in: query
          type: string
        - name: from_date
          in: query
          type: string
        - name: to_date
          in: query
          type: string
        - name: page
          in: query
          type: integer
        - name: items_per_page
          in: query
          type: integer
      - name: createsalesinvoice
        method: POST
        description: Create Sales Invoice
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: sales_invoices-key
      path: /sales_invoices/{key}
      operations:
      - name: getsalesinvoice
        method: GET
        description: Get Sales Invoice
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: key
          in: path
          type: string
          required: true
      - name: updatesalesinvoice
        method: PUT
        description: Update Sales Invoice
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: key
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletesalesinvoice
        method: DELETE
        description: Delete Sales Invoice
        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-sales-invoices-rest
    port: 8080
    description: REST adapter for Sage Accounting API — Sales Invoices. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/sales-invoices
      name: sales-invoices
      description: REST surface for sales_invoices.
      operations:
      - method: GET
        name: listsalesinvoices
        description: List Sales Invoices
        call: accounting-sales-invoices.listsalesinvoices
        with:
          contact_id: rest.contact_id
          status_id: rest.status_id
          from_date: rest.from_date
          to_date: rest.to_date
          page: rest.page
          items_per_page: rest.items_per_page
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createsalesinvoice
        description: Create Sales Invoice
        call: accounting-sales-invoices.createsalesinvoice
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sales-invoices/{key}
      name: sales-invoices-key
      description: REST surface for sales_invoices-key.
      operations:
      - method: GET
        name: getsalesinvoice
        description: Get Sales Invoice
        call: accounting-sales-invoices.getsalesinvoice
        with:
          key: rest.key
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatesalesinvoice
        description: Update Sales Invoice
        call: accounting-sales-invoices.updatesalesinvoice
        with:
          key: rest.key
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletesalesinvoice
        description: Delete Sales Invoice
        call: accounting-sales-invoices.deletesalesinvoice
        with:
          key: rest.key
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: accounting-sales-invoices-mcp
    port: 9090
    transport: http
    description: MCP adapter for Sage Accounting API — Sales Invoices. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-sales-invoices
      description: List Sales Invoices
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: accounting-sales-invoices.listsalesinvoices
      with:
        contact_id: tools.contact_id
        status_id: tools.status_id
        from_date: tools.from_date
        to_date: tools.to_date
        page: tools.page
        items_per_page: tools.items_per_page
      outputParameters:
      - type: object
        mapping: $.
    - name: create-sales-invoice
      description: Create Sales Invoice
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: accounting-sales-invoices.createsalesinvoice
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-sales-invoice
      description: Get Sales Invoice
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: accounting-sales-invoices.getsalesinvoice
      with:
        key: tools.key
      outputParameters:
      - type: object
        mapping: $.
    - name: update-sales-invoice
      description: Update Sales Invoice
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: accounting-sales-invoices.updatesalesinvoice
      with:
        key: tools.key
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-sales-invoice
      description: Delete Sales Invoice
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: accounting-sales-invoices.deletesalesinvoice
      with:
        key: tools.key
      outputParameters:
      - type: object
        mapping: $.