Tax Mapping

Tax Mapping - Get

HTTP Request

GET /api/v1/tax-code-expense-category-mappings/{id}

Interactive Demo

📋 Description: Retrieves the tax code expense category mapping associated with the specified identifier, providing insights into the financial organization structure and hierarchy of the entity. This operation facilitates effective management of financial classifications within 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	ResponseTaxCodeExpenseCategoryMappingDto

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",
    "isLeaseExpense": true,
    "expenseCategoryId": 0,
    "expenseCategoryDisplayId": "string",
    "expenseCategoryName": "string",
    "nonLeaseTaxCodeId": 0,
    "nonLeaseTaxCodeDisplayId": "string",
    "nonLeaseExemptionTaxCodeId": 0,
    "nonLeaseExemptionTaxCodeDisplayId": "string",
    "nonLeaseExemptionTaxPercentage": 0.1,
    "principalTaxCodeId": 0,
    "principalTaxCodeDisplayId": "string",
    "principalExemptionTaxCodeId": 0,
    "principalExemptionTaxCodeDisplayId": "string",
    "principalExemptionTaxPercentage": 0.1
  }
}

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

Tax Mapping - Update

HTTP Request

PUT /api/v1/tax-code-expense-category-mappings/{id}

Interactive Demo

📋 Description: Updates the tax code expense category mapping for a specified financial entity, allowing organizations to maintain accurate financial structures and hierarchies.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	TaxCodeExpenseCategoryMappingDto	true	Request body containing the updated tax code and expense category mapping details for the specified financial entity, ensuring alignment with the organization’s hierarchical structure.

Body Parameters

{
  "id": 0,
  "rowNumber": 0,
  "rowIdentifier": "string",
  "errors": [
    "string"
  ],
  "linkedErrors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "remarks": [
    "string"
  ],
  "skipMessage": "string",
  "determinationId": 0,
  "determinationDisplayId": "string",
  "isLeaseExpense": true,
  "expenseCategoryId": 0,
  "expenseCategoryDisplayId": "string",
  "expenseCategoryName": "string",
  "nonLeaseTaxCodeId": 0,
  "nonLeaseTaxCodeDisplayId": "string",
  "nonLeaseExemptionTaxCodeId": 0,
  "nonLeaseExemptionTaxCodeDisplayId": "string",
  "nonLeaseExemptionTaxPercentage": 0.1,
  "principalTaxCodeId": 0,
  "principalTaxCodeDisplayId": "string",
  "principalExemptionTaxCodeId": 0,
  "principalExemptionTaxCodeDisplayId": "string",
  "principalExemptionTaxPercentage": 0.1
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseTaxCodeExpenseCategoryMappingDto

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",
    "isLeaseExpense": true,
    "expenseCategoryId": 0,
    "expenseCategoryDisplayId": "string",
    "expenseCategoryName": "string",
    "nonLeaseTaxCodeId": 0,
    "nonLeaseTaxCodeDisplayId": "string",
    "nonLeaseExemptionTaxCodeId": 0,
    "nonLeaseExemptionTaxCodeDisplayId": "string",
    "nonLeaseExemptionTaxPercentage": 0.1,
    "principalTaxCodeId": 0,
    "principalTaxCodeDisplayId": "string",
    "principalExemptionTaxCodeId": 0,
    "principalExemptionTaxCodeDisplayId": "string",
    "principalExemptionTaxPercentage": 0.1
  }
}

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

Tax Mapping - Delete

HTTP Request

DELETE /api/v1/tax-code-expense-category-mappings/{id}

Interactive Demo

📋 Description: Deletes a specific tax code expense category mapping identified by the provided ID, thereby maintaining the integrity of the financial organization structure and 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

Tax Mapping - Create Or Update Bulk

HTTP Request

PUT /api/v1/tax-code-expense-category-mappings/createOrUpdate/bulk

Interactive Demo

📋 Description: Updates or creates multiple tax code to expense category mappings in bulk, facilitating the efficient management of financial organization structures within a hierarchical framework. This operation ensures that financial entities maintain accurate and consistent tax classifications across their organizational structure.

Parameters

Name	In	Type	Required	Description
body	body	TaxCodeExpenseCategoryMappingDto	true	Request body containing a bulk array of tax code and expense category mappings for financial entities, facilitating the creation or update of organizational structure hierarchies.

Body Parameters

[
  {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "determinationId": 0,
    "determinationDisplayId": "string",
    "isLeaseExpense": true,
    "expenseCategoryId": 0,
    "expenseCategoryDisplayId": "string",
    "expenseCategoryName": "string",
    "nonLeaseTaxCodeId": 0,
    "nonLeaseTaxCodeDisplayId": "string",
    "nonLeaseExemptionTaxCodeId": 0,
    "nonLeaseExemptionTaxCodeDisplayId": "string",
    "nonLeaseExemptionTaxPercentage": 0.1,
    "principalTaxCodeId": 0,
    "principalTaxCodeDisplayId": "string",
    "principalExemptionTaxCodeId": 0,
    "principalExemptionTaxCodeDisplayId": "string",
    "principalExemptionTaxPercentage": 0.1
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListTaxCodeExpenseCategoryMappingDto

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",
      "isLeaseExpense": true,
      "expenseCategoryId": 0,
      "expenseCategoryDisplayId": "string",
      "expenseCategoryName": "string",
      "nonLeaseTaxCodeId": 0,
      "nonLeaseTaxCodeDisplayId": "string",
      "nonLeaseExemptionTaxCodeId": 0,
      "nonLeaseExemptionTaxCodeDisplayId": "string",
      "nonLeaseExemptionTaxPercentage": 0.1,
      "principalTaxCodeId": 0,
      "principalTaxCodeDisplayId": "string",
      "principalExemptionTaxCodeId": 0,
      "principalExemptionTaxCodeDisplayId": "string",
      "principalExemptionTaxPercentage": 0.1
    }
  ]
}

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

Tax Mapping - Create Or Update

HTTP Request

PUT /api/v1/tax-code-expense-category-mappings/createOrUpdate

Interactive Demo

📋 Description: Updates or creates mappings between tax codes and expense categories within the financial organization structure, ensuring accurate alignment of financial entities in the hierarchy. This operation facilitates efficient management of tax-related expenses across the organization.

Parameters

Name	In	Type	Required	Description
body	body	TaxCodeExpenseCategoryMappingDto	true	Request body containing the tax code and expense category mapping data necessary for updating or creating financial entity hierarchies within the organization structure.

Body Parameters

{
  "id": 0,
  "rowNumber": 0,
  "rowIdentifier": "string",
  "errors": [
    "string"
  ],
  "linkedErrors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "remarks": [
    "string"
  ],
  "skipMessage": "string",
  "determinationId": 0,
  "determinationDisplayId": "string",
  "isLeaseExpense": true,
  "expenseCategoryId": 0,
  "expenseCategoryDisplayId": "string",
  "expenseCategoryName": "string",
  "nonLeaseTaxCodeId": 0,
  "nonLeaseTaxCodeDisplayId": "string",
  "nonLeaseExemptionTaxCodeId": 0,
  "nonLeaseExemptionTaxCodeDisplayId": "string",
  "nonLeaseExemptionTaxPercentage": 0.1,
  "principalTaxCodeId": 0,
  "principalTaxCodeDisplayId": "string",
  "principalExemptionTaxCodeId": 0,
  "principalExemptionTaxCodeDisplayId": "string",
  "principalExemptionTaxPercentage": 0.1
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseTaxCodeExpenseCategoryMappingDto

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",
    "isLeaseExpense": true,
    "expenseCategoryId": 0,
    "expenseCategoryDisplayId": "string",
    "expenseCategoryName": "string",
    "nonLeaseTaxCodeId": 0,
    "nonLeaseTaxCodeDisplayId": "string",
    "nonLeaseExemptionTaxCodeId": 0,
    "nonLeaseExemptionTaxCodeDisplayId": "string",
    "nonLeaseExemptionTaxPercentage": 0.1,
    "principalTaxCodeId": 0,
    "principalTaxCodeDisplayId": "string",
    "principalExemptionTaxCodeId": 0,
    "principalExemptionTaxCodeDisplayId": "string",
    "principalExemptionTaxPercentage": 0.1
  }
}

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

Tax Mapping - Bulk Update

HTTP Request

PUT /api/v1/tax-code-expense-category-mappings/bulk

Interactive Demo

📋 Description: Updates multiple tax code to expense category mappings in bulk, enabling efficient management of financial organization structures within a hierarchical framework.

Parameters

Name	In	Type	Required	Description
body	body	TaxCodeExpenseCategoryMappingDto	true	Request body containing a collection of tax code and expense category mappings to facilitate bulk updates within the financial organization structure.

Body Parameters

[
  {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "determinationId": 0,
    "determinationDisplayId": "string",
    "isLeaseExpense": true,
    "expenseCategoryId": 0,
    "expenseCategoryDisplayId": "string",
    "expenseCategoryName": "string",
    "nonLeaseTaxCodeId": 0,
    "nonLeaseTaxCodeDisplayId": "string",
    "nonLeaseExemptionTaxCodeId": 0,
    "nonLeaseExemptionTaxCodeDisplayId": "string",
    "nonLeaseExemptionTaxPercentage": 0.1,
    "principalTaxCodeId": 0,
    "principalTaxCodeDisplayId": "string",
    "principalExemptionTaxCodeId": 0,
    "principalExemptionTaxCodeDisplayId": "string",
    "principalExemptionTaxPercentage": 0.1
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListTaxCodeExpenseCategoryMappingDto

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",
      "isLeaseExpense": true,
      "expenseCategoryId": 0,
      "expenseCategoryDisplayId": "string",
      "expenseCategoryName": "string",
      "nonLeaseTaxCodeId": 0,
      "nonLeaseTaxCodeDisplayId": "string",
      "nonLeaseExemptionTaxCodeId": 0,
      "nonLeaseExemptionTaxCodeDisplayId": "string",
      "nonLeaseExemptionTaxPercentage": 0.1,
      "principalTaxCodeId": 0,
      "principalTaxCodeDisplayId": "string",
      "principalExemptionTaxCodeId": 0,
      "principalExemptionTaxCodeDisplayId": "string",
      "principalExemptionTaxPercentage": 0.1
    }
  ]
}

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

Tax Mapping - Bulk Create

HTTP Request

POST /api/v1/tax-code-expense-category-mappings/bulk

Interactive Demo

📋 Description: Creates multiple tax code to expense category mappings in bulk, facilitating the efficient organization and structuring of financial entities within your hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	TaxCodeExpenseCategoryMappingDto	true	Request body containing a collection of tax code and expense category mappings to facilitate the alignment of financial entities within the organizational structure.

Body Parameters

[
  {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "determinationId": 0,
    "determinationDisplayId": "string",
    "isLeaseExpense": true,
    "expenseCategoryId": 0,
    "expenseCategoryDisplayId": "string",
    "expenseCategoryName": "string",
    "nonLeaseTaxCodeId": 0,
    "nonLeaseTaxCodeDisplayId": "string",
    "nonLeaseExemptionTaxCodeId": 0,
    "nonLeaseExemptionTaxCodeDisplayId": "string",
    "nonLeaseExemptionTaxPercentage": 0.1,
    "principalTaxCodeId": 0,
    "principalTaxCodeDisplayId": "string",
    "principalExemptionTaxCodeId": 0,
    "principalExemptionTaxCodeDisplayId": "string",
    "principalExemptionTaxPercentage": 0.1
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListTaxCodeExpenseCategoryMappingDto

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",
      "isLeaseExpense": true,
      "expenseCategoryId": 0,
      "expenseCategoryDisplayId": "string",
      "expenseCategoryName": "string",
      "nonLeaseTaxCodeId": 0,
      "nonLeaseTaxCodeDisplayId": "string",
      "nonLeaseExemptionTaxCodeId": 0,
      "nonLeaseExemptionTaxCodeDisplayId": "string",
      "nonLeaseExemptionTaxPercentage": 0.1,
      "principalTaxCodeId": 0,
      "principalTaxCodeDisplayId": "string",
      "principalExemptionTaxCodeId": 0,
      "principalExemptionTaxCodeDisplayId": "string",
      "principalExemptionTaxPercentage": 0.1
    }
  ]
}

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

Tax Mapping - Bulk Delete

HTTP Request

DELETE /api/v1/tax-code-expense-category-mappings/bulk

Interactive Demo

📋 Description: Deletes multiple tax code expense category mappings in a single operation, allowing for efficient 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 code and expense category mapping identifiers to facilitate the bulk deletion of financial entity associations 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 Mapping - Search

HTTP Request

POST /api/v1/tax-code-expense-category-mappings/search

Interactive Demo

📋 Description: Creates a new mapping between tax codes and expense categories within the financial organization structure, facilitating accurate categorization and reporting for 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	TaxCodeExpenseCategoryMappingDtoFilter	false	Request body containing the criteria for searching tax code and expense category mappings within the financial organization structure, including relevant identifiers and filters.

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",
  "isLeaseExpenseIn": [
    true
  ],
  "expenseCategoryIdEqual": 0,
  "expenseCategoryDisplayIdLike": "string",
  "expenseCategoryNameEqual": "string",
  "nonLeaseTaxCodeIdIn": [
    0
  ],
  "nonLeaseTaxCodeIdEqual": 0,
  "nonLeaseTaxCodeDisplayIdIn": [
    "string"
  ],
  "nonLeaseTaxCodeDisplayIdLike": "string",
  "nonLeaseExemptionTaxCodeIdIn": [
    0
  ],
  "nonLeaseExemptionTaxCodeIdEqual": 0,
  "nonLeaseExemptionTaxCodeDisplayIdIn": [
    "string"
  ],
  "nonLeaseExemptionTaxCodeDisplayIdLike": "string",
  "nonLeaseExemptionTaxPercentageEqual": 0.1,
  "nonLeaseExemptionTaxPercentageLike": "string",
  "principalTaxCodeIdIn": [
    0
  ],
  "principalTaxCodeIdEqual": 0,
  "principalTaxCodeDisplayIdIn": [
    "string"
  ],
  "principalTaxCodeDisplayIdLike": "string",
  "principalExemptionTaxCodeIdIn": [
    0
  ],
  "principalExemptionTaxCodeIdEqual": 0,
  "principalExemptionTaxCodeDisplayIdIn": [
    "string"
  ],
  "principalExemptionTaxCodeDisplayIdLike": "string",
  "principalExemptionTaxPercentageEqual": 0.1,
  "principalExemptionTaxPercentageLike": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageTaxCodeExpenseCategoryMappingDto

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",
      "isLeaseExpense": true,
      "expenseCategoryId": 0,
      "expenseCategoryDisplayId": "string",
      "expenseCategoryName": "string",
      "nonLeaseTaxCodeId": 0,
      "nonLeaseTaxCodeDisplayId": "string",
      "nonLeaseExemptionTaxCodeId": 0,
      "nonLeaseExemptionTaxCodeDisplayId": "string",
      "nonLeaseExemptionTaxPercentage": 0.1,
      "principalTaxCodeId": 0,
      "principalTaxCodeDisplayId": "string",
      "principalExemptionTaxCodeId": 0,
      "principalExemptionTaxCodeDisplayId": "string",
      "principalExemptionTaxPercentage": 0.1
    }
  ],
  "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 Mapping - Find All

HTTP Request

GET /api/v1/tax-code-expense-category-mappings

Interactive Demo

📋 Description: Retrieves the mappings of tax codes to expense categories within the financial organization structure, facilitating the alignment of financial entities with their respective hierarchical classifications.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageTaxCodeExpenseCategoryMappingDto

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",
      "isLeaseExpense": true,
      "expenseCategoryId": 0,
      "expenseCategoryDisplayId": "string",
      "expenseCategoryName": "string",
      "nonLeaseTaxCodeId": 0,
      "nonLeaseTaxCodeDisplayId": "string",
      "nonLeaseExemptionTaxCodeId": 0,
      "nonLeaseExemptionTaxCodeDisplayId": "string",
      "nonLeaseExemptionTaxPercentage": 0.1,
      "principalTaxCodeId": 0,
      "principalTaxCodeDisplayId": "string",
      "principalExemptionTaxCodeId": 0,
      "principalExemptionTaxCodeDisplayId": "string",
      "principalExemptionTaxPercentage": 0.1
    }
  ],
  "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 Mapping - Create

HTTP Request

POST /api/v1/tax-code-expense-category-mappings

Interactive Demo

📋 Description: Creates a new mapping between tax codes and expense categories within the financial organization structure, facilitating accurate categorization and reporting for financial entities.

Parameters

Name	In	Type	Required	Description
body	body	TaxCodeExpenseCategoryMappingDto	true	Request body containing the mappings of tax codes to expense categories for financial entities within the organizational structure.

Body Parameters

{
  "id": 0,
  "rowNumber": 0,
  "rowIdentifier": "string",
  "errors": [
    "string"
  ],
  "linkedErrors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "remarks": [
    "string"
  ],
  "skipMessage": "string",
  "determinationId": 0,
  "determinationDisplayId": "string",
  "isLeaseExpense": true,
  "expenseCategoryId": 0,
  "expenseCategoryDisplayId": "string",
  "expenseCategoryName": "string",
  "nonLeaseTaxCodeId": 0,
  "nonLeaseTaxCodeDisplayId": "string",
  "nonLeaseExemptionTaxCodeId": 0,
  "nonLeaseExemptionTaxCodeDisplayId": "string",
  "nonLeaseExemptionTaxPercentage": 0.1,
  "principalTaxCodeId": 0,
  "principalTaxCodeDisplayId": "string",
  "principalExemptionTaxCodeId": 0,
  "principalExemptionTaxCodeDisplayId": "string",
  "principalExemptionTaxPercentage": 0.1
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseTaxCodeExpenseCategoryMappingDto

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",
    "isLeaseExpense": true,
    "expenseCategoryId": 0,
    "expenseCategoryDisplayId": "string",
    "expenseCategoryName": "string",
    "nonLeaseTaxCodeId": 0,
    "nonLeaseTaxCodeDisplayId": "string",
    "nonLeaseExemptionTaxCodeId": 0,
    "nonLeaseExemptionTaxCodeDisplayId": "string",
    "nonLeaseExemptionTaxPercentage": 0.1,
    "principalTaxCodeId": 0,
    "principalTaxCodeDisplayId": "string",
    "principalExemptionTaxCodeId": 0,
    "principalExemptionTaxCodeDisplayId": "string",
    "principalExemptionTaxPercentage": 0.1
  }
}

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

Tax Mapping - Get Metadata

HTTP Request

GET /api/v1/tax-code-expense-category-mappings/meta

Interactive Demo

📋 Description: Retrieves metadata for tax code expense category mappings within the financial organization structure, providing essential information for understanding the hierarchy and relationships of financial entities.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "IS_LEASE_EXPENSE"
]

Response Schema

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

---