brotherton-erpnext/erpnext/docs/current/models/accounts/payment_tool.html

473 lines
11 KiB
HTML
Raw Normal View History

2015-11-05 11:25:10 +00:00
<!-- title: Payment Tool -->
<div class="dev-header">
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.7.1</a>
<a class="btn btn-default btn-sm" href="https://github.com/frappe/erpnext/tree/develop/erpnext/accounts/doctype/payment_tool"
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
</div>
<span class="label label-info">Single</span>
<h3>Fields</h3>
<table class="table table-bordered" style="table-layout: fixed;">
<thead>
<tr>
<th style="width: 5%">Sr</th>
<th style="width: 25%">Fieldname</th>
<th style="width: 20%">Type</th>
<th style="width: 25%">Label</th>
<th style="width: 25%">Options</th>
</tr>
</thead>
<tbody>
<tr class="info">
<td>1</td>
<td ><code>sec_break1</code></td>
<td >
Section Break</td>
<td >
Find Invoices to Match
</td>
<td></td>
</tr>
<tr >
<td>2</td>
<td class="danger" title="Mandatory"><code>company</code></td>
<td >
Link</td>
<td >
Company
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/setup/company">Company</a>
</td>
</tr>
<tr >
<td>3</td>
<td class="danger" title="Mandatory"><code>party_type</code></td>
<td >
Link</td>
<td >
Party Type
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/core/doctype">DocType</a>
</td>
</tr>
<tr >
<td>4</td>
<td class="danger" title="Mandatory"><code>received_or_paid</code></td>
<td >
Select</td>
<td >
Received Or Paid
</td>
<td>
<pre>Received
Paid</pre>
</td>
</tr>
<tr >
<td>5</td>
<td ><code>col_break1</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>6</td>
<td class="danger" title="Mandatory"><code>party</code></td>
<td >
Dynamic Link</td>
<td >
Party
</td>
<td>
<pre>party_type</pre>
</td>
</tr>
<tr >
<td>7</td>
<td class="danger" title="Mandatory"><code>party_account</code></td>
<td >
Link</td>
<td >
Party Account
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/accounts/account">Account</a>
</td>
</tr>
<tr >
<td>8</td>
<td ><code>party_account_currency</code></td>
<td >
Link</td>
<td class="text-muted" title="Hidden">
Party Account Currency
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/geo/currency">Currency</a>
</td>
</tr>
<tr >
<td>9</td>
<td ><code>set_payment_amount</code></td>
<td >
Check</td>
<td >
Set Payment Amount = Outstanding Amount
</td>
<td></td>
</tr>
<tr >
<td>10</td>
<td ><code>get_outstanding_vouchers</code></td>
<td >
Button</td>
<td >
Get Outstanding Vouchers
</td>
<td></td>
</tr>
<tr class="info">
<td>11</td>
<td ><code>sec_break3</code></td>
<td >
Section Break</td>
<td >
Set Matching Amounts
</td>
<td></td>
</tr>
<tr >
<td>12</td>
<td ><code>vouchers</code></td>
<td >
Table</td>
<td >
Against Vouchers
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/accounts/payment_tool_detail">Payment Tool Detail</a>
</td>
</tr>
<tr class="info">
<td>13</td>
<td ><code>section_break_19</code></td>
<td >
Section Break</td>
<td >
Make Payment Entry
</td>
<td></td>
</tr>
<tr >
<td>14</td>
<td ><code>payment_mode</code></td>
<td >
Link</td>
<td >
Payment Mode
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/accounts/mode_of_payment">Mode of Payment</a>
</td>
</tr>
<tr >
<td>15</td>
<td ><code>payment_account</code></td>
<td >
Link</td>
<td >
Payment Account
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/accounts/account">Account</a>
</td>
</tr>
<tr >
<td>16</td>
<td ><code>total_payment_amount</code></td>
<td >
Currency</td>
<td >
Total Payment Amount
</td>
<td>
<pre>party_account_currency</pre>
</td>
</tr>
<tr >
<td>17</td>
<td ><code>data_22</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>18</td>
<td ><code>reference_date</code></td>
<td >
Date</td>
<td >
Reference Date
</td>
<td></td>
</tr>
<tr >
<td>19</td>
<td ><code>reference_no</code></td>
<td >
Data</td>
<td >
Reference No
</td>
<td></td>
</tr>
<tr >
<td>20</td>
<td ><code>make_journal_entry</code></td>
<td >
Button</td>
<td >
Make Journal Entry
</td>
<td></td>
</tr>
<tr class="info">
<td>21</td>
<td ><code>section_break_21</code></td>
<td >
Section Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>22</td>
<td ><code>make_jv_help</code></td>
<td >
Small Text</td>
<td >
</td>
<td></td>
</tr>
</tbody>
</table>
<hr>
<h3>Controller</h3>
<h4>erpnext.accounts.doctype.payment_tool.payment_tool</h4>
<h3 style="font-weight: normal;">Class <b>PaymentTool</b></h3>
<p style="padding-left: 30px;"><i>Inherits from frappe.model.document.Document</i></h4>
<div class="docs-attr-desc"><p></p>
</div>
<div style="padding-left: 30px;">
<p class="docs-attr-name">
<a name="make_journal_entry" href="#make_journal_entry" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>make_journal_entry</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
</div>
<hr>
<p><span class="label label-info">Public API</span>
<br><code>/api/method/erpnext.accounts.doctype.payment_tool.payment_tool.get_against_voucher_amount</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.accounts.doctype.payment_tool.payment_tool.get_against_voucher_amount" href="#erpnext.accounts.doctype.payment_tool.payment_tool.get_against_voucher_amount" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.accounts.doctype.payment_tool.payment_tool.<b>get_against_voucher_amount</b>
<i class="text-muted">(against_voucher_type, against_voucher_no, party_account, company)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="erpnext.accounts.doctype.payment_tool.payment_tool.get_orders_to_be_billed" href="#erpnext.accounts.doctype.payment_tool.payment_tool.get_orders_to_be_billed" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.accounts.doctype.payment_tool.payment_tool.<b>get_orders_to_be_billed</b>
<i class="text-muted">(party_type, party, party_account_currency, company_currency)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p><span class="label label-info">Public API</span>
<br><code>/api/method/erpnext.accounts.doctype.payment_tool.payment_tool.get_outstanding_vouchers</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.accounts.doctype.payment_tool.payment_tool.get_outstanding_vouchers" href="#erpnext.accounts.doctype.payment_tool.payment_tool.get_outstanding_vouchers" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.accounts.doctype.payment_tool.payment_tool.<b>get_outstanding_vouchers</b>
<i class="text-muted">(args)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<!-- autodoc -->
<!-- jinja -->
<!-- static -->