Retail Payer Record

An insurer's (payer's) part of one sale: who pays it, the claim, the shares line by line and the payer journal. One per payer sale, payer return and back-office payer invoice, linked from that sale; written only by the payer door, read by a System Manager.

Area: Sales and returns · Why it is here: contract payer · Fields: 25

iVendNext's own description: A sale's payer details (PB-8): who pays part of it, the claim, the shares line by line and the payer journal. One per payer sale, payer return and Desk payer invoice, linked from that sale; written only by the payer door, never by hand.

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/Retail%20Payer%20Record?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/Retail%20Payer%20Record/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"

Create one, if your app's role may:

curl -s -X POST "https://⟨site⟩/api/resource/Retail%20Payer%20Record" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
  -H "Content-Type: application/json" -d '{"⟨field⟩": …}'

Change one with PUT /api/resource/Retail%20Payer%20Record/⟨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.

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.

Field	Field name	Type	Read-only	Hidden	Links to
Sale Record Type	`sale_doctype`	Link	yes		DocType
Sale	`sale`	Data	yes
Company	`company`	Link	yes		Company
Payer Journal	`journal`	Link	yes		Journal Entry
Payer Service	`subscription`	Data	yes	yes
Payer Clearing Account	`clearing_account`	Link	yes		Account
Bill-Back Role	`bill_back_role`	Small Text	yes	yes
Payer	`payer_customer`	Link	yes		Customer
Payer Name	`payer_title`	Small Text	yes	yes
Payer Code	`payer_code`	Small Text	yes	yes
Plan	`plan`	Small Text	yes	yes
Member Reference	`member`	Small Text	yes	yes
Member	`member_label`	Small Text	yes	yes
Claim Reference	`claim_ref`	Data	yes	yes
Billed to Payer	`payer_share`	Currency	yes
Paid by Customer	`patient_share`	Currency	yes
Returned Whole Only	`no_partial_refund`	Check	yes
Payer Share Given Back	`back`	Currency	yes
Of It, Billed Back Earlier	`back_billed`	Currency	yes
Prescription Reference	`prescription`	Small Text	yes	yes
Prescriber	`prescriber`	Small Text	yes	yes
Prescriber Licence	`prescriber_licence`	Small Text	yes	yes
Lines	`lines`	Table	yes		Retail Payer Record Line
Payer Answer	`answer`	Long Text	yes	yes
Payer Answer (Sealed)	`ticket`	Long Text	yes	yes

Table: Retail Payer Record Line

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

Field	Field name	Type	Read-only	Hidden
Sale line	`line`	Int	yes
Billed to Payer	`payer_share`	Currency	yes
Paid by Customer	`patient_share`	Currency	yes
Payer Covered Qty	`covered_qty`	Float	yes
Payer GTIN	`gtin`	Data	yes	yes
Payer Share Given Back	`back`	Currency	yes

All record types · What you can use

This record type in the kit