Tax Code Determination¶
Tax Code Determination - Get¶
HTTP Request
GET /api/v1/tax-code-determinations/{id}
📋 Description: Retrieves the tax code determination details for a specified financial entity within the organizational structure, providing insights into the applicable tax regulations and classifications.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "countryId": 0,
21 "countryDisplayId": "string",
22 "countryTaxJurisdictionEnabled": true,
23 "forAllCompanies": true,
24 "companyId": 0,
25 "companyDisplayId": "string",
26 "companyName": "string",
27 "forAllAssetClasses": true,
28 "assetClassId": 0,
29 "assetClassDisplayId": "string",
30 "forAllPartners": true,
31 "partnerId": 0,
32 "partnerDisplayId": "string",
33 "partnerName": "string",
34 "taxJurisdictionId": 0,
35 "taxJurisdictionDisplayId": "string",
36 "defaultTaxCodeId": 0,
37 "defaultTaxCodeDisplayId": "string",
38 "defaultExemptionTaxCodeId": 0,
39 "defaultExemptionTaxCodeDisplayId": "string",
40 "defaultExemptionPercentage": 0.1
41 }
42}
Tax Code Determination - Update¶
HTTP Request
PUT /api/v1/tax-code-determinations/{id}
📋 Description: Updates the tax code determination for a specified financial entity within the organizational structure, ensuring compliance with hierarchical tax regulations.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated tax code determination data, including relevant organizational hierarchy and financial entity details. |
Body Parameters
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "erpSystemId": 0,
6 "erpSystemDisplayId": "string",
7 "countryId": 0,
8 "countryDisplayId": "string",
9 "countryTaxJurisdictionEnabled": true,
10 "forAllCompanies": true,
11 "companyId": 0,
12 "companyDisplayId": "string",
13 "companyName": "string",
14 "forAllAssetClasses": true,
15 "assetClassId": 0,
16 "assetClassDisplayId": "string",
17 "forAllPartners": true,
18 "partnerId": 0,
19 "partnerDisplayId": "string",
20 "partnerName": "string",
21 "taxJurisdictionId": 0,
22 "taxJurisdictionDisplayId": "string",
23 "defaultTaxCodeId": 0,
24 "defaultTaxCodeDisplayId": "string",
25 "defaultExemptionTaxCodeId": 0,
26 "defaultExemptionTaxCodeDisplayId": "string",
27 "defaultExemptionPercentage": 0.1
28}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "countryId": 0,
21 "countryDisplayId": "string",
22 "countryTaxJurisdictionEnabled": true,
23 "forAllCompanies": true,
24 "companyId": 0,
25 "companyDisplayId": "string",
26 "companyName": "string",
27 "forAllAssetClasses": true,
28 "assetClassId": 0,
29 "assetClassDisplayId": "string",
30 "forAllPartners": true,
31 "partnerId": 0,
32 "partnerDisplayId": "string",
33 "partnerName": "string",
34 "taxJurisdictionId": 0,
35 "taxJurisdictionDisplayId": "string",
36 "defaultTaxCodeId": 0,
37 "defaultTaxCodeDisplayId": "string",
38 "defaultExemptionTaxCodeId": 0,
39 "defaultExemptionTaxCodeDisplayId": "string",
40 "defaultExemptionPercentage": 0.1
41 }
42}
Tax Code Determination - Delete¶
HTTP Request
DELETE /api/v1/tax-code-determinations/{id}
📋 Description: Deletes a specified tax code determination 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 |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Tax Code Determination - Delete Or Decommission¶
HTTP Request
PUT /api/v1/tax-code-determinations/remove/{id}
📋 Description: Removes a specified tax code determination from the financial organization structure, ensuring the integrity of the hierarchy within the financial entity.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Tax Code Determination - Delete Or Decommission All¶
HTTP Request
PUT /api/v1/tax-code-determinations/remove/bulk
📋 Description: Removes multiple tax code determinations in bulk from the financial organization structure, ensuring accurate hierarchy management for financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing an array of tax code determination identifiers for bulk removal within the financial organization structure. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Tax Code Determination - Decommission¶
HTTP Request
PUT /api/v1/tax-code-determinations/decommission/{id}
📋 Description: Decommissions a specified tax code determination within the financial organization structure, effectively removing it from the active hierarchy of financial entities. This operation ensures that outdated or irrelevant tax code determinations are no longer utilized in organizational processes.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "countryId": 0,
21 "countryDisplayId": "string",
22 "countryTaxJurisdictionEnabled": true,
23 "forAllCompanies": true,
24 "companyId": 0,
25 "companyDisplayId": "string",
26 "companyName": "string",
27 "forAllAssetClasses": true,
28 "assetClassId": 0,
29 "assetClassDisplayId": "string",
30 "forAllPartners": true,
31 "partnerId": 0,
32 "partnerDisplayId": "string",
33 "partnerName": "string",
34 "taxJurisdictionId": 0,
35 "taxJurisdictionDisplayId": "string",
36 "defaultTaxCodeId": 0,
37 "defaultTaxCodeDisplayId": "string",
38 "defaultExemptionTaxCodeId": 0,
39 "defaultExemptionTaxCodeDisplayId": "string",
40 "defaultExemptionPercentage": 0.1
41 }
42}
Tax Code Determination - Decommission By Modification Date Before¶
HTTP Request
PUT /api/v1/tax-code-determinations/decommission/modified-before/{modified_before}
📋 Description: Decommissions tax code determinations that were modified before the specified date, ensuring the financial organization structure remains current and compliant. This operation is essential for maintaining an accurate hierarchy within financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
modified_before |
path |
string(date-time) |
true |
Specifies the date and time before which tax code determinations will be decommissioned, ensuring compliance with organizational financial structure and hierarchy requirements. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "countryId": 0,
22 "countryDisplayId": "string",
23 "countryTaxJurisdictionEnabled": true,
24 "forAllCompanies": true,
25 "companyId": 0,
26 "companyDisplayId": "string",
27 "companyName": "string",
28 "forAllAssetClasses": true,
29 "assetClassId": 0,
30 "assetClassDisplayId": "string",
31 "forAllPartners": true,
32 "partnerId": 0,
33 "partnerDisplayId": "string",
34 "partnerName": "string",
35 "taxJurisdictionId": 0,
36 "taxJurisdictionDisplayId": "string",
37 "defaultTaxCodeId": 0,
38 "defaultTaxCodeDisplayId": "string",
39 "defaultExemptionTaxCodeId": 0,
40 "defaultExemptionTaxCodeDisplayId": "string",
41 "defaultExemptionPercentage": 0.1
42 }
43 ]
44}
Tax Code Determination - Decommission Before Now¶
HTTP Request
PUT /api/v1/tax-code-determinations/decommission/modified-before-now
📋 Description: Decommissions tax code determinations that were modified before the current date, ensuring the financial organization structure remains accurate and up-to-date. This operation helps maintain the integrity of the hierarchy within financial entities.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "countryId": 0,
22 "countryDisplayId": "string",
23 "countryTaxJurisdictionEnabled": true,
24 "forAllCompanies": true,
25 "companyId": 0,
26 "companyDisplayId": "string",
27 "companyName": "string",
28 "forAllAssetClasses": true,
29 "assetClassId": 0,
30 "assetClassDisplayId": "string",
31 "forAllPartners": true,
32 "partnerId": 0,
33 "partnerDisplayId": "string",
34 "partnerName": "string",
35 "taxJurisdictionId": 0,
36 "taxJurisdictionDisplayId": "string",
37 "defaultTaxCodeId": 0,
38 "defaultTaxCodeDisplayId": "string",
39 "defaultExemptionTaxCodeId": 0,
40 "defaultExemptionTaxCodeDisplayId": "string",
41 "defaultExemptionPercentage": 0.1
42 }
43 ]
44}
Tax Code Determination - Decommission All¶
HTTP Request
PUT /api/v1/tax-code-determinations/decommission/bulk
📋 Description: Decommissions multiple tax code determinations in bulk, allowing financial organizations to efficiently manage their organizational structure and hierarchy by removing outdated or unnecessary tax codes.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing an array of tax code determination identifiers and associated metadata for bulk decommissioning within the financial organization structure. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "countryId": 0,
22 "countryDisplayId": "string",
23 "countryTaxJurisdictionEnabled": true,
24 "forAllCompanies": true,
25 "companyId": 0,
26 "companyDisplayId": "string",
27 "companyName": "string",
28 "forAllAssetClasses": true,
29 "assetClassId": 0,
30 "assetClassDisplayId": "string",
31 "forAllPartners": true,
32 "partnerId": 0,
33 "partnerDisplayId": "string",
34 "partnerName": "string",
35 "taxJurisdictionId": 0,
36 "taxJurisdictionDisplayId": "string",
37 "defaultTaxCodeId": 0,
38 "defaultTaxCodeDisplayId": "string",
39 "defaultExemptionTaxCodeId": 0,
40 "defaultExemptionTaxCodeDisplayId": "string",
41 "defaultExemptionPercentage": 0.1
42 }
43 ]
44}
Tax Code Determination - Create Or Update Bulk¶
HTTP Request
PUT /api/v1/tax-code-determinations/createOrUpdate/bulk
📋 Description: Creates or updates multiple tax code determinations in bulk for financial entities, ensuring accurate alignment within the organization’s structure and hierarchy.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing bulk tax code determination data for financial entities, including organization hierarchy and structure details. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "countryId": 0,
9 "countryDisplayId": "string",
10 "countryTaxJurisdictionEnabled": true,
11 "forAllCompanies": true,
12 "companyId": 0,
13 "companyDisplayId": "string",
14 "companyName": "string",
15 "forAllAssetClasses": true,
16 "assetClassId": 0,
17 "assetClassDisplayId": "string",
18 "forAllPartners": true,
19 "partnerId": 0,
20 "partnerDisplayId": "string",
21 "partnerName": "string",
22 "taxJurisdictionId": 0,
23 "taxJurisdictionDisplayId": "string",
24 "defaultTaxCodeId": 0,
25 "defaultTaxCodeDisplayId": "string",
26 "defaultExemptionTaxCodeId": 0,
27 "defaultExemptionTaxCodeDisplayId": "string",
28 "defaultExemptionPercentage": 0.1
29 }
30]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "countryId": 0,
22 "countryDisplayId": "string",
23 "countryTaxJurisdictionEnabled": true,
24 "forAllCompanies": true,
25 "companyId": 0,
26 "companyDisplayId": "string",
27 "companyName": "string",
28 "forAllAssetClasses": true,
29 "assetClassId": 0,
30 "assetClassDisplayId": "string",
31 "forAllPartners": true,
32 "partnerId": 0,
33 "partnerDisplayId": "string",
34 "partnerName": "string",
35 "taxJurisdictionId": 0,
36 "taxJurisdictionDisplayId": "string",
37 "defaultTaxCodeId": 0,
38 "defaultTaxCodeDisplayId": "string",
39 "defaultExemptionTaxCodeId": 0,
40 "defaultExemptionTaxCodeDisplayId": "string",
41 "defaultExemptionPercentage": 0.1
42 }
43 ]
44}
Tax Code Determination - Create Or Update¶
HTTP Request
PUT /api/v1/tax-code-determinations/createOrUpdate
📋 Description: Updates or creates tax code determinations for financial entities within the organizational structure, ensuring accurate alignment with the hierarchy and compliance requirements.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the tax code determination data, including organizational hierarchy details and financial entity attributes for creation or update purposes. |
Body Parameters
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "erpSystemId": 0,
6 "erpSystemDisplayId": "string",
7 "countryId": 0,
8 "countryDisplayId": "string",
9 "countryTaxJurisdictionEnabled": true,
10 "forAllCompanies": true,
11 "companyId": 0,
12 "companyDisplayId": "string",
13 "companyName": "string",
14 "forAllAssetClasses": true,
15 "assetClassId": 0,
16 "assetClassDisplayId": "string",
17 "forAllPartners": true,
18 "partnerId": 0,
19 "partnerDisplayId": "string",
20 "partnerName": "string",
21 "taxJurisdictionId": 0,
22 "taxJurisdictionDisplayId": "string",
23 "defaultTaxCodeId": 0,
24 "defaultTaxCodeDisplayId": "string",
25 "defaultExemptionTaxCodeId": 0,
26 "defaultExemptionTaxCodeDisplayId": "string",
27 "defaultExemptionPercentage": 0.1
28}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "countryId": 0,
21 "countryDisplayId": "string",
22 "countryTaxJurisdictionEnabled": true,
23 "forAllCompanies": true,
24 "companyId": 0,
25 "companyDisplayId": "string",
26 "companyName": "string",
27 "forAllAssetClasses": true,
28 "assetClassId": 0,
29 "assetClassDisplayId": "string",
30 "forAllPartners": true,
31 "partnerId": 0,
32 "partnerDisplayId": "string",
33 "partnerName": "string",
34 "taxJurisdictionId": 0,
35 "taxJurisdictionDisplayId": "string",
36 "defaultTaxCodeId": 0,
37 "defaultTaxCodeDisplayId": "string",
38 "defaultExemptionTaxCodeId": 0,
39 "defaultExemptionTaxCodeDisplayId": "string",
40 "defaultExemptionPercentage": 0.1
41 }
42}
Tax Code Determination - Bulk Update¶
HTTP Request
PUT /api/v1/tax-code-determinations/bulk
📋 Description: Updates multiple tax code determinations for financial entities within the organizational structure, allowing for efficient management of tax classifications in bulk.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing a collection of tax code determination entries, including relevant organizational hierarchy and financial entity identifiers for bulk processing. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "countryId": 0,
9 "countryDisplayId": "string",
10 "countryTaxJurisdictionEnabled": true,
11 "forAllCompanies": true,
12 "companyId": 0,
13 "companyDisplayId": "string",
14 "companyName": "string",
15 "forAllAssetClasses": true,
16 "assetClassId": 0,
17 "assetClassDisplayId": "string",
18 "forAllPartners": true,
19 "partnerId": 0,
20 "partnerDisplayId": "string",
21 "partnerName": "string",
22 "taxJurisdictionId": 0,
23 "taxJurisdictionDisplayId": "string",
24 "defaultTaxCodeId": 0,
25 "defaultTaxCodeDisplayId": "string",
26 "defaultExemptionTaxCodeId": 0,
27 "defaultExemptionTaxCodeDisplayId": "string",
28 "defaultExemptionPercentage": 0.1
29 }
30]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "countryId": 0,
22 "countryDisplayId": "string",
23 "countryTaxJurisdictionEnabled": true,
24 "forAllCompanies": true,
25 "companyId": 0,
26 "companyDisplayId": "string",
27 "companyName": "string",
28 "forAllAssetClasses": true,
29 "assetClassId": 0,
30 "assetClassDisplayId": "string",
31 "forAllPartners": true,
32 "partnerId": 0,
33 "partnerDisplayId": "string",
34 "partnerName": "string",
35 "taxJurisdictionId": 0,
36 "taxJurisdictionDisplayId": "string",
37 "defaultTaxCodeId": 0,
38 "defaultTaxCodeDisplayId": "string",
39 "defaultExemptionTaxCodeId": 0,
40 "defaultExemptionTaxCodeDisplayId": "string",
41 "defaultExemptionPercentage": 0.1
42 }
43 ]
44}
Tax Code Determination - Bulk Create¶
HTTP Request
POST /api/v1/tax-code-determinations/bulk
📋 Description: Submits a bulk request for tax code determinations across multiple financial entities within the organizational structure, enabling efficient processing and compliance management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing a collection of tax code determination entries, each representing a financial entity’s organizational structure and hierarchy for bulk processing. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "erpSystemId": 0,
7 "erpSystemDisplayId": "string",
8 "countryId": 0,
9 "countryDisplayId": "string",
10 "countryTaxJurisdictionEnabled": true,
11 "forAllCompanies": true,
12 "companyId": 0,
13 "companyDisplayId": "string",
14 "companyName": "string",
15 "forAllAssetClasses": true,
16 "assetClassId": 0,
17 "assetClassDisplayId": "string",
18 "forAllPartners": true,
19 "partnerId": 0,
20 "partnerDisplayId": "string",
21 "partnerName": "string",
22 "taxJurisdictionId": 0,
23 "taxJurisdictionDisplayId": "string",
24 "defaultTaxCodeId": 0,
25 "defaultTaxCodeDisplayId": "string",
26 "defaultExemptionTaxCodeId": 0,
27 "defaultExemptionTaxCodeDisplayId": "string",
28 "defaultExemptionPercentage": 0.1
29 }
30]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "status": "CREATED",
18 "displayId": "string",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "countryId": 0,
22 "countryDisplayId": "string",
23 "countryTaxJurisdictionEnabled": true,
24 "forAllCompanies": true,
25 "companyId": 0,
26 "companyDisplayId": "string",
27 "companyName": "string",
28 "forAllAssetClasses": true,
29 "assetClassId": 0,
30 "assetClassDisplayId": "string",
31 "forAllPartners": true,
32 "partnerId": 0,
33 "partnerDisplayId": "string",
34 "partnerName": "string",
35 "taxJurisdictionId": 0,
36 "taxJurisdictionDisplayId": "string",
37 "defaultTaxCodeId": 0,
38 "defaultTaxCodeDisplayId": "string",
39 "defaultExemptionTaxCodeId": 0,
40 "defaultExemptionTaxCodeDisplayId": "string",
41 "defaultExemptionPercentage": 0.1
42 }
43 ]
44}
Tax Code Determination - Bulk Delete¶
HTTP Request
DELETE /api/v1/tax-code-determinations/bulk
📋 Description: Deletes multiple tax code determinations in bulk, allowing financial organizations to efficiently manage their tax-related data within the organizational structure and hierarchy.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing a list of tax code determination identifiers for bulk deletion within the financial organization structure. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Tax Code Determination - Get Tax Code Mapping¶
HTTP Request
POST /api/v1/tax-code-determinations/tax-mapping
Deprecated
This endpoint is deprecated and may be removed in a future version. Please use alternative endpoints if available.
📋 Description: Creates a new tax mapping entry for a specified financial entity within the organizational structure, facilitating accurate tax code determinations based on the established hierarchy.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the tax mapping data necessary for determining the appropriate tax codes within the financial organization structure and hierarchy. |
Body Parameters
1{
2 "companyId": 0,
3 "partnerId": 0,
4 "taxJurisdictionId": 0,
5 "expenseCategoryId": 0
6}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "rowNumber": 0,
17 "rowIdentifier": "string",
18 "errors": [
19 "string"
20 ],
21 "linkedErrors": [
22 "string"
23 ],
24 "warnings": [
25 "string"
26 ],
27 "remarks": [
28 "string"
29 ],
30 "skipMessage": "string",
31 "determinationId": 0,
32 "determinationDisplayId": "string",
33 "isLeaseExpense": true,
34 "expenseCategoryId": 0,
35 "expenseCategoryDisplayId": "string",
36 "expenseCategoryName": "string",
37 "nonLeaseTaxCodeId": 0,
38 "nonLeaseTaxCodeDisplayId": "string",
39 "nonLeaseExemptionTaxCodeId": 0,
40 "nonLeaseExemptionTaxCodeDisplayId": "string",
41 "nonLeaseExemptionTaxPercentage": 0.1,
42 "principalTaxCodeId": 0,
43 "principalTaxCodeDisplayId": "string",
44 "principalExemptionTaxCodeId": 0,
45 "principalExemptionTaxCodeDisplayId": "string",
46 "principalExemptionTaxPercentage": 0.1
47 }
48}
Tax Code Determination - Get Tax Jurisdictions By Determination¶
HTTP Request
POST /api/v1/tax-code-determinations/tax-jurisdictions
📋 Description: Creates a new tax jurisdiction determination within the financial organization structure, enabling accurate tax code assignments based on the specified organizational hierarchy.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the tax jurisdiction data necessary for determining tax codes within the financial organization structure and hierarchy. |
Body Parameters
1{
2 "companyId": 0,
3 "partnerId": 0
4}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "determinations": [
16 {
17 "id": 0,
18 "status": "CREATED",
19 "displayId": "string",
20 "erpSystemId": 0,
21 "erpSystemDisplayId": "string",
22 "countryId": 0,
23 "countryDisplayId": "string",
24 "countryTaxJurisdictionEnabled": true,
25 "forAllCompanies": true,
26 "companyId": 0,
27 "companyDisplayId": "string",
28 "companyName": "string",
29 "forAllAssetClasses": true,
30 "assetClassId": 0,
31 "assetClassDisplayId": "string",
32 "forAllPartners": true,
33 "partnerId": 0,
34 "partnerDisplayId": "string",
35 "partnerName": "string",
36 "taxJurisdictionId": 0,
37 "taxJurisdictionDisplayId": "string",
38 "defaultTaxCodeId": 0,
39 "defaultTaxCodeDisplayId": "string",
40 "defaultExemptionTaxCodeId": 0,
41 "defaultExemptionTaxCodeDisplayId": "string",
42 "defaultExemptionPercentage": 0.1
43 }
44 ]
45 }
46}
Tax Code Determination - Get Tax Code Determinations¶
HTTP Request
POST /api/v1/tax-code-determinations/tax-determinations
📋 Description: Submits tax code determination requests for financial entities within the organizational hierarchy, enabling accurate tax classification based on the specified structure.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the financial entity’s organizational structure data, including tax code details necessary for accurate tax determinations. |
Body Parameters
1{
2 "companyId": 0,
3 "partnerId": 0,
4 "taxJurisdictionId": 0,
5 "expenseCategoryId": 0
6}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "rowNumber": 0,
18 "rowIdentifier": "string",
19 "errors": [
20 "string"
21 ],
22 "linkedErrors": [
23 "string"
24 ],
25 "warnings": [
26 "string"
27 ],
28 "remarks": [
29 "string"
30 ],
31 "skipMessage": "string",
32 "determinationId": 0,
33 "determinationDisplayId": "string",
34 "isLeaseExpense": true,
35 "expenseCategoryId": 0,
36 "expenseCategoryDisplayId": "string",
37 "expenseCategoryName": "string",
38 "nonLeaseTaxCodeId": 0,
39 "nonLeaseTaxCodeDisplayId": "string",
40 "nonLeaseExemptionTaxCodeId": 0,
41 "nonLeaseExemptionTaxCodeDisplayId": "string",
42 "nonLeaseExemptionTaxPercentage": 0.1,
43 "principalTaxCodeId": 0,
44 "principalTaxCodeDisplayId": "string",
45 "principalExemptionTaxCodeId": 0,
46 "principalExemptionTaxCodeDisplayId": "string",
47 "principalExemptionTaxPercentage": 0.1
48 }
49 ]
50}
Tax Code Determination - Search¶
HTTP Request
POST /api/v1/tax-code-determinations/search
📋 Description: Submits a request to search for tax code determinations within the financial organization structure, enabling users to identify relevant tax classifications 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 |
false |
Request body containing the criteria for searching tax code determinations within the financial organization structure, including relevant organizational hierarchy and entity details. |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
sort |
|
query |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
page |
Min: 0 |
size |
Min: 1 |
Body Parameters
1{
2 "idIn": [
3 0
4 ],
5 "idEqual": 0,
6 "idLike": "string",
7 "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
8 "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
9 "createdByLike": "string",
10 "createdByEqual": "string",
11 "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12 "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13 "modifiedByLike": "string",
14 "modifiedByEqual": "string",
15 "statusEqual": "CREATED",
16 "statusIn": [
17 "CREATED"
18 ],
19 "displayIdIn": [
20 "string"
21 ],
22 "displayIdLike": "string",
23 "erpSystemIdEqual": 0,
24 "erpSystemDisplayIdLike": "string",
25 "companyDisplayIdLike": "string",
26 "partnerDisplayIdLike": "string",
27 "countryIdEqual": 0,
28 "countryDisplayIdLike": "string",
29 "forAllCompaniesEqual": true,
30 "companyIdEqual": 0,
31 "companyNameLike": "string",
32 "forAllAssetClassesEqual": true,
33 "forAllPartnersEqual": true,
34 "partnerIdEqual": 0,
35 "partnerNameLike": "string",
36 "taxJurisdictionIdEqual": 0,
37 "taxJurisdictionDisplayIdLike": "string",
38 "defaultTaxCodeIdEqual": 0,
39 "defaultTaxCodeDisplayIdLike": "string",
40 "defaultExemptionTaxCodeIdEqual": 0,
41 "defaultExemptionTaxCodeDisplayIdLike": "string",
42 "defaultExemptionPercentageLike": "string"
43}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "paged": true,
7 "pageSize": 0,
8 "unpaged": true,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "status": "CREATED",
22 "displayId": "string",
23 "erpSystemId": 0,
24 "erpSystemDisplayId": "string",
25 "countryId": 0,
26 "countryDisplayId": "string",
27 "countryTaxJurisdictionEnabled": true,
28 "forAllCompanies": true,
29 "companyId": 0,
30 "companyDisplayId": "string",
31 "companyName": "string",
32 "forAllAssetClasses": true,
33 "assetClassId": 0,
34 "assetClassDisplayId": "string",
35 "forAllPartners": true,
36 "partnerId": 0,
37 "partnerDisplayId": "string",
38 "partnerName": "string",
39 "taxJurisdictionId": 0,
40 "taxJurisdictionDisplayId": "string",
41 "defaultTaxCodeId": 0,
42 "defaultTaxCodeDisplayId": "string",
43 "defaultExemptionTaxCodeId": 0,
44 "defaultExemptionTaxCodeDisplayId": "string",
45 "defaultExemptionPercentage": 0.1
46 }
47 ],
48 "number": 0,
49 "sort": {
50 "unsorted": true,
51 "sorted": true,
52 "empty": true
53 },
54 "first": true,
55 "last": true,
56 "empty": true
57}
Tax Code Determination - Find All¶
HTTP Request
GET /api/v1/tax-code-determinations
📋 Description: Retrieves tax code determinations for financial entities within the organizational structure, enabling users to understand the applicable tax classifications based on the hierarchy of the organization.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the tax code determinations should be returned in a paginated format, facilitating efficient navigation through the financial organization structure. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "paged": true,
7 "pageSize": 0,
8 "unpaged": true,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "status": "CREATED",
22 "displayId": "string",
23 "erpSystemId": 0,
24 "erpSystemDisplayId": "string",
25 "countryId": 0,
26 "countryDisplayId": "string",
27 "countryTaxJurisdictionEnabled": true,
28 "forAllCompanies": true,
29 "companyId": 0,
30 "companyDisplayId": "string",
31 "companyName": "string",
32 "forAllAssetClasses": true,
33 "assetClassId": 0,
34 "assetClassDisplayId": "string",
35 "forAllPartners": true,
36 "partnerId": 0,
37 "partnerDisplayId": "string",
38 "partnerName": "string",
39 "taxJurisdictionId": 0,
40 "taxJurisdictionDisplayId": "string",
41 "defaultTaxCodeId": 0,
42 "defaultTaxCodeDisplayId": "string",
43 "defaultExemptionTaxCodeId": 0,
44 "defaultExemptionTaxCodeDisplayId": "string",
45 "defaultExemptionPercentage": 0.1
46 }
47 ],
48 "number": 0,
49 "sort": {
50 "unsorted": true,
51 "sorted": true,
52 "empty": true
53 },
54 "first": true,
55 "last": true,
56 "empty": true
57}
Tax Code Determination - Create¶
HTTP Request
POST /api/v1/tax-code-determinations
📋 Description: Submits a request to determine the appropriate tax code for a specified financial entity within the organizational structure, facilitating compliance and accurate financial reporting.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the financial entity’s organizational structure data, including tax code determination details essential for compliance and hierarchy management. |
Body Parameters
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "erpSystemId": 0,
6 "erpSystemDisplayId": "string",
7 "countryId": 0,
8 "countryDisplayId": "string",
9 "countryTaxJurisdictionEnabled": true,
10 "forAllCompanies": true,
11 "companyId": 0,
12 "companyDisplayId": "string",
13 "companyName": "string",
14 "forAllAssetClasses": true,
15 "assetClassId": 0,
16 "assetClassDisplayId": "string",
17 "forAllPartners": true,
18 "partnerId": 0,
19 "partnerDisplayId": "string",
20 "partnerName": "string",
21 "taxJurisdictionId": 0,
22 "taxJurisdictionDisplayId": "string",
23 "defaultTaxCodeId": 0,
24 "defaultTaxCodeDisplayId": "string",
25 "defaultExemptionTaxCodeId": 0,
26 "defaultExemptionTaxCodeDisplayId": "string",
27 "defaultExemptionPercentage": 0.1
28}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "status": "CREATED",
17 "displayId": "string",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "countryId": 0,
21 "countryDisplayId": "string",
22 "countryTaxJurisdictionEnabled": true,
23 "forAllCompanies": true,
24 "companyId": 0,
25 "companyDisplayId": "string",
26 "companyName": "string",
27 "forAllAssetClasses": true,
28 "assetClassId": 0,
29 "assetClassDisplayId": "string",
30 "forAllPartners": true,
31 "partnerId": 0,
32 "partnerDisplayId": "string",
33 "partnerName": "string",
34 "taxJurisdictionId": 0,
35 "taxJurisdictionDisplayId": "string",
36 "defaultTaxCodeId": 0,
37 "defaultTaxCodeDisplayId": "string",
38 "defaultExemptionTaxCodeId": 0,
39 "defaultExemptionTaxCodeDisplayId": "string",
40 "defaultExemptionPercentage": 0.1
41 }
42}
Tax Code Determination - Get Metadata¶
HTTP Request
GET /api/v1/tax-code-determinations/meta
📋 Description: Retrieves metadata related to tax code determinations within the financial organization structure, providing insights into the hierarchy and classification of financial entities.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "DEFAULT_EXEMPTION_PERCENTAGE"
3]