Search

getAddresses

Retrieve customer, supplier, or company addresses.

Input parameters

Parameter nameDescriptionPossible valueRequired
ownerIDCustomer ID, supplier ID, or your own company's ID. See getCustomers and getSuppliers. (Customer and supplier IDs do not overlap.) Deprecated alternative name: clientIDInteger yes
typeIDAddress type ID. See getAddressTypes.Integer
searchAttributeNameSearch from attribute name.searchAttributeName and searchAttributeValue have to be specified bothString
searchAttributeValueSearch from attribute valueString
addedSince
changedSinceRetrieve 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)
langRetrieve item names in a specific language. If omitted, API will return item names in the default language of your ERPLY account.
Possible values:
  • 'eng' - English
  • 'spa' - Spanish
  • 'ger' - German
  • 'swe' - Swedish
  • 'fin' - Finnish
  • 'rus' - Russian
  • 'est' - Estonian
  • 'lat' - Latvian
  • 'lit' - Lithuanian
  • 'gre' - Greek
String
orderBy'addressID'
orderByDirBy default 'ASC'
recordsOnPageNumber of records API should return. By default 20, at most 100.Integer
pageNoAPI returns at most recordsOnPage items at a time. To retrive the next recordsOnPage items, send a new request with pageNo incremented by one. By default, API returns "page 1".Integer

Response

Field nameTypeDescription
addressIDInteger
ownerIDIntegerCustomer's or supplier's unique ID (deprecated alternative name: clientID)
typeIDIntegerAddress type ID, see getAddressTypes.
typeNameString (255)Address type.
typeActivelyUsed0 or 1Some 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.
streetString (65536)Street address (or more generally, address line 1).
address2String (65536)Street address, line 2. This field is exposed via Erply user interface only for US, CA and MX accounts!
cityString (255)City, region, or county.
postalCodeString (16)Postal code or ZIP code.(deprecated alternative name: postcode)
stateString (255)State. This field is exposed via Erply user interface only for US, CA and MX accounts!
countryString (255)
added
lastModified
lastModifierUsernameStringEmployee's username
lastModifierEmployeeIDIntegerID of the employee
attributesArrayAdditional attributes. Each item looks like this:

Field nameTypeDescription
attributeNameStringAttribute name
attributeTypeStringAttribute type
attributeValueStringAttribute value