Create or update (upsert) a receivable

post

https://core.sivo.com/receivables

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

When you send receivables to Sivo, send the records for your whole portfolio, not just the ones pledged to Sivo. Our risk team relies on portfolio-wide metrics, such as delinquency rates and obligor concentration, and those can only be calculated when every receivable is reported, however it is funded.

Receivables are upserted by the id you assign. A new id creates the receivable; an existing id updates it. See Updating Data for how partial updates work.

How receivables are funded

Use the funded_by property to indicate how each receivable is funded:

`funded_by`	Meaning
`sivo`	The receivable is funded by a Sivo debt line.
`balance_sheet`	The receivable is funded by your company's own balance sheet, that is, with equity.
`other`	The receivable is funded by another capital source. Name that source in `fund_name`, which is only allowed for this value.

funded_by determines how the receivable counts toward your debt line:

Every receivable, regardless of funded_by, is part of the total outstanding balance and of the portfolio metrics your risk team reviews, such as delinquency and top obligor concentration.
Only receivables funded by sivo are part of the pledged balance, and only the eligible ones among them are part of the eligible balance that backs your borrowing. See Get debt line metrics.

A receivable's funding can change over its life. When a receivable that was funded by your balance sheet is later pledged to Sivo, update it with funded_by set to sivo in the same POST you would use for any other change.

Example

Two receivables from the same portfolio, one funded by Sivo and one by a third party fund:

`id`	`obligor_id`	`origination_date`	`currency`	`product_type`	`funded_by`	`fund_name`
`rcv-2026-001`	`acct-1001`	`2026-08-01`	`USD`	`invoice`	`sivo`
`rcv-2026-002`	`acct-1002`	`2026-08-03`	`USD`	`invoice`	`other`	`Acme Fund I`

For an end-to-end walkthrough, including the entries that follow, see the Submit receivables recipe.

Body Params

Create a receivable

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

string

required

length between 1 and 255

The receivable ID assigned by the originator

obligor_id

string

length between 1 and 255

The obligor (account) associated with this receivable. Required at creation, optional for updates.

origination_date

date

The date on which this receivable was originated. Required at creation, optional for updates.

currency

string

^[A-Z]{3}$

ISO 4217 currency code for all monetary amounts on this receivable. Required at creation, optional for updates.

product_type

string

enum

The type of receivables product:

term_loan — Term Loan Receivables: Fixed-amount loans repaid in scheduled installments over a set term
line_of_credit — Line of Credit Receivables: Revolving credit facilities drawn and repaid flexibly up to a limit
buy_now_pay_later — Buy Now Pay Later Receivables: Point-of-sale financing repaid in short-term installments
credit_card — Card Receivables: Revolving card balances repaid by cardholders
invoice — Invoices: Purchased B2B invoices collected from the invoice debtor at a discount
earned_wage_access — Earned Wage Advances: Advances on wages already earned but not yet paid out
lease — Leases: Equipment or asset leases with contractual periodic payments
gig_payout — Gig Worker Payouts: Contractual earnings owed to workers by gig platforms (e.g., Uber, DoorDash)
creator_payout — Creator Payouts: Contractual content and ad revenue owed to creators by platforms (e.g., Google)
merchant_payout — Merchant Payouts: Merchant receivables awaiting settlement by payment processors (e.g., Stripe, Square)
rental_payout — Rental Payouts: Platform-verified short-term rental receivables (e.g., Airbnb, VRBO)
marketplace_payout — Marketplace Payouts: Marketplace seller sales proceeds awaiting payout (e.g., Amazon, Shopify)
real_estate_commission — Real Estate Commissions: Earned real estate commissions pending closing (e.g., RE/MAX, Century 21)
subscription — Subscription Revenue: Contracted recurring subscription receivables
government_salary — Government Salary Receivables: Approved government salaries pending payment
government_contract — Government Contracts: Approved government contract payments pending disbursement
bank_transfer — Bank Transfer Receivables: Funds in transit through delayed bank transfers
stock_sell_settlement — Stock Sell Settlements: Stock sale proceeds awaiting settlement. Required at creation, optional for updates.

funded_by

string

enum

Indicates whether this receivable is funded by sivo, your own balance sheet, or a third party capital source. Required at creation, optional for updates.

Allowed:

delinquent_amount

integer

≥ 0

Total amount that is currently overdue. Set to zero if not overdue. Required at creation, optional for updates.

delinquent_times

integer

0 to 2147483647

The number of times this receivable has become delinquent over its lifetime. Set to zero if never delinquent. Required at creation, optional for updates.

creditor_id

string | null

The creditor (account) associated with this receivable. When omitted, the creditor is assumed to be your organization or user.

origination_fee

integer | null

≥ 0

The origination fee that was charged to the obligor

periodic_fee

object | null

Periodic fees paid by the obligor

collateral

string | null

enum

The type of collateral used to secure this receivable. Leave empty if unsecured.

term

string | null

^\d+ (day|week|month|year)s?$

The term for this receivable, e.g. "12 months". Leave empty for revolving credit.

interest_rate

number | null

-10 to 10

The annual interest rate charged on outstanding principal

credit_limit

integer | null

≥ 0

For receivables allowing multiple draws (e.g. credit cards, lines of credit), the credit limit

payment_frequency

string | null

^\d+ (day|week|month|year)s?$

How often payments are expected from the obligor, e.g. "1 month"

metadata

object | null

Additional custom data associated with this receivable

fund_name

string | null

The name of the third party capital source. Should only be set when funded_by is other.

delinquent_since

date | null

The date on which this receivable became delinquent. Required when delinquent_amount is greater than zero and must be empty otherwise.

fiscal_id

^cfdi:.*$

The fiscal identifier assigned to this receivable by a tax authority, e.g. a Mexican CFDI, a Brazilian NFe, or a PEPPOL identifier

CFDI (Comprobante Fiscal Digital por Internet - Mexico) - A UUID identifier for Mexican digital fiscal invoices with cfdi: prefix

Headers

IdempotencyKey

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

How receivables are funded

Example

200Successful operation