API Reference
  1. Report

Report

get
https://staging-api.tyms.io/api/v1/report

This resource contains the endpoints needed to retrieve statement reports.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
required
Defaults to income_statement

This is the type of statement report you want to extract.

Allowed:
date
required
Defaults to 2025-01-01
date
required
Defaults to 2025-12-31
string
enum
required
Defaults to monthly

This is a grouping sequence to of your report

Allowed:
string
enum
required
Defaults to last_year

This is the timeline to compare for records against. Currently we only support comparism aginst the previous year.

Allowed:
Headers
string
Defaults to {{secret-key}}
Responses

Updated 9 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 months ago