brotherton-erpnext/erpnext/docs/current/models/hr/salary_slip.html

851 lines
19 KiB
HTML
Raw Normal View History

2015-12-03 12:58:19 +00:00
<!-- title: Salary Slip -->
<div class="dev-header">
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>
<a class="btn btn-default btn-sm" href="https://github.com/frappe/erpnext/tree/develop/erpnext/hr/doctype/salary_slip"
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
</div>
<p><b>Table Name:</b> <code>tabSalary Slip</code></p>
<h3>Fields</h3>
2015-12-10 11:47:41 +00:00
<table class="table table-bordered">
2015-12-03 12:58:19 +00:00
<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 >
<td>1</td>
<td ><code>column_break0</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>2</td>
<td class="danger" title="Mandatory"><code>employee</code></td>
<td >
Link</td>
<td >
Employee
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/hr/employee">Employee</a>
</td>
</tr>
<tr >
<td>3</td>
<td class="danger" title="Mandatory"><code>employee_name</code></td>
<td >
Data</td>
<td >
Employee Name
</td>
<td></td>
</tr>
<tr >
<td>4</td>
<td ><code>department</code></td>
<td >
Link</td>
<td >
Department
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/hr/department">Department</a>
</td>
</tr>
<tr >
<td>5</td>
<td ><code>designation</code></td>
<td >
Link</td>
<td >
Designation
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/hr/designation">Designation</a>
</td>
</tr>
<tr >
<td>6</td>
<td ><code>branch</code></td>
<td >
Link</td>
<td >
Branch
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/hr/branch">Branch</a>
</td>
</tr>
<tr >
<td>7</td>
<td ><code>letter_head</code></td>
<td >
Link</td>
<td >
Letter Head
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/print/letter_head">Letter Head</a>
</td>
</tr>
<tr >
<td>8</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>9</td>
<td ><code>column_break1</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>10</td>
<td class="danger" title="Mandatory"><code>month</code></td>
<td >
Select</td>
<td >
Month
</td>
<td>
<pre>
01
02
03
04
05
06
07
08
09
10
11
12</pre>
</td>
</tr>
<tr >
<td>11</td>
<td class="danger" title="Mandatory"><code>fiscal_year</code></td>
<td >
Link</td>
<td >
Fiscal Year
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/accounts/fiscal_year">Fiscal Year</a>
</td>
</tr>
<tr >
<td>12</td>
<td class="danger" title="Mandatory"><code>total_days_in_month</code></td>
<td >
Float</td>
<td >
Working Days
</td>
<td></td>
</tr>
<tr >
<td>13</td>
<td ><code>leave_without_pay</code></td>
<td >
Float</td>
<td >
Leave Without Pay
</td>
<td></td>
</tr>
<tr >
<td>14</td>
<td class="danger" title="Mandatory"><code>payment_days</code></td>
<td >
Float</td>
<td >
Payment Days
</td>
<td></td>
</tr>
<tr >
<td>15</td>
<td ><code>bank_name</code></td>
<td >
Data</td>
<td >
Bank Name
</td>
<td></td>
</tr>
<tr >
<td>16</td>
<td ><code>bank_account_no</code></td>
<td >
Data</td>
<td >
Bank Account No.
</td>
<td></td>
</tr>
<tr >
<td>17</td>
<td ><code>email_check</code></td>
<td >
Check</td>
<td >
Email
</td>
<td></td>
</tr>
<tr >
<td>18</td>
<td ><code>amended_from</code></td>
<td >
Link</td>
<td >
Amended From
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/hr/salary_slip">Salary Slip</a>
</td>
</tr>
<tr class="info">
<td>19</td>
<td ><code>earning_deduction</code></td>
<td >
Section Break</td>
<td >
Earning & Deduction
</td>
<td></td>
</tr>
<tr >
<td>20</td>
<td ><code>earning</code></td>
<td class="info">
Column Break</td>
<td >
Earning
</td>
<td></td>
</tr>
<tr >
<td>21</td>
<td ><code>html_21</code></td>
<td >
HTML</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>22</td>
<td ><code>earnings</code></td>
<td >
Table</td>
<td >
Earnings
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/hr/salary_slip_earning">Salary Slip Earning</a>
</td>
</tr>
<tr >
<td>23</td>
<td ><code>deduction</code></td>
<td class="info">
Column Break</td>
<td >
Deduction
</td>
<td></td>
</tr>
<tr >
<td>24</td>
<td ><code>html_24</code></td>
<td >
HTML</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>25</td>
<td ><code>deductions</code></td>
<td >
Table</td>
<td >
Deductions
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/hr/salary_slip_deduction">Salary Slip Deduction</a>
</td>
</tr>
<tr class="info">
<td>26</td>
<td ><code>totals</code></td>
<td >
Section Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>27</td>
<td ><code>column_break_25</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>28</td>
<td ><code>column_break_26</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>29</td>
<td ><code>arrear_amount</code></td>
<td >
Currency</td>
<td >
Arrear Amount
</td>
<td>
<pre>Company:company:default_currency</pre>
</td>
</tr>
<tr >
<td>30</td>
<td ><code>leave_encashment_amount</code></td>
<td >
Currency</td>
<td >
Leave Encashment Amount
</td>
<td>
<pre>Company:company:default_currency</pre>
</td>
</tr>
<tr >
<td>31</td>
<td ><code>gross_pay</code></td>
<td >
Currency</td>
<td >
Gross Pay
</td>
<td>
<pre>Company:company:default_currency</pre>
</td>
</tr>
<tr >
<td>32</td>
<td ><code>total_deduction</code></td>
<td >
Currency</td>
<td >
Total Deduction
</td>
<td>
<pre>Company:company:default_currency</pre>
</td>
</tr>
<tr >
<td>33</td>
<td ><code>net_pay</code></td>
<td >
Currency</td>
<td >
Net Pay
<p class="text-muted small">
Gross Pay + Arrear Amount +Encashment Amount - Total Deduction</p>
</td>
<td>
<pre>Company:company:default_currency</pre>
</td>
</tr>
<tr >
<td>34</td>
<td ><code>rounded_total</code></td>
<td >
Currency</td>
<td >
Rounded Total
</td>
<td>
<pre>Company:company:default_currency</pre>
</td>
</tr>
<tr >
<td>35</td>
<td ><code>total_in_words</code></td>
<td >
Data</td>
<td >
Total in words
<p class="text-muted small">
Net Pay (in words) will be visible once you save the Salary Slip.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
<hr>
<h3>Controller</h3>
<h4>erpnext.hr.doctype.salary_slip.salary_slip</h4>
<h3 style="font-weight: normal;">Class <b>SalarySlip</b></h3>
<p style="padding-left: 30px;"><i>Inherits from erpnext.utilities.transaction_base.TransactionBase</i></h4>
<div class="docs-attr-desc"><p></p>
</div>
<div style="padding-left: 30px;">
<p class="docs-attr-name">
<a name="autoname" href="#autoname" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>autoname</b>
<i class="text-muted">(self)</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="calculate_ded_total" href="#calculate_ded_total" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>calculate_ded_total</b>
<i class="text-muted">(self)</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="calculate_earning_total" href="#calculate_earning_total" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>calculate_earning_total</b>
<i class="text-muted">(self)</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="calculate_lwp" href="#calculate_lwp" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>calculate_lwp</b>
<i class="text-muted">(self, holidays, m)</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="calculate_net_pay" href="#calculate_net_pay" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>calculate_net_pay</b>
<i class="text-muted">(self)</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="check_existing" href="#check_existing" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>check_existing</b>
<i class="text-muted">(self)</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="check_sal_struct" href="#check_sal_struct" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>check_sal_struct</b>
<i class="text-muted">(self, joining_date, relieving_date)</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="get_emp_and_leave_details" href="#get_emp_and_leave_details" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_emp_and_leave_details</b>
<i class="text-muted">(self)</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="get_holidays_for_employee" href="#get_holidays_for_employee" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_holidays_for_employee</b>
<i class="text-muted">(self, start_date, end_date)</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="get_leave_details" href="#get_leave_details" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_leave_details</b>
<i class="text-muted">(self, joining_date=None, relieving_date=None, lwp=None)</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="get_payment_days" href="#get_payment_days" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_payment_days</b>
<i class="text-muted">(self, month, joining_date, relieving_date)</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="on_submit" href="#on_submit" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>on_submit</b>
<i class="text-muted">(self)</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="pull_emp_details" href="#pull_emp_details" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>pull_emp_details</b>
<i class="text-muted">(self)</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="pull_sal_struct" href="#pull_sal_struct" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>pull_sal_struct</b>
<i class="text-muted">(self, struct)</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="send_mail_funct" href="#send_mail_funct" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>send_mail_funct</b>
<i class="text-muted">(self)</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="validate" href="#validate" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate</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>
<h4>Linked In:</h4>
<ul>
<li>
<a href="https://frappe.github.io/erpnext/current/models/hr/salary_slip">Salary Slip</a>
</li>
</ul>
<!-- autodoc -->
<!-- jinja -->
<!-- static -->