POST
/
v0
/
receivable-adjustments
Create Receivable Adjustment
curl --request POST \
  --url https://api.sandbox.teal.dev/v0/receivable-adjustments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'teal-instance-id: <teal-instance-id>' \
  --data '{
  "receivable_line_id": "8Qr7YJtqo2YYux7yUduRa4",
  "description": "Veterinarian Consultation",
  "datetime": "2023-11-07T05:31:56Z",
  "amount": 137.54,
  "metadata": {}
}'
{
  "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
​
receivable_line_id
string
required
Examples:

"8Qr7YJtqo2YYux7yUduRa4"

​
description
string
required
Examples:

"Veterinarian Consultation"

​
datetime
string<date-time>
required

The datetime that the receivable was adjusted.

​
amount
required

The amount to adjust the line.

Examples:

137.54

​
metadata
object | null

Any metadata that you would like to associate with the adjustment.

Response

Successful Response

​
id
string
required
Examples:

"8Qr7YJtqo2YYux7yUduRa4"

​
receivable_line_id
string
required

The receivable line to adjust.

Examples:

"8Qr7YJtqo2YYux7yUduRa4"

​
description
string
required

The description of the adjustment.

Examples:

"Partial Refund"

​
datetime
string<date-time>
required

The datetime that that the receivable was adjusted.

​
amount
number
required

The amount to adjust the line.

Examples:

137.54

​
metadata
object | null

Metadata associated with the adjustment.

​
files
ReceivableAdjustmentFile · object[] | null

The files associated with the adjustment.