Country

Country - Get

HTTP Request

GET /api/v1/countries/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific financial entity within the organizational structure by its unique identifier, facilitating insights into the hierarchy and relationships of the organization.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseCountryDto

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",
    "name": "string",
    "schema": "string",
    "taxJurisdictionEnabled": true,
    "regionId": 0,
    "companyId": 0,
    "taxJurisdictionId": 0,
    "taxCodeId": 0,
    "paymentMethodId": 0
  }
}

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

Country - Update

HTTP Request

PUT /api/v1/countries/{id}

Interactive Demo

📋 Description: Updates the details of a specified country within the financial organization structure, allowing for modifications to the hierarchy and attributes of the financial entity.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	CountryDto	true	Request body containing the updated financial entity details for the specified country, including organizational structure and hierarchy information.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "schema": "string",
  "taxJurisdictionEnabled": true,
  "regionId": 0,
  "companyId": 0,
  "taxJurisdictionId": 0,
  "taxCodeId": 0,
  "paymentMethodId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseCountryDto

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",
    "name": "string",
    "schema": "string",
    "taxJurisdictionEnabled": true,
    "regionId": 0,
    "companyId": 0,
    "taxJurisdictionId": 0,
    "taxCodeId": 0,
    "paymentMethodId": 0
  }
}

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

Country - Delete

HTTP Request

DELETE /api/v1/countries/{id}

Interactive Demo

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

Country - Delete Or Decommission

HTTP Request

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

Interactive Demo

📋 Description: Removes a specified country from the financial organization structure, ensuring the integrity of the hierarchy within the financial entity.

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

Country - Delete Or Decommission All

HTTP Request

PUT /api/v1/countries/remove/bulk

Interactive Demo

📋 Description: Removes multiple countries from the financial organization structure in a single operation, streamlining the management of hierarchical relationships within financial entities.

Parameters

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

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

Country - Decommission

HTTP Request

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

Interactive Demo

📋 Description: Decommissions a specified country within the financial organization structure, effectively removing it from the active hierarchy of financial entities. This operation ensures that the organizational structure remains current and accurately reflects the operational landscape.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseCountryDto

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",
    "name": "string",
    "schema": "string",
    "taxJurisdictionEnabled": true,
    "regionId": 0,
    "companyId": 0,
    "taxJurisdictionId": 0,
    "taxCodeId": 0,
    "paymentMethodId": 0
  }
}

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

Country - Decommission By Modification Date Before

HTTP Request

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

Interactive Demo

📋 Description: Decommissions countries from the financial organization structure that were modified before the specified date, ensuring the hierarchy remains up-to-date and aligned with current operational needs.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the date and time before which the financial entity’s organizational structure modifications are to be decommissioned.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListCountryDto

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",
      "name": "string",
      "schema": "string",
      "taxJurisdictionEnabled": true,
      "regionId": 0,
      "companyId": 0,
      "taxJurisdictionId": 0,
      "taxCodeId": 0,
      "paymentMethodId": 0
    }
  ]
}

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

Country - Decommission Before Now

HTTP Request

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

Interactive Demo

📋 Description: Decommissions countries in the financial organization structure that have been modified before the current date, ensuring the hierarchy remains accurate and up-to-date.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListCountryDto

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",
      "name": "string",
      "schema": "string",
      "taxJurisdictionEnabled": true,
      "regionId": 0,
      "companyId": 0,
      "taxJurisdictionId": 0,
      "taxCodeId": 0,
      "paymentMethodId": 0
    }
  ]
}

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

Country - Decommission All

HTTP Request

PUT /api/v1/countries/decommission/bulk

Interactive Demo

📋 Description: Decommissions multiple countries from the financial organization structure in a single operation, ensuring updates to the hierarchy and organization alignment are efficiently managed.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of country identifiers and associated metadata for the bulk decommissioning of financial entities within the organizational structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListCountryDto

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",
      "name": "string",
      "schema": "string",
      "taxJurisdictionEnabled": true,
      "regionId": 0,
      "companyId": 0,
      "taxJurisdictionId": 0,
      "taxCodeId": 0,
      "paymentMethodId": 0
    }
  ]
}

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

Country - Create Or Update Bulk

HTTP Request

PUT /api/v1/countries/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple country records within the financial organization structure, facilitating the management of hierarchical relationships and ensuring accurate representation of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	CountryDto	true	Request body containing a bulk array of country 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",
    "name": "string",
    "schema": "string",
    "taxJurisdictionEnabled": true,
    "regionId": 0,
    "companyId": 0,
    "taxJurisdictionId": 0,
    "taxCodeId": 0,
    "paymentMethodId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListCountryDto

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",
      "name": "string",
      "schema": "string",
      "taxJurisdictionEnabled": true,
      "regionId": 0,
      "companyId": 0,
      "taxJurisdictionId": 0,
      "taxCodeId": 0,
      "paymentMethodId": 0
    }
  ]
}

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

Country - Create Or Update

HTTP Request

PUT /api/v1/countries/createOrUpdate

Interactive Demo

📋 Description: Updates or creates a financial entity within the organizational structure by submitting country-specific data. This operation ensures that the hierarchy of financial organizations remains accurate and up-to-date.

Parameters

Name	In	Type	Required	Description
body	body	CountryDto	true	Request body containing the financial entity details for creating or updating the organizational structure and hierarchy of countries within the financial organization.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "schema": "string",
  "taxJurisdictionEnabled": true,
  "regionId": 0,
  "companyId": 0,
  "taxJurisdictionId": 0,
  "taxCodeId": 0,
  "paymentMethodId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseCountryDto

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",
    "name": "string",
    "schema": "string",
    "taxJurisdictionEnabled": true,
    "regionId": 0,
    "companyId": 0,
    "taxJurisdictionId": 0,
    "taxCodeId": 0,
    "paymentMethodId": 0
  }
}

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

Country - Bulk Update

HTTP Request

PUT /api/v1/countries/bulk

Interactive Demo

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

Parameters

Name	In	Type	Required	Description
body	body	CountryDto	true	Request body containing a bulk update of country data, including organizational structure and hierarchy details for financial entities.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "schema": "string",
    "taxJurisdictionEnabled": true,
    "regionId": 0,
    "companyId": 0,
    "taxJurisdictionId": 0,
    "taxCodeId": 0,
    "paymentMethodId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListCountryDto

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",
      "name": "string",
      "schema": "string",
      "taxJurisdictionEnabled": true,
      "regionId": 0,
      "companyId": 0,
      "taxJurisdictionId": 0,
      "taxCodeId": 0,
      "paymentMethodId": 0
    }
  ]
}

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

Country - Bulk Create

HTTP Request

POST /api/v1/countries/bulk

Interactive Demo

📋 Description: Submits a bulk upload of country data to establish or update the financial organization structure, enabling efficient management of hierarchical relationships within financial entities.

Parameters

Name	In	Type	Required	Description
body	body	CountryDto	true	Request body containing an array of country data entries, each representing a financial entity’s organizational structure and hierarchy for bulk processing.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "schema": "string",
    "taxJurisdictionEnabled": true,
    "regionId": 0,
    "companyId": 0,
    "taxJurisdictionId": 0,
    "taxCodeId": 0,
    "paymentMethodId": 0
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListCountryDto

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",
      "name": "string",
      "schema": "string",
      "taxJurisdictionEnabled": true,
      "regionId": 0,
      "companyId": 0,
      "taxJurisdictionId": 0,
      "taxCodeId": 0,
      "paymentMethodId": 0
    }
  ]
}

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

Country - Bulk Delete

HTTP Request

DELETE /api/v1/countries/bulk

Interactive Demo

📋 Description: Deletes multiple country entries from the financial organization structure, allowing for streamlined management of the hierarchy within financial entities.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of country identifiers to be deleted from the financial organization structure, ensuring the integrity of the hierarchy and compliance with organizational standards.

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

Country - Update Tax Jurisdiction Enabled

HTTP Request

POST /api/v1/countries/updateTaxJurisdictionEnabled

Interactive Demo

📋 Description: Updates the tax jurisdiction status for specified countries within the financial organization structure, enabling or disabling tax compliance features as needed for effective hierarchy management.

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

Country - Search

HTTP Request

POST /api/v1/countries/search

Interactive Demo

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

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	CountryDtoFilter	false	Request body containing search criteria for identifying financial entities within the organizational structure and hierarchy of countries.

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",
  "nameLike": "string",
  "schemaLike": "string",
  "schemaEqual": "string",
  "taxJurisdictionEnabledEqual": true,
  "regionIdEqual": 0,
  "companyIdEqual": 0,
  "taxJurisdictionIdEqual": 0,
  "taxCodeIdEqual": 0,
  "paymentMethodIdEqual": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageCountryDto

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",
      "name": "string",
      "schema": "string",
      "taxJurisdictionEnabled": true,
      "regionId": 0,
      "companyId": 0,
      "taxJurisdictionId": 0,
      "taxCodeId": 0,
      "paymentMethodId": 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

Country - Search By Schema

HTTP Request

POST /api/v1/countries/schema/{schema}

Interactive Demo

📋 Description: Creates a new country schema within the financial organization structure, enabling the definition of hierarchical relationships and attributes for financial entities.

Parameters

Name	In	Type	Required	Description
schema	path	string	true	Specifies the schema type for the financial organization structure, enabling the accurate representation of the hierarchy and relationships within financial entities.
erpSystemId	query	integer(int64)	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseCountryDto

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",
    "name": "string",
    "schema": "string",
    "taxJurisdictionEnabled": true,
    "regionId": 0,
    "companyId": 0,
    "taxJurisdictionId": 0,
    "taxCodeId": 0,
    "paymentMethodId": 0
  }
}

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

Country - Detach Region

HTTP Request

POST /api/v1/countries/detach/region/{region_id}

Interactive Demo

📋 Description: Detaches a specified region from the financial organization structure, facilitating the reorganization of entities within the hierarchy. This operation is essential for maintaining accurate and efficient management of organizational relationships.

Parameters

Name	In	Type	Required	Description
region_id	path	integer(int64)	true	Unique identifier for the specific region within the financial organization structure, used to detach it from the associated country hierarchy.
body	body	CountryDto	true	Request body containing the details of the financial entity to be detached from the specified region, including relevant identifiers and metadata for organizational hierarchy management.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "schema": "string",
    "taxJurisdictionEnabled": true,
    "regionId": 0,
    "companyId": 0,
    "taxJurisdictionId": 0,
    "taxCodeId": 0,
    "paymentMethodId": 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

Country - Detach Company

HTTP Request

POST /api/v1/countries/detach/company/{company_id}

Interactive Demo

📋 Description: Detaches a specified company from its associated country within the financial organization structure, facilitating updates to the hierarchy and organizational alignment.

Parameters

Name	In	Type	Required	Description
company_id	path	integer(int64)	true	Unique identifier for the financial entity within the organizational structure, used to detach the specified company from its associated country.
body	body	CountryDto	true	Request body containing the details of the financial entity to be detached from the specified company, including relevant organizational hierarchy information.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "schema": "string",
    "taxJurisdictionEnabled": true,
    "regionId": 0,
    "companyId": 0,
    "taxJurisdictionId": 0,
    "taxCodeId": 0,
    "paymentMethodId": 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

Country - Attach Region

HTTP Request

POST /api/v1/countries/attach/region/{region_id}

Interactive Demo

📋 Description: Attaches a specified region to the financial organization structure, facilitating the alignment of organizational hierarchy and enhancing the management of financial entities.

Parameters

Name	In	Type	Required	Description
region_id	path	integer(int64)	true	Unique identifier for the specific region within the financial organization structure, used to attach a country to its corresponding regional hierarchy.
body	body	CountryDto	true	Request body containing the financial entity data necessary to associate a specified region with the organizational structure and hierarchy.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "schema": "string",
    "taxJurisdictionEnabled": true,
    "regionId": 0,
    "companyId": 0,
    "taxJurisdictionId": 0,
    "taxCodeId": 0,
    "paymentMethodId": 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

Country - Attach Company

HTTP Request

POST /api/v1/countries/attach/company/{company_id}

Interactive Demo

📋 Description: Attaches a specified company to a country within the financial organization structure, facilitating the establishment of hierarchical relationships and organizational alignment for financial entities.

Parameters

Name	In	Type	Required	Description
company_id	path	integer(int64)	true	Unique identifier for the financial entity within the organizational structure, used to attach country-specific data.
body	body	CountryDto	true	Request body containing the country association details for the specified company, including relevant organizational hierarchy and financial entity information.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "schema": "string",
    "taxJurisdictionEnabled": true,
    "regionId": 0,
    "companyId": 0,
    "taxJurisdictionId": 0,
    "taxCodeId": 0,
    "paymentMethodId": 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

Country - Find All

HTTP Request

GET /api/v1/countries

Interactive Demo

📋 Description: Retrieves a list of countries relevant to the financial organization structure, providing essential data for understanding the hierarchy and operational context of financial entities.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the country hierarchy retrieval should be paginated, facilitating efficient navigation through the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageCountryDto

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",
      "name": "string",
      "schema": "string",
      "taxJurisdictionEnabled": true,
      "regionId": 0,
      "companyId": 0,
      "taxJurisdictionId": 0,
      "taxCodeId": 0,
      "paymentMethodId": 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

Country - Create

HTTP Request

POST /api/v1/countries

Interactive Demo

📋 Description: Creates a new country entry within the financial organization structure, facilitating the establishment of hierarchical relationships among financial entities.

Parameters

Name	In	Type	Required	Description
body	body	CountryDto	true	Request body containing the details of the financial entity’s country structure, including hierarchical relationships and organizational attributes.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "schema": "string",
  "taxJurisdictionEnabled": true,
  "regionId": 0,
  "companyId": 0,
  "taxJurisdictionId": 0,
  "taxCodeId": 0,
  "paymentMethodId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseCountryDto

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",
    "name": "string",
    "schema": "string",
    "taxJurisdictionEnabled": true,
    "regionId": 0,
    "companyId": 0,
    "taxJurisdictionId": 0,
    "taxCodeId": 0,
    "paymentMethodId": 0
  }
}

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

Country - Get All By Region

HTTP Request

GET /api/v1/countries/region/{region_id}

Interactive Demo

📋 Description: Retrieves a list of countries associated with a specified region, facilitating the understanding of the financial organization structure and hierarchy within that geographical context.

Parameters

Name	In	Type	Required	Description
region_id	path	integer(int64)	true	Unique identifier for the specified region within the financial organization structure, used to retrieve hierarchical data related to that region.
pageable	query	Pageable	true	Indicates whether the results should be returned in a paginated format, facilitating efficient retrieval of financial entity data by region.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageCountryDto

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",
      "name": "string",
      "schema": "string",
      "taxJurisdictionEnabled": true,
      "regionId": 0,
      "companyId": 0,
      "taxJurisdictionId": 0,
      "taxCodeId": 0,
      "paymentMethodId": 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

Country - Get Metadata

HTTP Request

GET /api/v1/countries/meta

Interactive Demo

📋 Description: Retrieves metadata for countries within the financial organization structure, providing essential information for understanding the organizational hierarchy and financial entities.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "NAME"
]

Response Schema

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

Country - Find All By System ID

HTTP Request

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

Interactive Demo

📋 Description: Retrieves the organizational structure of financial entities associated with a specified ERP system, providing insights into the hierarchy and relationships within the organization.

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	PageCountryDto

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",
      "name": "string",
      "schema": "string",
      "taxJurisdictionEnabled": true,
      "regionId": 0,
      "companyId": 0,
      "taxJurisdictionId": 0,
      "taxCodeId": 0,
      "paymentMethodId": 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

Country - Get All By Company

HTTP Request

GET /api/v1/countries/company/{company_id}

Interactive Demo

📋 Description: Retrieves the list of countries associated with a specified company, providing insights into the organization’s financial structure and hierarchical relationships within its global operations.

Parameters

Name	In	Type	Required	Description
company_id	path	integer(int64)	true	Unique identifier for the financial entity within the organizational structure, used to retrieve country-specific information related to the specified company.
pageable	query	Pageable	true	Indicates whether the response should be paginated, allowing for efficient retrieval of country data associated with the specified financial entity.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageCountryDto

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",
      "name": "string",
      "schema": "string",
      "taxJurisdictionEnabled": true,
      "regionId": 0,
      "companyId": 0,
      "taxJurisdictionId": 0,
      "taxCodeId": 0,
      "paymentMethodId": 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

---