Reports
Get Ledger Statement
Get a ledger statement for the instance, containing the opening/closing balances with line entries for the period.
GET
/
v0
/
reports
/
ledger-statement
Authorization
Header
Query
curl --request GET \
--url https://api.sandbox.teal.dev/v0/reports/ledger-statement \
--header 'Authorization: <authorization>' \
--header 'teal-instance-id: <teal-instance-id>'
{
"ledger_statement": {
"amount": 1328.28,
"closing_balance": 4165.56,
"debit_credit": "debit",
"end_date": "2022-03-31",
"ledger_id": "2SkTUgtBTy86PHLyiUCdeD",
"lines": [],
"name": "Salaries And Wages Expense",
"opening_balance": 2837.28,
"start_date": "2022-01-01",
"sub_type": "operating_expenses",
"type": "expense"
},
"next_page_token": "<string>",
"prev_page_token": "<string>"
}
Authorizations
Authorization
string
headerrequiredThe access token received from the authorization server in the OAuth 2.0 flow.
Headers
teal-instance-id
string
requiredThe Teal instance ID
Query Parameters
ledger_id
string
requiredThe ledger ID
start_date
string
requiredThe start date of the ledger statement, inclusive
end_date
string
requiredThe end date of the ledger statement, inclusive
limit
integer | null
The number of records to return. Max limit is 100.
page_token
string
Response
200 - application/json
ledger_statement
object
requirednext_page_token
string | null
requiredThe token to use to request the next page
prev_page_token
string | null
requiredThe token to use to request the previous page
curl --request GET \
--url https://api.sandbox.teal.dev/v0/reports/ledger-statement \
--header 'Authorization: <authorization>' \
--header 'teal-instance-id: <teal-instance-id>'
{
"ledger_statement": {
"amount": 1328.28,
"closing_balance": 4165.56,
"debit_credit": "debit",
"end_date": "2022-03-31",
"ledger_id": "2SkTUgtBTy86PHLyiUCdeD",
"lines": [],
"name": "Salaries And Wages Expense",
"opening_balance": 2837.28,
"start_date": "2022-01-01",
"sub_type": "operating_expenses",
"type": "expense"
},
"next_page_token": "<string>",
"prev_page_token": "<string>"
}