Get Statements

Retrieves the statements generated for a shop and the key statement information based on a specified date range or their payment status. Use this API to get an overview of your daily statements over a range of time, or to find out which statements have been paid or not. For the detailed transactions, refer to Get Statement Transactions or Get Order Statement Transactions. Applicable for all regions' sellers. Only data after 2023-07-01 is available.

---

For common parameters, refer to How to call TikTok Shop APIs - Common Parameters

• PAID: Payment has been transferred to the seller.
• FAILED: Payment transfer failed.
• PROCESSING: Payment is currently being processed. Default: All statuses are returned. | page_size |int |N |20 |The number of results to be returned per page. Default: 20 Valid range: [1-100] | page_token |string |N |6AsPQsUMvH3RkchNUPPh22NROHkE0D8pmq/N5M1kHYcZmtRyv9aVrNv65W7Q6tFA+7D1ud64MPNz5OaT |An opaque token used to retrieve the next page of a paginated result set. Retrieve this value from the result of the next_page_token from a previous response. It is not needed for the first page. | sort_field |string |Y |statement_time |The returned results will be sorted by the specified field. Only supports statement_time. | sort_order |string |N |ASC |The sort order for the sort_field parameter. Default: ASC Possible values:
• ASC: Ascending order
• DESC: Descending order | statement_time_ge |int |N |1623812664 |Filter statements to show only those that are generated on or after the specified date and time. Unix timestamp.

Note: statement_time_ge and statement_time_le together constitute the creation time filter condition.

• If statement_time_ge is filled but statement_time_lt is empty, statement_time_lt will default to the current time.
• If statement_time_lt is filled but statement_time_ge is empty, statement_time_ge will default to the earliest shop time.

Example: As statements are generated daily at 00:00 UTC, to retrieve statements for the period from Oct 5 to Oct 10, configure the parameters as follows:

• Set statement_time_ge to 00:00 on Oct 6 or any time on Oct 5 (excluding 00:00).
• Set statement_time_lt to any time on Oct 11 (excluding 00:00). | sign |string |Y |5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c |Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. | timestamp |int |Y |1623812664 |Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |

Query

https://open-api.tiktokglobalshop.com/finance/202309/statements?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&statement_time_lt=1623812664&payment_status=PAID&page_size=20&page_token=6AsPQsUMvH3RkchNUPPh22NROHkE0D8pmq/N5M1kHYcZmtRyv9aVrNv65W7Q6tFA+7D1ud64MPNz5OaT&sort_field=statement_time&sort_order=ASC&statement_time_ge=1623812664

Possible values:

• PAID: Payment has been transferred to the seller.
• FAILED: Payment transfer failed.
• PROCESSING: Payment is currently being processed. | ^^payment_id |string |3459275187040258849 |The payment ID. | ^^net_sales_amount |string |-70 |The final revenue amount after seller discounts are deducted. Applicable only for local sellers outside the SEA region. | ^^shipping_cost_amount |string |-70 |The shipping fees. Applicable only for local sellers outside the SEA region. | ^^payment_time |int |1685548800 |The Unix payment timestamp |

{"code":0,"data":{"next_page_token":"6AsPQsUMvH3RkchNUPPh22NROHkE0D8pmq/N5M1kHYcZmtRyv9aVrNv65W7Q6tFA+7D1ud64MPNz5OaT","statements":[{"id":"7238804564097517339","statement_time":1685548800,"settlement_amount":"100","currency":"GBP","revenue_amount":"200","fee_amount":"-30","adjustment_amount":"-70","payment_status":"PAID","payment_id":"3459275187040258849","net_sales_amount":"-70","shipping_cost_amount":"-70","payment_time":1685548800}]},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}

For common error codes, refer to How to call TikTok Shop APIs - Common Error Code