Contact statement
curl --request GET \
--url https://staging-api.usetyms.com/v1/adam/reports/contact-statement/{uuid} \
--header 'X-API-Key: <api-key>'import requests
url = "https://staging-api.usetyms.com/v1/adam/reports/contact-statement/{uuid}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://staging-api.usetyms.com/v1/adam/reports/contact-statement/{uuid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "success",
"message": "Customer statement retrieved successfully",
"data": {
"opening_balance": 25000,
"closing_balance": 125000,
"total_charges": 150000,
"total_payments": 50000,
"currency": "NGN",
"statement": [
{
"uuid": "st444444444444444444444444444444",
"transaction_type": "sales",
"type": "record",
"date": "2026-03-01T00:00:00.000000Z",
"transaction_no": "INV-1042",
"narration": "Website design services — March",
"charges": 150000,
"payment": 0,
"opening_balance": 25000,
"closing_balance": 175000,
"currency": "NGN"
}
]
}
}{
"status": "failed",
"message": "<string>"
}Reports
Contact statement
Customer or vendor account statement. Returns opening balance, closing balance, total charges, total payments, and each movement (invoice, bill, payment) with running balance. Used for portal statements and collections.
GET
/
reports
/
contact-statement
/
{uuid}
Contact statement
curl --request GET \
--url https://staging-api.usetyms.com/v1/adam/reports/contact-statement/{uuid} \
--header 'X-API-Key: <api-key>'import requests
url = "https://staging-api.usetyms.com/v1/adam/reports/contact-statement/{uuid}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://staging-api.usetyms.com/v1/adam/reports/contact-statement/{uuid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "success",
"message": "Customer statement retrieved successfully",
"data": {
"opening_balance": 25000,
"closing_balance": 125000,
"total_charges": 150000,
"total_payments": 50000,
"currency": "NGN",
"statement": [
{
"uuid": "st444444444444444444444444444444",
"transaction_type": "sales",
"type": "record",
"date": "2026-03-01T00:00:00.000000Z",
"transaction_no": "INV-1042",
"narration": "Website design services — March",
"charges": 150000,
"payment": 0,
"opening_balance": 25000,
"closing_balance": 175000,
"currency": "NGN"
}
]
}
}{
"status": "failed",
"message": "<string>"
}Authorizations
Business secret tyms_sk_... for business-scoped routes. Partner secret for register-business and referred-business distributor routes.
Path Parameters
Contact uuid.
Query Parameters
Period start date (Y-m-d). Alias: from_date.
Alias for from.
Period end date (Y-m-d). Alias: to_date.
Alias for to.
Pass 1 to return raw data only without the status/message wrapper.
Available options:
1 Response
Contact statement with running balances