POST
/
v0
/
receivable-adjustments
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
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

Body

application/json
receivable_line_id
string
required
description
string
required
datetime
string
required

The datetime that the receivable was adjusted.

amount
required

The amount to adjust the line.

metadata
object | null

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

Response

201 - application/json
id
string
required
receivable_line_id
string
required

The receivable line to adjust.

description
string
required

The description of the adjustment.

datetime
string
required

The datetime that that the receivable was adjusted.

amount
number
required

The amount to adjust the line.

metadata
object | null

Metadata associated with the adjustment.

files
object[] | null

The files associated with the adjustment.