POST
/
v0
/
receivable-lines
curl --request POST \
  --url https://api.sandbox.teal.dev/v0/receivable-lines \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'teal-instance-id: <teal-instance-id>' \
  --data '{
  "ledger_id": "CNmWM3X6AcvRdEwZKxq4bL",
  "tag_ids": [
    "<string>"
  ],
  "description": "Veterinarian Consultation",
  "amount": 10237.23,
  "ar_ledger_id": "148WgMMyvNczuK8mjJrt6W",
  "receivable_id": "8Qr7YJtqo2YYux7yUduRa4"
}'
{
  "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"
        }
      ]
    }
  ]
}

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

​
modified-by
string | null

An optional identifier for audit logging.

Body

application/json
​
ledger_id
string
required
Example:

"CNmWM3X6AcvRdEwZKxq4bL"

​
description
string
required
Example:

"Veterinarian Consultation"

​
amount
required

The amount of the receivable line.

Example:

10237.23

​
ar_ledger_id
string
required
Example:

"148WgMMyvNczuK8mjJrt6W"

​
receivable_id
string
required
Example:

"8Qr7YJtqo2YYux7yUduRa4"

​
tag_ids
string[] | null

The tag ids of the tags associated with this receivable line.

Response

201
application/json
Successful Response
​
id
string
required
Example:

"CNmWM3X6AcvRdEwZKxq4bL"

​
ledger_id
string
required
Example:

"CNmWM3X6AcvRdEwZKxq4bL"

​
description
string
required
Example:

"Veterinarian Consultation"

​
amount
number
required

The original amount of the receivable line.

Example:

10237.23

​
adjusted_amount
number
required

The amount of the receivable line after adjustments.

Example:

328.13

​
adjustments
object[] | null
required

The adjustments made to the receivable line.

​
tags
object[] | null

The tag ids of the tags associated with this receivable line.

Get Receivable StatusUpdate Receivable Line