Avalara Excise Platform API — Business Entities

naftiko: 1.0.0-alpha2
info:
  label: Avalara Excise Platform API — Business Entities
  description: 'Avalara Excise Platform API — Business Entities. 5 operations. Lead operation: Avalara List Business Entities.
    Self-contained Naftiko capability covering one Avalara business surface.'
  tags:
  - Avalara
  - Business Entities
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    AVALARA_API_KEY: AVALARA_API_KEY
capability:
  consumes:
  - type: http
    namespace: excise-business-entities
    baseUri: https://exciseapi.avalara.com/api/v1
    description: Avalara Excise Platform API — Business Entities business capability. Self-contained, no shared references.
    resources:
    - name: BusinessEntities
      path: /BusinessEntities
      operations:
      - name: listbusinessentities
        method: GET
        description: Avalara List Business Entities
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createbusinessentity
        method: POST
        description: Avalara Create a Business Entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: BusinessEntities-entityId
      path: /BusinessEntities/{entityId}
      operations:
      - name: getbusinessentity
        method: GET
        description: Avalara Get a Business Entity by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: entityId
          in: path
          type: string
          required: true
      - name: updatebusinessentity
        method: PUT
        description: Avalara Update a Business Entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: entityId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletebusinessentity
        method: DELETE
        description: Avalara Delete a Business Entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: entityId
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.AVALARA_API_KEY}}'
  exposes:
  - type: rest
    namespace: excise-business-entities-rest
    port: 8080
    description: REST adapter for Avalara Excise Platform API — Business Entities. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/businessentities
      name: businessentities
      description: REST surface for BusinessEntities.
      operations:
      - method: GET
        name: listbusinessentities
        description: Avalara List Business Entities
        call: excise-business-entities.listbusinessentities
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createbusinessentity
        description: Avalara Create a Business Entity
        call: excise-business-entities.createbusinessentity
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/businessentities/{entityid}
      name: businessentities-entityid
      description: REST surface for BusinessEntities-entityId.
      operations:
      - method: GET
        name: getbusinessentity
        description: Avalara Get a Business Entity by ID
        call: excise-business-entities.getbusinessentity
        with:
          entityId: rest.entityId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatebusinessentity
        description: Avalara Update a Business Entity
        call: excise-business-entities.updatebusinessentity
        with:
          entityId: rest.entityId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletebusinessentity
        description: Avalara Delete a Business Entity
        call: excise-business-entities.deletebusinessentity
        with:
          entityId: rest.entityId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: excise-business-entities-mcp
    port: 9090
    transport: http
    description: MCP adapter for Avalara Excise Platform API — Business Entities. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: avalara-list-business-entities
      description: Avalara List Business Entities
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: excise-business-entities.listbusinessentities
      outputParameters:
      - type: object
        mapping: $.
    - name: avalara-create-business-entity
      description: Avalara Create a Business Entity
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: excise-business-entities.createbusinessentity
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: avalara-get-business-entity-id
      description: Avalara Get a Business Entity by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: excise-business-entities.getbusinessentity
      with:
        entityId: tools.entityId
      outputParameters:
      - type: object
        mapping: $.
    - name: avalara-update-business-entity
      description: Avalara Update a Business Entity
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: excise-business-entities.updatebusinessentity
      with:
        entityId: tools.entityId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: avalara-delete-business-entity
      description: Avalara Delete a Business Entity
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: excise-business-entities.deletebusinessentity
      with:
        entityId: tools.entityId
      outputParameters:
      - type: object
        mapping: $.