Get Tax Treatment
GET/api/ledger/connections/:connectionId/tax-treatment
Read the connection's tax treatment: the active mode, the organisation's country (captured from the provider and cached), the mode that country implies as a default, how many tax rates still lack a provider tax-code mapping, and the provider's available tax codes.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token.
Modes:
provider_computed— each document line declares its mapped provider tax code and the provider computes the tax. Required for filing regions (AU, NZ, UK, CA) where the tax return is prepared from the provider.posted_as_line— documents are pushed without tax codes and the tax posts as a ledger line to the mapped Sales Tax account. The default, and standard for US organisations.
region_default is the mode implied by country_code; is_filing_region is true for AU/NZ/UK/CA.
Returns 404 when the connection id does not name the configured accounting connection.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not Found
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.