LocationDto

Example Json Object

 1{
 2  "id": 0,
 3  "status": "CREATED",
 4  "displayId": "string",
 5  "erpSystemId": 0,
 6  "erpSystemDisplayId": "string",
 7  "city": "string",
 8  "cityOne": "string",
 9  "country": "string",
10  "region": "string",
11  "street": "string",
12  "streetSupplimentoryOne": "string",
13  "streetSupplimentoryTwo": "string",
14  "houseNumber": "string",
15  "postalCode": "string",
16  "assetId": 0
17}

📄 Description: Data transfer object representing a location within the financial organization structure, detailing its hierarchical position and association with the overall organizational framework.

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

Unique identifier for the resource

status

string

false

none

Status of the resource

displayId

string

true

none

Unique identifier for the display

erpSystemId

integer(int64)

false

none

Unique identifier for the erp system

erpSystemDisplayId

string

false

none

Unique identifier for the erp system display

city

string

false

none

Represents the city associated with the financial entity’s location within the organizational structure.

cityOne

string

false

none

Represents the primary city associated with the financial entity within the organizational structure.

country

string

false

none

Represents the country in which the financial entity operates, essential for defining the organization’s structure and hierarchy within the financial organization framework.

region

string

false

none

Represents the geographical area associated with the financial entity within the organizational structure.

street

string

false

none

Represents the street address of a financial entity within the organizational structure, facilitating accurate location identification and hierarchy management.

streetSupplimentoryOne

string

false

none

Additional address information for the financial entity, enhancing the clarity of the organization’s location within its hierarchical structure.

streetSupplimentoryTwo

string

false

none

Additional address information for a financial entity, enhancing the organizational structure and hierarchy details within the system.

houseNumber

string

false

none

Represents the specific house number associated with a financial entity’s location within the organizational structure.

postalCode

string

false

none

Code for the postal

assetId

integer(int64)

false

none

Unique identifier for the asset

Enumerated Values

Attribute

Value

status

ACTIVE, CREATED, DECOMMISSIONED, DISABLED