Skip to main content
A receivable sale groups one business day’s receivables into a single purchase that Lead debits from your operating account. Lead creates every receivable sale. You read them with GET /v2/receivable_sales and GET /v2/receivable_sales/{receivable_sale_id}.
A failed sale also carries a failure block:

Fields

The purchase_amount_breakdown block

Lead may add components to this block without a version change. Each component is a signed integer, and one that reduces the amount due is negative. To check the total, add every key present, not only the three above. purchase_amount does not include partner-owed fees and premiums. Lead bills those separately under your program agreement.

The failure block

Membership rules

  • One sale per business day. Each business day’s eligible receivables go into one receivable sale for your program. Handle more than one sale for the same request_date, since Lead may regenerate a sale for a day.
  • Fixed at creation. Once a sale is created, its receivables, purchase_amount, and breakdown do not change, including on a retry after a failure.
  • Late receivables roll forward. A receivable that becomes eligible after the day’s sale is created joins the next business day’s sale.

List and retrieve

GET /v2/receivable_sales returns your program’s receivable sales, most recently created first. Filters:
  • request_date, request_date[after], request_date[on_or_after], request_date[before], request_date[on_or_before]. Sales for a business day or a range.
  • status. One of created, settled, failed.
  • limit (1 to 100, default 10), starting_after, ending_before. Cursor pagination. Cursors are receivable sale IDs.
GET /v2/receivable_sales/{receivable_sale_id} returns one receivable sale. It returns 404 if the ID does not exist. To list a sale’s receivables, call GET /v2/receivables?receivable_sale_id={receivable_sale_id}.

Coming from the Sales Request and Response files

Receivable Sale Overview · Receivable Sale Statuses · The Receivable Object · The Core Transaction Object