Apply Tax Rate Mappings

POST 
/api/ledger/connections/:connectionId/tax-rate-mappings/apply

Save several tax rate mappings at once - the companion save for Auto-Map.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Authentication: Requires Bearer token.

Body fields:

• mappings (array, required, min 1) - the pairings to save.
• mappings[].tax_rate_id (integer, required) - the tax rate to map.
• mappings[].provider_tax_code (string or null, required key) - the provider tax code (Xero: the tax type identifier, e.g. OUTPUT; QuickBooks: the tax code id). Send null to clear that mapping. The key must be present even when null.

All or nothing: if any code is unknown or archived in the provider the whole set is rejected and nothing is saved. Returns the refreshed mapping rows. Returns 404 when the connection id does not name the configured accounting connection; 422 on an unknown tax rate or provider code.

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

422

Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.

429

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.