Region

Get A Resource By ID

HTTP Request

GET /api/v1/regions/{id}

📋 Description: Retrieves detailed information about a specific financial entity’s region within the organizational structure, identified by the provided region 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

ResponseRegionDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {
15    "id": 0,
16    "status": "CREATED",
17    "displayId": "string",
18    "erpSystemId": 0,
19    "erpSystemDisplayId": "string",
20    "name": "string",
21    "countryId": 0,
22    "countryDisplayId": "string"
23  }
24}

Update A Resource

HTTP Request

PUT /api/v1/regions/{id}

📋 Description: Updates the details of a specified region within the financial organization structure, allowing for adjustments to the hierarchy and organization of financial entities.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

RegionDto

true

Request body containing updated details for the specified region, including organizational hierarchy and financial entity attributes.

Body Parameters

 1{
 2  "id": 0,
 3  "status": "CREATED",
 4  "displayId": "string",
 5  "erpSystemId": 0,
 6  "erpSystemDisplayId": "string",
 7  "name": "string",
 8  "countryId": 0,
 9  "countryDisplayId": "string"
10}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseRegionDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {
15    "id": 0,
16    "status": "CREATED",
17    "displayId": "string",
18    "erpSystemId": 0,
19    "erpSystemDisplayId": "string",
20    "name": "string",
21    "countryId": 0,
22    "countryDisplayId": "string"
23  }
24}

Delete

HTTP Request

DELETE /api/v1/regions/{id}

📋 Description: Deletes a specified region 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

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {}
15}

Delete Or Decommission

HTTP Request

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

📋 Description: Removes a specified region 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

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {}
15}

Delete Or Decommission All

HTTP Request

PUT /api/v1/regions/remove/bulk

📋 Description: Removes multiple regions from the financial organization structure in a single operation, ensuring efficient management of the entity’s hierarchical configuration.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

true

Request body containing a list of region identifiers to be removed in bulk from the financial organization structure, ensuring an updated hierarchy within the entity.

Body Parameters

1[
2  0
3]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {}
15}

Decommission

HTTP Request

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

📋 Description: Decommissions a specified region within the financial organization structure, effectively removing it from the active hierarchy and ensuring that it is no longer considered in organizational operations. This operation is essential for maintaining an accurate representation of the financial entity’s structure.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseRegionDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {
15    "id": 0,
16    "status": "CREATED",
17    "displayId": "string",
18    "erpSystemId": 0,
19    "erpSystemDisplayId": "string",
20    "name": "string",
21    "countryId": 0,
22    "countryDisplayId": "string"
23  }
24}

Decommission By Modification Date Before

HTTP Request

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

📋 Description: Decommissions financial entities in the organization structure that were modified before the specified date, ensuring the hierarchy remains current and aligned with business needs.

Parameters

Name

In

Type

Required

Description

modified_before

path

string(date-time)

true

Specifies the cutoff date for decommissioning regions in the financial organization structure, allowing for the selective removal of entities modified before this date.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListRegionDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": [
15    {
16      "id": 0,
17      "status": "CREATED",
18      "displayId": "string",
19      "erpSystemId": 0,
20      "erpSystemDisplayId": "string",
21      "name": "string",
22      "countryId": 0,
23      "countryDisplayId": "string"
24    }
25  ]
26}

Decommission Before Now

HTTP Request

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

📋 Description: Decommissions regions within the financial organization structure that have been modified before the current date, ensuring the hierarchy remains up-to-date and aligned with organizational needs.

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListRegionDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": [
15    {
16      "id": 0,
17      "status": "CREATED",
18      "displayId": "string",
19      "erpSystemId": 0,
20      "erpSystemDisplayId": "string",
21      "name": "string",
22      "countryId": 0,
23      "countryDisplayId": "string"
24    }
25  ]
26}

Decommission All

HTTP Request

PUT /api/v1/regions/decommission/bulk

📋 Description: Decommissions multiple regions within the financial organization structure, allowing for efficient management of the hierarchy and alignment of financial entities.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

true

Request body containing a list of financial entity regions to be decommissioned in bulk, including relevant identifiers and metadata for organizational structure management.

Body Parameters

1[
2  0
3]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListRegionDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": [
15    {
16      "id": 0,
17      "status": "CREATED",
18      "displayId": "string",
19      "erpSystemId": 0,
20      "erpSystemDisplayId": "string",
21      "name": "string",
22      "countryId": 0,
23      "countryDisplayId": "string"
24    }
25  ]
26}

Bulk Create-Or-Update Resources

HTTP Request

PUT /api/v1/regions/createOrUpdate/bulk

📋 Description: Updates or creates multiple regions within the financial organization structure in a single operation, allowing for efficient management of organizational hierarchy and entity configurations.

Parameters

Name

In

Type

Required

Description

body

body

RegionDto

true

Request body containing a bulk array of region data for creating or updating financial entities within the organizational structure and hierarchy.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "status": "CREATED",
 5    "displayId": "string",
 6    "erpSystemId": 0,
 7    "erpSystemDisplayId": "string",
 8    "name": "string",
 9    "countryId": 0,
10    "countryDisplayId": "string"
11  }
12]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListRegionDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": [
15    {
16      "id": 0,
17      "status": "CREATED",
18      "displayId": "string",
19      "erpSystemId": 0,
20      "erpSystemDisplayId": "string",
21      "name": "string",
22      "countryId": 0,
23      "countryDisplayId": "string"
24    }
25  ]
26}

Create Or Update A Resource

HTTP Request

PUT /api/v1/regions/createOrUpdate

📋 Description: Creates or updates a financial entity’s organizational structure within the specified region, ensuring the hierarchy reflects the latest changes in the organization.

Parameters

Name

In

Type

Required

Description

body

body

RegionDto

true

Request body containing the financial entity’s regional data, including hierarchical structure and organizational attributes for creation or update purposes.

Body Parameters

 1{
 2  "id": 0,
 3  "status": "CREATED",
 4  "displayId": "string",
 5  "erpSystemId": 0,
 6  "erpSystemDisplayId": "string",
 7  "name": "string",
 8  "countryId": 0,
 9  "countryDisplayId": "string"
10}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseRegionDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {
15    "id": 0,
16    "status": "CREATED",
17    "displayId": "string",
18    "erpSystemId": 0,
19    "erpSystemDisplayId": "string",
20    "name": "string",
21    "countryId": 0,
22    "countryDisplayId": "string"
23  }
24}

Bulk-Update Resources

HTTP Request

PUT /api/v1/regions/bulk

📋 Description: Updates multiple regions within the financial organization structure in a single request, allowing for efficient management of hierarchical relationships among financial entities.

Parameters

Name

In

Type

Required

Description

body

body

RegionDto

true

Request body containing a bulk update of regional financial entity data, including organizational hierarchy and structure details.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "status": "CREATED",
 5    "displayId": "string",
 6    "erpSystemId": 0,
 7    "erpSystemDisplayId": "string",
 8    "name": "string",
 9    "countryId": 0,
10    "countryDisplayId": "string"
11  }
12]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListRegionDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": [
15    {
16      "id": 0,
17      "status": "CREATED",
18      "displayId": "string",
19      "erpSystemId": 0,
20      "erpSystemDisplayId": "string",
21      "name": "string",
22      "countryId": 0,
23      "countryDisplayId": "string"
24    }
25  ]
26}

Bulk Create

HTTP Request

POST /api/v1/regions/bulk

📋 Description: Submits a bulk creation request for multiple regions within the financial organization structure, enabling efficient management of organizational hierarchy and entity classification.

Parameters

Name

In

Type

Required

Description

body

body

RegionDto

true

Request body containing a list of region data for bulk creation or updates within the financial organization structure, including hierarchical relationships and associated attributes.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "status": "CREATED",
 5    "displayId": "string",
 6    "erpSystemId": 0,
 7    "erpSystemDisplayId": "string",
 8    "name": "string",
 9    "countryId": 0,
10    "countryDisplayId": "string"
11  }
12]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListRegionDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": [
15    {
16      "id": 0,
17      "status": "CREATED",
18      "displayId": "string",
19      "erpSystemId": 0,
20      "erpSystemDisplayId": "string",
21      "name": "string",
22      "countryId": 0,
23      "countryDisplayId": "string"
24    }
25  ]
26}

Bulk Delete

HTTP Request

DELETE /api/v1/regions/bulk

📋 Description: Deletes multiple regions from the financial organization structure, allowing for efficient management of the hierarchy within financial entities.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

true

Request body containing an array of region identifiers to be deleted from the financial organization structure hierarchy.

Body Parameters

1[
2  0
3]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {}
15}

Search Resources

HTTP Request

POST /api/v1/regions/search

📋 Description: Submits a search request for financial organization regions, enabling users to identify and retrieve specific hierarchical structures within the financial entity.

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

RegionDtoFilter

false

Request body containing search criteria for identifying financial entities within the organizational structure and hierarchy.

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

 1{
 2  "idIn": [
 3    0
 4  ],
 5  "idEqual": 0,
 6  "idLike": "string",
 7  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
 8  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
 9  "createdByLike": "string",
10  "createdByEqual": "string",
11  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13  "modifiedByLike": "string",
14  "modifiedByEqual": "string",
15  "statusEqual": "CREATED",
16  "statusIn": [
17    "CREATED"
18  ],
19  "displayIdIn": [
20    "string"
21  ],
22  "displayIdLike": "string",
23  "erpSystemIdEqual": 0,
24  "erpSystemIdIn": [
25    0
26  ],
27  "erpSystemDisplayIdLike": "string",
28  "nameLike": "string",
29  "countryIdEqual": 0,
30  "countryDisplayIdEqual": "string"
31}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageRegionDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": true,
 7    "pageSize": 0,
 8    "paged": true,
 9    "offset": 0,
10    "sort": {
11      "unsorted": true,
12      "sorted": true,
13      "empty": true
14    }
15  },
16  "numberOfElements": 0,
17  "size": 0,
18  "content": [
19    {
20      "id": 0,
21      "status": "CREATED",
22      "displayId": "string",
23      "erpSystemId": 0,
24      "erpSystemDisplayId": "string",
25      "name": "string",
26      "countryId": 0,
27      "countryDisplayId": "string"
28    }
29  ],
30  "number": 0,
31  "sort": {
32    "unsorted": true,
33    "sorted": true,
34    "empty": true
35  },
36  "first": true,
37  "last": true,
38  "empty": true
39}

Detach Country

HTTP Request

POST /api/v1/regions/detach/country/{relation_id}

📋 Description: Detaches a specified country from the financial organization structure hierarchy using the provided relation ID, thereby updating the organizational relationships within the financial entity.

Parameters

Name

In

Type

Required

Description

relation_id

path

integer(int64)

true

Unique identifier for the financial entity’s relationship within the organizational structure, used to detach a country from the specified hierarchy.

body

body

RegionDto

true

Request body containing the details of the financial entity’s relationship to be detached from the specified country, including relevant identifiers and metadata.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "status": "CREATED",
 5    "displayId": "string",
 6    "erpSystemId": 0,
 7    "erpSystemDisplayId": "string",
 8    "name": "string",
 9    "countryId": 0,
10    "countryDisplayId": "string"
11  }
12]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {}
15}

Attach Country

HTTP Request

POST /api/v1/regions/attach/country/{relation_id}

📋 Description: Attaches a specified country to a financial organization’s structure using the provided relation ID, facilitating the establishment of hierarchical relationships within the entity.

Parameters

Name

In

Type

Required

Description

relation_id

path

integer(int64)

true

Unique identifier for the country relationship within the financial organization structure, facilitating the attachment of regions to the specified country entity.

body

body

RegionDto

true

Request body containing the country association details, including relationship attributes and hierarchical positioning within the financial organization structure.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "status": "CREATED",
 5    "displayId": "string",
 6    "erpSystemId": 0,
 7    "erpSystemDisplayId": "string",
 8    "name": "string",
 9    "countryId": 0,
10    "countryDisplayId": "string"
11  }
12]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseVoid

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {}
15}

List All Resources

HTTP Request

GET /api/v1/regions

📋 Description: Retrieves a list of regions within the financial organization structure, providing insights into the hierarchical organization of financial entities.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the financial organization structure query should be returned in a paginated format, facilitating efficient navigation through large datasets of regions.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageRegionDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": true,
 7    "pageSize": 0,
 8    "paged": true,
 9    "offset": 0,
10    "sort": {
11      "unsorted": true,
12      "sorted": true,
13      "empty": true
14    }
15  },
16  "numberOfElements": 0,
17  "size": 0,
18  "content": [
19    {
20      "id": 0,
21      "status": "CREATED",
22      "displayId": "string",
23      "erpSystemId": 0,
24      "erpSystemDisplayId": "string",
25      "name": "string",
26      "countryId": 0,
27      "countryDisplayId": "string"
28    }
29  ],
30  "number": 0,
31  "sort": {
32    "unsorted": true,
33    "sorted": true,
34    "empty": true
35  },
36  "first": true,
37  "last": true,
38  "empty": true
39}

Create

HTTP Request

POST /api/v1/regions

📋 Description: Creates a new region within the financial organization structure, enabling the establishment of hierarchical relationships and enhancing the management of financial entities.

Parameters

Name

In

Type

Required

Description

body

body

RegionDto

true

Request body containing the details of a new financial entity’s regional structure, including hierarchy and organizational attributes.

Body Parameters

 1{
 2  "id": 0,
 3  "status": "CREATED",
 4  "displayId": "string",
 5  "erpSystemId": 0,
 6  "erpSystemDisplayId": "string",
 7  "name": "string",
 8  "countryId": 0,
 9  "countryDisplayId": "string"
10}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseRegionDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "errors": {
 4    "all": [
 5      {
 6        "type": "GENERIC",
 7        "errorMessage": "string",
 8        "source": {},
 9        "field": "string",
10        "errorKey": "string"
11      }
12    ]
13  },
14  "object": {
15    "id": 0,
16    "status": "CREATED",
17    "displayId": "string",
18    "erpSystemId": 0,
19    "erpSystemDisplayId": "string",
20    "name": "string",
21    "countryId": 0,
22    "countryDisplayId": "string"
23  }
24}

Get Metadata

HTTP Request

GET /api/v1/regions/meta

📋 Description: Retrieves metadata related to the organizational structure and hierarchy of financial entities, providing essential insights for effective management and analysis.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

1[
2  "NAME"
3]

Response Schema

Find All By System ID

HTTP Request

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

📋 Description: Retrieves the organizational structure and hierarchy details for a specified financial entity within the ERP system, identified by the unique system ID.

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 of the specified ERP system.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageRegionDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": true,
 7    "pageSize": 0,
 8    "paged": true,
 9    "offset": 0,
10    "sort": {
11      "unsorted": true,
12      "sorted": true,
13      "empty": true
14    }
15  },
16  "numberOfElements": 0,
17  "size": 0,
18  "content": [
19    {
20      "id": 0,
21      "status": "CREATED",
22      "displayId": "string",
23      "erpSystemId": 0,
24      "erpSystemDisplayId": "string",
25      "name": "string",
26      "countryId": 0,
27      "countryDisplayId": "string"
28    }
29  ],
30  "number": 0,
31  "sort": {
32    "unsorted": true,
33    "sorted": true,
34    "empty": true
35  },
36  "first": true,
37  "last": true,
38  "empty": true
39}

Get All By Country

HTTP Request

GET /api/v1/regions/country/{id}

📋 Description: Retrieves detailed information about a specific country within the financial organization structure, identified by the provided country ID. This operation supports the understanding of the organizational hierarchy and structure of financial entities.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

pageable

query

Pageable

true

Indicates whether the response should be paginated, facilitating efficient retrieval of hierarchical data related to financial entities within the specified country.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageRegionDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": true,
 7    "pageSize": 0,
 8    "paged": true,
 9    "offset": 0,
10    "sort": {
11      "unsorted": true,
12      "sorted": true,
13      "empty": true
14    }
15  },
16  "numberOfElements": 0,
17  "size": 0,
18  "content": [
19    {
20      "id": 0,
21      "status": "CREATED",
22      "displayId": "string",
23      "erpSystemId": 0,
24      "erpSystemDisplayId": "string",
25      "name": "string",
26      "countryId": 0,
27      "countryDisplayId": "string"
28    }
29  ],
30  "number": 0,
31  "sort": {
32    "unsorted": true,
33    "sorted": true,
34    "empty": true
35  },
36  "first": true,
37  "last": true,
38  "empty": true
39}