Skip to main content

List Payout Type Mappings

GET 

/api/tiktok-shop/:integrationInstance/payout-type-mappings

List the payout line types for a connection, the connection's own overrides beating the global rows for the same line type.

Required scope: accounting:read

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

Filter by mapping group with filter[mapping_group_id] (a group ID; operator forms such as filter[mapping_group_id.is_one_of]=2,5 work too). filter[search] matches transaction type, amount type, transaction description and financial code; a number also matches the mapping ID exactly, and search_columns=id restricts the search to the ID. Also supports filter[mapping_status] (mapped / unmapped), filter[group_status] (assigned / unassigned), filter[typical_amount_sign], filter[transaction_type], filter[amount_type], filter[transaction_description], filter[financial_code], filter[created_at.*] and filter[updated_at.*]; pagination defaults to 10 per page. Allowed sorts: id, transaction_type, amount_type, financial_code, created_at (default financial_code).

Request​

Responses​

OK

Response Headers
    Content-Type