The vertex account object

A comprehensive list of the vertex account resource's attributes and relationships

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	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.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	datetime	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.versions	array	The associated changes.
meta.mode	string	The resource environment (can be one of test or live)