--- title: "List the receivables a debt line funds" method: GET path: "/debt-lines/{id}/receivables" tags: ["Debt Lines"] --- # List the receivables a debt line funds `GET /debt-lines/{id}/receivables` ## Request - Base URL: `https://core.sivo.com` - URL: `https://core.sivo.com/debt-lines/{id}/receivables` - Auth: one of: - API key in header `Authorization` - OAuth 2 - Authorization code: `https://dashboard.sivo.com/oauth/authorize` - Client credentials - Token URL: `https://core.sivo.com/oauth/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) ## Path parameters - `id` string, required: An object id with prefix ## Query parameters - `limit` integer: Maximum number of results to return, from 1 to 100; defaults to 25 - `page` string: Opaque page token from a previous response's next_page or previous_page; pass it back unchanged, with the same sort and filters - `expand` string[]: Extra fields to include in the page; total_count counts the matching results, exactly up to 10000 - `sort` 'origination_date_desc' | 'origination_date_asc' | 'balance_desc' | 'balance_asc': Result order; defaults to origination_date_desc ## Response `200` Successful operation - object: One page of a list - `data` object[], required - `id` string, required: An object ID assigned and owned by the originator - `metric` object, required - `id` string, required: Receivable ID - `created_at` string, date-time, required: When the metric row was created - `updated_at` string, date-time, required: When the metric row was last updated - `outdated_at` string, date-time, required: When the metric row was last marked as needing recalculation - `debt_line_id` string, nullable: The most recent active debt line for the originator - `loan_apr` number, nullable: APR calculated from the receivable properties (fees, interest rate, and term) - `xirr_apr` number, nullable: APR calculated from the full receivable cash flows using XIRR - `simple_apr` number, nullable: APR calculated from the net receivable cash flows without compounding - `apr` number, nullable: Effective APR chosen between xirr_apr and simple_apr, capped by loan_apr - `is_eligible` object, nullable: Map of eligibility criteria to whether the receivable satisfies each one - `obligor_type` boolean - `country` boolean - `currency` boolean - `product_type` boolean - `term_length` boolean - `credit_limit` boolean - `max_balance` boolean - `apr` boolean - `review` boolean - `balance` integer, nullable: Latest reported balance of the receivable, floored at 0 (a negative balance holds no value) and 0 once it defaults - `default_balance` integer, nullable: Balance at the time the receivable went into default - `disbursed` integer, nullable: Total amount disbursed to the obligor - `closed_on` string, date, nullable: Date on which the receivable was reported closed - `status` 'active' | 'closed' | 'null', nullable: Latest reported status of the receivable - `repayment_days` integer, nullable: Days from the first disbursement (or origination) to collection in full; empty while the receivable is outstanding - `receivable` object, required - `obligor_id` string, required: The obligor (account) associated with this receivable - `origination_date` string, date, required: The date on which this receivable was originated - `currency` string, 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_amount` integer, required: Total amount that is currently overdue. Set to zero if not overdue. - `delinquent_times` integer, required: The number of times this receivable has become delinquent over its lifetime. Set to zero if never delinquent. - `creditor_id` string: The creditor (account) associated with this receivable. When omitted, the creditor is assumed to be your organization or user. - `origination_fee` integer: The origination fee that was charged to the obligor - `periodic_fee` object: Periodic fees paid by the obligor - `cycle_type` string, required: How often the obligor pays this fee, e.g. "1 month" or "2 weeks" - `amount` integer, required: Fee amount that is paid by the obligor on each period - `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. - `term` string: The term for this receivable, e.g. "12 months". Leave empty for revolving credit. - `interest_rate` number: 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: How often payments are expected from the obligor, e.g. "1 month" - `metadata` object: Additional custom data associated with this receivable - `fund_name` string: The name of the third party capital source. Should only be set when `funded_by` is `other`. - `delinquent_since` string, date: The date on which this receivable became delinquent. Required when delinquent_amount is greater than zero and must be empty otherwise. - `fiscal_id` union: The fiscal identifier assigned to this receivable by a tax authority, e.g. a Mexican CFDI, a Brazilian NFe, or a PEPPOL identifier - string: CFDI (Comprobante Fiscal Digital por Internet - Mexico) - A UUID identifier for Mexican digital fiscal invoices with cfdi: prefix - string: NFe (Nota Fiscal Eletrônica - Brazil) - A 44-digit access key (Chave de Acesso) for Brazilian electronic invoices with nfe: prefix - string: PEPPOL (Pan-European Public Procurement OnLine) - A PEPPOL participant identifier with scheme ID and value, with peppol: prefix - `id` string, required: The receivable ID assigned by the originator - `created_at` string, date-time, required: Creation date and time - `created_by` string, required: ID of the user that created this object - `updated_at` string, date-time, required: Last update date and time - `updated_by` string, required: ID of the user that last updated this object - `obligor` object, required - `name` string, required: Non-empty text string - `type` 'business' | 'individual', required: Legal classification of the seller entity - `first_name` string: First (given) name of an individual - `last_name` string: Last (family) name of an individual - `address` object: Primary business address of the seller - `region` string: State, province, prefecture, or region component. For the US and Canada, MUST be 2-letter abbreviation. - `country` string, required: ISO 3166-1 alpha-2 country code - `formatted` string: Full mailing address, formatted for display or use on a mailing label. This field MAY contain multiple lines, separated by newlines. - `street_address` string: Full street address component, which MAY include house number, street name, Post Office Box, and multi-line extended street address information. This field MAY contain multiple lines, separated by newlines. - `locality` string: City, town, or locality component. - `postal_code` string: Zip code or postal code component. - `shipping` object: Delivery address for shipments - `region` string: State, province, prefecture, or region component. For the US and Canada, MUST be 2-letter abbreviation. - `country` string, required: ISO 3166-1 alpha-2 country code - `formatted` string: Full mailing address, formatted for display or use on a mailing label. This field MAY contain multiple lines, separated by newlines. - `street_address` string: Full street address component, which MAY include house number, street name, Post Office Box, and multi-line extended street address information. This field MAY contain multiple lines, separated by newlines. - `locality` string: City, town, or locality component. - `postal_code` string: Zip code or postal code component. - `website` string: Seller website - `email` string, email: Contact email address for the seller - `phone` string: Contact phone number for the seller - `industry` string: NAICS industry code: https://www.naics.com/search/ - `legal_entity_id` union: Legal entity identifier. National schemes must match the address country: ein: and ssn: US, rfc: MX, nit: CO or BO, nif: ES, crn: GB, bn: CA; duns: is valid in any country - string: DUNS (Data Universal Numbering System) - An 9-digit code with duns: prefix - string: EIN (Employer Identification Number) - An 9-digit code with ein: prefix - string: SSN (Social Security Number) - An 9-digit code with ssn: prefix - string: RFC (Registro Federal de Contribuyentes - Mexico) - A 12 or 13-character alphanumeric code with rfc: prefix - string: NIT (Número de Identificación Tributaria - Colombia and Bolivia) - For Colombia the 5 to 10-digit base number, without dots and without the check digit (DV); for Bolivia the 7 to 12-digit number. With nit: prefix - string: NIF (Número de Identificación Fiscal - Spain) - A 9-character code (a company CIF, a DNI or a NIE), uppercase without spaces or dashes, with nif: prefix - string: CRN (Companies House registration number - United Kingdom) - An 8-character code (8 digits, or a 2-letter prefix such as SC and 6 digits) with crn: prefix - string: BN (Business Number - Canada) - The 9-digit CRA business number, without the program account suffix, with bn: prefix - `credit_score` union: Credit score - string: Paydex credit score - A 3-digit score with paydex: prefix - string: Experian credit score - A 3-digit score with experian: prefix - string: DataCrédito Experian (Colombia) credit score - A 3-digit score with datacredito: prefix - string: TransUnion credit score - A 3-digit score with transunion: prefix - `kyx_status` 'draft' | 'submitted' | 'approved' | 'rejected': Know Your Customer verification status - `active_since` string, date: Date when the seller was first active in the platform - `monthly_revenue` integer: Monthly revenue of the seller in USD - `monthly_costs` integer: Monthly costs of the seller in USD - `cash_on_hand` integer: Cash on hand of the seller in USD - `avg_sale_size` integer: Average sale size of the seller in USD - `performance_score` integer: Performance score between 1 (poor) and 10 (excellent) - `buyer_concentration` number: Percentage of total revenue from the top 20% of buyers - `average_days_to_pay` integer: Average days to pay - `lifetime_spend` integer: Total amount spent by the buyer in USD - `customer_count` integer: Number of customers - `insurance` object: Indicates that buyer is insured against non-payment - `rating` string, required: Insurance rating from 3rd party provider - `limit` integer, required: Maximum amount in USD that will be insured for a given buyer across all their invoices - `coverage` number, required: Percentage of the invoice that the insurer will pay if the buyer defaults - `metadata` object: Additional custom data associated with this seller - `id` string, required: The account ID assigned by the originator - `created_at` string, date-time, required: Creation date and time - `created_by` string, required: ID of the user that created this object - `updated_at` string, date-time, required: Last update date and time - `updated_by` string, required: ID of the user that last updated this object - `has_more` boolean, required: Whether more results follow this page in the list order - `next_page` string, nullable, required: Token for the page after this one, or null when this is the last page - `previous_page` string, nullable, required: Token for the page before this one, or null when this is the first page - `total_count` integer: Number of results matching the filters, exact up to 10000; 10001 means more than that. Only present when the request expands total_count ## Changes - **2026-11-03** `4bbab9699612`: 1 info - endpoint added [Operation history](https://skmtc.dev/sivo/apis/sivo-advance-api/changes/debt-lines/:id/receivables/get.md) --- [API](https://skmtc.dev/sivo/apis/sivo-advance-api.md) - [All operations](https://skmtc.dev/sivo/apis/sivo-advance-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sivo/apis/sivo-advance-api/revisions/4bbab9699612?raw)