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

11 KiB

Version 6.x.x
<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>

Single

Fields

    <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>

Company

        </td>
    </tr>
    
    <tr >
        <td>3</td>
        <td class="danger" title="Mandatory"><code>party_type</code></td>
        <td >
            Link</td>
        <td >
            Party Type
            
        </td>
        <td>

DocType

        </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

    <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>

Account

        </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>

Currency

        </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>

Payment Tool Detail

        </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>

Mode of Payment

        </td>
    </tr>
    
    <tr >
        <td>15</td>
        <td ><code>payment_account</code></td>
        <td >
            Link</td>
        <td >
            Payment Account
            
        </td>
        <td>

Account

        </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>
Sr Fieldname Type Label Options
<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>
<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>
<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>

<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>

<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>