Tax Rate Mapping

Tax Rate Mapping - Get

HTTP Request

GET /api/v1/tax-rate-mappings/{id}

Interactive Demo

📋 Description: Retrieves the tax rate mapping associated with a specific financial entity within the organizational structure, providing insights into the hierarchical tax configurations.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseTaxRateMappingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "determinationId": 0,
    "determinationDisplayId": "string",
    "description": "string",
    "taxRate": 0.1,
    "taxAccountId": 0,
    "taxAccountDisplayId": "string",
    "effectiveFrom": "2019-08-24"
  }
}

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

Tax Rate Mapping - Update

HTTP Request

PUT /api/v1/tax-rate-mappings/{id}

Interactive Demo

📋 Description: Updates the tax rate mapping for a specified financial entity within the organizational structure, allowing for adjustments to the hierarchy and compliance with regulatory requirements.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	TaxRateMappingDto	true	Request body containing the updated tax rate mapping data, including the financial entity identifier and associated hierarchy details.

Body Parameters

{
  "id": 0,
  "rowNumber": 0,
  "rowIdentifier": "string",
  "errors": [
    "string"
  ],
  "linkedErrors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "remarks": [
    "string"
  ],
  "skipMessage": "string",
  "determinationId": 0,
  "determinationDisplayId": "string",
  "description": "string",
  "taxRate": 0.1,
  "taxAccountId": 0,
  "taxAccountDisplayId": "string",
  "effectiveFrom": "2019-08-24"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseTaxRateMappingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "determinationId": 0,
    "determinationDisplayId": "string",
    "description": "string",
    "taxRate": 0.1,
    "taxAccountId": 0,
    "taxAccountDisplayId": "string",
    "effectiveFrom": "2019-08-24"
  }
}

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

Tax Rate Mapping - Delete

HTTP Request

DELETE /api/v1/tax-rate-mappings/{id}

Interactive Demo

📋 Description: Deletes a specified tax rate mapping within the financial organization structure, ensuring the integrity of the entity’s hierarchical configuration.

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 Rate Mapping - Create Or Update Bulk

HTTP Request

PUT /api/v1/tax-rate-mappings/createOrUpdate/bulk

Interactive Demo

📋 Description: Updates or creates multiple tax rate mappings in bulk for financial entities within the organizational structure, ensuring accurate alignment of tax rates with the respective hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	TaxRateMappingDto	true	Request body containing a collection of tax rate mappings for bulk creation or updates within the financial organization structure, ensuring alignment with the hierarchical configuration of financial entities.

Body Parameters

[
  {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "determinationId": 0,
    "determinationDisplayId": "string",
    "description": "string",
    "taxRate": 0.1,
    "taxAccountId": 0,
    "taxAccountDisplayId": "string",
    "effectiveFrom": "2019-08-24"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListTaxRateMappingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "rowNumber": 0,
      "rowIdentifier": "string",
      "errors": [
        "string"
      ],
      "linkedErrors": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "remarks": [
        "string"
      ],
      "skipMessage": "string",
      "determinationId": 0,
      "determinationDisplayId": "string",
      "description": "string",
      "taxRate": 0.1,
      "taxAccountId": 0,
      "taxAccountDisplayId": "string",
      "effectiveFrom": "2019-08-24"
    }
  ]
}

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

Tax Rate Mapping - Create Or Update

HTTP Request

PUT /api/v1/tax-rate-mappings/createOrUpdate

Interactive Demo

📋 Description: Creates or updates tax rate mappings within the financial organization structure, ensuring accurate alignment of tax rates with the respective financial entities in the hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	TaxRateMappingDto	true	Request body containing the tax rate mapping data, including organization identifiers and associated financial entity details for creating or updating hierarchical tax structures.

Body Parameters

{
  "id": 0,
  "rowNumber": 0,
  "rowIdentifier": "string",
  "errors": [
    "string"
  ],
  "linkedErrors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "remarks": [
    "string"
  ],
  "skipMessage": "string",
  "determinationId": 0,
  "determinationDisplayId": "string",
  "description": "string",
  "taxRate": 0.1,
  "taxAccountId": 0,
  "taxAccountDisplayId": "string",
  "effectiveFrom": "2019-08-24"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseTaxRateMappingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "determinationId": 0,
    "determinationDisplayId": "string",
    "description": "string",
    "taxRate": 0.1,
    "taxAccountId": 0,
    "taxAccountDisplayId": "string",
    "effectiveFrom": "2019-08-24"
  }
}

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

Tax Rate Mapping - Bulk Update

HTTP Request

PUT /api/v1/tax-rate-mappings/bulk

Interactive Demo

📋 Description: Updates multiple tax rate mappings in bulk for financial entities within the organizational structure, ensuring accurate alignment with hierarchical tax regulations.

Parameters

Name	In	Type	Required	Description
body	body	TaxRateMappingDto	true	Request body containing a collection of tax rate mappings to be applied in bulk to the financial organization structure, ensuring accurate alignment with the organizational hierarchy.

Body Parameters

[
  {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "determinationId": 0,
    "determinationDisplayId": "string",
    "description": "string",
    "taxRate": 0.1,
    "taxAccountId": 0,
    "taxAccountDisplayId": "string",
    "effectiveFrom": "2019-08-24"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListTaxRateMappingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "rowNumber": 0,
      "rowIdentifier": "string",
      "errors": [
        "string"
      ],
      "linkedErrors": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "remarks": [
        "string"
      ],
      "skipMessage": "string",
      "determinationId": 0,
      "determinationDisplayId": "string",
      "description": "string",
      "taxRate": 0.1,
      "taxAccountId": 0,
      "taxAccountDisplayId": "string",
      "effectiveFrom": "2019-08-24"
    }
  ]
}

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

Tax Rate Mapping - Bulk Create

HTTP Request

POST /api/v1/tax-rate-mappings/bulk

Interactive Demo

📋 Description: Submits bulk tax rate mappings for financial entities within the organizational structure, enabling efficient updates to the hierarchy of tax classifications.

Parameters

Name	In	Type	Required	Description
body	body	TaxRateMappingDto	true	Request body containing a collection of tax rate mappings for multiple financial entities, structured to align with the organization’s hierarchy and compliance requirements.

Body Parameters

[
  {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "determinationId": 0,
    "determinationDisplayId": "string",
    "description": "string",
    "taxRate": 0.1,
    "taxAccountId": 0,
    "taxAccountDisplayId": "string",
    "effectiveFrom": "2019-08-24"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListTaxRateMappingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "rowNumber": 0,
      "rowIdentifier": "string",
      "errors": [
        "string"
      ],
      "linkedErrors": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "remarks": [
        "string"
      ],
      "skipMessage": "string",
      "determinationId": 0,
      "determinationDisplayId": "string",
      "description": "string",
      "taxRate": 0.1,
      "taxAccountId": 0,
      "taxAccountDisplayId": "string",
      "effectiveFrom": "2019-08-24"
    }
  ]
}

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

Tax Rate Mapping - Bulk Delete

HTTP Request

DELETE /api/v1/tax-rate-mappings/bulk

Interactive Demo

📋 Description: Deletes multiple tax rate mappings 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 rate mapping identifiers to be deleted, relevant for managing the financial organization structure and 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

Tax Rate Mapping - Search

HTTP Request

POST /api/v1/tax-rate-mappings/search

Interactive Demo

📋 Description: Submits a request to search for tax rate mappings within the financial organization structure, allowing users to identify and manage tax-related configurations for various 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	TaxRateMappingDtoFilter	false	Request body containing the criteria for searching tax rate mappings within the financial organization structure, including relevant identifiers and parameters to facilitate accurate retrieval.

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",
  "determinationIdEqual": 0,
  "determinationDisplayIdLike": "string",
  "descriptionLike": "string",
  "taxRateEqual": 0.1,
  "taxRateLike": "string",
  "taxAccountIdEqual": 0,
  "taxAccountDisplayIdLike": "string",
  "effectiveFromGreaterThanOrEqual": "2019-08-24",
  "effectiveFromLessThanOrEqual": "2019-08-24",
  "effectiveFromEqual": "2019-08-24"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageTaxRateMappingDto

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,
      "rowNumber": 0,
      "rowIdentifier": "string",
      "errors": [
        "string"
      ],
      "linkedErrors": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "remarks": [
        "string"
      ],
      "skipMessage": "string",
      "determinationId": 0,
      "determinationDisplayId": "string",
      "description": "string",
      "taxRate": 0.1,
      "taxAccountId": 0,
      "taxAccountDisplayId": "string",
      "effectiveFrom": "2019-08-24"
    }
  ],
  "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 Rate Mapping - Find All

HTTP Request

GET /api/v1/tax-rate-mappings

Interactive Demo

📋 Description: Retrieves the tax rate mappings associated with the financial organization structure, providing insights into the hierarchical relationships and applicable tax rates for each financial entity.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageTaxRateMappingDto

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,
      "rowNumber": 0,
      "rowIdentifier": "string",
      "errors": [
        "string"
      ],
      "linkedErrors": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "remarks": [
        "string"
      ],
      "skipMessage": "string",
      "determinationId": 0,
      "determinationDisplayId": "string",
      "description": "string",
      "taxRate": 0.1,
      "taxAccountId": 0,
      "taxAccountDisplayId": "string",
      "effectiveFrom": "2019-08-24"
    }
  ],
  "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 Rate Mapping - Create

HTTP Request

POST /api/v1/tax-rate-mappings

Interactive Demo

📋 Description: Creates a new tax rate mapping within the financial organization structure, allowing for the alignment of tax rates to specific financial entities in the organizational hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	TaxRateMappingDto	true	Request body containing the tax rate mapping data, including organization identifiers and hierarchical structure details for financial entities.

Body Parameters

{
  "id": 0,
  "rowNumber": 0,
  "rowIdentifier": "string",
  "errors": [
    "string"
  ],
  "linkedErrors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "remarks": [
    "string"
  ],
  "skipMessage": "string",
  "determinationId": 0,
  "determinationDisplayId": "string",
  "description": "string",
  "taxRate": 0.1,
  "taxAccountId": 0,
  "taxAccountDisplayId": "string",
  "effectiveFrom": "2019-08-24"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseTaxRateMappingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "determinationId": 0,
    "determinationDisplayId": "string",
    "description": "string",
    "taxRate": 0.1,
    "taxAccountId": 0,
    "taxAccountDisplayId": "string",
    "effectiveFrom": "2019-08-24"
  }
}

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

Tax Rate Mapping - Get Metadata

HTTP Request

GET /api/v1/tax-rate-mappings/meta

Interactive Demo

📋 Description: Retrieves metadata related to tax rate mappings within the financial organization structure, providing insights into the hierarchical relationships and classifications of financial entities.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "DESCRIPTION"
]

Response Schema

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

---