General Ledger Report
Available Filters
Filter Type | Name | Field | Description |
---|---|---|---|
between | start_date | date | created during or after the given date |
between | end_date | date | created during or before the given date |
Equals | currency_code | string | reports using the given currency as primary currency |
Equals | accountid | uuid | Filter by specific Account |
Equals | locale | string | Language to show on report |
Get General Ledger Report
#Request
curl --location --request GET 'https://api.freshbooks.com/accounting/businesses/{business_uuid}/reports/general_ledger' \
--header 'Authorization: Bearer <SET BEARER TOKEN>'
#Response
{
"response": {
"result": {
"general_ledger": {
"company_name": "<company name>",
"download_token": "<download token>",
"start_date": "2023-01-01",
"end_date": "2023-12-31",
"currency_code": "USD",
"locale": "en",
"summary_only": false,
"summary": {
"total_credit": {
"amount": "1945.00",
"code": "USD"
}
},
"data": [
{
"accountid": "2a990740-40d6-4529-a604-be0d68cf9d90",
"account_name": "Cash",
"account_number": "1000",
"debit": {
"amount": "1355.00",
"code": "USD"
},
"credit": {
"amount": "430.00",
"code": "USD"
},
"net_movement_debit": {
"amount": "925.00",
"code": "USD"
},
"net_movement_credit": {
"amount": "0.00",
"code": "USD"
},
"sub_accounts": [
{
"sub_accountid": "2a990740-40d6-4529-a604-be0d68cf9d90",
"sub_account_name": "Cash (general)",
"sub_account_number": "1000",
"debit": {
"amount": "75.00",
"code": "USD"
},
"credit": {
"amount": "100.00",
"code": "USD"
},
"net_movement_debit": {
"amount": "0.00",
"code": "USD"
},
"net_movement_credit": {
"amount": "25.00",
"code": "USD"
},
"transactions": [
{
"entity_type": "adjustment",
"reference": "example adjustment",
"description": "example adjustment description",
"date": "2023-06-01",
"client_name": null,
"debit": {
"amount": "25.00",
"code": "USD"
},
"credit": {
"amount": "0.00",
"code": "USD"
},
"expenseid": null,
"invoiceid": null,
"paymentid": null,
"incomeid": null,
"creditid": null,
"clientid": null,
"billid": null,
"bill_paymentid": null
},
{
"entity_type": "adjustment",
"reference": "example adjustment",
"description": "example adjustment description",
"date": "2023-06-01",
"client_name": null,
"debit": {
"amount": "25.00",
"code": "USD"
},
"credit": {
"amount": "0.00",
"code": "USD"
},
"expenseid": null,
"invoiceid": null,
"paymentid": null,
"incomeid": null,
"creditid": null,
"clientid": null,
"billid": null,
"bill_paymentid": null
},
< ... more transactions data ... >
],
"account_type": "asset",
"account_sub_type": "Cash & Bank"
},
< ... more sub_accounts data ...>
],
"account_type": "asset",
"account_sub_type": "Cash & Bank"
},
< ... more accounts data ... >
]
}
}
}
}
Example General Ledger with report filters
#Request
curl --location --request GET 'https://api.freshbooks.com/accounting/businesses/{business_uuid}/reports/general_ledger?start_date=2023-02-01&end_date=2023-02-28¤cy_code=CAD&locale=en' \
--header 'Authorization: Bearer <SET BEARER TOKEN>'