Receivables
Create Receivable
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
Receivables
Create Receivable
Creates a receivable.
POST
/
v0
/
ledgers
/
{ar_ledger_id}
/
receivables
curl --request POST \
--url https://api.sandbox.teal.dev/v0/ledgers/{ar_ledger_id}/receivables \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'teal-instance-id: <teal-instance-id>' \
--data '{
"id": "INV-001",
"datetime": "2023-11-07T05:31:56Z",
"due_datetime": "2023-11-07T05:31:56Z",
"lines": [
{
"ledger_id": "CNmWM3X6AcvRdEwZKxq4bL",
"tag_ids": [
"<string>"
],
"description": "Veterinarian Consultation",
"amount": 10237.23
}
],
"metadata": {}
}'
{
"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
An optional identifier for audit logging.
Path Parameters
The AR ledger ID
Body
application/json
Response
201
application/json
Successful Response
The response is of type object
.
curl --request POST \
--url https://api.sandbox.teal.dev/v0/ledgers/{ar_ledger_id}/receivables \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'teal-instance-id: <teal-instance-id>' \
--data '{
"id": "INV-001",
"datetime": "2023-11-07T05:31:56Z",
"due_datetime": "2023-11-07T05:31:56Z",
"lines": [
{
"ledger_id": "CNmWM3X6AcvRdEwZKxq4bL",
"tag_ids": [
"<string>"
],
"description": "Veterinarian Consultation",
"amount": 10237.23
}
],
"metadata": {}
}'
{
"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"
}
]
}