Persist the tenant id and Vertex Connect tax-engine ids on a Zuora connection and register webhook notifications. Enable tax collection with the settings routes afterwards. Returns 400 if tenantId or zuoraVertexTaxEngineId is empty. Returns 404 if the connection does not exist, is not a Zuora connection, or belongs to an organization your credential cannot access. A multi-org credential must send an Organization-Id, Connection-Id or Entity-Id selector, or gets a 400.
Release date, as YYYY-MM-DD. Defaults to 2026-07-21.
Target organization id (Organization-Id selector).
Target connection id; resolves to its organization.
Platform entity id; resolves to a connection's organization.
Optional source to disambiguate an Entity-Id.
The unique identifier of the connection.
Zuora tenant id.
Vertex Connect tax engine id.
Vertex Connect tax company id.
Kintsugi's unique identifier for the connection.
Id of the organization this connection belongs to.
The platform's own identifier for the entity this connection points at (e.g. a QuickBooks realm id, D365 company id, NetSuite subsidiary id). Use it to resolve a connection from an id you already hold. null until captured on (re)connect or backfilled.
The connection's own external identifier: an Apideck consumer id for a Vault-backed source, or the platform-specific value the connector stores (e.g. a Shopify shop id, a Stripe publishable key).
Origin platform of the connection (e.g. SHOPIFY, QUICKBOOKS). Any origin outside the published values is reported as OTHER.
ACUMATICAAIRWALLEXAMAZONAPIAPPLE_APP_STOREBESTBUYBIGCOMMERCEBILL_COMBUNNYCAMPFIRECHARGEBEECHECKOUTCHAMPDEELDUALENTRYEBAYECWIDETSYFACEBOOKFAIREFRESHBOOKSGOOGLE_APP_STOREGOOGLE_EXPRESSGROUPONGUSTOHYPERLINEINSTAGRAMINTUIT_ENTERPRISE_SUITEKICKSTARTERKILL_BILLMACYSMAGENTOMAXIOMERCADO_LIBREMICROSOFT_DYNAMICS_365MODALYSTNETSUITENEWEGGNOCNOCNORDSTROMODOOOPENMETERORBORDWAYOTHERPAYPALPINTERESTPLENTYONEQUICKBOOKSRECURLYRILLETRIPPLINGSAGE-INTACCTSALESFORCESHOPIFYSHOPLINESHOPWARESQUARESPACESTRIPETARGETTIKTOKVERTEX_O_SERIESWALMARTWAYFAIRWISHWIXWOOCOMMERCEXEROZENSKARZOHOZUORALifecycle status of the connection.
ACTIVEINACTIVECONNECTION_ERRORHuman-readable store or account name for the connection; an empty string when the connection has none.
Public shop/account URL when the source exposes one; not a secret.
When the connection was created.
When the connection was last updated.
When this connection last completed a successful sync.
True once the initial historical import has finished.
Approximate count of records synced so far.
True when this connection meets the prerequisites for L2 tax-engine enablement.
L2 flag: whether tax calculation is enabled on this connection.
When taxCalculationEnabled last flipped from false to true. Preserved across a later disable and restamped on re-enable.
When this connection opted out of L2 tax collection; null when not opted out.
True when the connection needs re-authorization or reconfiguration.
True when Vertex O Series tax is enabled for this connection.
Default tax country for this connection (ISO 3166-1 alpha-2); null when unset.
Amazon marketplace id; null for every non-Amazon connection.
Which NetSuite transaction types this connection syncs. null for every non-NetSuite connection.
INVOICE_ONLYSALES_ORDER_ONLYSALES_ORDER_AND_INVOICECASH_SALE_ONLYINVOICE_AND_CASH_SALEALLTrue when NetSuite cash-sale sync is enabled; null for every non-NetSuite connection.
NetSuite account id; null for every non-NetSuite connection.
NetSuite subsidiary id; null for every non-NetSuite connection.
True for a NetSuite OneWorld account; null for every non-NetSuite connection.
Import floor for this D365 connection, as YYYY-MM-DD. null for every non-D365 connection, or when unset.
Import floor for this Airwallex connection, as YYYY-MM-DD. null for every non-Airwallex connection, or when unset.
Import floor for this WooCommerce connection, as YYYY-MM-DD. null for every non-WooCommerce connection, or when unset.
Import floor for this Amazon connection, as YYYY-MM-DD. null for every non-Amazon connection, or when unset.
Import floor for this Xero connection, as YYYY-MM-DD. null for every non-Xero connection, or when unset.
Zuora Vertex tax engine id; null for every non-Zuora connection.
Zuora Vertex tax company id; null for every non-Zuora connection.
Raw Apideck Vault connection state (e.g. callable) for a Vault-backed source; null otherwise.
True once a Rillet webhook signing token has been saved.
True once an Odoo HMAC secret has been saved.
True once a Campfire webhook signing secret has been saved.
True once a Kill Bill HMAC secret has been saved.
True once an Ordway webhook secret has been saved.
Timestamp of the last Ordway webhook callback received, as reported by Ordway; null if none yet.
True once Bill.com webhook delivery has been configured.
PlentyONE username; null for every non-PlentyONE connection.
Import floor for this PlentyONE connection, as YYYY-MM-DD. null for every non-PlentyONE connection, or when unset.
Import ceiling for this PlentyONE connection, as YYYY-MM-DD. null for every non-PlentyONE connection, or when unset.
How this PlentyONE connection handles marketplace orders. null for every non-PlentyONE connection.
skiptagSuccessful Response
The request was invalid.
Authentication failed or was missing.
The credential is not permitted for this request.
The requested resource was not found.
The request failed validation.