Skip to main content

Set Up Facilitator Tax Clearing Account

POST 

/api/ledger/facilitator-tax/clearing-account

Maps the Marketplace Facilitator Tax clearing account without adopting the clearing treatment, so a marketplace-facilitator settlement or payout code can be re-pointed to it before adoption (adoption is refused while such a code is still mapped to Sales Tax). It maps the same account adopting would: an existing liability named Marketplace Facilitator Tax that passes the clearing-account rules, otherwise a new current liability on the first free code from 2210. With Xero or QuickBooks connected, the account is created in the provider and linked first; if the provider refuses, nothing is created or mapped.

Required scope: accounting:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Idempotent: when a clearing account is already mapped it is returned unchanged. How orders post does not change until the clearing treatment is adopted.

No request body.

Use it when a suggestion from a suggest-tax endpoint has sets_up_clearing_account = true: call this, then map the code to the returned id with the channel's update or bulk-assign mappings endpoint.

Authentication: Requires Bearer token and the integrations.update permission.

Request​

Responses​

OK

Response Headers
    Content-Type