Skip to main content

Update Tax Treatment

PUT 

/api/ledger/connections/:connectionId/tax-treatment

Set who computes the tax on documents pushed to this connection.

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:

  • mode (string, required) — provider_computed or posted_as_line.

Forward-only: changing the mode never re-pushes documents that already synced — it only affects how the next document is built. In provider_computed mode, a document whose line carries an unmapped tax rate will fail to sync with an actionable error until the rate is mapped.

Returns the refreshed tax-treatment state. Returns 404 when the connection id does not name the configured accounting connection; 422 when the mode is not a known option.

Request

Responses

OK

Response Headers
    Content-Type