Skip to main content

List Payout Type Mappings

GET 
/api/shopify/:integrationInstance/payout-type-mappings

Returns the resolved payout type mappings for the integration instance: per-instance override rows plus the global default rows they have not overridden. Each row maps a financial code (a normalized type / source / reason combination from Shopify Payments balance transactions) to a general-ledger account and an optional mapping group; is_override indicates an instance-specific row. Before listing, any financial codes newly seen in the instance's synced balance transactions are registered as unmapped global rows so they can be configured.

Not yet available to API tokens

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

Authentication: Requires Bearer token.

Filterable columns: type, source_type, reason, financial_code, typical_amount_sign, mapping_status (mapped/unmapped), group_status (assigned/unassigned) (text), created_at, updated_at (datetime). filter[search] matches type, source type, reason, and financial code.

Filtering: pass filter[column]=value for an exact match, or filter[column.operator]=value with operators such as contains, does_not_contain, is, is_not, is_one_of, starts_with, ends_with, is_empty, is_not_empty (text), greater_than, less_than, greater_than_or_equal, less_than_or_equal, between (numeric), and is, is_not, before, after, on_or_before, on_or_after, between, today, yesterday, past_week, past_month, past_year, days_ago, past_days (date/datetime). Complex AND/OR trees can be sent as a base64-encoded JSON tree in the filter_groups parameter.

Allowed sorts: type, source_type, financial_code, created_at (prefix with - for descending; default financial_code). Pagination defaults to 10 per page.

Request​

Responses​

OK

Response Headers
    Content-Type