GET
/
v0
/
reports
/
receivable-balances
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/reports/receivable-balances \
  --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": 123
    }
  ],
  "unassigned_balance": 123,
  "total_balance": 123
}

Authorizations

Authorization
string
headerrequired

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
tag_balances
object[]
required

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

unassigned_balance
number
required

Balance owed that is not assigned to a tag.

total_balance
number
required

The total balance owed.