Skip to main content

Address Types

EntityDatastoreDatastore.AdressType

Address types classify addresses (e.g., visiting, postal, invoice). They are referenced by addresses on Relations.

Use the Datastore_AdressType endpoint to query address types.

Endpoints

List Address Types

GET/v1/odata/Datastore_AdressType

Single Address Type

GET/v1/odata/Datastore_AdressType({id})

Fields

Datastore Fields (inherited)

FieldTypeDescription
NameStringDisplay name
CodeStringUnique code identifier
LocalizedNameStringLocalized display name
IsDefaultBooleanWhether this is the default value

Relationships

RelationshipTarget EntityCardinalityDescription
AddressAddress1:NAddress

Expanding Relationships

GET/v1/odata/Datastore_AdressType({id})?$expand=Address
GET/v1/odata/Datastore_AdressType({id})/Address

Filtering Examples

GET/v1/odata/Datastore_AdressType?$filter=Name eq '{Name}'&$top={top}
GET/v1/odata/Datastore_AdressType?$filter=contains(Name, '{Name}')&$top={top}
GET/v1/odata/Datastore_AdressType?$filter=Code eq '{Code}'&$top={top}
GET/v1/odata/Datastore_AdressType?$filter=IsDefault eq {IsDefault}&$top={top}