Avalara · Capability
Avalara AvaTax APIs — Customers
Avalara AvaTax APIs — Customers. 13 operations. Lead operation: Avalara CreateCustomers. Self-contained Naftiko capability covering one Avalara business surface.
What You Can Do
POST
Post
— Avalara CreateCustomers
/v1/api/v2/companies/{companyid}/customers
GET
Get
— Avalara QueryCustomers
/v1/api/v2/companies/{companyid}/customers
POST
Post
— Avalara LinkShipToCustomersToBillCustomer
/v1/api/v2/companies/{companyid}/customers/billto/{code}/shipto/link
DELETE
Delete
— Avalara DeleteCustomer
/v1/api/v2/companies/{companyid}/customers/{customercode}
GET
Get
— Avalara GetCustomer
/v1/api/v2/companies/{companyid}/customers/{customercode}
PUT
Put
— Avalara UpdateCustomer
/v1/api/v2/companies/{companyid}/customers/{customercode}
GET
Get
— Avalara ListAttributesForCustomer
/v1/api/v2/companies/{companyid}/customers/{customercode}/attributes
PUT
Put
— Avalara LinkAttributesToCustomer
/v1/api/v2/companies/{companyid}/customers/{customercode}/attributes/link
PUT
Put
— Avalara UnlinkAttributesFromCustomer
/v1/api/v2/companies/{companyid}/customers/{customercode}/attributes/unlink
GET
Get
— Avalara ListCertificatesForCustomer
/v1/api/v2/companies/{companyid}/customers/{customercode}/certificates
POST
Post
— Avalara LinkCertificatesToCustomer
/v1/api/v2/companies/{companyid}/customers/{customercode}/certificates/link
POST
Post
— Avalara UnlinkCertificatesFromCustomer
/v1/api/v2/companies/{companyid}/customers/{customercode}/certificates/unlink
GET
Get
— Avalara ListValidCertificatesForCustomer
/v1/api/v2/companies/{companyid}/customers/{customercode}/certificates/{country}/{region}
MCP Tools
avalara-createcustomers
Avalara CreateCustomers
avalara-querycustomers
Avalara QueryCustomers
read-only
idempotent
avalara-linkshiptocustomerstobillcustomer
Avalara LinkShipToCustomersToBillCustomer
avalara-deletecustomer
Avalara DeleteCustomer
idempotent
avalara-getcustomer
Avalara GetCustomer
read-only
idempotent
avalara-updatecustomer
Avalara UpdateCustomer
idempotent
avalara-listattributesforcustomer
Avalara ListAttributesForCustomer
read-only
idempotent
avalara-linkattributestocustomer
Avalara LinkAttributesToCustomer
idempotent
avalara-unlinkattributesfromcustomer
Avalara UnlinkAttributesFromCustomer
idempotent
avalara-listcertificatesforcustomer
Avalara ListCertificatesForCustomer
read-only
idempotent
avalara-linkcertificatestocustomer
Avalara LinkCertificatesToCustomer
avalara-unlinkcertificatesfromcustomer
Avalara UnlinkCertificatesFromCustomer
avalara-listvalidcertificatesforcustomer
Avalara ListValidCertificatesForCustomer
read-only
idempotent
Capability Spec
naftiko: 1.0.0-alpha2
info:
label: Avalara AvaTax APIs — Customers
description: 'Avalara AvaTax APIs — Customers. 13 operations. Lead operation: Avalara CreateCustomers. Self-contained Naftiko
capability covering one Avalara business surface.'
tags:
- Avalara
- Customers
created: '2026-05-19'
modified: '2026-05-19'
binds:
- namespace: env
keys:
AVALARA_API_KEY: AVALARA_API_KEY
capability:
consumes:
- type: http
namespace: avatax-apis-customers
baseUri: http://{{baseurl}}
description: Avalara AvaTax APIs — Customers business capability. Self-contained, no shared references.
resources:
- name: api-v2-companies-companyId-customers
path: /api/v2/companies/{companyId}/customers
operations:
- name: post
method: POST
description: Avalara CreateCustomers
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Content-Type
in: header
type: string
- name: X-Avalara-Client
in: header
type: string
description: Identifies the software you are using to call this API. For more information on the client header,
see [Client Headers](https://developer.avalara.com/avatax/cli
- name: companyId
in: path
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: get
method: GET
description: Avalara QueryCustomers
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
type: string
description: Identifies the software you are using to call this API. For more information on the client header,
see [Client Headers](https://developer.avalara.com/avatax/cli
- name: companyId
in: path
type: string
required: true
- name: api-v2-companies-companyId-customers-billto-code-shipto-link
path: /api/v2/companies/{companyId}/customers/billto/{code}/shipto/link
operations:
- name: post
method: POST
description: Avalara LinkShipToCustomersToBillCustomer
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Content-Type
in: header
type: string
- name: X-Avalara-Client
in: header
type: string
description: Identifies the software you are using to call this API. For more information on the client header,
see [Client Headers](https://developer.avalara.com/avatax/cli
- name: companyId
in: path
type: string
required: true
- name: code
in: path
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: api-v2-companies-companyId-customers-customerCode
path: /api/v2/companies/{companyId}/customers/{customerCode}
operations:
- name: delete
method: DELETE
description: Avalara DeleteCustomer
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
type: string
description: Identifies the software you are using to call this API. For more information on the client header,
see [Client Headers](https://developer.avalara.com/avatax/cli
- name: companyId
in: path
type: string
required: true
- name: customerCode
in: path
type: string
required: true
- name: get
method: GET
description: Avalara GetCustomer
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
type: string
description: Identifies the software you are using to call this API. For more information on the client header,
see [Client Headers](https://developer.avalara.com/avatax/cli
- name: companyId
in: path
type: string
required: true
- name: customerCode
in: path
type: string
required: true
- name: put
method: PUT
description: Avalara UpdateCustomer
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Content-Type
in: header
type: string
- name: X-Avalara-Client
in: header
type: string
description: Identifies the software you are using to call this API. For more information on the client header,
see [Client Headers](https://developer.avalara.com/avatax/cli
- name: companyId
in: path
type: string
required: true
- name: customerCode
in: path
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: api-v2-companies-companyId-customers-customerCode-attributes
path: /api/v2/companies/{companyId}/customers/{customerCode}/attributes
operations:
- name: get
method: GET
description: Avalara ListAttributesForCustomer
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
type: string
description: Identifies the software you are using to call this API. For more information on the client header,
see [Client Headers](https://developer.avalara.com/avatax/cli
- name: companyId
in: path
type: string
required: true
- name: customerCode
in: path
type: string
required: true
- name: api-v2-companies-companyId-customers-customerCode-attributes-link
path: /api/v2/companies/{companyId}/customers/{customerCode}/attributes/link
operations:
- name: put
method: PUT
description: Avalara LinkAttributesToCustomer
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Content-Type
in: header
type: string
- name: X-Avalara-Client
in: header
type: string
description: Identifies the software you are using to call this API. For more information on the client header,
see [Client Headers](https://developer.avalara.com/avatax/cli
- name: companyId
in: path
type: string
required: true
- name: customerCode
in: path
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: api-v2-companies-companyId-customers-customerCode-attributes-unlink
path: /api/v2/companies/{companyId}/customers/{customerCode}/attributes/unlink
operations:
- name: put
method: PUT
description: Avalara UnlinkAttributesFromCustomer
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Content-Type
in: header
type: string
- name: X-Avalara-Client
in: header
type: string
description: Identifies the software you are using to call this API. For more information on the client header,
see [Client Headers](https://developer.avalara.com/avatax/cli
- name: companyId
in: path
type: string
required: true
- name: customerCode
in: path
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: api-v2-companies-companyId-customers-customerCode-certificates
path: /api/v2/companies/{companyId}/customers/{customerCode}/certificates
operations:
- name: get
method: GET
description: Avalara ListCertificatesForCustomer
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
type: string
description: Identifies the software you are using to call this API. For more information on the client header,
see [Client Headers](https://developer.avalara.com/avatax/cli
- name: companyId
in: path
type: string
required: true
- name: customerCode
in: path
type: string
required: true
- name: api-v2-companies-companyId-customers-customerCode-certificates-link
path: /api/v2/companies/{companyId}/customers/{customerCode}/certificates/link
operations:
- name: post
method: POST
description: Avalara LinkCertificatesToCustomer
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Content-Type
in: header
type: string
- name: X-Avalara-Client
in: header
type: string
description: Identifies the software you are using to call this API. For more information on the client header,
see [Client Headers](https://developer.avalara.com/avatax/cli
- name: companyId
in: path
type: string
required: true
- name: customerCode
in: path
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: api-v2-companies-companyId-customers-customerCode-certificates-unlink
path: /api/v2/companies/{companyId}/customers/{customerCode}/certificates/unlink
operations:
- name: post
method: POST
description: Avalara UnlinkCertificatesFromCustomer
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Content-Type
in: header
type: string
- name: X-Avalara-Client
in: header
type: string
description: Identifies the software you are using to call this API. For more information on the client header,
see [Client Headers](https://developer.avalara.com/avatax/cli
- name: companyId
in: path
type: string
required: true
- name: customerCode
in: path
type: string
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: api-v2-companies-companyId-customers-customerCode-certificates-country-region
path: /api/v2/companies/{companyId}/customers/{customerCode}/certificates/{country}/{region}
operations:
- name: get
method: GET
description: Avalara ListValidCertificatesForCustomer
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: X-Avalara-Client
in: header
type: string
description: Identifies the software you are using to call this API. For more information on the client header,
see [Client Headers](https://developer.avalara.com/avatax/cli
- name: companyId
in: path
type: string
required: true
- name: customerCode
in: path
type: string
required: true
- name: country
in: path
type: string
required: true
- name: region
in: path
type: string
required: true
authentication:
type: basic
username: '{{env.AVALARA_USER}}'
password: '{{env.AVALARA_PASS}}'
exposes:
- type: rest
namespace: avatax-apis-customers-rest
port: 8080
description: REST adapter for Avalara AvaTax APIs — Customers. One Spectral-compliant resource per consumed operation,
prefixed with /v1.
resources:
- path: /v1/api/v2/companies/{companyid}/customers
name: api-v2-companies-companyid-customers
description: REST surface for api-v2-companies-companyId-customers.
operations:
- method: POST
name: post
description: Avalara CreateCustomers
call: avatax-apis-customers.post
with:
Content-Type: rest.Content-Type
X-Avalara-Client: rest.X-Avalara-Client
companyId: rest.companyId
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: GET
name: get
description: Avalara QueryCustomers
call: avatax-apis-customers.get
with:
X-Avalara-Client: rest.X-Avalara-Client
companyId: rest.companyId
outputParameters:
- type: object
mapping: $.
- path: /v1/api/v2/companies/{companyid}/customers/billto/{code}/shipto/link
name: api-v2-companies-companyid-customers-billto-code-shipto-link
description: REST surface for api-v2-companies-companyId-customers-billto-code-shipto-link.
operations:
- method: POST
name: post
description: Avalara LinkShipToCustomersToBillCustomer
call: avatax-apis-customers.post
with:
Content-Type: rest.Content-Type
X-Avalara-Client: rest.X-Avalara-Client
companyId: rest.companyId
code: rest.code
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/api/v2/companies/{companyid}/customers/{customercode}
name: api-v2-companies-companyid-customers-customercode
description: REST surface for api-v2-companies-companyId-customers-customerCode.
operations:
- method: DELETE
name: delete
description: Avalara DeleteCustomer
call: avatax-apis-customers.delete
with:
X-Avalara-Client: rest.X-Avalara-Client
companyId: rest.companyId
customerCode: rest.customerCode
outputParameters:
- type: object
mapping: $.
- method: GET
name: get
description: Avalara GetCustomer
call: avatax-apis-customers.get
with:
X-Avalara-Client: rest.X-Avalara-Client
companyId: rest.companyId
customerCode: rest.customerCode
outputParameters:
- type: object
mapping: $.
- method: PUT
name: put
description: Avalara UpdateCustomer
call: avatax-apis-customers.put
with:
Content-Type: rest.Content-Type
X-Avalara-Client: rest.X-Avalara-Client
companyId: rest.companyId
customerCode: rest.customerCode
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/api/v2/companies/{companyid}/customers/{customercode}/attributes
name: api-v2-companies-companyid-customers-customercode-attributes
description: REST surface for api-v2-companies-companyId-customers-customerCode-attributes.
operations:
- method: GET
name: get
description: Avalara ListAttributesForCustomer
call: avatax-apis-customers.get
with:
X-Avalara-Client: rest.X-Avalara-Client
companyId: rest.companyId
customerCode: rest.customerCode
outputParameters:
- type: object
mapping: $.
- path: /v1/api/v2/companies/{companyid}/customers/{customercode}/attributes/link
name: api-v2-companies-companyid-customers-customercode-attributes-link
description: REST surface for api-v2-companies-companyId-customers-customerCode-attributes-link.
operations:
- method: PUT
name: put
description: Avalara LinkAttributesToCustomer
call: avatax-apis-customers.put
with:
Content-Type: rest.Content-Type
X-Avalara-Client: rest.X-Avalara-Client
companyId: rest.companyId
customerCode: rest.customerCode
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/api/v2/companies/{companyid}/customers/{customercode}/attributes/unlink
name: api-v2-companies-companyid-customers-customercode-attributes-unlink
description: REST surface for api-v2-companies-companyId-customers-customerCode-attributes-unlink.
operations:
- method: PUT
name: put
description: Avalara UnlinkAttributesFromCustomer
call: avatax-apis-customers.put
with:
Content-Type: rest.Content-Type
X-Avalara-Client: rest.X-Avalara-Client
companyId: rest.companyId
customerCode: rest.customerCode
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/api/v2/companies/{companyid}/customers/{customercode}/certificates
name: api-v2-companies-companyid-customers-customercode-certificates
description: REST surface for api-v2-companies-companyId-customers-customerCode-certificates.
operations:
- method: GET
name: get
description: Avalara ListCertificatesForCustomer
call: avatax-apis-customers.get
with:
X-Avalara-Client: rest.X-Avalara-Client
companyId: rest.companyId
customerCode: rest.customerCode
outputParameters:
- type: object
mapping: $.
- path: /v1/api/v2/companies/{companyid}/customers/{customercode}/certificates/link
name: api-v2-companies-companyid-customers-customercode-certificates-link
description: REST surface for api-v2-companies-companyId-customers-customerCode-certificates-link.
operations:
- method: POST
name: post
description: Avalara LinkCertificatesToCustomer
call: avatax-apis-customers.post
with:
Content-Type: rest.Content-Type
X-Avalara-Client: rest.X-Avalara-Client
companyId: rest.companyId
customerCode: rest.customerCode
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/api/v2/companies/{companyid}/customers/{customercode}/certificates/unlink
name: api-v2-companies-companyid-customers-customercode-certificates-unlink
description: REST surface for api-v2-companies-companyId-customers-customerCode-certificates-unlink.
operations:
- method: POST
name: post
description: Avalara UnlinkCertificatesFromCustomer
call: avatax-apis-customers.post
with:
Content-Type: rest.Content-Type
X-Avalara-Client: rest.X-Avalara-Client
companyId: rest.companyId
customerCode: rest.customerCode
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/api/v2/companies/{companyid}/customers/{customercode}/certificates/{country}/{region}
name: api-v2-companies-companyid-customers-customercode-certificates-country-region
description: REST surface for api-v2-companies-companyId-customers-customerCode-certificates-country-region.
operations:
- method: GET
name: get
description: Avalara ListValidCertificatesForCustomer
call: avatax-apis-customers.get
with:
X-Avalara-Client: rest.X-Avalara-Client
companyId: rest.companyId
customerCode: rest.customerCode
country: rest.country
region: rest.region
outputParameters:
- type: object
mapping: $.
- type: mcp
namespace: avatax-apis-customers-mcp
port: 9090
transport: http
description: MCP adapter for Avalara AvaTax APIs — Customers. One tool per consumed operation, routed inline through this
capability's consumes block.
tools:
- name: avalara-createcustomers
description: Avalara CreateCustomers
hints:
readOnly: false
destructive: false
idempotent: false
call: avatax-apis-customers.post
with:
Content-Type: tools.Content-Type
X-Avalara-Client: tools.X-Avalara-Client
companyId: tools.companyId
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: avalara-querycustomers
description: Avalara QueryCustomers
hints:
readOnly: true
destructive: false
idempotent: true
call: avatax-apis-customers.get
with:
X-Avalara-Client: tools.X-Avalara-Client
companyId: tools.companyId
outputParameters:
- type: object
mapping: $.
- name: avalara-linkshiptocustomerstobillcustomer
description: Avalara LinkShipToCustomersToBillCustomer
hints:
readOnly: false
destructive: false
idempotent: false
call: avatax-apis-customers.post
with:
Content-Type: tools.Content-Type
X-Avalara-Client: tools.X-Avalara-Client
companyId: tools.companyId
code: tools.code
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: avalara-deletecustomer
description: Avalara DeleteCustomer
hints:
readOnly: false
destructive: true
idempotent: true
call: avatax-apis-customers.delete
with:
X-Avalara-Client: tools.X-Avalara-Client
companyId: tools.companyId
customerCode: tools.customerCode
outputParameters:
- type: object
mapping: $.
- name: avalara-getcustomer
description: Avalara GetCustomer
hints:
readOnly: true
destructive: false
idempotent: true
call: avatax-apis-customers.get
with:
X-Avalara-Client: tools.X-Avalara-Client
companyId: tools.companyId
customerCode: tools.customerCode
outputParameters:
- type: object
mapping: $.
- name: avalara-updatecustomer
description: Avalara UpdateCustomer
hints:
readOnly: false
destructive: false
idempotent: true
call: avatax-apis-customers.put
with:
Content-Type: tools.Content-Type
X-Avalara-Client: tools.X-Avalara-Client
companyId: tools.companyId
customerCode: tools.customerCode
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: avalara-listattributesforcustomer
description: Avalara ListAttributesForCustomer
hints:
readOnly: true
destructive: false
idempotent: true
call: avatax-apis-customers.get
with:
X-Avalara-Client: tools.X-Avalara-Client
companyId: tools.companyId
customerCode: tools.customerCode
outputParameters:
- type: object
mapping: $.
- name: avalara-linkattributestocustomer
description: Avalara LinkAttributesToCustomer
hints:
readOnly: false
destructive: false
idempotent: true
call: avatax-apis-customers.put
with:
Content-Type: tools.Content-Type
X-Avalara-Client: tools.X-Avalara-Client
companyId: tools.companyId
customerCode: tools.customerCode
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: avalara-unlinkattributesfromcustomer
description: Avalara UnlinkAttributesFromCustomer
hints:
readOnly: false
destructive: false
idempotent: true
call: avatax-apis-customers.put
with:
Content-Type: tools.Content-Type
X-Avalara-Client: tools.X-Avalara-Client
companyId: tools.companyId
customerCode: tools.customerCode
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: avalara-listcertificatesforcustomer
description: Avalara ListCertificatesForCustomer
hints:
readOnly: true
destructive: false
idempotent: true
call: avatax-apis-customers.get
with:
X-Avalara-Client: tools.X-Avalara-Client
companyId: tools.companyId
customerCode: tools.customerCode
outputParameters:
- type: object
mapping: $.
- name: avalara-linkcertificatestocustomer
description: Avalara LinkCertificatesToCustomer
hints:
readOnly: false
destructive: false
idempotent: false
call: avatax-apis-customers.post
with:
Content-Type: tools.Content-Type
X-Avalara-Client: tools.X-Avalara-Client
companyId: tools.companyId
customerCode: tools.customerCode
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: avalara-unlinkcertificatesfromcustomer
description: Avalara UnlinkCertificatesFromCustomer
hints:
readOnly: false
destructive: false
idempotent: false
call: avatax-apis-customers.post
with:
Content-Type: tools.Content-Type
X-Avalara-Client: tools.X-Avalara-Client
companyId: tools.companyId
customerCode: tools.customerCode
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: avalara-listvalidcertificatesforcustomer
description: Avalara ListValidCertificatesForCustomer
hints:
readOnly: true
destructive: false
idempotent: true
call: avatax-apis-customers.get
with:
X-Avalara-Client: tools.X-Avalara-Client
companyId: tools.companyId
customerCode: tools.customerCode
country: tools.country
region: tools.region
outputParameters:
- type: object
mapping: $.