brotherton-erpnext/erpnext/docs/current/models/projects/project.md

19 KiB

Version 6.x.x
<a class="btn btn-default btn-sm" href="https://github.com/frappe/erpnext/tree/develop/erpnext/projects/doctype/project"
	target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
<p><b>Table Name:</b> <code>tabProject</code></p>

Fields

    <tr >
        <td>1</td>
        <td class="danger" title="Mandatory"><code>project_name</code></td>
        <td >
            Data</td>
        <td >
            Project Name
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>2</td>
        <td class="danger" title="Mandatory"><code>status</code></td>
        <td >
            Select</td>
        <td >
            Status
            
        </td>
        <td>
            <pre>Open

Completed Cancelled

    <tr >
        <td>3</td>
        <td ><code>project_type</code></td>
        <td >
            Select</td>
        <td >
            Project Type
            
        </td>
        <td>
            <pre>Internal

External Other

    <tr >
        <td>4</td>
        <td ><code>column_break_5</code></td>
        <td class="info">
            Column Break</td>
        <td >
            
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>5</td>
        <td ><code>is_active</code></td>
        <td >
            Select</td>
        <td >
            Is Active
            
        </td>
        <td>
            <pre>Yes

No

    <tr >
        <td>6</td>
        <td ><code>priority</code></td>
        <td >
            Select</td>
        <td >
            Priority
            
        </td>
        <td>
            <pre>Medium

Low High

    <tr class="info">
        <td>7</td>
        <td ><code>section_break_12</code></td>
        <td >
            Section Break</td>
        <td >
            
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>8</td>
        <td ><code>expected_start_date</code></td>
        <td >
            Date</td>
        <td >
            Expected Start Date
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>9</td>
        <td ><code>column_break_11</code></td>
        <td class="info">
            Column Break</td>
        <td >
            
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>10</td>
        <td ><code>expected_end_date</code></td>
        <td >
            Date</td>
        <td >
            Expected End Date
            
        </td>
        <td></td>
    </tr>
    
    <tr class="info">
        <td>11</td>
        <td ><code>customer_details</code></td>
        <td >
            Section Break</td>
        <td >
            
            
        </td>
        <td>
            <pre>icon-user</pre>
        </td>
    </tr>
    
    <tr >
        <td>12</td>
        <td ><code>customer</code></td>
        <td >
            Link</td>
        <td >
            Customer
            
        </td>
        <td>

Customer

        </td>
    </tr>
    
    <tr >
        <td>13</td>
        <td ><code>column_break_14</code></td>
        <td class="info">
            Column Break</td>
        <td >
            
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>14</td>
        <td ><code>sales_order</code></td>
        <td >
            Link</td>
        <td >
            Sales Order
            
        </td>
        <td>

Sales Order

        </td>
    </tr>
    
    <tr class="info">
        <td>15</td>
        <td ><code>sb_milestones</code></td>
        <td >
            Section Break</td>
        <td >
            Tasks
            
        </td>
        <td>
            <pre>icon-flag</pre>
        </td>
    </tr>
    
    <tr >
        <td>16</td>
        <td ><code>tasks</code></td>
        <td >
            Table</td>
        <td >
            Tasks
            
        </td>
        <td>

Project Task

        </td>
    </tr>
    
    <tr >
        <td>17</td>
        <td ><code>percent_complete</code></td>
        <td >
            Percent</td>
        <td >
            % Tasks Completed
            
        </td>
        <td></td>
    </tr>
    
    <tr class="info">
        <td>18</td>
        <td ><code>section_break0</code></td>
        <td >
            Section Break</td>
        <td >
            
            
        </td>
        <td>
            <pre>icon-list</pre>
        </td>
    </tr>
    
    <tr >
        <td>19</td>
        <td ><code>notes</code></td>
        <td >
            Text Editor</td>
        <td >
            Notes
            
        </td>
        <td></td>
    </tr>
    
    <tr class="info">
        <td>20</td>
        <td ><code>section_break_18</code></td>
        <td >
            Section Break</td>
        <td >
            
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>21</td>
        <td ><code>actual_start_date</code></td>
        <td >
            Data</td>
        <td >
            Actual Start Date
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>22</td>
        <td ><code>actual_time</code></td>
        <td >
            Float</td>
        <td >
            Actual Time (in Hours)
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>23</td>
        <td ><code>column_break_20</code></td>
        <td class="info">
            Column Break</td>
        <td >
            
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>24</td>
        <td ><code>actual_end_date</code></td>
        <td >
            Date</td>
        <td >
            Actual End Date
            
        </td>
        <td></td>
    </tr>
    
    <tr class="info">
        <td>25</td>
        <td ><code>section_break_26</code></td>
        <td >
            Section Break</td>
        <td >
            
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>26</td>
        <td ><code>estimated_costing</code></td>
        <td >
            Currency</td>
        <td >
            Estimated Costing
            
        </td>
        <td>
            <pre>Company:company:default_currency</pre>
        </td>
    </tr>
    
    <tr >
        <td>27</td>
        <td ><code>column_break_22</code></td>
        <td class="info">
            Column Break</td>
        <td >
            
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>28</td>
        <td ><code>company</code></td>
        <td >
            Link</td>
        <td >
            Company
            
        </td>
        <td>

Company

        </td>
    </tr>
    
    <tr >
        <td>29</td>
        <td ><code>cost_center</code></td>
        <td >
            Link</td>
        <td >
            Default Cost Center
            
        </td>
        <td>

Cost Center

        </td>
    </tr>
    
    <tr class="info">
        <td>30</td>
        <td ><code>project_details</code></td>
        <td >
            Section Break</td>
        <td >
            
            
        </td>
        <td>
            <pre>icon-money</pre>
        </td>
    </tr>
    
    <tr >
        <td>31</td>
        <td ><code>total_costing_amount</code></td>
        <td >
            Currency</td>
        <td >
            Total Costing Amount (via Time Logs)
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>32</td>
        <td ><code>total_expense_claim</code></td>
        <td >
            Currency</td>
        <td >
            Total Expense Claim (via Expense Claims)
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>33</td>
        <td ><code>column_break_28</code></td>
        <td class="info">
            Column Break</td>
        <td >
            
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>34</td>
        <td ><code>total_billing_amount</code></td>
        <td >
            Currency</td>
        <td >
            Total Billing Amount (via Time Logs)
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>35</td>
        <td ><code>total_purchase_cost</code></td>
        <td >
            Currency</td>
        <td >
            Total Purchase Cost (via Purchase Invoice)
            
        </td>
        <td></td>
    </tr>
    
    <tr class="info">
        <td>36</td>
        <td ><code>margin</code></td>
        <td >
            Section Break</td>
        <td >
            
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>37</td>
        <td ><code>gross_margin</code></td>
        <td >
            Currency</td>
        <td >
            Gross Margin
            
        </td>
        <td>
            <pre>Company:company:default_currency</pre>
        </td>
    </tr>
    
    <tr >
        <td>38</td>
        <td ><code>column_break_37</code></td>
        <td class="info">
            Column Break</td>
        <td >
            
            
        </td>
        <td></td>
    </tr>
    
    <tr >
        <td>39</td>
        <td ><code>per_gross_margin</code></td>
        <td >
            Percent</td>
        <td >
            Gross Margin %
            
        </td>
        <td></td>
    </tr>
    
</tbody>
Sr Fieldname Type Label Options
<hr>
<h3>Controller</h3>
<h4>erpnext.projects.doctype.project.project</h4>






    
<h3 style="font-weight: normal;">Class <b>Project</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="__setup__" href="#__setup__" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>__setup__</b>
    <i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>

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

<p class="docs-attr-name">
    <a name="get_tasks" href="#get_tasks" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>get_tasks</b>
    <i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>

<p class="docs-attr-name">
    <a name="onload" href="#onload" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>onload</b>
    <i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Load project tasks for quick view</p>

<p class="docs-attr-name">
    <a name="sync_tasks" href="#sync_tasks" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>sync_tasks</b>
    <i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>sync tasks and remove table</p>

<p class="docs-attr-name">
    <a name="update_costing" href="#update_costing" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>update_costing</b>
    <i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>

<p class="docs-attr-name">
    <a name="update_percent_complete" href="#update_percent_complete" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>update_percent_complete</b>
    <i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>

<p class="docs-attr-name">
    <a name="update_project" href="#update_project" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>update_project</b>
    <i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>

<p class="docs-attr-name">
    <a name="update_purchase_costing" href="#update_purchase_costing" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>update_purchase_costing</b>
    <i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>

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

<p class="docs-attr-name">
    <a name="validate_dates" href="#validate_dates" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	<b>validate_dates</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.projects.doctype.project.project.get_cost_center_name</code>
</p>
<p class="docs-attr-name">
    <a name="erpnext.projects.doctype.project.project.get_cost_center_name" href="#erpnext.projects.doctype.project.project.get_cost_center_name" class="text-muted small">
        <i class="icon-link small" style="color: #ccc;"></i></a>
	erpnext.projects.doctype.project.project.<b>get_cost_center_name</b>
    <i class="text-muted">(project_name)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>

    <h4>Linked In:</h4>
    <ul>
    
		
        <li>

BOM

        <li>

Delivery Note

        <li>

Expense Claim

        <li>

Production Order

        <li>

Purchase Invoice Item

        <li>

Purchase Order Item

        <li>

Purchase Receipt Item

        <li>

Sales Invoice

        <li>

Sales Order

        <li>

Stock Entry

        <li>

Stock Ledger Entry

        <li>

Supplier Quotation Item

        <li>

Task

        <li>

Time Log

    </ul>