Contact
A person to reach at a customer or a supplier, with their phone and email.
Area: Customers and groups · Why it is here: retail core · Fields: 25
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/Contact?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/Contact/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Create one, if your app's role may:
curl -s -X POST "https://⟨site⟩/api/resource/Contact" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
-H "Content-Type: application/json" -d '{"⟨field⟩": …}'
Change one with PUT /api/resource/Contact/⟨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.
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 |
|---|---|---|---|---|---|---|
| First Name | first_name |
Data | ||||
| Middle Name | middle_name |
Data | ||||
| Last Name | last_name |
Data | ||||
| Full Name | full_name |
Data | yes | yes | ||
| Email Address | email_id |
Data | yes | |||
| User Id | user |
Link | User | |||
| Address | address |
Link | Address | |||
| Sync with Google Contacts | sync_with_google_contacts |
Check | ||||
| Status | status |
Select | one of: Passive, Open, Replied | |||
| Salutation | salutation |
Link | Salutation | |||
| Designation | designation |
Data | ||||
| Gender | gender |
Link | Gender | |||
| Phone | phone |
Data | yes | |||
| Mobile No | mobile_no |
Data | yes | |||
| Company Name | company_name |
Data | ||||
| Image | image |
Attach Image | yes | |||
| Google Contacts | google_contacts |
Link | Google Contacts | |||
| Google Contacts Id | google_contacts_id |
Data | yes | |||
| Pulled from Google Contacts | pulled_from_google_contacts |
Check | yes | |||
| Email IDs | email_ids |
Table | Contact Email | |||
| Contact Numbers | phone_nos |
Table | Contact Phone | |||
| Links | links |
Table | Dynamic Link | |||
| Is Primary Contact | is_primary_contact |
Check | ||||
| Department | department |
Data | ||||
| Unsubscribed | unsubscribed |
Check |
Table: Contact Email
The rows of email_ids. Each row also has idx (its place), parent, parentfield and parenttype.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Email ID | email_id |
Data | yes | |||
| Is Primary | is_primary |
Check |
Table: Contact Phone
The rows of phone_nos. Each row also has idx (its place), parent, parentfield and parenttype.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Number | phone |
Data | yes | |||
| Is Primary Phone | is_primary_phone |
Check | ||||
| Is Primary Mobile | is_primary_mobile_no |
Check |
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 |