Record a sale
sale_createRecord a sale and generate a draft bill of sale with buyer, item identifiers, price, and date, returning a BOS number you can later edit, finalize, and print.
Instructions
Record a sale and generate the bill of sale: who sold, who bought, what item (with VIN, serial or IMEI where it has one), the price in minor units and the date. Returns the BOS-YYYY-NNNN number of the draft. The draft can still be changed with sale_update; sale_finalize freezes it into the signing copy and sale_render prints it. Free tier: 10 drafts.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| vin | No | Vehicle Identification Number, 17 characters, for a vehicle sale | |
| date | No | The date of the sale, YYYY-MM-DD. Default today | |
| imei | No | IMEI, 15 digits, for a phone or tablet | |
| as_is | No | Include the as-is clause: sold with all faults, no warranties except any written here. Default true, the norm for second-hand sales; pass false to leave it out | |
| notes | No | Anything else the document should say, e.g. payment method or what is included in the sale | |
| serial | No | Serial number, for equipment and electronics | |
| currency | Yes | ISO code the price is in | |
| quantity | No | How many units this document covers. Default 1 | |
| warranty | No | A warranty the seller does give, in their own words, e.g. The seller warrants the engine for 30 days from the sale date | |
| condition | No | The condition at handover, e.g. used, good working order, or new, sealed | |
| buyer_name | Yes | Who is buying, e.g. Jane Kowalska or Northwind Sp. z o.o. | |
| buyer_email | No | The buyer's email | |
| buyer_phone | No | The buyer's phone number | |
| price_minor | Yes | The sale price in whole minor units (integer cents). 120000 is USD 1,200.00 | |
| seller_name | No | Who is selling. Defaults to the shared business profile's name when the profile has one | |
| duplicate_ok | No | Record it even though an identical sale to the same buyer exists, for a genuinely repeated sale. Default false | |
| seller_email | No | The seller's email | |
| seller_phone | No | The seller's phone number | |
| buyer_address | No | The buyer's postal address, one string | |
| item_category | No | What kind of item, e.g. vehicle, equipment, electronics, stock | |
| seller_address | No | The seller's postal address, one string | |
| identifier_other | No | Any other identifying number, e.g. a hull number or an asset tag | |
| item_description | Yes | What was sold, specific enough to identify it, e.g. 2019 Honda Civic 1.5 petrol, grey, or MacBook Pro 14-inch 2021 |