Account Aging Report
The Account Aging Report shows details regarding overdue invoices from clients
Access Requirements
Access | Requires Authorization |
Scopes | user:reports:read |
Available Filters
Filter Type | Name | Field | Description |
---|---|---|---|
between | start_date | date | created during or after the given date |
Equals | currency_code | string | reports using the given currency as primary currency |
Field Descriptions
Field | Type | Description |
---|---|---|
totals | object | subfields: intervals (0-30 , 31-60 , 61-90 , 91+ ). Each interval represents the amount due from overdue invoices. |
interval(x)’s | object | subfields: amount , code |
amount | string | the amount of money paid or owed |
code | string | the currency that the amount is in |
download_token | string | the download token allows you to download the report into a csv file |
accounts | array | holds client objects |
userid | int | unique id for the client |
lname | string | the last name of the client |
fname | string | the first name of the client |
organization | string | the organization the client belongs to |
email | string | the email belonging to the client |
company_name | string | the company that the report refers to |
currency_code | string | three-letter currency code for overdue payments |
end_date | date | the ending date for the profit/loss report query |
Get Account Aging Report
#REQUEST
curl -X GET "https://api.freshbooks.com/accounting/account/<account_id>/reports/accounting/accounts_aging?start_date=2017-01-01&end_date=2017-12-31" \
-H "Authorization: Bearer <a token>"
-H "Api-Version: alpha"
#RESPONSE
{
"response": {
"result": {
"accounts_aging": {
"end_date": "2017-12-31",
"totals": {
"0-30": {
"amount": "0.00",
"code": "CAD"
},
"61-90": {
"amount": "0.00",
"code": "CAD"
},
"total": {
"amount": "0.00",
"code": "CAD"
},
"91+": {
"amount": "0.00",
"code": "CAD"
}, "31-60": {
"amount": "0.00",
"code": "CAD"
}
},
"download_token": āLots of Charactersā,
"accounts": [],
"company_name": "FB",
"currency_code": "CAD"
}
}
}
}
Search Example with Account Aging Report
curl -X GET 'https://api.freshbooks.com/accounting/account/<accountid>/reports/accounting/accounts_aging?end_date=2017-05-17' \
-H "Authorization: Bearer <a token>"
-H "Api-Version: alpha"