574 lines
13 KiB
HTML
574 lines
13 KiB
HTML
<!-- title: Process Payroll -->
|
|
|
|
|
|
|
|
|
|
|
|
<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/process_payroll"
|
|
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">
|
|
<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>section_break0</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
Select Employees
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>2</td>
|
|
<td ><code>column_break0</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>3</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>4</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>5</td>
|
|
<td ><code>send_email</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Send Email
|
|
<p class="text-muted small">
|
|
Check if you want to send salary slip in mail to each employee while submitting salary slip</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>6</td>
|
|
<td ><code>column_break1</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>7</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>8</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 class="info">
|
|
<td>9</td>
|
|
<td ><code>select_payroll_year_and_month</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
Select Payroll Year and Month
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>10</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>11</td>
|
|
<td ><code>column_break_11</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>12</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 class="info">
|
|
<td>13</td>
|
|
<td ><code>process_payroll</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
Process Payroll
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>14</td>
|
|
<td ><code>column_break2</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>15</td>
|
|
<td ><code>create_salary_slip</code></td>
|
|
<td >
|
|
Button</td>
|
|
<td >
|
|
Create Salary Slip
|
|
<p class="text-muted small">
|
|
Creates salary slip for above mentioned criteria.</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>16</td>
|
|
<td ><code>column_break3</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>17</td>
|
|
<td ><code>submit_salary_slip</code></td>
|
|
<td >
|
|
Button</td>
|
|
<td >
|
|
Submit Salary Slip
|
|
<p class="text-muted small">
|
|
Submit all salary slips for the above selected criteria</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>18</td>
|
|
<td ><code>column_break4</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>19</td>
|
|
<td ><code>make_bank_entry</code></td>
|
|
<td >
|
|
Button</td>
|
|
<td >
|
|
Make Bank Entry
|
|
<p class="text-muted small">
|
|
Create Bank Entry for the total salary paid for the above selected criteria</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>20</td>
|
|
<td ><code>section_break2</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>21</td>
|
|
<td ><code>activity_log</code></td>
|
|
<td >
|
|
HTML</td>
|
|
<td >
|
|
Activity Log
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<hr>
|
|
<h3>Controller</h3>
|
|
<h4>erpnext.hr.doctype.process_payroll.process_payroll</h4>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 style="font-weight: normal;">Class <b>ProcessPayroll</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="check_mandatory" href="#check_mandatory" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>check_mandatory</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="create_log" href="#create_log" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>create_log</b>
|
|
<i class="text-muted">(self, ss_list)</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="create_sal_slip" href="#create_sal_slip" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>create_sal_slip</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Creates salary slip for selected employees if already not created</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="create_submit_log" href="#create_submit_log" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>create_submit_log</b>
|
|
<i class="text-muted">(self, all_ss, not_submitted_ss)</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="format_as_links" href="#format_as_links" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>format_as_links</b>
|
|
<i class="text-muted">(self, ss_list)</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_list" href="#get_emp_list" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>get_emp_list</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Returns list of active employees based on selected criteria
|
|
and for which salary structure exists</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="get_filter_condition" href="#get_filter_condition" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>get_filter_condition</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_joining_releiving_condition" href="#get_joining_releiving_condition" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>get_joining_releiving_condition</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_sal_slip_list" href="#get_sal_slip_list" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>get_sal_slip_list</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Returns list of salary slips based on selected criteria
|
|
which are not submitted</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="get_total_salary" href="#get_total_salary" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>get_total_salary</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Get total salary amount from submitted salary slip based on selected criteria</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<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, salary_account=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="submit_salary_slip" href="#submit_salary_slip" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>submit_salary_slip</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Submit all salary slips based on selected criteria</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
</div>
|
|
<hr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="erpnext.hr.doctype.process_payroll.process_payroll.get_month_details" href="#erpnext.hr.doctype.process_payroll.process_payroll.get_month_details" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
erpnext.hr.doctype.process_payroll.process_payroll.<b>get_month_details</b>
|
|
<i class="text-muted">(year, month)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- autodoc -->
|
|
<!-- jinja -->
|
|
<!-- static --> |