Get Payout Finance Settings
GET/api/shopify/:integrationInstance/payout-finance-settings
Returns the resolved payout finance settings for the integration instance: the fallback revenue and expense accounts used for unmapped payout lines, the clearing account payouts settle against, the accounting sync mode (per_order or per_payout; default per_order), and the optional payout accounting start date before which payouts are not posted. Fallback and clearing accounts fall back to the workspace-wide values when the instance has none of its own.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Unpaid orders (net-terms and other orders placed without payment), and the rare order paid outside Shopify Payments, never appear in a Shopify Payments payout:
- outside_payout_orders: invoice_per_order (each such order posts its own invoice and credits) or leave_out (they stay out of your books). The choice is recorded on each order when it is created, so changing it applies to new orders only. A store already in per-payout mode before this setting existed reads leave_out until it is changed.
- invoiced_order_payout_nominal_code_id: the clearing account a payout line posts to when it pays or refunds an order that was already invoiced per order, so its revenue is booked once. A payout that needs it is held until it is set.
- outside_payout_order_count_since_start: in per-payout mode, how many orders since the start date were paid outside Shopify Payments and left out of your books (payout_settlement left_out); otherwise 0.
- sales_channel_id: the instance's sales channel, for filtering sales orders (filter[sales_channel_id]).
Authentication: Requires Bearer token.
Also returns payout_entry_date, split_payouts_at_month_end and the four automatic-sync switches (see Update Payout Finance Settings), plus store_timezone (the Shopify store's timezone, null until the first payout sync) and tenant_timezone (the timezone payout dates are calculated in).
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.