Avalara Shared Company Service API — Companies

naftiko: 1.0.0-alpha2
info:
  label: Avalara Shared Company Service API — Companies
  description: 'Avalara Shared Company Service API — Companies. 5 operations. Lead operation: Avalara List 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: shared-company-service-companies
    baseUri: https://api.avalara.com/shared/v1
    description: Avalara Shared Company Service API — Companies business capability. Self-contained, no shared references.
    resources:
    - name: companies
      path: /companies
      operations:
      - name: listcompanies
        method: GET
        description: Avalara List Companies
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: $filter
          in: query
          type: string
        - name: $top
          in: query
          type: integer
        - name: $skip
          in: query
          type: integer
      - name: createcompany
        method: POST
        description: Avalara Create a Company Record
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: companies-companyId
      path: /companies/{companyId}
      operations:
      - name: getcompany
        method: GET
        description: Avalara Get a Company by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: companyId
          in: path
          type: string
          required: true
      - name: updatecompany
        method: PUT
        description: Avalara Update a Company Record
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: companyId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletecompany
        method: DELETE
        description: Avalara Delete a Company Record
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: companyId
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.AVALARA_API_KEY}}'
  exposes:
  - type: rest
    namespace: shared-company-service-companies-rest
    port: 8080
    description: REST adapter for Avalara Shared Company Service API — Companies. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/companies
      name: companies
      description: REST surface for companies.
      operations:
      - method: GET
        name: listcompanies
        description: Avalara List Companies
        call: shared-company-service-companies.listcompanies
        with:
          $filter: rest.$filter
          $top: rest.$top
          $skip: rest.$skip
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcompany
        description: Avalara Create a Company Record
        call: shared-company-service-companies.createcompany
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/companies/{companyid}
      name: companies-companyid
      description: REST surface for companies-companyId.
      operations:
      - method: GET
        name: getcompany
        description: Avalara Get a Company by ID
        call: shared-company-service-companies.getcompany
        with:
          companyId: rest.companyId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatecompany
        description: Avalara Update a Company Record
        call: shared-company-service-companies.updatecompany
        with:
          companyId: rest.companyId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecompany
        description: Avalara Delete a Company Record
        call: shared-company-service-companies.deletecompany
        with:
          companyId: rest.companyId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: shared-company-service-companies-mcp
    port: 9090
    transport: http
    description: MCP adapter for Avalara Shared Company Service API — Companies. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: avalara-list-companies
      description: Avalara List Companies
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shared-company-service-companies.listcompanies
      with:
        $filter: tools.$filter
        $top: tools.$top
        $skip: tools.$skip
      outputParameters:
      - type: object
        mapping: $.
    - name: avalara-create-company-record
      description: Avalara Create a Company Record
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shared-company-service-companies.createcompany
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: avalara-get-company-id
      description: Avalara Get a Company by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shared-company-service-companies.getcompany
      with:
        companyId: tools.companyId
      outputParameters:
      - type: object
        mapping: $.
    - name: avalara-update-company-record
      description: Avalara Update a Company Record
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: shared-company-service-companies.updatecompany
      with:
        companyId: tools.companyId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: avalara-delete-company-record
      description: Avalara Delete a Company Record
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: shared-company-service-companies.deletecompany
      with:
        companyId: tools.companyId
      outputParameters:
      - type: object
        mapping: $.