Skip to main content

Get Facilitator Tax Status

GET 

/api/ledger/facilitator-tax/status

Gets where the account stands on marketplace-facilitator sales tax: the treatment in force (clearing when facilitator tax posts to a dedicated clearing account, liability_account when it still posts to Sales Tax), the history of clearing windows, the clearing and Sales Tax accounts, how many settlement or payout tax codes still need review (with the facilitator codes still mapped to Sales Tax, which must be re-pointed before adopting), the accounts a repair counter leg or the clearing account may use, the channels classified as marketplace facilitator and those still unclassified, whether adopting or repairing is possible right now (and why not), a 12-month impact summary, the locked-period policy and the active lock date.

Required scope: accounting:read

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

Accounting provider: accounting_provider is "Xero" or "QuickBooks Online" when one is connected, otherwise null. With a provider, clearing_account.linked_to_provider and each clearing_account_options[].linked_to_provider say whether the account is linked to a provider account (null without a provider); only linked accounts can be picked when adopting, because postings to an unlinked account can't sync. suggested_clearing_account.create_in_provider is true when adopting will also create the suggested account in the provider, and clearing_account_provider_note explains what adopting does there (null when nothing needs doing). impact_summary.draft_only_tax is facilitator tax that sits only on SKU drafts the provider never received; it is not counted in posted_to_sales_tax and there is nothing to repair for it.

Amounts are in the base currency.

Authentication: Requires Bearer token. Open to API tokens with the accounting:read scope.

Request​

Responses​

OK

Response Headers
    Content-Type