Location

Location - Get

HTTP Request

GET /api/v1/locations/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific financial entity’s location within the organizational structure, identified by the provided ID.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseLocationDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "city": "string",
    "cityOne": "string",
    "country": "string",
    "region": "string",
    "street": "string",
    "streetSupplimentoryOne": "string",
    "streetSupplimentoryTwo": "string",
    "houseNumber": "string",
    "postalCode": "string",
    "assetId": 0
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Location - Update

HTTP Request

PUT /api/v1/locations/{id}

Interactive Demo

📋 Description: Updates the details of a specified financial entity location within the organizational structure, allowing for adjustments to hierarchy and operational alignment.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	LocationDto	true	Request body containing the updated financial entity location details, including hierarchical structure and organizational attributes.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "city": "string",
  "cityOne": "string",
  "country": "string",
  "region": "string",
  "street": "string",
  "streetSupplimentoryOne": "string",
  "streetSupplimentoryTwo": "string",
  "houseNumber": "string",
  "postalCode": "string",
  "assetId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseLocationDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "city": "string",
    "cityOne": "string",
    "country": "string",
    "region": "string",
    "street": "string",
    "streetSupplimentoryOne": "string",
    "streetSupplimentoryTwo": "string",
    "houseNumber": "string",
    "postalCode": "string",
    "assetId": 0
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Location - Delete

HTTP Request

DELETE /api/v1/locations/{id}

Interactive Demo

📋 Description: Deletes a specified location from the financial organization structure, ensuring the hierarchy remains accurate and up-to-date for effective organizational management.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Location - Delete Or Decommission

HTTP Request

PUT /api/v1/locations/remove/{id}

Interactive Demo

📋 Description: Removes a specified location from the financial organization structure, ensuring the hierarchy remains accurate and up-to-date for effective management of financial entities.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Location - Delete Or Decommission All

HTTP Request

PUT /api/v1/locations/remove/bulk

Interactive Demo

📋 Description: Removes multiple locations from the financial organization structure in a single request, ensuring the hierarchy remains accurate and up-to-date.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of location identifiers to be removed in bulk from the financial organization structure, ensuring updates to the hierarchy of financial entities.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Location - Decommission

HTTP Request

PUT /api/v1/locations/decommission/{id}

Interactive Demo

📋 Description: Decommissions a specified financial entity location within the organizational structure, effectively removing it from the hierarchy and ensuring accurate representation of the current operational framework.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseLocationDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "city": "string",
    "cityOne": "string",
    "country": "string",
    "region": "string",
    "street": "string",
    "streetSupplimentoryOne": "string",
    "streetSupplimentoryTwo": "string",
    "houseNumber": "string",
    "postalCode": "string",
    "assetId": 0
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Location - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/locations/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Decommissions financial organization locations that have been modified before the specified date, ensuring the integrity of the organizational structure and hierarchy within the financial entity. This operation helps maintain an up-to-date and efficient organizational framework.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the date and time before which the financial organization structure locations were modified, facilitating the decommissioning of outdated entries.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListLocationDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "city": "string",
      "cityOne": "string",
      "country": "string",
      "region": "string",
      "street": "string",
      "streetSupplimentoryOne": "string",
      "streetSupplimentoryTwo": "string",
      "houseNumber": "string",
      "postalCode": "string",
      "assetId": 0
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Location - Decommission Before Now

HTTP Request

PUT /api/v1/locations/decommission/modified-before-now

Interactive Demo

📋 Description: Decommissions financial entity locations that have been modified before the current date, ensuring the organization’s structure remains up-to-date and aligned with operational needs.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListLocationDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "city": "string",
      "cityOne": "string",
      "country": "string",
      "region": "string",
      "street": "string",
      "streetSupplimentoryOne": "string",
      "streetSupplimentoryTwo": "string",
      "houseNumber": "string",
      "postalCode": "string",
      "assetId": 0
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Location - Decommission All

HTTP Request

PUT /api/v1/locations/decommission/bulk

Interactive Demo

📋 Description: Updates the status of multiple locations within the financial organization structure to ‘decommissioned,’ facilitating the management of organizational hierarchy and ensuring accurate representation of active financial entities.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of financial entity locations to be decommissioned in bulk, including their identifiers and relevant metadata for organizational structure updates.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListLocationDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "city": "string",
      "cityOne": "string",
      "country": "string",
      "region": "string",
      "street": "string",
      "streetSupplimentoryOne": "string",
      "streetSupplimentoryTwo": "string",
      "houseNumber": "string",
      "postalCode": "string",
      "assetId": 0
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Location - Create Or Update Bulk

HTTP Request

PUT /api/v1/locations/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple financial entity locations within the organization structure in a single request, ensuring the hierarchy is accurately maintained.

Parameters

Name	In	Type	Required	Description
body	body	LocationDto	true	Request body containing a bulk array of location data for creating or updating financial entities within the organizational structure and hierarchy.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "city": "string",
    "cityOne": "string",
    "country": "string",
    "region": "string",
    "street": "string",
    "streetSupplimentoryOne": "string",
    "streetSupplimentoryTwo": "string",
    "houseNumber": "string",
    "postalCode": "string",
    "assetId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListLocationDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "city": "string",
      "cityOne": "string",
      "country": "string",
      "region": "string",
      "street": "string",
      "streetSupplimentoryOne": "string",
      "streetSupplimentoryTwo": "string",
      "houseNumber": "string",
      "postalCode": "string",
      "assetId": 0
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Location - Create Or Update

HTTP Request

PUT /api/v1/locations/createOrUpdate

Interactive Demo

📋 Description: Creates or updates a financial entity’s location within the organizational structure, ensuring accurate hierarchy representation and alignment with business needs.

Parameters

Name	In	Type	Required	Description
body	body	LocationDto	true	Request body containing the details of the financial entity’s location, including hierarchical structure and organizational attributes for creation or update purposes.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "city": "string",
  "cityOne": "string",
  "country": "string",
  "region": "string",
  "street": "string",
  "streetSupplimentoryOne": "string",
  "streetSupplimentoryTwo": "string",
  "houseNumber": "string",
  "postalCode": "string",
  "assetId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseLocationDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "city": "string",
    "cityOne": "string",
    "country": "string",
    "region": "string",
    "street": "string",
    "streetSupplimentoryOne": "string",
    "streetSupplimentoryTwo": "string",
    "houseNumber": "string",
    "postalCode": "string",
    "assetId": 0
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Location - Bulk Update

HTTP Request

PUT /api/v1/locations/bulk

Interactive Demo

📋 Description: Updates multiple location records within the financial organization structure, allowing for efficient management of the hierarchy and relationships among financial entities.

Parameters

Name	In	Type	Required	Description
body	body	LocationDto	true	Request body containing a bulk update of financial entity location data, including organizational hierarchy and structural attributes.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "city": "string",
    "cityOne": "string",
    "country": "string",
    "region": "string",
    "street": "string",
    "streetSupplimentoryOne": "string",
    "streetSupplimentoryTwo": "string",
    "houseNumber": "string",
    "postalCode": "string",
    "assetId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListLocationDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "city": "string",
      "cityOne": "string",
      "country": "string",
      "region": "string",
      "street": "string",
      "streetSupplimentoryOne": "string",
      "streetSupplimentoryTwo": "string",
      "houseNumber": "string",
      "postalCode": "string",
      "assetId": 0
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Location - Bulk Create

HTTP Request

POST /api/v1/locations/bulk

Interactive Demo

📋 Description: Submits a bulk upload of location data to establish or update the organizational structure of financial entities, ensuring accurate hierarchy representation within the system.

Parameters

Name	In	Type	Required	Description
body	body	LocationDto	true	Request body containing a collection of financial entity location data, structured to facilitate the bulk creation or update of organizational hierarchy within the financial organization.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "city": "string",
    "cityOne": "string",
    "country": "string",
    "region": "string",
    "street": "string",
    "streetSupplimentoryOne": "string",
    "streetSupplimentoryTwo": "string",
    "houseNumber": "string",
    "postalCode": "string",
    "assetId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListLocationDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "city": "string",
      "cityOne": "string",
      "country": "string",
      "region": "string",
      "street": "string",
      "streetSupplimentoryOne": "string",
      "streetSupplimentoryTwo": "string",
      "houseNumber": "string",
      "postalCode": "string",
      "assetId": 0
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Location - Bulk Delete

HTTP Request

DELETE /api/v1/locations/bulk

Interactive Demo

📋 Description: Deletes multiple locations within the financial organization structure, allowing for efficient management of the entity’s hierarchical framework.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of location identifiers to be deleted from the financial organization structure, reflecting changes in the hierarchy of the financial entity.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Location - Search

HTTP Request

POST /api/v1/locations/search

Interactive Demo

📋 Description: Submits a request to search for financial entities within the organizational structure, allowing users to identify and analyze hierarchical relationships effectively.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	Zero-based page index (0..N)
size	query	integer	false	The size of the page to be returned
sort	query	array[string]	false	Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
body	body	LocationDtoFilter	false	Request body containing search criteria for financial entities within the organizational structure, including parameters for hierarchy and location details.

Default Values

Parameter	Default	Type
page	0	query
size	100	query
sort	["createdAt,ASC"]	query

Parameter Constraints

Parameter	Constraints
page	Min: 0
size	Min: 1

Body Parameters

{
  "idIn": [
    0
  ],
  "idEqual": 0,
  "idLike": "string",
  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "createdByLike": "string",
  "createdByEqual": "string",
  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedByLike": "string",
  "modifiedByEqual": "string",
  "statusEqual": "CREATED",
  "statusIn": [
    "CREATED"
  ],
  "displayIdIn": [
    "string"
  ],
  "displayIdLike": "string",
  "erpSystemIdEqual": 0,
  "erpSystemIdIn": [
    0
  ],
  "erpSystemDisplayIdLike": "string",
  "cityLike": "string",
  "cityOneLike": "string",
  "countryLike": "string",
  "regionLike": "string",
  "streetLike": "string",
  "streetSupplimentoryOneLike": "string",
  "streetSupplimentoryTwoLike": "string",
  "houseNumberLike": "string",
  "postalCodeLike": "string",
  "assetIdEqual": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageLocationDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "city": "string",
      "cityOne": "string",
      "country": "string",
      "region": "string",
      "street": "string",
      "streetSupplimentoryOne": "string",
      "streetSupplimentoryTwo": "string",
      "houseNumber": "string",
      "postalCode": "string",
      "assetId": 0
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Location - Find All

HTTP Request

GET /api/v1/locations

Interactive Demo

📋 Description: Retrieves a list of financial entities within the organizational structure, providing insights into the hierarchy and relationships among various locations.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results for the financial organization structure locations should be returned in a paginated format, facilitating efficient data retrieval and management within the organizational hierarchy.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageLocationDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "city": "string",
      "cityOne": "string",
      "country": "string",
      "region": "string",
      "street": "string",
      "streetSupplimentoryOne": "string",
      "streetSupplimentoryTwo": "string",
      "houseNumber": "string",
      "postalCode": "string",
      "assetId": 0
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Location - Create

HTTP Request

POST /api/v1/locations

Interactive Demo

📋 Description: Creates a new location within the financial organization structure, enabling the establishment of hierarchical relationships among financial entities.

Parameters

Name	In	Type	Required	Description
body	body	LocationDto	true	Request body containing the hierarchical structure data for a financial organization, including details on locations and their relationships within the entity.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "city": "string",
  "cityOne": "string",
  "country": "string",
  "region": "string",
  "street": "string",
  "streetSupplimentoryOne": "string",
  "streetSupplimentoryTwo": "string",
  "houseNumber": "string",
  "postalCode": "string",
  "assetId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseLocationDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "city": "string",
    "cityOne": "string",
    "country": "string",
    "region": "string",
    "street": "string",
    "streetSupplimentoryOne": "string",
    "streetSupplimentoryTwo": "string",
    "houseNumber": "string",
    "postalCode": "string",
    "assetId": 0
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Location - Get Metadata

HTTP Request

GET /api/v1/locations/meta

Interactive Demo

📋 Description: Retrieves metadata related to the financial organization structure, including details about locations within the hierarchy of financial entities. This operation supports effective management and analysis of organizational configurations.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "CITY"
]

Response Schema

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Location - Find All By System ID

HTTP Request

GET /api/v1/locations/erp-system/{systemId}

Interactive Demo

📋 Description: Fetches the details of a specified financial entity’s organizational structure within the ERP system, enabling users to understand the hierarchy and relationships of various components.

Parameters

Name	In	Type	Required	Description
systemId	path	integer(int64)	true	Unique identifier for the system
pageable	query	Pageable	true	Indicates whether the results should be returned in a paginated format, facilitating efficient navigation through the financial organization structure associated with the specified ERP system.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageLocationDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "city": "string",
      "cityOne": "string",
      "country": "string",
      "region": "string",
      "street": "string",
      "streetSupplimentoryOne": "string",
      "streetSupplimentoryTwo": "string",
      "houseNumber": "string",
      "postalCode": "string",
      "assetId": 0
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Location - Get All By Asset

HTTP Request

GET /api/v1/locations/asset/{asset_id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific asset within the financial organization structure, providing insights into its hierarchical positioning and associated organizational elements.

Parameters

Name	In	Type	Required	Description
asset_id	path	integer(int64)	true	Unique identifier for the financial asset within the organization’s structure, used to retrieve detailed information about its location in the hierarchy.
pageable	query	Pageable	true	Indicates whether the results should be returned in a paginated format, facilitating efficient data retrieval within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageLocationDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "city": "string",
      "cityOne": "string",
      "country": "string",
      "region": "string",
      "street": "string",
      "streetSupplimentoryOne": "string",
      "streetSupplimentoryTwo": "string",
      "houseNumber": "string",
      "postalCode": "string",
      "assetId": 0
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---