Create Receivable

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": "<string>",
  "datetime": "2023-11-07T05:31:56Z",
  "due_datetime": "2023-11-07T05:31:56Z",
  "lines": [
    {
      "ledger_id": "<string>",
      "description": "<string>",
      "amount": 10237.23,
      "tag_ids": [
        "<string>"
      ]
    }
  ],
  "metadata": {}
}
'

{
  "id": "<string>",
  "ledger_id": "<string>",
  "datetime": "2023-11-07T05:31:56Z",
  "due_datetime": "2023-11-07T05:31:56Z",
  "lines": [
    {
      "id": "<string>",
      "ledger_id": "<string>",
      "description": "<string>",
      "amount": 123,
      "adjusted_amount": 123,
      "adjustments": [
        {
          "id": "<string>",
          "receivable_line_id": "<string>",
          "description": "<string>",
          "datetime": "2023-11-07T05:31:56Z",
          "amount": 123,
          "metadata": {},
          "files": [
            {
              "id": "<string>",
              "file_name": "credit.pdf"
            }
          ]
        }
      ],
      "tags": [
        {
          "id": "<string>",
          "name": "<string>",
          "tag_group_id": "<string>"
        }
      ]
    }
  ],
  "metadata": {},
  "files": [
    {
      "id": "<string>",
      "file_name": "invoice.pdf"
    }
  ]
}

POST

ledgers

{ar_ledger_id}

receivables

Create Receivable

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": "<string>",
  "datetime": "2023-11-07T05:31:56Z",
  "due_datetime": "2023-11-07T05:31:56Z",
  "lines": [
    {
      "ledger_id": "<string>",
      "description": "<string>",
      "amount": 10237.23,
      "tag_ids": [
        "<string>"
      ]
    }
  ],
  "metadata": {}
}
'

{
  "id": "<string>",
  "ledger_id": "<string>",
  "datetime": "2023-11-07T05:31:56Z",
  "due_datetime": "2023-11-07T05:31:56Z",
  "lines": [
    {
      "id": "<string>",
      "ledger_id": "<string>",
      "description": "<string>",
      "amount": 123,
      "adjusted_amount": 123,
      "adjustments": [
        {
          "id": "<string>",
          "receivable_line_id": "<string>",
          "description": "<string>",
          "datetime": "2023-11-07T05:31:56Z",
          "amount": 123,
          "metadata": {},
          "files": [
            {
              "id": "<string>",
              "file_name": "credit.pdf"
            }
          ]
        }
      ],
      "tags": [
        {
          "id": "<string>",
          "name": "<string>",
          "tag_group_id": "<string>"
        }
      ]
    }
  ],
  "metadata": {},
  "files": [
    {
      "id": "<string>",
      "file_name": "invoice.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.

Path Parameters

ar_ledger_id

string

required

The AR ledger ID

Body

application/json

string

required

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

Minimum string length: 1

datetime

string<date-time>

required

The datetime that the receivable was created.

due_datetime

string<date-time>

required

The datetime that the receivable is due.

lines

ReceivableLineCreate · object[]

required

The line items of the receivable.

Show child attributes

lines.ledger_id

string

required

lines.description

string

required

lines.amount

required

The amount of the receivable line.

Example:

10237.23

lines.tag_ids

string[] | null

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

metadata

Metadata · object

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

Show child attributes

metadata.{key}

string

Response

Successful Response

string

required

ledger_id

string

required

datetime

string<date-time>

required

The datetime that the invoice was created.

due_datetime

string<date-time>

required

The datetime that the invoice is due.

lines

ReceivableLine · object[] | null

required

Expandable. The line items of the receivable.

Show child attributes

lines.id

string

required

lines.ledger_id

string

required

lines.description

string

required

lines.amount

number

required

The original amount of the receivable line.

lines.adjusted_amount

number

required

The amount of the receivable line after adjustments.

lines.adjustments

ReceivableAdjustment · object[] | null

required

The adjustments made to the receivable line.

Show child attributes

lines.adjustments.id

string

required

lines.adjustments.receivable_line_id

string

required

The receivable line to adjust.

lines.adjustments.description

string

required

The description of the adjustment.

lines.adjustments.datetime

string<date-time>

required

The datetime that that the receivable was adjusted.

lines.adjustments.amount

number

required

The amount to adjust the line.

lines.adjustments.metadata

Metadata · object

Metadata associated with the adjustment.

Show child attributes

lines.adjustments.metadata.{key}

string

lines.adjustments.files

ReceivableAdjustmentFile · object[] | null

The files associated with the adjustment.

Show child attributes

lines.adjustments.files.id

string

required

lines.adjustments.files.file_name

string | null

required

The file name.

Example:

"credit.pdf"

lines.tags

Tag · object[] | null

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

Show child attributes

lines.tags.id

string

required

The unique ID of the object.

lines.tags.name

string

required

An arbitrary string, useful for identifying the tag to the user.

The ID of the tag group.

metadata

Metadata · object

Metadata associated with the receivable.

Show child attributes

metadata.{key}

string

files

ReceivableFile · object[] | null

The files associated with this receivable.

Show child attributes

files.id

string

required

files.file_name

string | null

required

The file name

Example:

"invoice.pdf"

⌘I

API overview

Teal API Endpoints

API Migration

Create Receivable

Authorizations

Headers

Path Parameters

Body

Response