Sign in
Finance

Settlement statements in a window

TikTok's daily settlement statements for the shop, newest first: what was settled, what fees and adjustments were taken, and whether the payout is PAID, PROCESSING or FAILED. Windowed by statement date (UTC). Sums are per currency over the whole window, before paging. Read data_status before trusting an empty page: scope_missing means the shop's TikTok authorization lacks the finance scope.

post/finance/statements

Request body

start_datestring date nullable

Inclusive statement-date window start (UTC). Defaults to 29 days before end_date.

end_datestring date nullable

Inclusive statement-date window end (UTC). Defaults to yesterday.

payment_status'PAID' | 'PROCESSING' | 'FAILED' nullable

Only statements whose payout is in this state.

limitinteger

Page size.

offsetinteger

Page offset; narrow the window instead of paging deeper.

Response

Successful Response

shop_idinteger required
tts_shop_idstring required
start_datestring required
end_datestring required
currenciesstring[] required

Currencies present in the whole window, before paging.

total_settlement_by_currencyobject required

Sum of settlement_amount over the whole window, per currency, before paging.

Changes

Changed in 1 of the 29 revisions of this API.1

Of the 29 revisions, 1 has no diff computed.