Avalara VAT Reporting API — Returns

naftiko: 1.0.0-alpha2
info:
  label: Avalara VAT Reporting API — Returns
  description: 'Avalara VAT Reporting API — Returns. 3 operations. Lead operation: Avalara List VAT Returns. Self-contained
    Naftiko capability covering one Avalara business surface.'
  tags:
  - Avalara
  - Returns
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    AVALARA_API_KEY: AVALARA_API_KEY
capability:
  consumes:
  - type: http
    namespace: vat-reporting-returns
    baseUri: https://api.avalara.com/vat-reporting/v1
    description: Avalara VAT Reporting API — Returns business capability. Self-contained, no shared references.
    resources:
    - name: returns
      path: /returns
      operations:
      - name: listreturns
        method: GET
        description: Avalara List VAT Returns
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: status
          in: query
          type: string
        - name: periodStart
          in: query
          type: string
        - name: periodEnd
          in: query
          type: string
        - name: countryCode
          in: query
          type: string
        - name: $top
          in: query
          type: integer
        - name: $skip
          in: query
          type: integer
    - name: returns-returnId
      path: /returns/{returnId}
      operations:
      - name: getreturn
        method: GET
        description: Avalara Get a VAT Return by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: returnId
          in: path
          type: string
          required: true
    - name: returns-returnId-submit
      path: /returns/{returnId}/submit
      operations:
      - name: submitreturn
        method: POST
        description: Avalara Submit a VAT Return for Filing
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: returnId
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.AVALARA_API_KEY}}'
  exposes:
  - type: rest
    namespace: vat-reporting-returns-rest
    port: 8080
    description: REST adapter for Avalara VAT Reporting API — Returns. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/returns
      name: returns
      description: REST surface for returns.
      operations:
      - method: GET
        name: listreturns
        description: Avalara List VAT Returns
        call: vat-reporting-returns.listreturns
        with:
          status: rest.status
          periodStart: rest.periodStart
          periodEnd: rest.periodEnd
          countryCode: rest.countryCode
          $top: rest.$top
          $skip: rest.$skip
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/returns/{returnid}
      name: returns-returnid
      description: REST surface for returns-returnId.
      operations:
      - method: GET
        name: getreturn
        description: Avalara Get a VAT Return by ID
        call: vat-reporting-returns.getreturn
        with:
          returnId: rest.returnId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/returns/{returnid}/submit
      name: returns-returnid-submit
      description: REST surface for returns-returnId-submit.
      operations:
      - method: POST
        name: submitreturn
        description: Avalara Submit a VAT Return for Filing
        call: vat-reporting-returns.submitreturn
        with:
          returnId: rest.returnId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: vat-reporting-returns-mcp
    port: 9090
    transport: http
    description: MCP adapter for Avalara VAT Reporting API — Returns. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: avalara-list-vat-returns
      description: Avalara List VAT Returns
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vat-reporting-returns.listreturns
      with:
        status: tools.status
        periodStart: tools.periodStart
        periodEnd: tools.periodEnd
        countryCode: tools.countryCode
        $top: tools.$top
        $skip: tools.$skip
      outputParameters:
      - type: object
        mapping: $.
    - name: avalara-get-vat-return-id
      description: Avalara Get a VAT Return by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vat-reporting-returns.getreturn
      with:
        returnId: tools.returnId
      outputParameters:
      - type: object
        mapping: $.
    - name: avalara-submit-vat-return-filing
      description: Avalara Submit a VAT Return for Filing
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: vat-reporting-returns.submitreturn
      with:
        returnId: tools.returnId
      outputParameters:
      - type: object
        mapping: $.