Tax Jurisdiction

Tax Jurisdiction - Get

HTTP Request

GET /api/v1/tax-jurisdictions/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific tax jurisdiction within the financial organization structure, identified by the provided ID, to support organizational hierarchy and compliance needs.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseTaxJurisdictionDto

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",
    "costCenterId": 0,
    "countryId": 0,
    "countryDisplayId": "string"
  }
}

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

Tax Jurisdiction - Update

HTTP Request

PUT /api/v1/tax-jurisdictions/{id}

Interactive Demo

📋 Description: Updates the details of a specific tax jurisdiction within the financial organization structure, identified by the provided ID, to ensure accurate representation of the entity’s hierarchical tax obligations.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	TaxJurisdictionDto	true	Request body containing the updated tax jurisdiction details, including name, rates, and applicable financial entity hierarchy information.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "schema": "string",
  "costCenterId": 0,
  "countryId": 0,
  "countryDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseTaxJurisdictionDto

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",
    "costCenterId": 0,
    "countryId": 0,
    "countryDisplayId": "string"
  }
}

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

Tax Jurisdiction - Delete

HTTP Request

DELETE /api/v1/tax-jurisdictions/{id}

Interactive Demo

📋 Description: Deletes a specified tax jurisdiction from the financial organization structure, ensuring the hierarchy remains accurate and up-to-date for compliance and reporting purposes.

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

Tax Jurisdiction - Delete Or Decommission

HTTP Request

PUT /api/v1/tax-jurisdictions/remove/{id}

Interactive Demo

📋 Description: Removes a specified tax jurisdiction from the financial organization structure, ensuring that the hierarchy accurately reflects current operational requirements.

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

Tax Jurisdiction - Delete Or Decommission All

HTTP Request

PUT /api/v1/tax-jurisdictions/remove/bulk

Interactive Demo

📋 Description: Removes multiple tax jurisdictions in bulk from the financial organization’s structure, streamlining the management of organizational hierarchies and ensuring compliance with relevant tax regulations.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of tax jurisdiction identifiers to facilitate the bulk removal of specified financial entities from the organizational structure.

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

Tax Jurisdiction - Decommission

HTTP Request

PUT /api/v1/tax-jurisdictions/decommission/{id}

Interactive Demo

📋 Description: Decommissions a specified tax jurisdiction within the financial organization structure, effectively removing it from the active hierarchy of financial entities. This operation ensures the integrity and accuracy of the organization’s tax-related data 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	ResponseTaxJurisdictionDto

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",
    "costCenterId": 0,
    "countryId": 0,
    "countryDisplayId": "string"
  }
}

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

Tax Jurisdiction - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/tax-jurisdictions/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Decommissions tax jurisdictions that have been modified before the specified date, ensuring the financial organization structure remains current and compliant with regulatory requirements. This operation supports the management of organizational hierarchies within financial entities.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the cutoff date for decommissioning tax jurisdictions that were modified before the given date, ensuring alignment with the organization’s financial structure and hierarchy.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListTaxJurisdictionDto

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",
      "costCenterId": 0,
      "countryId": 0,
      "countryDisplayId": "string"
    }
  ]
}

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

Tax Jurisdiction - Decommission Before Now

HTTP Request

PUT /api/v1/tax-jurisdictions/decommission/modified-before-now

Interactive Demo

📋 Description: Decommissions tax jurisdictions that have been modified prior to the current date, ensuring the financial organization structure remains up-to-date and compliant with regulatory requirements. This operation is essential for maintaining an accurate hierarchy within the financial entity.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListTaxJurisdictionDto

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",
      "costCenterId": 0,
      "countryId": 0,
      "countryDisplayId": "string"
    }
  ]
}

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

Tax Jurisdiction - Decommission All

HTTP Request

PUT /api/v1/tax-jurisdictions/decommission/bulk

Interactive Demo

📋 Description: Decommissions multiple tax jurisdictions in bulk, allowing organizations to efficiently manage their financial entity structures and hierarchies within the financial organization framework.

Parameters

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

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListTaxJurisdictionDto

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",
      "costCenterId": 0,
      "countryId": 0,
      "countryDisplayId": "string"
    }
  ]
}

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

Tax Jurisdiction - Create Or Update Bulk

HTTP Request

PUT /api/v1/tax-jurisdictions/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple tax jurisdictions in bulk, ensuring accurate alignment within the financial organization structure and hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	TaxJurisdictionDto	true	Request body containing a bulk array of tax jurisdiction data, including identifiers and attributes necessary for creating or updating financial entity structures within the organization hierarchy.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "schema": "string",
    "costCenterId": 0,
    "countryId": 0,
    "countryDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListTaxJurisdictionDto

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",
      "costCenterId": 0,
      "countryId": 0,
      "countryDisplayId": "string"
    }
  ]
}

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

Tax Jurisdiction - Create Or Update

HTTP Request

PUT /api/v1/tax-jurisdictions/createOrUpdate

Interactive Demo

📋 Description: Creates or updates tax jurisdiction records within the financial organization structure, ensuring accurate alignment of organizational hierarchy and compliance for financial entities.

Parameters

Name	In	Type	Required	Description
body	body	TaxJurisdictionDto	true	Request body containing the tax jurisdiction details, including identifiers and attributes necessary for creating or updating the financial entity’s organizational structure.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "schema": "string",
  "costCenterId": 0,
  "countryId": 0,
  "countryDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseTaxJurisdictionDto

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",
    "costCenterId": 0,
    "countryId": 0,
    "countryDisplayId": "string"
  }
}

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

Tax Jurisdiction - Bulk Update

HTTP Request

PUT /api/v1/tax-jurisdictions/bulk

Interactive Demo

📋 Description: Updates multiple tax jurisdictions in bulk, allowing organizations to efficiently manage their financial entity structures and hierarchies within the financial organization framework.

Parameters

Name	In	Type	Required	Description
body	body	TaxJurisdictionDto	true	Request body containing a bulk update of tax jurisdiction data, including identifiers and attributes relevant to the financial organization structure and hierarchy.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "schema": "string",
    "costCenterId": 0,
    "countryId": 0,
    "countryDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListTaxJurisdictionDto

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",
      "costCenterId": 0,
      "countryId": 0,
      "countryDisplayId": "string"
    }
  ]
}

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

Tax Jurisdiction - Bulk Create

HTTP Request

POST /api/v1/tax-jurisdictions/bulk

Interactive Demo

📋 Description: Submits a bulk upload of tax jurisdictions to enhance the financial organization structure, ensuring accurate hierarchy and compliance for financial entities.

Parameters

Name	In	Type	Required	Description
body	body	TaxJurisdictionDto	true	Request body containing a collection of tax jurisdiction data, including identifiers and attributes necessary for establishing the financial organization structure and hierarchy.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "schema": "string",
    "costCenterId": 0,
    "countryId": 0,
    "countryDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListTaxJurisdictionDto

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",
      "costCenterId": 0,
      "countryId": 0,
      "countryDisplayId": "string"
    }
  ]
}

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

Tax Jurisdiction - Bulk Delete

HTTP Request

DELETE /api/v1/tax-jurisdictions/bulk

Interactive Demo

📋 Description: Deletes multiple tax jurisdictions in a single operation, streamlining the management of financial entity structures within the organization’s hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of tax jurisdiction identifiers to facilitate the bulk deletion of financial entity tax jurisdictions within the organizational structure.

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

Tax Jurisdiction - Search

HTTP Request

POST /api/v1/tax-jurisdictions/search

Interactive Demo

📋 Description: Submits a request to search for tax jurisdictions within the financial organization structure, allowing users to identify relevant tax entities based on specified criteria.

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	TaxJurisdictionDtoFilter	false	Request body containing the criteria for searching tax jurisdictions, including relevant organizational structure and hierarchy details for financial entities.

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",
  "uiSelector": "string",
  "nameLike": "string",
  "schemaLike": "string",
  "costCenterIdEqual": 0,
  "countryIdEqual": 0,
  "countryDisplayIdLike": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageTaxJurisdictionDto

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",
      "costCenterId": 0,
      "countryId": 0,
      "countryDisplayId": "string"
    }
  ],
  "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

Tax Jurisdiction - Detach Country

HTTP Request

POST /api/v1/tax-jurisdictions/detach/country/{country_id}

Interactive Demo

📋 Description: Detaches a specified country from the financial organization structure, effectively updating the hierarchy of tax jurisdictions associated with the financial entity. This operation ensures accurate alignment of tax responsibilities within the organizational framework.

Parameters

Name	In	Type	Required	Description
country_id	path	integer(int64)	true	Unique identifier for the country within the financial organization structure, used to detach tax jurisdictions associated with that country.
body	body	TaxJurisdictionDto	true	Request body containing the details required to detach a specified country from its associated tax jurisdiction within the financial organization structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "schema": "string",
    "costCenterId": 0,
    "countryId": 0,
    "countryDisplayId": "string"
  }
]

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

Tax Jurisdiction - Attach Country

HTTP Request

POST /api/v1/tax-jurisdictions/attach/country/{country_id}

Interactive Demo

📋 Description: Attaches a specified country to the tax jurisdiction hierarchy within the financial organization structure, enabling streamlined management of tax compliance across different regions.

Parameters

Name	In	Type	Required	Description
country_id	path	integer(int64)	true	Unique identifier for the country associated with the tax jurisdiction, facilitating the organization and hierarchy of financial entities within the financial organization structure.
body	body	TaxJurisdictionDto	true	Request body containing the tax jurisdiction details to be associated with the specified country, including relevant identifiers and attributes for effective financial organization structure management.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "schema": "string",
    "costCenterId": 0,
    "countryId": 0,
    "countryDisplayId": "string"
  }
]

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

Tax Jurisdiction - Find All

HTTP Request

GET /api/v1/tax-jurisdictions

Interactive Demo

📋 Description: Retrieves a list of tax jurisdictions associated with the financial organization structure, providing insights into the hierarchical relationships and regulatory environments of financial entities.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the tax jurisdictions query should be returned in a paginated format, facilitating efficient data retrieval within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageTaxJurisdictionDto

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",
      "costCenterId": 0,
      "countryId": 0,
      "countryDisplayId": "string"
    }
  ],
  "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

Tax Jurisdiction - Create

HTTP Request

POST /api/v1/tax-jurisdictions

Interactive Demo

📋 Description: Creates a new tax jurisdiction within the financial organization structure, enabling the establishment of hierarchical tax entities for accurate financial reporting and compliance.

Parameters

Name	In	Type	Required	Description
body	body	TaxJurisdictionDto	true	Request body containing the tax jurisdiction details, including identifiers and hierarchical relationships relevant to the financial organization’s structure.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "name": "string",
  "schema": "string",
  "costCenterId": 0,
  "countryId": 0,
  "countryDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseTaxJurisdictionDto

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",
    "costCenterId": 0,
    "countryId": 0,
    "countryDisplayId": "string"
  }
}

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

Tax Jurisdiction - Get Metadata

HTTP Request

GET /api/v1/tax-jurisdictions/meta

Interactive Demo

📋 Description: Retrieves metadata related to tax jurisdictions within the financial organization structure, providing essential information for understanding the hierarchy and classification of 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

Tax Jurisdiction - Find All By System ID

HTTP Request

GET /api/v1/tax-jurisdictions/erp-system/{systemId}

Interactive Demo

📋 Description: Retrieves tax jurisdiction details for a specified ERP system, enabling organizations to understand their financial entity structure and hierarchy within the broader financial organization framework.

Parameters

Name	In	Type	Required	Description
systemId	path	integer(int64)	true	Unique identifier for the system
pageable	query	Pageable	true	Indicates whether the response should be paginated, facilitating the retrieval of tax jurisdiction data within the financial organization structure for efficient data management.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageTaxJurisdictionDto

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",
      "costCenterId": 0,
      "countryId": 0,
      "countryDisplayId": "string"
    }
  ],
  "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

Tax Jurisdiction - Get All By Country

HTTP Request

GET /api/v1/tax-jurisdictions/country/{country_id}

Interactive Demo

📋 Description: Fetches tax jurisdiction details for a specified country, providing essential information for managing the financial organization structure and ensuring compliance within the hierarchical framework of financial entities.

Parameters

Name	In	Type	Required	Description
country_id	path	integer(int64)	true	Unique identifier for the country within the financial organization structure, used to retrieve tax jurisdiction details.
pageable	query	Pageable	true	Indicates whether the results of the tax jurisdictions query for the specified country should be returned in a paginated format, facilitating efficient data retrieval within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageTaxJurisdictionDto

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",
      "costCenterId": 0,
      "countryId": 0,
      "countryDisplayId": "string"
    }
  ],
  "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

---