# The vertex account object

A vertex account object is returned as part of the response body of each successful list, retrieve, create or update API call to the `/api/vertex_accounts` endpoint.

## Fields

| Field                             | Type      | Description                                                                                                                                                                                         |
| --------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **type**                          | `string`  | `vertex_accounts`                                                                                                                                                                                   |
| **id**                            | `string`  | The vertex account unique identifier                                                                                                                                                                |
| links.**self**                    | `string`  | The vertex 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.**kind**               | `string`  | The Vertex account kind. One of 'cloud', 'on\_demand', or 'on\_premise'.                                                                                                                            |
| attributes.**baseurl**            | `string`  | The Vertex API baseurl, optional for 'cloud' kind.                                                                                                                                                  |
| attributes.**client\_id**         | `string`  | The Vertex account client ID.                                                                                                                                                                       |
| attributes.**client\_secret**     | `string`  | The Vertex account client secret.                                                                                                                                                                   |
| attributes.**api\_endpoint**      | `string`  | The API endpoint as computed by specified kind and baseurl.                                                                                                                                         |
| attributes.**commit\_invoice**    | `boolean` | Indicates if the transaction will be recorded and visible on the Vertex website.                                                                                                                    |
| attributes.**\_refresh\_token**   | `boolean` | Send this attribute if you want to manually refresh the access token.                                                                                                                               |
| attributes.**token\_expires\_at** | `string`  | The expiration date/time of the access token.                                                                                                                                                       |
| 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.                                                                                                                                                                        |
| meta.**mode**                     | `string`  | The resource environment (can be one of `test` or `live`)                                                                                                                                           |


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

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

The question should be specific, self-contained, and written in natural language.
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.