The external tax calculator object
A comprehensive list of the external tax calculator resource's attributes and relationships
An external tax calculator object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/external_tax_calculators
endpoint.
Fields
Field | Type | Description |
---|---|---|
type |
|
|
id |
| The external tax calculator unique identifier |
links.self |
| The external tax calculator endpoint URL |
attributes._reset_circuit |
| Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. |
attributes.circuit_failure_count |
| The number of consecutive failures recorded by the circuit breaker associated to this resource, will be reset on first successful call to callback. |
attributes.circuit_state |
| The circuit breaker state, by default it is 'closed'. It can become 'open' once the number of consecutive failures overlaps the specified threshold, in such case no further calls to the failing callback are made. |
attributes.created_at |
| Time at which the resource was created. |
attributes.metadata |
| 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.name |
| The tax calculator's internal name. |
attributes.reference |
| 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 |
| Any identifier of the third party system that defines the reference code. |
attributes.shared_secret |
| The shared secret used to sign the external request payload. |
attributes.tax_calculator_url |
| The URL to the service that will compute the taxes. |
attributes.updated_at |
| Time at which the resource was last updated. |
relationships.attachments |
| The associated attachments. |
relationships.markets |
| The associated markets. |
relationships.versions |
| The associated changes. |
meta.mode |
| The resource environment (can be one of |
Last updated