Journal Entry
A booking in the retailer's accounts, such as a payer's claim billed back to the customer.
Area: Payments and payment methods · Why it is here: recipe integration_user; the request collection · Fields: 49 · 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/Journal%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/Journal%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/Journal%20Entry" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
-H "Content-Type: application/json" -d '{"voucher_type": …, "naming_series": …, "company": …, "posting_date": …, "accounts": …}'
Change one with PUT /api/resource/Journal%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.
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 |
|---|---|---|---|---|---|---|
| Is System Generated | is_system_generated |
Check | yes | |||
| Title | title |
Data | yes | |||
| Entry Type | voucher_type |
Select | yes | one of: Journal Entry, Inter Company Journal Entry, Bank Entry, Cash Entry, Credit Card Entry, Debit Note, Credit Note, Contra Entry, Excise Entry, Write Off Entry, Opening Entry, Depreciation Entry … | ||
| Series | naming_series |
Select | yes | one of: ACC-JV-.YYYY.- | ||
| Finance Book | finance_book |
Link | yes | Finance Book | ||
| Process Deferred Accounting | process_deferred_accounting |
Link | yes | Process Deferred Accounting | ||
| Reversal Of | reversal_of |
Link | yes | Journal Entry | ||
| Tax Withholding Category | tax_withholding_category |
Link | Tax Withholding Category | |||
| From Template | from_template |
Link | Journal Entry Template | |||
| Company | company |
Link | yes | Company | ||
| Posting Date | posting_date |
Date | yes | |||
| Apply Tax Withholding Amount | apply_tds |
Check | ||||
| Accounting Entries | accounts |
Table | yes | Journal Entry Account | ||
| Reference Number | cheque_no |
Data | ||||
| Reference Date | cheque_date |
Date | ||||
| User Remark | user_remark |
Small Text | ||||
| Payer Sale (added by iVendNext) | custom_mpos_payer_pos_invoice |
Data | yes | |||
| Total Debit | total_debit |
Currency | yes | |||
| Total Credit | total_credit |
Currency | yes | |||
| Difference (Dr - Cr) | difference |
Currency | yes | |||
| Multi Currency | multi_currency |
Check | ||||
| Total Amount Currency | total_amount_currency |
Link | yes | yes | Currency | |
| Total Amount | total_amount |
Currency | yes | yes | ||
| Total Amount in Words | total_amount_in_words |
Data | yes | yes | ||
| Clearance Date | clearance_date |
Date | yes | |||
| Remark | remark |
Small Text | yes | |||
| Paid Loan | paid_loan |
Data | yes | |||
| Inter Company Journal Entry Reference | inter_company_journal_entry_reference |
Link | yes | Journal Entry | ||
| Bill No | bill_no |
Data | ||||
| Bill Date | bill_date |
Date | ||||
| Due Date | due_date |
Date | ||||
| Reference 1 (added by iVendNext) | custom_reference_1 |
Data | yes | |||
| Reference 2 (added by iVendNext) | custom_reference_2 |
Data | yes | |||
| Reference 3 (added by iVendNext) | custom_reference_3 |
Data | yes | |||
| Reference 4 (added by iVendNext) | custom_reference_4 |
Data | yes | |||
| Reference 5 (added by iVendNext) | custom_reference_5 |
Data | yes | |||
| Write Off Based On | write_off_based_on |
Select | one of: Accounts Receivable, Accounts Payable | |||
| Write Off Amount | write_off_amount |
Currency | ||||
| Pay To / Recd From | pay_to_recd_from |
Data | ||||
| Letter Head | letter_head |
Link | Letter Head | |||
| Print Heading | select_print_heading |
Link | Print Heading | |||
| Mode of Payment | mode_of_payment |
Link | Mode of Payment | |||
| Payment Order | payment_order |
Link | yes | Payment Order | ||
| Is Opening | is_opening |
Select | one of: No, Yes | |||
| Stock Entry | stock_entry |
Link | yes | Stock Entry | ||
| Auto Repeat | auto_repeat |
Link | yes | Auto Repeat | ||
| Amended From | amended_from |
Link | yes | Journal Entry | ||
| Payer Entry (added by iVendNext) | custom_mpos_payer_entry |
Select | yes | one of: Sale, Bill back, Return | ||
| Bill-Back Reason (added by iVendNext) | custom_mpos_payer_reason |
Data | yes |
Table: Journal Entry Account
The rows of accounts. Each row also has idx (its place), parent, parentfield and parenttype.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Account | account |
Link | yes | Account | ||
| Account Type | account_type |
Data | yes | |||
| Bank Account | bank_account |
Link | Bank Account | |||
| Party Type | party_type |
Link | DocType | |||
| Party | party |
Dynamic Link | ||||
| Cost Center | cost_center |
Link | Cost Center | |||
| Project | project |
Link | Project | |||
| Account Currency | account_currency |
Link | yes | Currency | ||
| Exchange Rate | exchange_rate |
Float | ||||
| Debit | debit_in_account_currency |
Currency | ||||
| Debit in Company Currency | debit |
Currency | yes | |||
| Credit | credit_in_account_currency |
Currency | ||||
| Credit in Company Currency | credit |
Currency | yes | |||
| Reference Type | reference_type |
Select | one of: Sales Invoice, Purchase Invoice, Journal Entry, Sales Order, Purchase Order, Expense Claim, Asset, Loan, Payroll Entry, Employee Advance, Exchange Rate Revaluation, Invoice Discounting … | |||
| Reference Name | reference_name |
Dynamic Link | ||||
| Reference Due Date | reference_due_date |
Date | ||||
| Reference Detail No | reference_detail_no |
Data | yes | |||
| Is Advance | is_advance |
Select | one of: No, Yes | |||
| User Remark | user_remark |
Small Text | ||||
| Against Account | against_account |
Text | yes |