Teal API Endpoints
- Categorization
- Chart of Accounts Templates
- Instances
- Journal Entries
- Ledgers
- Line Entries
- Payables
- Platform
- Quickbooks
- Receivables
- Reports
- Tags
- Transaction Sources
- Transactions
- Transfers
API Migration
- Migration Guides
- Deprecated Endpoints
Get Receivable
Gets a receivable.
curl --request GET \
--url https://api.sandbox.teal.dev/v0/ledgers/{ar_ledger_id}/receivables/{receivable_id} \
--header 'Authorization: Bearer <token>' \
--header 'teal-instance-id: <teal-instance-id>'
{
"id": "INV-001",
"ledger_id": "CNmWM3X6AcvRdEwZKxq4bL",
"datetime": "2023-11-07T05:31:56Z",
"due_datetime": "2023-11-07T05:31:56Z",
"metadata": {},
"lines": [
{
"id": "CNmWM3X6AcvRdEwZKxq4bL",
"ledger_id": "CNmWM3X6AcvRdEwZKxq4bL",
"tags": [
{
"id": "UjL3BQnEaJtecuC7CUeDk",
"name": "Sprinter - 1ab-c23",
"tag_group_id": "NCB2xo5S1yQbNgyWskXpwG"
}
],
"description": "Veterinarian Consultation",
"amount": 10237.23,
"adjusted_amount": 328.13,
"adjustments": [
{
"id": "8Qr7YJtqo2YYux7yUduRa4",
"receivable_line_id": "8Qr7YJtqo2YYux7yUduRa4",
"description": "Partial Refund",
"datetime": "2023-11-07T05:31:56Z",
"amount": 137.54,
"metadata": {},
"files": [
{
"id": "CNmWM3X6AcvRdEwZKxq4bL",
"file_name": "credit.pdf"
}
]
}
]
}
],
"files": [
{
"id": "CNmWM3X6AcvRdEwZKxq4bL",
"file_name": "invoice.pdf"
}
]
}
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
The Teal instance ID
Path Parameters
The Receivable ID
The AR ledger ID
Response
"INV-001"
"CNmWM3X6AcvRdEwZKxq4bL"
The datetime that the invoice was created.
The datetime that the invoice is due.
Expandable. The line items of the receivable.
"CNmWM3X6AcvRdEwZKxq4bL"
"CNmWM3X6AcvRdEwZKxq4bL"
"Veterinarian Consultation"
The original amount of the receivable line.
10237.23
The amount of the receivable line after adjustments.
328.13
The adjustments made to the receivable line.
"8Qr7YJtqo2YYux7yUduRa4"
The receivable line to adjust.
"8Qr7YJtqo2YYux7yUduRa4"
The description of the adjustment.
"Partial Refund"
The datetime that that the receivable was adjusted.
The amount to adjust the line.
137.54
Metadata associated with the adjustment.
The tag ids of the tags associated with this receivable line.
The unique ID of the object.
"UjL3BQnEaJtecuC7CUeDk"
An arbitrary string, useful for identifying the tag to the user.
"Sprinter - 1ab-c23"
The ID of the tag group.
"NCB2xo5S1yQbNgyWskXpwG"
curl --request GET \
--url https://api.sandbox.teal.dev/v0/ledgers/{ar_ledger_id}/receivables/{receivable_id} \
--header 'Authorization: Bearer <token>' \
--header 'teal-instance-id: <teal-instance-id>'
{
"id": "INV-001",
"ledger_id": "CNmWM3X6AcvRdEwZKxq4bL",
"datetime": "2023-11-07T05:31:56Z",
"due_datetime": "2023-11-07T05:31:56Z",
"metadata": {},
"lines": [
{
"id": "CNmWM3X6AcvRdEwZKxq4bL",
"ledger_id": "CNmWM3X6AcvRdEwZKxq4bL",
"tags": [
{
"id": "UjL3BQnEaJtecuC7CUeDk",
"name": "Sprinter - 1ab-c23",
"tag_group_id": "NCB2xo5S1yQbNgyWskXpwG"
}
],
"description": "Veterinarian Consultation",
"amount": 10237.23,
"adjusted_amount": 328.13,
"adjustments": [
{
"id": "8Qr7YJtqo2YYux7yUduRa4",
"receivable_line_id": "8Qr7YJtqo2YYux7yUduRa4",
"description": "Partial Refund",
"datetime": "2023-11-07T05:31:56Z",
"amount": 137.54,
"metadata": {},
"files": [
{
"id": "CNmWM3X6AcvRdEwZKxq4bL",
"file_name": "credit.pdf"
}
]
}
]
}
],
"files": [
{
"id": "CNmWM3X6AcvRdEwZKxq4bL",
"file_name": "invoice.pdf"
}
]
}