brotherton-erpnext/erpnext/docs/current/models/hr/expense_claim.md

599 lines
13 KiB
Markdown
Raw Normal View History

2015-11-05 11:25:10 +00:00
<!-- title: Expense Claim -->
<div class="dev-header">
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>
2015-11-05 11:25:10 +00:00
<a class="btn btn-default btn-sm" href="https://github.com/frappe/erpnext/tree/develop/erpnext/hr/doctype/expense_claim"
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>tabExpense Claim</code></p>
<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 >
<td>1</td>
<td class="danger" title="Mandatory"><code>naming_series</code></td>
<td >
Select</td>
<td >
Series
</td>
<td>
<pre>EXP</pre>
</td>
</tr>
<tr >
<td>2</td>
<td ><code>approval_status</code></td>
<td >
Select</td>
<td >
Approval Status
</td>
<td>
<pre>Draft
Approved
Rejected</pre>
</td>
</tr>
<tr >
<td>3</td>
<td ><code>exp_approver</code></td>
<td >
Link</td>
<td >
Approver
<p class="text-muted small">
A user with "Expense Approver" role</p>
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/core/user">User</a>
</td>
</tr>
<tr >
<td>4</td>
<td ><code>column_break0</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>5</td>
<td ><code>total_claimed_amount</code></td>
<td >
Currency</td>
<td >
Total Claimed Amount
</td>
<td>
<pre>Company:company:default_currency</pre>
</td>
</tr>
<tr >
<td>6</td>
<td ><code>total_sanctioned_amount</code></td>
<td >
Currency</td>
<td >
Total Sanctioned Amount
</td>
<td>
<pre>Company:company:default_currency</pre>
</td>
</tr>
<tr class="info">
<td>7</td>
<td ><code>expense_details</code></td>
<td >
Section Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>8</td>
<td class="danger" title="Mandatory"><code>expenses</code></td>
<td >
Table</td>
<td >
Expenses
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/hr/expense_claim_detail">Expense Claim Detail</a>
</td>
</tr>
<tr class="info">
<td>9</td>
<td ><code>sb1</code></td>
<td >
Section Break</td>
<td >
</td>
<td>
<pre>Simple</pre>
</td>
</tr>
<tr >
<td>10</td>
<td class="danger" title="Mandatory"><code>posting_date</code></td>
<td >
Date</td>
<td >
Posting Date
</td>
<td></td>
</tr>
<tr >
<td>11</td>
<td class="danger" title="Mandatory"><code>employee</code></td>
<td >
Link</td>
<td >
From Employee
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/hr/employee">Employee</a>
</td>
</tr>
<tr >
<td>12</td>
<td ><code>employee_name</code></td>
<td >
Data</td>
<td >
Employee Name
</td>
<td></td>
</tr>
<tr >
<td>13</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>14</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>15</td>
<td ><code>cb1</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>16</td>
<td ><code>total_amount_reimbursed</code></td>
<td >
Currency</td>
<td >
Total Amount Reimbursed
</td>
<td>
<pre>Company:company:default_currency</pre>
</td>
</tr>
<tr >
<td>17</td>
<td ><code>remark</code></td>
<td >
Small Text</td>
<td >
Remark
</td>
<td></td>
</tr>
<tr >
<td>18</td>
<td ><code>project</code></td>
<td >
Link</td>
<td >
Project
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/projects/project">Project</a>
</td>
</tr>
<tr >
<td>19</td>
<td ><code>task</code></td>
<td >
Link</td>
<td >
Task
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/projects/task">Task</a>
</td>
</tr>
<tr >
<td>20</td>
<td ><code>title</code></td>
<td >
Data</td>
<td class="text-muted" title="Hidden">
Title
</td>
<td></td>
</tr>
<tr >
<td>21</td>
<td ><code>email_id</code></td>
<td >
Data</td>
<td class="text-muted" title="Hidden">
Employees Email Id
</td>
<td></td>
</tr>
<tr >
<td>22</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/expense_claim">Expense Claim</a>
</td>
</tr>
</tbody>
</table>
<hr>
<h3>Controller</h3>
<h4>erpnext.hr.doctype.expense_claim.expense_claim</h4>
<h3 style="font-weight: normal;">Class <b>ExpenseClaim</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="calculate_total_amount" href="#calculate_total_amount" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>calculate_total_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="get_feed" href="#get_feed" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_feed</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="on_cancel" href="#on_cancel" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>on_cancel</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="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="update_task" href="#update_task" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>update_task</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="update_task_and_project" href="#update_task_and_project" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>update_task_and_project</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>
<p class="docs-attr-name">
<a name="validate_expense_approver" href="#validate_expense_approver" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_expense_approver</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_sanctioned_amount" href="#validate_sanctioned_amount" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_sanctioned_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>
</div>
<hr>
<h3 style="font-weight: normal;">Class <b>InvalidExpenseApproverError</b></h3>
<p style="padding-left: 30px;"><i>Inherits from frappe.exceptions.ValidationError</i></h4>
<div class="docs-attr-desc"><p></p>
</div>
<div style="padding-left: 30px;">
</div>
<hr>
<p><span class="label label-info">Public API</span>
<br><code>/api/method/erpnext.hr.doctype.expense_claim.expense_claim.get_expense_approver</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.hr.doctype.expense_claim.expense_claim.get_expense_approver" href="#erpnext.hr.doctype.expense_claim.expense_claim.get_expense_approver" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.hr.doctype.expense_claim.expense_claim.<b>get_expense_approver</b>
<i class="text-muted">(doctype, txt, searchfield, start, page_len, filters)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<h4>Linked In:</h4>
<ul>
2015-11-10 13:28:56 +00:00
2015-11-05 11:25:10 +00:00
<li>
<a href="https://frappe.github.io/erpnext/current/models/hr/expense_claim">Expense Claim</a>
</li>
2015-11-10 13:28:56 +00:00
2015-11-05 11:25:10 +00:00
</ul>
<!-- autodoc -->
<!-- jinja -->
<!-- static -->