Address DTO v18

The address object is used to store all addresses which are available. Addresses consist of the known properties and are referenced to their parent object by the object reference. This way each address gets its standard parent object, but can be referenced by certain working objects like activities.

In addition we take each address and enrich it with a related location object by asking Google for the corresponding coordinates.


Address Resolution Logic

The address that is used for activities in the planning list uses the following logic:

  1. Current Activity Address, if it exists (e.g. activity coming from ERP)
  2. Source Activity Address, if it exists (e.g. activity created as a copy of an existing activity)
  3. Address of the Service Call, if it exists
  4. Address of the Equipment linked to the Activity, if it exists
  5. Address of the First Equipment of the Service Call, if it exists
  6. BP Default ShipTo address type, if any
  7. BP Default BillTo address type, if any
  8. BP Default ShipTo address type, if any
  9. BP First BillTo address type, if any
  10. BP default address, if any

Field Name Type Category Constraint Reference Description
block String Optional length >= 1 & length <= 128 The block.
building String Optional length >= 1 & length <= 64 The building number.
city String Optional length >= 1 & length <= 128 The city.
country String Optional length >= 1 & length <= 128 The value of a country which must be one of the Country objects.
county String Optional length >= 1 & length <= 128 The county.
defaultAddress boolean Optional Indicates if this address should be shown as default address.
floor String Optional length >= 1 & length <= 64 The floor number.
name String Optional length >= 1 & length <= 128 The name.
name2 String Optional length >= 1 & length <= 128 A second name.
name3 String Optional length >= 1 & length <= 128 A third name.
object ObjectRef Required The object to which the address reference (e.g. a BusinessPartner if this is an address of it).
postOfficeBox String Optional length >= 0 & length <= 255 Rented Postal office box.
remarks String Optional length >= 1 & length <= 2147483647 Remarks or notes related to this address, can be used for any string based content which contains necessary information.
room String Optional length >= 1 & length <= 64 The room number.
state String Optional length >= 1 & length <= 128 The state.
street String Optional length >= 1 & length <= 512 The street.
streetNo String Optional length >= 0 & length <= 255
type String Optional length >= 0 & length <= 255

Allowed values are defined into Enumerations having enumType = ADDRESS_TYPE.
For learning about Enumerations, please check this.
The type.
zipCode String Optional length >= 1 & length <= 128 The zip code.