601 lines
14 KiB
HTML
601 lines
14 KiB
HTML
<!-- title: Salary Structure -->
|
|
|
|
|
|
|
|
|
|
|
|
<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_structure"
|
|
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 Structure</code></p>
|
|
|
|
|
|
|
|
|
|
<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 >
|
|
<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 ><code>employee_name</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Employee Name
|
|
|
|
</td>
|
|
<td></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>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>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>7</td>
|
|
<td ><code>column_break1</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>8</td>
|
|
<td class="danger" title="Mandatory"><code>is_active</code></td>
|
|
<td >
|
|
Select</td>
|
|
<td >
|
|
Is Active
|
|
|
|
</td>
|
|
<td>
|
|
<pre>
|
|
Yes
|
|
No</pre>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>9</td>
|
|
<td class="danger" title="Mandatory"><code>from_date</code></td>
|
|
<td >
|
|
Date</td>
|
|
<td >
|
|
From Date
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>10</td>
|
|
<td ><code>to_date</code></td>
|
|
<td >
|
|
Date</td>
|
|
<td >
|
|
To Date
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>11</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 class="info">
|
|
<td>12</td>
|
|
<td ><code>earning_deduction</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
Monthly Earning & Deduction
|
|
<p class="text-muted small">
|
|
Salary breakup based on Earning and Deduction.</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>13</td>
|
|
<td ><code>earning</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
Earning
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>14</td>
|
|
<td class="danger" title="Mandatory"><code>earnings</code></td>
|
|
<td >
|
|
Table</td>
|
|
<td >
|
|
Earnings
|
|
|
|
</td>
|
|
<td>
|
|
|
|
|
|
|
|
|
|
<a href="https://frappe.github.io/erpnext/current/models/hr/salary_structure_earning">Salary Structure Earning</a>
|
|
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>15</td>
|
|
<td ><code>deduction</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
Deduction
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>16</td>
|
|
<td ><code>deductions</code></td>
|
|
<td >
|
|
Table</td>
|
|
<td >
|
|
Deductions
|
|
|
|
</td>
|
|
<td>
|
|
|
|
|
|
|
|
|
|
<a href="https://frappe.github.io/erpnext/current/models/hr/salary_structure_deduction">Salary Structure Deduction</a>
|
|
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>17</td>
|
|
<td ><code>section_break0</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td>
|
|
<pre>Simple</pre>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>18</td>
|
|
<td ><code>column_break2</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>19</td>
|
|
<td ><code>total_earning</code></td>
|
|
<td >
|
|
Currency</td>
|
|
<td >
|
|
Total Earning
|
|
|
|
</td>
|
|
<td>
|
|
<pre>Company:company:default_currency</pre>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>20</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>21</td>
|
|
<td ><code>column_break3</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>22</td>
|
|
<td ><code>net_pay</code></td>
|
|
<td >
|
|
Currency</td>
|
|
<td >
|
|
Net Pay
|
|
|
|
</td>
|
|
<td>
|
|
<pre>Company:company:default_currency</pre>
|
|
</td>
|
|
</tr>
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<hr>
|
|
<h3>Controller</h3>
|
|
<h4>erpnext.hr.doctype.salary_structure.salary_structure</h4>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 style="font-weight: normal;">Class <b>SalaryStructure</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="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="before_test_insert" href="#before_test_insert" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>before_test_insert</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Make any existing salary structure for employee inactive.</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="get_employee_details" href="#get_employee_details" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>get_employee_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_other_active_salary_structure" href="#get_other_active_salary_structure" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>get_other_active_salary_structure</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_ss_values" href="#get_ss_values" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>get_ss_values</b>
|
|
<i class="text-muted">(self, employee)</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="make_earn_ded_table" href="#make_earn_ded_table" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>make_earn_ded_table</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="make_table" href="#make_table" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>make_table</b>
|
|
<i class="text-muted">(self, doct_name, tab_fname, tab_name)</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>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="validate_amount" href="#validate_amount" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>validate_amount</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_employee" href="#validate_employee" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>validate_employee</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_joining_date" href="#validate_joining_date" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>validate_joining_date</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.hr.doctype.salary_structure.salary_structure.make_salary_slip</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="erpnext.hr.doctype.salary_structure.salary_structure.make_salary_slip" href="#erpnext.hr.doctype.salary_structure.salary_structure.make_salary_slip" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
erpnext.hr.doctype.salary_structure.salary_structure.<b>make_salary_slip</b>
|
|
<i class="text-muted">(source_name, target_doc=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- autodoc -->
|
|
<!-- jinja -->
|
|
<!-- static --> |