Update a receivable

patch

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

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

string

required

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

An object id with prefix

Body Params

Update a creditor

debtor_id

string

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

The debtor (account) associated with this receivable

program_id

string

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

The program this receivable is associated with

origination_date

date

The date on which this receivable was originated

currency

string

^[A-Z]{3}$

ISO 4217 currency code for all monetary amounts on this receivable

credit_type

string

enum

The type of credit extended to the debtor

funded_by

string

enum

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

Allowed:

delinquent_days

integer

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

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

delinquent_times

integer

0 to 2147483647

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

origination_fee

integer | null

The origination fee that was charged to the debtor

periodic_fee

object | null

Periodic fees paid by the debtor

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

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 debtor, 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.

Headers

if-match

date-time

required

ETag value for Optimistic Concurrency Control (OCC). Should contain the last known updated_at timestamp in ISO 8601 format.

Response

200Successful operation