SIsivo
Receivables

Create or update (upsert) a receivable entry

Changed on
post/receivables/{id}/entries

Request

Path parameters

idstring required

An object ID assigned and owned by the originator

Example:acct-123

Headers

Idempotency-Keystring

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

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

Request body

idstring required

The receivable entry ID assigned by the originator

datestring date

Date on which the transaction occurred. Required at creation, optional for updates.

amountinteger

Amount for the transaction. Required at creation, optional for updates.

balanceinteger

Receivable balance including the amount in this transaction. Required at creation, optional for updates.

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

Type of the transaction being reported. Required at creation, optional for updates.

receivable_status'active' | 'closed'

Status of the receivable at the time the transaction occurred. Required at creation, optional for updates.

descriptionstring nullable

Description associated with this transaction

metadataobject nullable

Additional custom data associated with this receivable entry

Example request

{
  "id": "acct-123",
  "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' | 'sale' | '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 entry

idstring required

The receivable entry ID assigned by the originator

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": "acct-123",
  "created_at": "2024-01-15T10:30:00Z",
  "created_by": "user_0123456789ABCDEFGHIJKLMNOPq",
  "updated_at": "2024-01-15T10:30:00Z",
  "updated_by": "user_0123456789ABCDEFGHIJKLMNOPq"
}

Changes