Create a receivable

post

https://core.sivo.com/creditors/{creditor_id}/receivables

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

creditor_id

string

required

^[a-z]{3,7}_[0-9A-Za-z]{27}$

An object id with prefix

Body Params

Create a creditor

debtor_id

string

required

^[a-z]{3,7}_[0-9A-Za-z]{27}$

The debtor (account) associated with this receivable

program_id

string

required

^[a-z]{3,7}_[0-9A-Za-z]{27}$

The program this receivable is associated with

origination_date

date

required

The date on which this receivable was originated

currency

string

required

^[A-Z]{3}$

ISO 4217 currency code for all monetary amounts on this receivable

credit_type

string

enum

required

The type of credit extended to the debtor

funded_by

string

enum

required

Indicates whether this receivable is funded by sivo, your own balance sheet, or a third party capital source

Allowed:

delinquent_days

integer

required

0 to 2147483647

Number of days that have passed since the due date for overdue payments. Set to zero if not overdue.

delinquent_amount

integer

required

Total amount that is currently overdue. Set to zero if not overdue.

delinquent_times

integer

required

0 to 2147483647

Number of times this receivable has had overdue payments. Set to zero if it never has.

origination_fee

integer

The origination fee that was charged to the debtor

periodic_fee

object

Periodic fees paid by the debtor

collateral

string

enum

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

term

string

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

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

interest_rate

number

-10 to 10

The annual interest rate charged on outstanding principal

credit_limit

integer

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

payment_frequency

string

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

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

metadata

object

Additional custom data associated with this receivable

fund_name

string

length ≥ 1

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

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

200Successful operation