Skip to main content
GET
/
reports
/
income-statement
Income statement
curl --request GET \
  --url https://api.usetyms.com/v1/adam/reports/income-statement \
  --header 'X-API-Key: <api-key>'
import requests

url = "https://api.usetyms.com/v1/adam/reports/income-statement"

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://api.usetyms.com/v1/adam/reports/income-statement', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
{
  "status": "success",
  "message": "Income statement generated successfully",
  "data": {
    "headings": [
      {
        "label": "Revenue",
        "level": 1
      }
    ],
    "content": [
      {
        "label": "Sales",
        "amount": 12500.5,
        "children": []
      }
    ],
    "totals": {
      "net_income": 4200
    }
  },
  "meta": {
    "from": "2024-01-01",
    "to": "2024-03-31"
  }
}

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.

Query Parameters

from_date
string<date>
to_date
string<date>
from
string
to
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

Profit and loss (same basis as in-app reports)

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.