Skip to main content
GET
Contact statement

Authorizations

X-API-Key
string
header
default:your_tyms_sk_or_partner_key
required

Business secret tyms_sk_... for business-scoped routes. Partner secret for register-business and referred-business distributor routes.

Path Parameters

uuid
string
required

Contact uuid.

Query Parameters

from
string<date>

Period start date (Y-m-d). Alias: from_date.

from_date
string<date>

Alias for from.

to
string<date>

Period end date (Y-m-d). Alias: to_date.

to_date
string<date>

Alias for to.

list
enum<integer>

Pass 1 to return raw data only without the status/message wrapper.

Available options:
1

Response

Contact statement with running balances

status
string
required
Example:

"success"

message
string
required
data
any

Single resource, array of resources, statement sections, or async job metadata — see each operation's example.

meta
object

Pagination (page, limit, total) and/or report range (from, to). Cash flow may include previous_period_end.