HMRC VAT (Making Tax Digital) API — Obligations

naftiko: 1.0.0-alpha2
info:
  label: HMRC VAT (Making Tax Digital) API — Obligations
  description: 'HMRC VAT (Making Tax Digital) API — Obligations. 1 operations. Lead operation: Retrieve VAT obligations. Self-contained
    Naftiko capability covering one Hmrc business surface.'
  tags:
  - Hmrc
  - Obligations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    HMRC_API_KEY: HMRC_API_KEY
capability:
  consumes:
  - type: http
    namespace: vat-mtd-obligations
    baseUri: https://api.service.hmrc.gov.uk
    description: HMRC VAT (Making Tax Digital) API — Obligations business capability. Self-contained, no shared references.
    resources:
    - name: organisations-vat-vrn-obligations
      path: /organisations/vat/{vrn}/obligations
      operations:
      - name: getvatobligations
        method: GET
        description: Retrieve VAT obligations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: vrn
          in: path
          type: string
          description: VAT Registration Number (9 digits)
          required: true
        - name: from
          in: query
          type: string
          description: Obligation period start date (YYYY-MM-DD), minimum 2017-01-01
          required: true
        - name: to
          in: query
          type: string
          description: Obligation period end date (must be within 366 days of 'from')
          required: true
        - name: status
          in: query
          type: string
        - name: Authorization
          in: header
          type: string
          description: Bearer token (OAuth 2.0)
          required: true
        - name: Gov-Client-Connection-Method
          in: header
          type: string
          description: Fraud prevention header – client connection method
          required: true
        - name: Gov-Vendor-Version
          in: header
          type: string
          description: Fraud prevention header – vendor application version
          required: true
    authentication:
      type: bearer
      token: '{{env.HMRC_API_KEY}}'
  exposes:
  - type: rest
    namespace: vat-mtd-obligations-rest
    port: 8080
    description: REST adapter for HMRC VAT (Making Tax Digital) API — Obligations. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/organisations/vat/{vrn}/obligations
      name: organisations-vat-vrn-obligations
      description: REST surface for organisations-vat-vrn-obligations.
      operations:
      - method: GET
        name: getvatobligations
        description: Retrieve VAT obligations
        call: vat-mtd-obligations.getvatobligations
        with:
          vrn: rest.vrn
          from: rest.from
          to: rest.to
          status: rest.status
          Authorization: rest.Authorization
          Gov-Client-Connection-Method: rest.Gov-Client-Connection-Method
          Gov-Vendor-Version: rest.Gov-Vendor-Version
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: vat-mtd-obligations-mcp
    port: 9090
    transport: http
    description: MCP adapter for HMRC VAT (Making Tax Digital) API — Obligations. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: retrieve-vat-obligations
      description: Retrieve VAT obligations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vat-mtd-obligations.getvatobligations
      with:
        vrn: tools.vrn
        from: tools.from
        to: tools.to
        status: tools.status
        Authorization: tools.Authorization
        Gov-Client-Connection-Method: tools.Gov-Client-Connection-Method
        Gov-Vendor-Version: tools.Gov-Vendor-Version
      outputParameters:
      - type: object
        mapping: $.