Sign in

v1

latestOpenAPI 3.1.02026-07-247328324.6 KB
Receivables

Create an item

post/creditors/{creditor_id}/receivables/{receivable_id}/items

Path parameters

creditor_idstring required

An object id with prefix

Example:user_0123456789ABCDEFGHIJKLMNOPq

An object id with prefix

receivable_idstring required

An object id with prefix

Example:user_0123456789ABCDEFGHIJKLMNOPq

An object id with prefix

Headers

IdempotencyKeystring

A unique key per operation, could be V4 UUID or other high‑entropy random string. Keys can be up to 255 characters. See Idempotent Requests.

Example:978771af-77de-4e24-ba39-f602502ceb78

A unique key per operation, could be V4 UUID or other high‑entropy random string. Keys can be up to 255 characters. See Idempotent Requests.

Request body

datestring date required

Date on which the transaction occurred

amountinteger required

Amount for the transaction

balanceinteger required

Receivable balance including the amount in this transaction

type'disbursement' | 'interest' | 'late_fee' | 'origination_fee' | 'periodic_fee' | 'principal' | 'refund' | 'other' required

Type of the transaction being reported

receivable_status'active' | 'closed' required

Status of the receivable at the time the transaction occurred

descriptionstring

Description associated with this transaction

metadataobject

Additional custom data associated with this receivable item

Example request

{
  "date": "2024-01-15",
  "amount": 10000,
  "balance": 10000,
  "metadata": {
    "key": "value"
  }
}

Response

Successful operation

datestring date required

Date on which the transaction occurred

amountinteger required

Amount for the transaction

balanceinteger required

Receivable balance including the amount in this transaction

type'disbursement' | 'interest' | 'late_fee' | 'origination_fee' | 'periodic_fee' | 'principal' | 'refund' | 'other' required

Type of the transaction being reported

receivable_status'active' | 'closed' required

Status of the receivable at the time the transaction occurred

descriptionstring

Description associated with this transaction

metadataobject

Additional custom data associated with this receivable item

idstring required

An object id with prefix

created_atstring date-time required

Creation date and time

created_bystring required

ID of the user that created this object

updated_atstring date-time required

Last update date and time

updated_bystring required

ID of the user that last updated this object

Example response

{
  "date": "2024-01-15",
  "amount": 10000,
  "balance": 10000,
  "metadata": {
    "key": "value"
  },
  "id": "user_0123456789ABCDEFGHIJKLMNOPq",
  "created_at": "2024-01-15T10:30:00Z",
  "created_by": "user_0123456789ABCDEFGHIJKLMNOPq",
  "updated_at": "2024-01-15T10:30:00Z",
  "updated_by": "user_0123456789ABCDEFGHIJKLMNOPq"
}