Sign in

v1

latestOpenAPI 3.1.02026-07-247328324.6 KB
Receivables

Update a receivable

patch/creditors/{creditor_id}/receivables/{id}

Path parameters

creditor_idstring required

An object id with prefix

Example:user_0123456789ABCDEFGHIJKLMNOPq

An object id with prefix

idstring required

An object id with prefix

Example:user_0123456789ABCDEFGHIJKLMNOPq

An object id with prefix

Headers

if-matchstring date-time required

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

Example:2024-01-15T10:30:00Z

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

Request body

debtor_idstring

The debtor (account) associated with this receivable

program_idstring

The program this receivable is associated with

origination_datestring date

The date on which this receivable was originated

currencystring

ISO 4217 currency code for all monetary amounts on this receivable

credit_type'term_loan' | 'line_of_credit' | 'buy_now_pay_later' | 'credit_card' | 'invoice_factoring' | 'revenue_based_financing' | 'earned_wage_access' | 'leasing'

The type of credit extended to the debtor

funded_by'sivo' | 'balance_sheet' | 'other'

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

delinquent_daysinteger

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

delinquent_amountinteger

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

delinquent_timesinteger

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

origination_feeinteger nullable

The origination fee that was charged to the debtor

collateral'cash' | 'vehicle' | 'equipment' | 'all_business_assets' | 'receivables' | 'residential_property' | 'commercial_property' | 'other' | 'null' nullable

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

termstring nullable

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

interest_ratenumber nullable

The annual interest rate charged on outstanding principal

credit_limitinteger nullable

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

payment_frequencystring nullable

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

metadataobject nullable

Additional custom data associated with this receivable

fund_namestring nullable

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

Example request

{
  "debtor_id": "user_0123456789ABCDEFGHIJKLMNOPq",
  "program_id": "user_0123456789ABCDEFGHIJKLMNOPq",
  "origination_date": "2024-01-15",
  "currency": "USD",
  "delinquent_days": 42,
  "delinquent_amount": 10000,
  "delinquent_times": 42,
  "origination_fee": 10000,
  "periodic_fee": {
    "cycle_type": "30 days",
    "amount": 10000
  },
  "term": "30 days",
  "interest_rate": 0.05,
  "credit_limit": 10000,
  "payment_frequency": "30 days",
  "metadata": {
    "key": "value"
  }
}

Response

Successful operation

debtor_idstring required

The debtor (account) associated with this receivable

program_idstring required

The program this receivable is associated with

origination_datestring date required

The date on which this receivable was originated

currencystring required

ISO 4217 currency code for all monetary amounts on this receivable

credit_type'term_loan' | 'line_of_credit' | 'buy_now_pay_later' | 'credit_card' | 'invoice_factoring' | 'revenue_based_financing' | 'earned_wage_access' | 'leasing' required

The type of credit extended to the debtor

funded_by'sivo' | 'balance_sheet' | 'other' required

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

delinquent_daysinteger required

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

delinquent_amountinteger required

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

delinquent_timesinteger required

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

origination_feeinteger

The origination fee that was charged to the debtor

collateral'cash' | 'vehicle' | 'equipment' | 'all_business_assets' | 'receivables' | 'residential_property' | 'commercial_property' | 'other'

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

termstring

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

interest_ratenumber

The annual interest rate charged on outstanding principal

credit_limitinteger

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

payment_frequencystring

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

metadataobject

Additional custom data associated with this receivable

fund_namestring

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

idstring required

An object id with prefix

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

{
  "debtor_id": "user_0123456789ABCDEFGHIJKLMNOPq",
  "program_id": "user_0123456789ABCDEFGHIJKLMNOPq",
  "origination_date": "2024-01-15",
  "currency": "USD",
  "delinquent_days": 42,
  "delinquent_amount": 10000,
  "delinquent_times": 42,
  "origination_fee": 10000,
  "periodic_fee": {
    "cycle_type": "30 days",
    "amount": 10000
  },
  "term": "30 days",
  "interest_rate": 0.05,
  "credit_limit": 10000,
  "payment_frequency": "30 days",
  "metadata": {
    "key": "value"
  },
  "id": "user_0123456789ABCDEFGHIJKLMNOPq",
  "created_at": "2024-01-15T10:30:00Z",
  "created_by": "user_0123456789ABCDEFGHIJKLMNOPq",
  "updated_at": "2024-01-15T10:30:00Z",
  "updated_by": "user_0123456789ABCDEFGHIJKLMNOPq"
}