POS Invoice

One sale rung up at a till: its lines, payments, customer and store. A till return is a POS Invoice with Is Return ticked.

Area: Till sales · Why it is here: openapi.yaml; contract fiscal_reader; guide chapter 01c; guide chapter 10; recipe customer_history_page; recipe duty_free_allowance; recipe gift_card_on_spend; recipe loyalty_provider; recipe lucky_draw; recipe portal; recipe post_sale_feedback; recipe receipt_format; recipe restaurant_back_office; recipe stock_alerts; recipe system_sync; recipe webhook_receiver; sample S13; sample S2; sample S22; sample S25; sample S3; sample S36; sample S4; sample S41; sample S43; sample S49; sample S52; sample S9; the MCP server; the feed client; the request collection; retail core · Fields: 219 · 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/POS%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/POS%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/POS%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/POS%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 · s4_receipt_pack · s7_system_sync · s9_bi_feed · s13_portal · s22_customer_loyalty · s25_gift_on_spend · s27_stock_alerts · s28_merge_and_history · s30_units_as_serials · s32_coupon_rules · s36_duty_free · s39_pharmacy_counter · s40_expiry_recall · s41_regulated_register · s42_optical_prescriptions · s43_third_party_payer · s44_lucky_draw · s45_restaurant_back_office · s49_post_sale_feedback · s52_phone_plans

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: AR Payment

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

Table: Coupon Detail

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

Table: Fulfillment Plan Details

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

Table: Item Reason Code

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

Table: Item Surcharge

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

Table: Lost Sale

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

Table: POS Invoice Item

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

Table: POS Invoice Sale Attribute

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

Table: POS Invoice Transaction Item Attribute

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

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 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 Coupon

The rows of custom_coupons. 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