Get Storefront Accounting Settings
GET/api/storefront/:integrationInstance/finance-settings
Gets how one store books its revenue: per order, or per Stripe payout, and the accounts payouts post to.
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token. Open to API tokens with the accounting:read scope.
Fields:
accounting_sync_mode:per_order(each order's own invoice and payment, the default) orper_payout(the store's revenue is booked from its processor payouts).payout_processors: the processors whose payouts book revenue in per-payout mode (stripe — PayPal has no payouts; its orders are always booked per order). Orders paid any other way keep their per-order documents.payout_accounting_start_date(Y-m-d or null): payouts arriving before it are listed but never post; orders before it keep their per-order documents.payout_deposit_nominal_code_ids: per processor, the bank or clearing account its payouts land in (null = not set; a payout then posts its documents but its deposit waits).processor_fee_nominal_code_ids:{paypal: id}— the expense account the fee PayPal keeps on each payment posts to (null = the merchant-fee account). PayPal has no payouts: its balance is a bank account in the books, each PayPal order is a deposit into it (booked per order), and each payment's fee posts as its own entry (Dr this account / Cr the PayPal account), synced as Spend Money in Xero or a Purchase in QuickBooks.shared_account_owner: when one processor account serves several stores,"<provider>:<account id>"→ the integration instance ID of the store that books its payouts.shared_accountslists those accounts with the stores reporting them and the current owner.available_processors: the payout processors this store has taken money through or reported payouts for.processors_with_payouts: the processors this store already has payouts from. Their deposit accounts stay in force (and editable) even when they are no longer inpayout_processors, because their existing payouts' deposits still post to them.payout_sync_error: the last processor permission the store reported missing (provider,permission,message,at), or null.fallback_settings: per processor, the accounts used for a line type that has no mapped account (see Get Storefront Payout Fallback Settings).
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.