Avalara AvaTax REST API — Companies

naftiko: 1.0.0-alpha2
info:
  label: Avalara AvaTax REST API — Companies
  description: 'Avalara AvaTax REST API — Companies. 6 operations. Lead operation: Avalara List All Companies. Self-contained
    Naftiko capability covering one Avalara business surface.'
  tags:
  - Avalara
  - Companies
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    AVALARA_API_KEY: AVALARA_API_KEY
capability:
  consumes:
  - type: http
    namespace: avatax-rest-companies
    baseUri: https://rest.avatax.com
    description: Avalara AvaTax REST API — Companies business capability. Self-contained, no shared references.
    resources:
    - name: api-v2-companies
      path: /api/v2/companies
      operations:
      - name: querycompanies
        method: GET
        description: Avalara List All Companies
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createcompany
        method: POST
        description: Avalara Create a New Company
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-v2-companies-initialize
      path: /api/v2/companies/initialize
      operations:
      - name: initializecompany
        method: POST
        description: Avalara Initialize a New Company with Recommended Defaults
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-v2-companies-id
      path: /api/v2/companies/{id}
      operations:
      - name: getcompany
        method: GET
        description: Avalara Retrieve a Company by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
        - name: $include
          in: query
          type: string
      - name: updatecompany
        method: PUT
        description: Avalara Update a Company
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletecompany
        method: DELETE
        description: Avalara Delete a Company
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
    authentication:
      type: bearer
      token: '{{env.AVALARA_API_KEY}}'
  exposes:
  - type: rest
    namespace: avatax-rest-companies-rest
    port: 8080
    description: REST adapter for Avalara AvaTax REST API — Companies. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/v2/companies
      name: api-v2-companies
      description: REST surface for api-v2-companies.
      operations:
      - method: GET
        name: querycompanies
        description: Avalara List All Companies
        call: avatax-rest-companies.querycompanies
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcompany
        description: Avalara Create a New Company
        call: avatax-rest-companies.createcompany
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v2/companies/initialize
      name: api-v2-companies-initialize
      description: REST surface for api-v2-companies-initialize.
      operations:
      - method: POST
        name: initializecompany
        description: Avalara Initialize a New Company with Recommended Defaults
        call: avatax-rest-companies.initializecompany
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v2/companies/{id}
      name: api-v2-companies-id
      description: REST surface for api-v2-companies-id.
      operations:
      - method: GET
        name: getcompany
        description: Avalara Retrieve a Company by ID
        call: avatax-rest-companies.getcompany
        with:
          id: rest.id
          $include: rest.$include
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatecompany
        description: Avalara Update a Company
        call: avatax-rest-companies.updatecompany
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecompany
        description: Avalara Delete a Company
        call: avatax-rest-companies.deletecompany
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: avatax-rest-companies-mcp
    port: 9090
    transport: http
    description: MCP adapter for Avalara AvaTax REST API — Companies. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: avalara-list-all-companies
      description: Avalara List All Companies
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: avatax-rest-companies.querycompanies
      outputParameters:
      - type: object
        mapping: $.
    - name: avalara-create-new-company
      description: Avalara Create a New Company
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: avatax-rest-companies.createcompany
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: avalara-initialize-new-company-recommended
      description: Avalara Initialize a New Company with Recommended Defaults
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: avatax-rest-companies.initializecompany
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: avalara-retrieve-company-id
      description: Avalara Retrieve a Company by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: avatax-rest-companies.getcompany
      with:
        id: tools.id
        $include: tools.$include
      outputParameters:
      - type: object
        mapping: $.
    - name: avalara-update-company
      description: Avalara Update a Company
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: avatax-rest-companies.updatecompany
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: avalara-delete-company
      description: Avalara Delete a Company
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: avatax-rest-companies.deletecompany
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.