This call is deprecated. For managing customer addresses, use CRM API.
The corresponding new call is: GET /v1/addresses.
Retrieve customer, supplier, or company addresses.
Important: if you operate in the European Union, the General Data Protection Regulation (GDPR) requires all processing done with customers' personal information to be logged. If you retrieve customer addresses, you are responsible for logging everything you do with the data. If it is not possible to keep the logs in the system that processes the data, you may consider writing the log entries into Erply, with the logProcessingOfCustomerData call.
| Parameter name | Description | Possible value | Required |
|---|---|---|---|
| addressIDs | Retrieve multiple addresses, IDs separated by commas. Eg. "1,2,3,4,5". | string | |
| ownerID | Customer ID, supplier ID, or your own company's ID. See getCustomers and getSuppliers. (Customer and supplier IDs do not overlap.) Deprecated alternative name: clientID | integer | yes |
| typeID | Address type ID. See getAddressTypes. | integer | |
| searchAttributeName | Name of attribute to search from. Both "searchAttributeName" and "searchAttributeValue" have to be specified. Error 1030 will be returned if value is an array. | string | |
| searchAttributeValue | Attribute value to search for. Error 1030 will be returned if value is an array. | string | |
| addedSince | Retrieve only items that have been created since the specified timestamp. Usually, you will want to use "changedSince" instead — see below. | integer | |
| changedSince | Retrieve only items that have been added or modified since the specified timestamp. Use it to keep a local database in sync with Erply. | Integer (Unix timestamp) | |
| lang | Retrieve item names in a specific language. If omitted, API will return item names in the default language of your Erply account. Possible values:
|
string | |
| orderBy | 'addressID' | ||
| orderByDir | Sort direction: 'asc' (ascending order) or 'desc' (descending order). By default, items are sorted in ascending order. | string | |
| recordsOnPage | Number of records API should return. By default 20, at most 100. | integer | |
| pageNo | API returns at most recordsOnPage items at a time. To retrieve the next recordsOnPage items, send a new request with pageNo incremented by one. By default, API returns "page 1". | integer |
| Field name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| addressID | integer | |||||||||||||
| ownerID | integer | Customer's or supplier's unique ID (deprecated alternative name: clientID) | ||||||||||||
| typeID | integer | Address type ID, see getAddressTypes. | ||||||||||||
| typeName | String (255) | Address type. | ||||||||||||
| typeActivelyUsed | integer | 0 or 1. Some address types are "archival types" -- addresses in these groups are not used for invoicing. This parameter indicates whether the type of this address is an archival type or not. | ||||||||||||
| street | String (65536) | Street address (or more generally, address line 1). | ||||||||||||
| address2 | String (65536) | Street address, line 2. This field is exposed via Erply user interface only for US, CA and MX accounts! | ||||||||||||
| city | String (255) | City, region, or county. | ||||||||||||
| postalCode | String (16) | Postal code or ZIP code.(deprecated alternative name: postcode) | ||||||||||||
| state | String (255) | State. This field is exposed via Erply user interface only for US, CA and MX accounts! | ||||||||||||
| country | String (255) | |||||||||||||
| added | integer | |||||||||||||
| lastModified | integer | |||||||||||||
| lastModifierUsername | string | Employee's username | ||||||||||||
| lastModifierEmployeeID | integer | ID of the employee | ||||||||||||
| attributes | array | Additional attributes. Each item looks like this:
|