POS Opening Entry
A till's day opened by a cashier, with the cash in the drawer at the start.
Area: Till sales · Why it is here: retail core · Fields: 24 · 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%20Opening%20Entry?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%20Opening%20Entry/⟨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%20Opening%20Entry" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
-H "Content-Type: application/json" -d '{"period_start_date": …, "posting_date": …, "company": …, "pos_profile": …, "user": …, "balance_details": …}'
Change one with PUT /api/resource/POS%20Opening%20Entry/⟨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
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 |
|---|---|---|---|---|---|---|
| Period Start Date | period_start_date |
Datetime | yes | |||
| Period End Date | period_end_date |
Date | yes | |||
| Status | status |
Select | yes | yes | one of: Draft, Open, Closed, Cancelled | |
| Posting Date | posting_date |
Date | yes | |||
| Set Posting Date | set_posting_date |
Check | ||||
| Company | company |
Link | yes | Company | ||
| POS Profile | pos_profile |
Link | yes | POS Profile | ||
| Interface Profile (added by iVendNext) | interface_profile |
Link | yes | Interface Profile | ||
| Active POS Terminal (added by iVendNext) | custom_active_pos_terminal |
Link | POS Terminal | |||
| POS Closing Entry | pos_closing_entry |
Data | yes | |||
| Cashier | user |
Link | yes | User | ||
| Current Cashier (added by iVendNext) | custom_current_cashier |
Link | yes | User | ||
| Team (added by iVendNext) | custom_team |
Link | Team | |||
| Cash Drawer (added by iVendNext) | custom_cash_drawer |
Select | yes | one of: Cash Drawer 1, Cash Drawer 2 | ||
| Opening Balance Details | balance_details |
Table | yes | POS Opening Entry Detail | ||
| Currency Denomination Count (added by iVendNext) | custom_currency_denomination_count |
Table | Currency Denomination Count | |||
| Cash In Out Detail (added by iVendNext) | custom_cash_in_out_detail |
Table | yes | Cash In Out | ||
| Amended From | amended_from |
Link | yes | POS Opening Entry | ||
| Shift start on Terminal (added by iVendNext) | custom_shift_start_on_terminal |
Link | yes | POS Terminal | ||
| Shift suspended on (added by iVendNext) | custom_shift_suspended_on |
Link | yes | POS Terminal | ||
| POS Drawered Open (added by iVendNext) | custom_mpos_drawered_open |
Check | yes | |||
| Origin Channel (added by iVendNext) | custom_origin_channel |
Data | yes | |||
| Suspended By (added by iVendNext) | custom_suspended_by |
Data | yes | |||
| Suspend Date Time (added by iVendNext) | custom_suspend_date_time |
Datetime | yes |
Table: Cash In Out
The rows of custom_cash_in_out_detail. Each row also has idx (its place), parent, parentfield and parenttype.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Transaction Type | transaction_type |
Select | yes | one of: Cash In, Cash Out, Expense | ||
| Master Type | master_type |
Select | yes | one of: Reason Code Master, Store Expense Type | ||
| Reason Code | reason_code |
Dynamic Link | yes | |||
| Manager Override | manager_override |
Check | ||||
| Comment | comment |
Data | yes | |||
| Amount | amount |
Float | yes | |||
| Created By | created_by |
Link | User | |||
| Terminal | terminal |
Link | POS Terminal |
Table: Currency Denomination Count
The rows of custom_currency_denomination_count. Each row also has idx (its place), parent, parentfield and parenttype.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Currency | currency |
Link | yes | yes | Currency | |
| Denomination Type | denomination_type |
Data | yes | |||
| Denomination Value | denomination_value |
Currency | yes | yes | ||
| Count | count |
Int | ||||
| Amount | amount |
Currency | yes |
Table: POS Opening Entry Detail
The rows of balance_details. Each row also has idx (its place), parent, parentfield and parenttype.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Mode of Payment | mode_of_payment |
Link | yes | Mode of Payment | ||
| Opening Amount | opening_amount |
Currency | yes |