Retail Partner Code
A code your service made for a paid sale line (fulfil at sale), with its state.
Area: Your app: its install, its user and its doors · Why it is here: contract partner_fulfil · Fields: 24
iVendNext's own description: One row per sold line a partner makes a code for (a voucher, a PIN). Written by iVendNext only. Cancel code asks the partner to cancel it.
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%20Partner%20Code?fields=%5B%22*%22%5D&limit_page_length=20" \
-H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Read one:
curl -s "https://⟨site⟩/api/resource/Retail%20Partner%20Code/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Your app reads it; it does not write it here: iVendNext writes it from your service's answer to fulfil at sale. 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 | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Sale | invoice |
Link | yes | POS Invoice | ||
| Item | item_code |
Link | yes | Item | ||
| Sale line | item_row |
Data | yes | |||
| Partner | label |
Data | yes | |||
| Status | status |
Select | yes | one of: Pending, Issued, Refused, Voided | ||
| Extension subscription | subscription |
Link | yes | Retail Extension Subscription | ||
| POS Profile | pos_profile |
Link | yes | POS Profile | ||
| Company | company |
Link | yes | Company | ||
| Sold by | sold_by |
Link | yes | User | ||
| Language | lang |
Link | yes | Language | ||
| Idempotency key | idempotency_key |
Data | yes | |||
| Code reference | ref |
Data | yes | |||
| Printed lines | code_lines |
Password | yes | |||
| Why it was not issued | reason |
Small Text | yes | |||
| Why the cancel was refused | void_reason |
Small Text | yes | |||
| Currency | currency |
Link | yes | Currency | ||
| Currency exponent | currency_exponent |
Int | yes | |||
| Face value (minor units) | face_minor |
Int | yes | |||
| Line amount (minor units) | amount_minor |
Int | yes | |||
| Tries | attempts |
Int | yes | |||
| Last try | last_try |
Datetime | yes | |||
| Receipt printed without it | released |
Check | yes | |||
| Flagged for review | flagged |
Check | yes | |||
| Cancelled on | voided_on |
Datetime | yes |