Skip to main content

Get Facilitator Tax Impact Report

GET 

/api/ledger/facilitator-tax/impact

Gets the marketplace-facilitator tax tie-out report: one row per channel and month with the facilitator tax on that channel's orders, the tax those orders' invoices and credits posted to Sales Tax, the facilitator tax the channel's settlements report and the accounts those settlement codes landed on, the variance between orders and settlements, what has already been repaired, and the proposed reclass entries still owed.

Required scope: accounting:read

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

Row fields:

  • order_facilitator_tax: tax on the channel's marketplace-facilitator orders (invoices less credits).
  • posted_to_sales_tax: net credit those documents left on Sales Tax. With Xero or QuickBooks connected, only entries the provider holds count (posted, linked to a provider document, imported from it, or in a batch the provider received); without a provider every live SKU entry counts.
  • draft_only_tax: with a provider connected, the same Sales Tax credit on SKU drafts the provider never received (for example per-order invoices of a channel whose invoice sync is off). It is not in the provider's books, so nothing is proposed for it. Always 0 without a provider.
  • settlement_facilitator_tax / settlement_destinations: the facilitator tax in the channel's settlements, and the signed net credit it left on each account (positive = credited, negative = debited).
  • variance: order_facilitator_tax minus settlement_facilitator_tax (0 when the channel posts no settlements).
  • repaired: reclass already booked for the row.
  • proposed_reclass: debit/credit account pairs still owed, each with Sales Tax on one side; proposed_reclass_total includes the counter amount.
  • needs_counter_account / counter_amount: tax credited to Sales Tax that no settlement code accounts for; it must be moved to the account the channel's payments deposited to (positive = debit Sales Tax, credit the counter account). suggested_counter_account is offered when the channel's payment type maps one.
  • unpaid_residue: the signed part of the counter residue no cash settled, left in Sales Tax and never posted. Each invoice is weighed by the payments applied to it (converted at each payment's own rate); each credit note by the refunds paid out on it. Positive = tax on invoices still unpaid (it sits in Accounts Receivable); negative = refunded tax on credit notes no refund was paid out on (for example a credit that only offset an unpaid invoice). Re-run the repair once the invoice is paid or the refund goes out. Only cash the accounting provider accepted counts: a payment applied there (linked to its provider payment, no sync error) or one pulled from it; a payment still waiting to push or rejected by the provider counts as unpaid.
  • incomplete_settlement_tax / incomplete_settlement_tax_reason: a settlement in the month carries a classified withheld (remitted) tax code beside a buyer-tax code that could not be classified, so the collected leg it offsets is unknown. Nothing is proposed for the row and the repair skips it (outcome needs_review) until the code is classified.
  • period_locked: the month is on or before the lock date.

Top-level totals sums the rows (including draft_only_tax; periods_affected counts the months that still need a repair) and currency is the base currency code.

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

Request​

Responses​

OK

Response Headers
    Content-Type