> For the complete documentation index, see [llms.txt](https://docs.commercelayer.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.commercelayer.io/core-api-reference/avalara_accounts/object.md).

# 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**                | `string`  | Time at which the resource was created.                                                                                                                                                                                                    |
| attributes.**updated\_at**                | `string`  | 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**            | `boolean` | Indicates if the transaction will be recorded and visible on the Avalara website.                                                                                                                                                          |
| attributes.**ddp**                        | `boolean` | Indicates if the seller is responsible for paying/remitting the customs duty & import tax to the customs authorities.                                                                                                                      |
| attributes.**pass\_tax\_exemption\_code** | `boolean` | Indicates if the customer tax exemption code is sent to Avalara as entity use code, letting Avalara determine the taxes (codes not recognized by Avalara are fully taxed). When disabled, tax calculation is skipped for exempt customers. |
| relationships.**markets**                 | `array`   | The associated markets.                                                                                                                                                                                                                    |
| relationships.**attachments**             | `array`   | The associated attachments.                                                                                                                                                                                                                |
| relationships.**events**                  | `array`   | The associated events.                                                                                                                                                                                                                     |
| relationships.**event\_stores**           | `array`   | The associated event stores.                                                                                                                                                                                                               |
| relationships.**tax\_categories**         | `array`   | The associated tax categories.                                                                                                                                                                                                             |
| meta.**mode**                             | `string`  | The resource environment (can be one of `test` or `live`)                                                                                                                                                                                  |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.commercelayer.io/core-api-reference/avalara_accounts/object.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.