Cash flow statement

curl --request GET \
  --url https://api.useadam.io/v1/adam/reports/cash-flow-statement \
  --header 'X-API-Key: <api-key>'

{
  "status": "success",
  "message": "Cash flow statement generated successfully",
  "data": {
    "headings": [
      {
        "label": "Operating activities",
        "level": 1
      }
    ],
    "content": [],
    "totals": {
      "net_change_in_cash": 1500
    }
  },
  "meta": {
    "from": "2024-01-01",
    "to": "2024-03-31",
    "previous_period_end": "2023-12-31"
  }
}

GET

https://api.useadam.io/v1/adam

reports

cash-flow-statement

Cash flow statement

curl --request GET \
  --url https://api.useadam.io/v1/adam/reports/cash-flow-statement \
  --header 'X-API-Key: <api-key>'

{
  "status": "success",
  "message": "Cash flow statement generated successfully",
  "data": {
    "headings": [
      {
        "label": "Operating activities",
        "level": 1
      }
    ],
    "content": [],
    "totals": {
      "net_change_in_cash": 1500
    }
  },
  "meta": {
    "from": "2024-01-01",
    "to": "2024-03-31",
    "previous_period_end": "2023-12-31"
  }
}

Authorizations

X-API-Key

string

header

default:your_tyms_sk_or_partner_key

required

Business secret tyms_sk_... for all routes except Register business, which expects your partner secret.

Query Parameters

from_date

string<date>

to_date

string<date>

from

string

currency

string

transaction_type

string

contact

string

employee

string

creator

string

department

string

branch

string

project

string

account

string

cut_off_date

string

Response

200 - application/json

Indirect-style cash flow; meta.previous_period_end when present

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.