GET
/
v0
/
reports
/
receivable-aging
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/reports/receivable-aging \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'
{
  "tag_balances": [
    {
      "tag": {
        "id": "UjL3BQnEaJtecuC7CUeDk",
        "name": "Sprinter - 1ab-c23",
        "tag_group_id": "NCB2xo5S1yQbNgyWskXpwG"
      },
      "balance": {
        "total": 123,
        "current": 123,
        "overdue_1_30": 123,
        "overdue_31_60": 123,
        "overdue_61_90": 123,
        "overdue_91": 123
      }
    }
  ],
  "unassigned_balances": {
    "total": 123,
    "current": 123,
    "overdue_1_30": 123,
    "overdue_31_60": 123,
    "overdue_61_90": 123,
    "overdue_91": 123
  },
  "total_balances": {
    "total": 123,
    "current": 123,
    "overdue_1_30": 123,
    "overdue_31_60": 123,
    "overdue_61_90": 123,
    "overdue_91": 123
  },
  "overdue_balance": 123
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
teal-instance-id
string
required

The Teal instance ID

Query Parameters

​
ledger_id
string
required

The AR ledger ID

​
date
string
required

The date for the report

​
tag_group_id
string
required

The tag group ID used as payment criteria

Response

200
application/json
Successful Response
​
tag_balances
object[]
required

List of balances owed for each tag in the tag group by period.

​
unassigned_balances
object
required

Balances owed that are not assigned to a tag by period.

​
total_balances
object
required

The total balances owed by period.

​
overdue_balance
number
required

The total balance that is owed and overdue.

Delete Receivable Adjustment FileGet Receivables Balances