TaxProvider
iRetail PRO store node 1.0.0-m1
← All documentation · Source: contracts openapi/store-v1.yaml at 8000474.
← iRetail PRO store node 1.0.0-m1
TaxProviderAddress object
line1 required
|
string |
|
city required
|
string |
|
region required
|
string |
|
postal_code required
|
string |
TaxRateChange object
code required
|
string |
|
from_ppm required
|
integer |
|
to_ppm required
|
integer |
TaxProviderStatus object
state required
|
"never" | "ok" | "failed" |
|
last_attempt_at required
|
string (date-time) | null |
|
last_success_at required
|
string (date-time) | null |
|
error required
|
"key_missing" | "provider_unreachable" | "provider_refused" | "bad_answer" | null |
|
changed required
|
array of TaxRateChange |
The codes the last successful sync moved, in store order. |
TaxProvider object
provider required
|
"avalara" | "taxjar" | null |
|
account_id required
|
string | null |
Avalara's account number; null for TaxJar. |
key_name required
|
string | null |
The node reads the key from IRETAIL_TAX_KEY_<NAME> or the file IRETAIL_TAX_KEY_<NAME>_FILE names; never the key itself. |
key_present required
|
boolean |
Whether the node finds the named key; the key never leaves the node. |
sandbox required
|
boolean |
|
address required
|
TaxProviderAddress | null |
|
mapping required
|
object |
Which tax code takes each jurisdiction's rate. |
status required
|
TaxProviderStatus |