API reference
Search…
⌃K
Links

The avalara account object

A comprehensive list of the avalara account resource's attributes and relationships
An avalara account object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/avalara_accounts endpoint.

Fields

Field
Type
Description
type
string
avalara_accounts
id
string
The avalara account unique identifier
links.self
string
The avalara account endpoint URL
attributes.name
string
The tax calculator's internal name.
attributes.created_at
datetime
Time at which the resource was created.
attributes.updated_at
datetime
Time at which the resource was last updated.
attributes.reference
string
A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
attributes.reference_origin
string
Any identifier of the third party system that defines the reference code
attributes.metadata
object
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
attributes.username
string
The Avalara account username.
attributes.password
string
The Avalara account password.
attributes.company_code
string
The Avalara company code.
attributes.commit_invoice
string
Indicates if the transaction will be recorded and visible on the Avalara website.
attributes.ddp
string
Indicates if the seller is responsible for paying/remitting the customs duty & import tax to the customs authorities.
relationships.markets
array
The associated markets.
relationships.attachments
array
The associated attachments.
relationships.tax_categories
array
The associated tax categories.
meta.mode
string
The resource environment (can be one of test or live)