Payment Entry

A payment received from a customer or paid to a supplier, booked in the retailer's accounts.

Area: Payments and payment methods · Why it is here: retail core · Fields: 68 · 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/Payment%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/Payment%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/Payment%20Entry" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
  -H "Content-Type: application/json" -d '{"naming_series": …, "payment_type": …, "posting_date": …, "company": …, "paid_from": …, "paid_to": …}'

Change one with PUT /api/resource/Payment%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
Series	`naming_series`	Select	yes			one of: ACC-PAY-.YYYY.-
Payment Type	`payment_type`	Select	yes			one of: Receive, Pay, Internal Transfer
POS Invoice (added by iVendNext)	`custom_pos_invoice`	Link		yes		POS Invoice
Payment Order Status	`payment_order_status`	Select		yes	yes	one of: Initiated, Payment Ordered
Posting Date	`posting_date`	Date	yes
Company	`company`	Link	yes			Company
Mode of Payment	`mode_of_payment`	Link				Mode of Payment
Party Type	`party_type`	Link				DocType
Party	`party`	Dynamic Link
Party Name	`party_name`	Data
Book Advance Payments in Separate Party Account	`book_advance_payments_in_separate_party_account`	Check		yes	yes
Reconcile on Advance Payment Date	`reconcile_on_advance_payment_date`	Check		yes	yes
Advance Reconciliation Takes Effect On	`advance_reconciliation_takes_effect_on`	Select			yes	one of: Advance Payment Date, Oldest Of Invoice Or Advance, Reconciliation Date
Company Bank Account	`bank_account`	Link				Bank Account
Party Bank Account	`party_bank_account`	Link				Bank Account
Contact	`contact_person`	Link				Contact
Email	`contact_email`	Data		yes
Party Balance	`party_balance`	Currency		yes
Account Paid From	`paid_from`	Link	yes			Account
Paid From Account Type	`paid_from_account_type`	Data			yes
Account Currency (From)	`paid_from_account_currency`	Link	yes	yes		Currency
Account Balance (From)	`paid_from_account_balance`	Currency		yes
Account Paid To	`paid_to`	Link	yes			Account
Paid To Account Type	`paid_to_account_type`	Data			yes
Account Currency (To)	`paid_to_account_currency`	Link	yes	yes		Currency
Account Balance (To)	`paid_to_account_balance`	Currency		yes
Paid Amount	`paid_amount`	Currency	yes
Paid Amount After Tax	`paid_amount_after_tax`	Currency		yes	yes
Source Exchange Rate	`source_exchange_rate`	Float	yes
Paid Amount (Company Currency)	`base_paid_amount`	Currency	yes	yes
Paid Amount After Tax (Company Currency)	`base_paid_amount_after_tax`	Currency		yes	yes
Received Amount	`received_amount`	Currency	yes
Received Amount After Tax	`received_amount_after_tax`	Currency		yes	yes
Target Exchange Rate	`target_exchange_rate`	Float	yes
Received Amount (Company Currency)	`base_received_amount`	Currency	yes	yes
Received Amount After Tax (Company Currency)	`base_received_amount_after_tax`	Currency		yes	yes
Payment References	`references`	Table				Payment Entry Reference
Total Allocated Amount	`total_allocated_amount`	Currency		yes
Total Allocated Amount (Company Currency)	`base_total_allocated_amount`	Currency		yes
Unallocated Amount	`unallocated_amount`	Currency
Difference Amount (Company Currency)	`difference_amount`	Currency		yes
Purchase Taxes and Charges Template	`purchase_taxes_and_charges_template`	Link				Purchase Taxes and Charges Template
Sales Taxes and Charges Template	`sales_taxes_and_charges_template`	Link				Sales Taxes and Charges Template
Apply Tax Withholding Amount	`apply_tax_withholding_amount`	Check
Tax Withholding Category	`tax_withholding_category`	Link				Tax Withholding Category
Advance Taxes and Charges	`taxes`	Table				Advance Taxes and Charges
Total Taxes and Charges (Company Currency)	`base_total_taxes_and_charges`	Currency		yes
Total Taxes and Charges	`total_taxes_and_charges`	Currency		yes
Payment Deductions or Loss	`deductions`	Table				Payment Entry Deduction
Cheque/Reference No	`reference_no`	Data
Cheque/Reference Date	`reference_date`	Date
Clearance Date	`clearance_date`	Date		yes
Project	`project`	Link				Project
Cost Center	`cost_center`	Link				Cost Center
Status	`status`	Select		yes		one of: Draft, Submitted, Cancelled
Custom Remarks	`custom_remarks`	Check
Remarks	`remarks`	Small Text
In Words (Company Currency)	`base_in_words`	Small Text		yes
Is Opening	`is_opening`	Select				one of: No, Yes
Letter Head	`letter_head`	Link				Letter Head
Print Heading	`print_heading`	Link				Print Heading
Bank	`bank`	Read Only		yes
Bank Account No	`bank_account_no`	Read Only		yes
Payment Order	`payment_order`	Link		yes		Payment Order
In Words	`in_words`	Small Text		yes
Auto Repeat	`auto_repeat`	Link		yes		Auto Repeat
Amended From	`amended_from`	Link		yes		Payment Entry
Title	`title`	Data		yes	yes

Table: Advance Taxes and Charges

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

Field	Field name	Type	Required	Read-only	Links to
Add Or Deduct	`add_deduct_tax`	Select	yes		one of: Add, Deduct
Type	`charge_type`	Select	yes		one of: Actual, On Paid Amount, On Previous Row Amount, On Previous Row Total
Reference Row #	`row_id`	Data
Account Head	`account_head`	Link	yes		Account
Description	`description`	Small Text	yes
Considered In Paid Amount	`included_in_paid_amount`	Check
Cost Center	`cost_center`	Link			Cost Center
Tax Rate	`rate`	Float
Account Currency	`currency`	Link		yes	Currency
Amount	`tax_amount`	Currency
Total	`total`	Currency		yes
Allocated Amount	`allocated_amount`	Currency
Amount (Company Currency)	`base_tax_amount`	Currency		yes
Total (Company Currency)	`base_total`	Currency		yes

Table: Payment Entry Deduction

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

Field	Field name	Type	Required	Read-only	Links to
Account	`account`	Link	yes		Account
Cost Center	`cost_center`	Link	yes		Cost Center
Amount (Company Currency)	`amount`	Currency	yes
Is Exchange Gain / Loss?	`is_exchange_gain_loss`	Check		yes
Description	`description`	Small Text

Table: Payment Entry Reference

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

Field	Field name	Type	Required	Read-only	Links to
Type	`reference_doctype`	Link	yes		DocType
Name	`reference_name`	Dynamic Link	yes
Due Date	`due_date`	Date		yes
Supplier Invoice No	`bill_no`	Data		yes
Payment Term	`payment_term`	Link			Payment Term
Payment Term Outstanding	`payment_term_outstanding`	Float		yes
Account Type	`account_type`	Data
Payment Type	`payment_type`	Data
Reconcile Effect On	`reconcile_effect_on`	Date		yes
Grand Total	`total_amount`	Float		yes
Outstanding	`outstanding_amount`	Float		yes
Allocated	`allocated_amount`	Float
Exchange Rate	`exchange_rate`	Float		yes
Exchange Gain/Loss	`exchange_gain_loss`	Currency		yes
Account	`account`	Link			Account
Payment Request	`payment_request`	Link			Payment Request
Payment Request Outstanding	`payment_request_outstanding`	Float		yes

All record types · What you can use

This record type in the kit