Sales Invoice

A sale booked in the back office, or a till's day of sales merged into one document; a return is a Sales Invoice with Is Return ticked that names the sale it returns.

Area: Sales and returns · Why it is here: openapi.yaml; api/validate.sh; guide chapter 02; recipe bulk_reads; recipe customer_history_page; recipe price_checker; recipe print_pack; recipe webhook_receiver; sample S2; sample S29; sample S3; sample S39; sample S41; sample S43; the MCP server; the request collection; retail core · Fields: 172 · Submitted (booked) records: send docstatus: 1 to book it as you create it, or submit a draft with submit.

Read and write it

Every call runs as your app's own user, with its key in one header, at the retailer's own address. The user reads and writes only what its role allows: your app's user, and the rights the retailer gives it.

Read a list (only name unless you ask for fields):

curl -s "https://⟨site⟩/api/resource/Sales%20Invoice?fields=%5B%22*%22%5D&limit_page_length=20" \
  -H "Authorization: token ⟨api key⟩:⟨api secret⟩"

Read one, with its tables:

curl -s "https://⟨site⟩/api/resource/Sales%20Invoice/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"

Create one (the required fields first), if your app's role may:

curl -s -X POST "https://⟨site⟩/api/resource/Sales%20Invoice" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
  -H "Content-Type: application/json" -d '{"naming_series": …, "company": …, "posting_date": …, "currency": …, "conversion_rate": …, "selling_price_list": …}'

Change one with PUT /api/resource/Sales%20Invoice/⟨name⟩ and the fields you change; a table sent there replaces its rows, so send its existing rows too. All the record calls and their answers: the API reference.

Samples that use it

s1_warranty · s2_bins · s3_price_audit · s24_price_checker · s28_merge_and_history · s29_print_pack · s30_units_as_serials · s32_coupon_rules · s39_pharmacy_counter · s40_expiry_recall · s41_regulated_register · s43_third_party_payer · s45_restaurant_back_office

Fields

Read from the product at POS 2.1.0.667 (till app 60147699c): its own fields, the fields iVendNext adds to it, and iVendNext's changes to any of them. Read-only fields are set by iVendNext; a hidden one is not on the form but can be read. Every record also has name (its id, in the address), owner, creation, modified, modified_by and docstatus (0 a draft, 1 submitted, 2 cancelled), all read-only.

Table: Packed Item

The rows of packed_items. Each row also has idx (its place), parent, parentfield and parenttype.

Table: Payment Schedule

The rows of payment_schedule. Each row also has idx (its place), parent, parentfield and parenttype.

Table: Pricing Rule Detail

The rows of pricing_rules. Each row also has idx (its place), parent, parentfield and parenttype.

Table: Sales Invoice Advance

The rows of advances. Each row also has idx (its place), parent, parentfield and parenttype.

Table: Sales Invoice Item

The rows of items. Each row also has idx (its place), parent, parentfield and parenttype.

Table: Sales Invoice Payment

The rows of payments. Each row also has idx (its place), parent, parentfield and parenttype.

Table: Sales Invoice Timesheet

The rows of timesheets. Each row also has idx (its place), parent, parentfield and parenttype.

Table: Sales Taxes and Charges

The rows of taxes. Each row also has idx (its place), parent, parentfield and parenttype.

Table: Sales Team

The rows of sales_team. Each row also has idx (its place), parent, parentfield and parenttype.

Table: Transaction Promotion Bonus Buys Detail

The rows of custom_promotions. Each row also has idx (its place), parent, parentfield and parenttype.

All record types · What you can use

This record type in the kit