Shiloh/brotherton-erpnext
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
cff91abd8d
brotherton-erpnext/erpnext/docs/current/models/utilities/address.html

710 lines
15 KiB
HTML
Raw Normal View History

[docs] updated generated docs
2015-12-03 12:58:19 +00:00
<!-- title: Address -->
<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/utilities/doctype/address"
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>tabAddress</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 class="info">
<td>1</td>
<td ><code>address_details</code></td>
<td >
Section Break</td>
<td >
</td>
<td>
<pre>icon-map-marker</pre>
</td>
</tr>
<tr >
<td>2</td>
<td ><code>address_title</code></td>
<td >
Data</td>
<td >
Address Title
<p class="text-muted small">
Name of person or organization that this address belongs to.</p>
</td>
<td></td>
</tr>
<tr >
<td>3</td>
<td class="danger" title="Mandatory"><code>address_type</code></td>
<td >
Select</td>
<td >
Address Type
</td>
<td>
<pre>Billing
Shipping
Office
Personal
Plant
Postal
Shop
Subsidiary
Warehouse
Other</pre>
</td>
</tr>
<tr >
<td>4</td>
<td class="danger" title="Mandatory"><code>address_line1</code></td>
<td >
Data</td>
<td >
Address Line 1
</td>
<td></td>
</tr>
<tr >
<td>5</td>
<td ><code>address_line2</code></td>
<td >
Data</td>
<td >
Address Line 2
</td>
<td></td>
</tr>
<tr >
<td>6</td>
<td class="danger" title="Mandatory"><code>city</code></td>
<td >
Data</td>
<td >
City/Town
</td>
<td></td>
</tr>
<tr >
<td>7</td>
<td ><code>state</code></td>
<td >
Data</td>
<td >
State
</td>
<td></td>
</tr>
<tr >
<td>8</td>
<td ><code>pincode</code></td>
<td >
Data</td>
<td >
Postal Code
</td>
<td></td>
</tr>
<tr >
<td>9</td>
<td class="danger" title="Mandatory"><code>country</code></td>
<td >
Link</td>
<td >
Country
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/geo/country">Country</a>
</td>
</tr>
<tr >
<td>10</td>
<td ><code>column_break0</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>11</td>
<td ><code>email_id</code></td>
<td >
Data</td>
<td >
Email Id
</td>
<td></td>
</tr>
<tr >
<td>12</td>
<td ><code>phone</code></td>
<td >
Data</td>
<td >
Phone
</td>
<td></td>
</tr>
<tr >
<td>13</td>
<td ><code>fax</code></td>
<td >
Data</td>
<td >
Fax
</td>
<td></td>
</tr>
<tr >
<td>14</td>
<td ><code>is_primary_address</code></td>
<td >
Check</td>
<td >
Preferred Billing Address
</td>
<td></td>
</tr>
<tr >
<td>15</td>
<td ><code>is_shipping_address</code></td>
<td >
Check</td>
<td >
Preferred Shipping Address
</td>
<td></td>
</tr>
<tr class="info">
<td>16</td>
<td ><code>linked_with</code></td>
<td >
Section Break</td>
<td >
Reference
</td>
<td>
<pre>icon-pushpin</pre>
</td>
</tr>
<tr >
<td>17</td>
<td ><code>customer</code></td>
<td >
Link</td>
<td >
Customer
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/selling/customer">Customer</a>
</td>
</tr>
<tr >
<td>18</td>
<td ><code>customer_name</code></td>
<td >
Data</td>
<td >
Customer Name
</td>
<td></td>
</tr>
<tr >
<td>19</td>
<td ><code>supplier</code></td>
<td >
Link</td>
<td >
Supplier
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/buying/supplier">Supplier</a>
</td>
</tr>
<tr >
<td>20</td>
<td ><code>supplier_name</code></td>
<td >
Data</td>
<td >
Supplier Name
</td>
<td></td>
</tr>
<tr >
<td>21</td>
<td ><code>sales_partner</code></td>
<td >
Link</td>
<td >
Sales Partner
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/setup/sales_partner">Sales Partner</a>
</td>
</tr>
<tr >
<td>22</td>
<td ><code>column_break_22</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>23</td>
<td ><code>lead</code></td>
<td >
Link</td>
<td >
Lead
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/crm/lead">Lead</a>
</td>
</tr>
<tr >
<td>24</td>
<td ><code>lead_name</code></td>
<td >
Data</td>
<td >
Lead Name
</td>
<td></td>
</tr>
</tbody>
</table>
<hr>
<h3>Controller</h3>
<h4>erpnext.utilities.doctype.address.address</h4>
<h3 style="font-weight: normal;">Class <b>Address</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="_unset_other" href="#_unset_other" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>_unset_other</b>
<i class="text-muted">(self, is_address_type)</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="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="get_display" href="#get_display" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_display</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="link_address" href="#link_address" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>link_address</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Link address based on owner</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_primary_address" href="#validate_primary_address" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_primary_address</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Validate that there can only be one primary address for particular customer, supplier</p>
</div>
<br>
<p class="docs-attr-name">
<a name="validate_shipping_address" href="#validate_shipping_address" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_shipping_address</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Validate that there can only be one shipping address for particular customer, supplier</p>
</div>
<br>
</div>
<hr>
<p><span class="label label-info">Public API</span>
<br><code>/api/method/erpnext.utilities.doctype.address.address.get_address_display</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.utilities.doctype.address.address.get_address_display" href="#erpnext.utilities.doctype.address.address.get_address_display" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.utilities.doctype.address.address.<b>get_address_display</b>
<i class="text-muted">(address_dict)</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="erpnext.utilities.doctype.address.address.get_list_context" href="#erpnext.utilities.doctype.address.address.get_list_context" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.utilities.doctype.address.address.<b>get_list_context</b>
<i class="text-muted">(context=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="erpnext.utilities.doctype.address.address.get_territory_from_address" href="#erpnext.utilities.doctype.address.address.get_territory_from_address" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.utilities.doctype.address.address.<b>get_territory_from_address</b>
<i class="text-muted">(address)</i>
</p>
<div class="docs-attr-desc"><p>Tries to match city, state and country of address to existing territory</p>
</div>
<br>
<p class="docs-attr-name">
<a name="erpnext.utilities.doctype.address.address.has_website_permission" href="#erpnext.utilities.doctype.address.address.has_website_permission" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.utilities.doctype.address.address.<b>has_website_permission</b>
<i class="text-muted">(doc, ptype, user, verbose=False)</i>
</p>
<div class="docs-attr-desc"><p>Returns true if customer or lead matches with user</p>
</div>
<br>
<h4>Linked In:</h4>
<ul>
<li>
<a href="https://frappe.github.io/erpnext/current/models/stock/delivery_note">Delivery Note</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/selling/installation_note">Installation Note</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/support/maintenance_schedule">Maintenance Schedule</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/support/maintenance_visit">Maintenance Visit</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/crm/opportunity">Opportunity</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/accounts/purchase_invoice">Purchase Invoice</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/buying/purchase_order">Purchase Order</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/stock/purchase_receipt">Purchase Receipt</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/selling/quotation">Quotation</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/accounts/sales_invoice">Sales Invoice</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/selling/sales_order">Sales Order</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/buying/supplier_quotation">Supplier Quotation</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/support/warranty_claim">Warranty Claim</a>
</li>
</ul>
<!-- autodoc -->
<!-- jinja -->
<!-- static -->
Reference in New Issue Copy Permalink