Skip to main content

List Channel Sync Explanations

GET 
/api/ledger/settings/channel-sync

What reaches the accounting system (QuickBooks Online or Xero) from every sales channel: the combined result of the connection, Sync by Transaction Type, Batching, each channel's own invoice and credit switches, the unpaid-orders rule and, for Shopify and eBay, the payout mode — per kind of document, with the settings that decided it.

Not yet available to API tokens

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

Authentication: Requires Bearer token.

Outcomes (verdicts[].outcome): auto sent automatically · held sent once the order is paid · manual only sent with Sync Now · payout carried by the channel's payout documents · never not sent (left out, or not used in this mode) · blocked nothing can be sent (no or broken connection, or record generation paused).

Steps (verdicts[].steps[]) are the settings in the order they apply. state: pass lets it through · stop stops it, even Sync Now · manual turns automatic sending off (Sync Now still sends) · hold waits for payment · info context only. link is the app path of the screen that changes the setting (null when it is edited on Channel Accounting itself).

Kinds (verdicts[].kind): invoices, credits, paid_orders / unpaid_orders (Shopify and eBay in per-payout mode), payouts (Shopify and eBay), settlements (Amazon).

Conflicts list settings that currently do nothing because a stronger setting wins (winner).

The account-wide type_toggles cover invoices, credits and bills; batching is the account-wide default granularity (off, per_document, daily, monthly). connection is null when no accounting system is connected.

Request​

Responses​

OK

Response Headers
    Content-Type