SIsivo
Receivables

Create or update (upsert) a receivable

Changed on
post/receivables

Request

  • Base URL
    https://core.sivo.com
  • Auth
    • API key in header Authorization
    • or OAuth 2
      Authorization codehttps://dashboard.sivo.com/oauth/authorize
      Client credentials
      Token URLhttps://core.sivo.com/oauth/token
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Headers

Idempotency-Keystring

A unique key per operation, could be V4 UUID or other high‑entropy random string. Keys can be up to 256 bytes. See Idempotent Requests.

Example:978771af-77de-4e24-ba39-f602502ceb78

Request body

idstring required

The receivable ID assigned by the originator

obligor_idstring

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

origination_datestring date

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

currencystring

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

product_type'term_loan' | 'line_of_credit' | 'buy_now_pay_later' | 'credit_card' | 'invoice' | 'earned_wage_access' | 'lease' | 'gig_payout' | 'creator_payout' | 'merchant_payout' | 'rental_payout' | 'marketplace_payout' | 'real_estate_commission' | 'subscription' | 'government_salary' | 'government_contract' | 'bank_transfer' | 'stock_sell_settlement'

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'sivo' | 'balance_sheet' | 'other'

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

delinquent_amountinteger

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

delinquent_timesinteger

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_idstring nullable

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

origination_feeinteger nullable

The origination fee that was charged to the obligor

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

delinquent_sincestring date nullable

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

Example request

{
  "id": "acct-123",
  "obligor_id": "acct-123",
  "origination_date": "2024-01-15",
  "currency": "USD",
  "delinquent_amount": 10000,
  "delinquent_times": 42,
  "creditor_id": "acct-123",
  "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"
  },
  "delinquent_since": "2024-01-15",
  "fiscal_id": "cfdi:550e8400-e29b-41d4-a716-446655440000"
}

Response

Successful operation

obligor_idstring required

The obligor (account) associated with this receivable

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

product_type'term_loan' | 'line_of_credit' | 'buy_now_pay_later' | 'credit_card' | 'invoice' | 'earned_wage_access' | 'lease' | 'gig_payout' | 'creator_payout' | 'merchant_payout' | 'rental_payout' | 'marketplace_payout' | 'real_estate_commission' | 'subscription' | 'government_salary' | 'government_contract' | 'bank_transfer' | 'stock_sell_settlement' required

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
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_amountinteger required

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

delinquent_timesinteger required

The number of times this receivable has become delinquent over its lifetime. Set to zero if never delinquent.

creditor_idstring

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

origination_feeinteger

The origination fee that was charged to the obligor

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

delinquent_sincestring date

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

idstring required

The receivable ID assigned by the originator

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

{
  "obligor_id": "acct-123",
  "origination_date": "2024-01-15",
  "currency": "USD",
  "delinquent_amount": 10000,
  "delinquent_times": 42,
  "creditor_id": "acct-123",
  "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"
  },
  "delinquent_since": "2024-01-15",
  "fiscal_id": "cfdi:550e8400-e29b-41d4-a716-446655440000",
  "id": "acct-123",
  "created_at": "2024-01-15T10:30:00Z",
  "created_by": "user_0123456789ABCDEFGHIJKLMNOPq",
  "updated_at": "2024-01-15T10:30:00Z",
  "updated_by": "user_0123456789ABCDEFGHIJKLMNOPq"
}

Changes