NextGen APIs

Addresses: Revision 1 (2024 W1)

Resource Fields

PII

SI

Field

Description

Format



id

The "id" refers to the identifier of a specific entity within the context of the API. It is automatically generated, does not change, and can only be accessed in read mode. It serves as a search filter to locate data based on a list of values.

This field is also named “addressId“ when used as path parameter.




targetId

Technical object

Asset: Revision 1 (2024 W1) or Accounts: Revision 1 (2024 W1)




typeId

Type

Address Types: Revision 1 (2024 W1)




description

Description




validityStart

Validity start date




validityEnd

Validity end date




nationId

Nation

Countries: Revision 1 (2024 W1)




districtCodeId

District

Districts: Revision 1 (2024 W1)


warning


normalizedMunicipality

Normalized Municipality

See note

warning


normalizedLocality

Normalized locality

See note

warning


normalizedPostalCode

Normalized Postal Code

See note

warning


normalizedStreet

Normalized Street

See note

warning


normalizedStreetNumber

Normalized Street Number

See note

warning


street

Initial Street


warning


streetNumber

Initial Street Number


warning


apartment

Initial apartment number


warning


streetNumberExtension

Extended customer street


warning


floor

Floor


warning


lot

Lot


warning


staircase

Stair case




xCoordinate

X coordinate

Geographical Coordinates




yCoordinate

Y coordinate

Geographical Coordinates


warning


municipalityCode

Municipality code




note

Notes


warning


normalizationToponym

Toponym




directions

Directions




code

Code


warning


municipality

Initial municipality


warning


locality

Initial locality


warning


postalCode

Initial postcode




geocodingAccuracy





geocodingStatusId





municipalityId

Municipality


API list