× FreshBooks App Logo
FreshBooks
Official App
Free - Google Play
Get it
You're currently on our US site. Select your regional site here:

Account Aging Report

The Account Aging Report shows details regarding overdue invoices from clients

Access Requirements

AccessRequires Authorization
Scopesuser:reports:read

Available Filters

Filter TypeNameFieldDescription
betweenstart_datedatecreated during or after the given date
Equalscurrency_codestringreports using the given currency as primary currency

Field Descriptions

FieldTypeDescription
totalsobjectsubfields: intervals (0-30, 31-60, 61-90, 91+). Each interval represents the amount due from overdue invoices.
interval(x)’sobjectsubfields: amount, code
amountstringthe amount of money paid or owed
codestringthe currency that the amount is in
download_tokenstringthe download token allows you to download the report into a csv file
accountsarrayholds client objects
useridintunique id for the client
lnamestringthe last name of the client
fnamestringthe first name of the client
organizationstringthe organization the client belongs to
emailstringthe email belonging to the client
company_namestringthe company that the report refers to
currency_codestringthree-letter currency code for overdue payments
end_datedatethe 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"