POS Closing Entry
A till's day closed: the sales of the day counted, each payment method's takings compared with what the till recorded.
Area: Till sales · Why it is here: recipe ai_manager; recipe bi_feed; sample S9; retail core · Fields: 30 · 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%20Closing%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%20Closing%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%20Closing%20Entry" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
-H "Content-Type: application/json" -d '{"period_end_date": …, "posting_date": …, "posting_time": …, "pos_opening_entry": …, "company": …, "pos_profile": …}'
Change one with PUT /api/resource/POS%20Closing%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 | yes | ||
| Period End Date | period_end_date |
Datetime | yes | |||
| Posting Date | posting_date |
Date | yes | |||
| Posting Time | posting_time |
Time | yes | |||
| POS Opening Entry | pos_opening_entry |
Link | yes | POS Opening Entry | ||
| Status | status |
Select | yes | yes | one of: Draft, Submitted, Queued, Failed, Cancelled | |
| Company | company |
Link | yes | Company | ||
| POS Terminal (added by iVendNext) | custom_pos_terminal |
Link | POS Terminal | |||
| POS Profile | pos_profile |
Link | yes | POS Profile | ||
| Cashier | user |
Link | yes | User | ||
| POS Transactions | pos_transactions |
Table | POS Invoice Reference | |||
| Payment Reconciliation | payment_reconciliation |
Table | POS Closing Entry Detail | |||
| Currency Denomination Count (added by iVendNext) | custom_currency_denomination_count |
Table | Currency Denomination Count | |||
| Tender Count Detail (added by iVendNext) | custom_tender_count_detail |
Table | Tender Count Detail | |||
| Cash In Out Detail (added by iVendNext) | custom_cash_in_out_detail |
Table | yes | Cash In Out | ||
| Grand Total | grand_total |
Currency | yes | |||
| Net Total | net_total |
Currency | yes | |||
| Total Quantity | total_quantity |
Float | yes | |||
| Opening Amount (added by iVendNext) | custom_opening_amount |
Currency | ||||
| Expected Drawer (added by iVendNext) | custom_expected_drawer |
Currency | ||||
| Cash In/Cash Out (added by iVendNext) | custom_cashin_cashout |
Currency | ||||
| Expenses (added by iVendNext) | custom_expenses |
Currency | ||||
| Sales (added by iVendNext) | custom_sales |
Currency | ||||
| Refunds (added by iVendNext) | custom_refunds |
Currency | ||||
| Gift Card Sales (added by iVendNext) | custom_gc_sales |
Currency | ||||
| Transaction Total (added by iVendNext) | custom_transaction_total |
Currency | ||||
| Total Number of Transactions (added by iVendNext) | custom_total_no_of_transactions |
Int | ||||
| Taxes | taxes |
Table | yes | POS Closing Entry Taxes | ||
| Error | error_message |
Small Text | yes | |||
| Amended From | amended_from |
Link | yes | POS Closing Entry |
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 Closing Entry Detail
The rows of payment_reconciliation. 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 | ||
| Currency (added by iVendNext) | custom_currency |
Link | yes | Currency | ||
| Opening Amount | opening_amount |
Currency | yes | yes | ||
| Expected Amount | expected_amount |
Currency | yes | |||
| Closing Amount | closing_amount |
Currency | yes | |||
| POS Counted (added by iVendNext) | custom_mpos_counted |
Check | yes | |||
| Difference | difference |
Currency | yes | |||
| Count (added by iVendNext) | custom_count |
Int | yes | |||
| Is Counted (added by iVendNext) | custom_is_counted |
Check | yes | yes |
Table: POS Closing Entry Taxes
The rows of taxes. Each row also has idx (its place), parent, parentfield and parenttype.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Account Head | account_head |
Link | yes | Account | ||
| Tax Rate | rate |
Percent | yes | |||
| Amount | amount |
Currency | yes |
Table: POS Invoice Reference
The rows of pos_transactions. Each row also has idx (its place), parent, parentfield and parenttype.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| POS Invoice | pos_invoice |
Link | yes | POS Invoice | ||
| Date | posting_date |
Date | yes | |||
| Customer | customer |
Link | yes | yes | Customer | |
| Amount | grand_total |
Currency | yes | |||
| Is Return | is_return |
Check | yes | |||
| Return Against | return_against |
Link | yes | POS Invoice |
Table: Tender Count Detail
The rows of custom_tender_count_detail. 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 | ||
| Transaction ID | transaction_id |
Data | yes | |||
| Card/Account Number | account_number |
Data | yes | |||
| Amount | amount |
Float | yes | |||
| Verified | verified |
Check |