Tax Code

Tax Code - Get

HTTP Request

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

Interactive Demo

📋 Description: Retrieves detailed information about a specific tax code within the financial organization structure, identified by its unique ID, to facilitate compliance and reporting within the organizational hierarchy.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseTaxCodeDto

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

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

Tax Code - Update

HTTP Request

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

Interactive Demo

📋 Description: Updates the specified tax code within the financial organization structure, allowing for modifications to its attributes to reflect changes in the hierarchy of the financial entity.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	TaxCodeDto	true	Request body containing the updated tax code information, including attributes relevant to the financial organization structure and hierarchy.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseTaxCodeDto

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

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

Tax Code - Delete

HTTP Request

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

Interactive Demo

📋 Description: Deletes a specified tax code from the financial organization structure, ensuring the hierarchy remains accurate and up-to-date for 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

Tax Code - Delete Or Decommission

HTTP Request

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

Interactive Demo

📋 Description: Removes a specified tax code from the financial organization structure, ensuring the hierarchy remains accurate and compliant with organizational standards.

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 Code - Delete Or Decommission All

HTTP Request

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

Interactive Demo

📋 Description: Removes multiple tax codes in bulk from the financial organization structure, ensuring the hierarchy remains accurate and up-to-date for effective financial entity management.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of tax code identifiers to be removed in bulk from the financial organization’s structure, ensuring streamlined management of the entity’s hierarchical tax classifications.

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 Code - Decommission

HTTP Request

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

Interactive Demo

📋 Description: Decommissions a specified tax code within the financial organization structure, effectively removing it from active use in the hierarchy of financial entities. This operation ensures that outdated or unnecessary tax codes are no longer applied in financial transactions.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseTaxCodeDto

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

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

Tax Code - Decommission By Modification Date Before

HTTP Request

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

Interactive Demo

📋 Description: Decommissions tax codes that were modified before the specified date, allowing organizations to maintain an updated financial structure and hierarchy. This operation ensures that obsolete tax codes are effectively removed from the financial entity’s records.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the cutoff date for decommissioning tax codes 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	ResponseListTaxCodeDto

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

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

Tax Code - Decommission Before Now

HTTP Request

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

Interactive Demo

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListTaxCodeDto

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

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

Tax Code - Decommission All

HTTP Request

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

Interactive Demo

📋 Description: Decommissions multiple tax codes in bulk, allowing financial organizations to efficiently manage their organizational structure and hierarchy by removing obsolete or redundant tax classifications.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of tax codes to be decommissioned in bulk, ensuring alignment with the organization’s financial structure and hierarchy.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListTaxCodeDto

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

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

Tax Code - Create Or Update Bulk

HTTP Request

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

Interactive Demo

📋 Description: Creates or updates multiple tax codes in bulk within the financial organization structure, ensuring accurate alignment with the hierarchy of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	TaxCodeDto	true	Request body containing a bulk array of tax code data, including identifiers and attributes, to facilitate the creation or updating of tax codes within the financial organization structure.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListTaxCodeDto

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

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

Tax Code - Create Or Update

HTTP Request

PUT /api/v1/tax-codes/createOrUpdate

Interactive Demo

📋 Description: Creates or updates tax codes within the financial organization structure, ensuring accurate representation of the hierarchy and compliance for financial entities.

Parameters

Name	In	Type	Required	Description
body	body	TaxCodeDto	true	Request body containing the tax code details, including identifiers and attributes necessary for creating or updating financial entities within the organizational structure.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseTaxCodeDto

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

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

Tax Code - Bulk Update

HTTP Request

PUT /api/v1/tax-codes/bulk

Interactive Demo

📋 Description: Updates multiple tax codes in bulk for financial entities within the organizational structure, ensuring alignment with the latest regulatory requirements and internal hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	TaxCodeDto	true	Request body containing a collection of tax code entries to be updated in the financial organization structure, including relevant identifiers and attributes for each code.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListTaxCodeDto

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

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

Tax Code - Bulk Create

HTTP Request

POST /api/v1/tax-codes/bulk

Interactive Demo

📋 Description: Submits a bulk upload of tax codes to enhance the financial organization structure, enabling efficient management of hierarchical relationships within financial entities.

Parameters

Name	In	Type	Required	Description
body	body	TaxCodeDto	true	Request body containing a collection of tax code entries, each associated with the financial organization’s structure and hierarchy, to facilitate bulk updates within the financial entity.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListTaxCodeDto

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

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

Tax Code - Bulk Delete

HTTP Request

DELETE /api/v1/tax-codes/bulk

Interactive Demo

📋 Description: Deletes multiple tax codes in a single operation, streamlining the management of financial entities within the organizational structure and hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of tax code identifiers to be deleted in bulk from the financial organization 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 Code - Search

HTTP Request

POST /api/v1/tax-codes/search

Interactive Demo

📋 Description: Submits a request to search for tax codes within the financial organization structure, enabling users to efficiently locate relevant codes 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	TaxCodeDtoFilter	false	Request body containing the search criteria for tax codes relevant to the financial organization structure, including parameters for organization hierarchy and entity classification.

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",
  "procedureEqual": "string",
  "procedureLike": "string",
  "countryIdEqual": 0,
  "countryDisplayIdEqual": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageTaxCodeDto

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",
      "procedure": "string",
      "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 Code - Detach Country

HTTP Request

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

Interactive Demo

📋 Description: Detaches a specified tax code from the financial entity associated with the given country ID, facilitating updates to the organization’s financial structure and hierarchy. This operation ensures accurate alignment of tax codes within the financial organization 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 associated tax codes.
body	body	TaxCodeDto	true	Request body containing the financial entity’s tax code details to be detached from the specified country, ensuring accurate organizational structure and compliance.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "procedure": "string",
    "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 Code - Attach Country

HTTP Request

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

Interactive Demo

📋 Description: Attaches tax codes to a specified country within the financial organization structure, facilitating the alignment of tax regulations with the hierarchical framework of financial entities.

Parameters

Name	In	Type	Required	Description
country_id	path	integer(int64)	true	Unique identifier for the country associated with the tax code attachment within the financial organization structure.
body	body	TaxCodeDto	true	Request body containing the tax code details to be associated with the specified country, facilitating the alignment of financial entities within the organizational structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "name": "string",
    "procedure": "string",
    "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 Code - Find All

HTTP Request

GET /api/v1/tax-codes

Interactive Demo

📋 Description: Retrieves a list of tax codes associated with the financial organization structure, providing insights into the hierarchical categorization of financial entities.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the response should be paginated, facilitating efficient retrieval of tax codes within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageTaxCodeDto

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",
      "procedure": "string",
      "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 Code - Create

HTTP Request

POST /api/v1/tax-codes

Interactive Demo

📋 Description: Creates a new tax code within the financial organization structure, enabling the establishment of hierarchical tax classifications for financial entities.

Parameters

Name	In	Type	Required	Description
body	body	TaxCodeDto	true	Request body containing the tax code details, including attributes necessary for defining the financial entity’s organizational structure and hierarchy.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseTaxCodeDto

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

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

Tax Code - Get Metadata

HTTP Request

GET /api/v1/tax-codes/meta

Interactive Demo

📋 Description: Retrieves metadata for tax codes within the financial organization structure, providing insights into 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 Code - Find All By System ID

HTTP Request

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

Interactive Demo

📋 Description: Retrieves tax codes associated with a specified ERP system, facilitating the management of financial entities within the organizational structure and hierarchy.

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 codes within the specified financial organization structure for the given ERP system.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageTaxCodeDto

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",
      "procedure": "string",
      "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 Code - Get All By Country

HTTP Request

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

Interactive Demo

📋 Description: Retrieves tax codes associated with a specified country, facilitating the alignment of financial entities within the organizational structure and hierarchy.

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 associated tax codes.
pageable	query	Pageable	true	Indicates whether the results should be paginated, allowing users to retrieve tax codes for a specified country in a structured manner within the financial organization hierarchy.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageTaxCodeDto

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",
      "procedure": "string",
      "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

---