Create or update (upsert) a receivable entry

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Receivable entries are the cash events on a receivable: disbursements, repayments, interest, fees, and refunds. Sivo uses them to calculate the receivable's metrics (see List receivable metrics), so report the full history of every receivable, starting from the day it was created.

Entries are upserted by the id you assign. A new id creates the entry; an existing id updates it, which makes the call safe to retry and lets you correct an entry you reported by mistake. See Updating Data for how partial updates work, and use the delete endpoint to remove an entry entirely.

Types

Every entry carries a non-negative amount; the direction of the cash flow comes from its type.

typeMeaning
disbursementFunds or goods delivered to the obligor, increasing the receivable balance. For an installment loan, report the loan amount when the loan is originated; loans with several disbursements and revolving lines report one entry per disbursement. For an invoice, report the invoice amount on the invoice date.
principalA repayment of principal received from the obligor. Do not include interest or fees here; report those as separate entries.
interestInterest collected from the obligor.
origination_feeAn origination fee collected when the receivable is created.
periodic_feeA recurring non-interest fee collected from the obligor.
late_feeA fee collected from the obligor because of a late payment.
refundA full or partial refund returned to the obligor. This offsets earlier disbursements and reduces the receivable balance.
saleA sale whose proceeds the obligor, a payment processor, holds until it pays them out, increasing the receivable balance like a disbursement but earning no yield. Report the day's net card sales on the sale date and the payout as a principal entry.
otherAny other transaction associated with the receivable. Use description to explain it.

When a single payment covers principal, interest, and fees, split it into one entry per type, all on the same date. Report the entry that collects the receivable in full with receivable_status set to closed; Sivo takes that entry's date as the date the receivable was closed.

Scheduled payments

Some receivables, such as term loans, have a payment schedule. Report the scheduled payments as entries with their future date so they can be used in metric calculations. Sivo reads the current balance and status from the most recent entry dated on or before today, so entries dated in the future are stored but not applied until their date arrives. When the payment is actually made, update the same entry id with the real amount, balance, and date.

Example

An invoice for USD $2,500.00 issued on August 1, then paid in full with a late fee on September 5, is reported as three entries, each in its own POST:

iddatetypeamountbalancereceivable_status
ent-00012026-08-01disbursement250000250000active
ent-00022026-09-05late_fee5000250000active
ent-00032026-09-05principal2500000closed

For an end-to-end walkthrough, see the Submit receivables recipe.

Path Params
string
required
length between 1 and 255

An object ID assigned and owned by the originator

Body Params

Create a receivable

Creates the receivable entry when the id is new, otherwise updates the existing entry with the provided fields. Set an optional field to null to clear it.

string
required
length between 1 and 255

The receivable entry ID assigned by the originator

date

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

integer
≥ 0

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

integer

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

string
enum

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

string
enum

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

Allowed:
string | null

Description associated with this transaction

metadata
object | null

Additional custom data associated with this receivable entry

Headers
string

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.

Response

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json