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 '{
  "datetime": "2023-11-07T05:31:56Z",
  "due_datetime": "2023-11-07T05:31:56Z",
  "id": "INV-001",
  "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": {}
}

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

Path Parameters

ar_ledger_id
string
required

The AR ledger ID

Body

application/json
datetime
string
required

The datetime that the receivable was created.

due_datetime
string
required

The datetime that the receivable is due.

id
string
required

The ID of the receivable. Must be unique per ledger.

lines
object[]
required

The line items of the receivable.

metadata
object | null

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

Response

201 - application/json
id
string
required
ledger_id
string
required
datetime
string
required

The datetime that the invoice was created.

due_datetime
string
required

The datetime that the invoice is due.

metadata
object | null

Metadata associated with the receivable.