Address
A postal address of a customer, a supplier or the company.
Area: Customers and groups · Why it is here: guide chapter 04; recipe receipt_format; retail core · Fields: 16
Read and write it
Every call runs as your app's own user, with its key in one header, at the retailer's own address. The user reads and writes only what its role allows: your app's user, and the rights the retailer gives it.
Read a list (only name unless you ask for fields):
curl -s "https://⟨site⟩/api/resource/Address?fields=%5B%22*%22%5D&limit_page_length=20" \
-H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Read one, with its tables:
curl -s "https://⟨site⟩/api/resource/Address/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Create one (the required fields first), if your app's role may:
curl -s -X POST "https://⟨site⟩/api/resource/Address" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
-H "Content-Type: application/json" -d '{"address_type": …, "address_line1": …, "city": …, "country": …}'
Change one with PUT /api/resource/Address/⟨name⟩ and the fields you change; a table sent there replaces its rows, so send its existing rows too. All the record calls and their answers: the API reference.
Samples that use it
s4_receipt_pack · s41_regulated_register
Fields
Read from the product at POS 2.1.0.667 (till app 60147699c): its own fields, the fields iVendNext adds to it, and iVendNext's changes to any of them. Read-only fields are set by iVendNext; a hidden one is not on the form but can be read. Every record also has name (its id, in the address), owner, creation, modified, modified_by and docstatus (0 a draft, 1 submitted, 2 cancelled), all read-only.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Address Title | address_title |
Data | ||||
| Address Type | address_type |
Select | yes | one of: Billing, Shipping, Office, Personal, Plant, Postal, Shop, Subsidiary, Warehouse, Current, Permanent, Other | ||
| Address Line 1 | address_line1 |
Data | yes | |||
| Address Line 2 | address_line2 |
Data | ||||
| City/Town | city |
Data | yes | |||
| County | county |
Data | ||||
| State/Province | state |
Data | ||||
| Country | country |
Link | yes | Country | ||
| Postal Code | pincode |
Data | ||||
| Email Address | email_id |
Data | ||||
| Phone | phone |
Data | ||||
| Fax | fax |
Data | ||||
| Preferred Billing Address | is_primary_address |
Check | ||||
| Preferred Shipping Address | is_shipping_address |
Check | ||||
| Disabled | disabled |
Check | ||||
| Links | links |
Table | Dynamic Link |
Table: Dynamic Link
The rows of links. Each row also has idx (its place), parent, parentfield and parenttype.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Link Document Type | link_doctype |
Link | yes | DocType | ||
| Link Name | link_name |
Dynamic Link | yes | |||
| Link Title | link_title |
Read Only | yes |