Tax Calculation¶
Calculate Smart Tax¶
HTTP Request
POST /api/v1/tax-service/calc/smart
📋 Description: This API is going to calculate Smart tax and return a List of tax items based on all Available Tax configuration.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the hierarchical structure and financial entity details necessary for calculating tax obligations within the organization. |
Body Parameters
1{
2 "requestUniqueId": "string",
3 "taxCalculationType": "NET",
4 "erpSystem": {
5 "id": 0,
6 "displayId": "string"
7 },
8 "company": {
9 "id": 0,
10 "displayId": "string"
11 },
12 "contractCurrency": {
13 "id": 0,
14 "displayId": "string"
15 },
16 "documentDate": "2019-08-24",
17 "postingDate": "2019-08-24",
18 "transactionDate": "2019-08-24"
19}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "requestUniqueId": "string",
3 "systemType": "NAKISA",
4 "taxCalculationType": "NET",
5 "success": true,
6 "errorMessage": "string",
7 "taxDetails": [
8 {
9 "taxAmount": 0,
10 "taxBaseAmount": 0,
11 "totalTaxDocumentAmount": 0,
12 "taxRate": 0,
13 "taxAccount": "string",
14 "accountingKey": "string",
15 "conditionKey": "string",
16 "taxCodeDisplayId": "string",
17 "taxJurisdictionDisplayId": "string",
18 "taxCodeId": 0,
19 "taxJurisdictionId": 0,
20 "itemNoAcc": "string"
21 }
22 ]
23}
Calculate Advanced Taxes¶
HTTP Request
POST /api/v1/tax-service/calc/smart/bulk
📋 Description: This API is going to calculate Fi Services taxes in bulk and return a List of tax items based on all Available Tax configuration.
Note: The Maximum number of requests is 10
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing a bulk set of financial entity data structured according to the organization’s hierarchy for tax calculation purposes. |
Body Parameters
1{
2 "requestUniqueId": "string",
3 "taxCalculationType": "NET",
4 "erpSystem": {
5 "id": 0,
6 "displayId": "string"
7 },
8 "company": {
9 "id": 0,
10 "displayId": "string"
11 },
12 "contractCurrency": {
13 "id": 0,
14 "displayId": "string"
15 },
16 "documentDate": "2019-08-24",
17 "postingDate": "2019-08-24",
18 "transactionDate": "2019-08-24"
19}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "requestUniqueId": "string",
4 "systemType": "NAKISA",
5 "taxCalculationType": "NET",
6 "success": true,
7 "errorMessage": "string",
8 "taxDetails": [
9 {
10 "taxAmount": 0,
11 "taxBaseAmount": 0,
12 "totalTaxDocumentAmount": 0,
13 "taxRate": 0,
14 "taxAccount": "string",
15 "accountingKey": "string",
16 "conditionKey": "string",
17 "taxCodeDisplayId": "string",
18 "taxJurisdictionDisplayId": "string",
19 "taxCodeId": 0,
20 "taxJurisdictionId": 0,
21 "itemNoAcc": "string"
22 }
23 ]
24 }
25]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the outcome of a tax calculation for a financial entity within an organization’s hierarchical structure, providing essential details for compliance and reporting.] |
|
» requestUniqueId |
string |
false |
none |
Unique identifier for the request unique |
» systemType |
string |
false |
none |
Type of the system |
» taxCalculationType |
string |
false |
none |
Type of the tax calculation |
» success |
boolean |
false |
none |
Boolean flag indicating success status |
» errorMessage |
string |
false |
none |
Text value for errorMessage in TaxCalculationResponse |
» taxDetails |
false |
none |
List of taxDetails items |
|
»» taxAmount |
number |
false |
none |
Amount of tax |
»» taxBaseAmount |
number |
false |
none |
Amount of tax base |
»» totalTaxDocumentAmount |
number |
false |
none |
Amount of total tax document |
»» taxRate |
number |
false |
none |
Rate of tax |
»» taxAccount |
string |
false |
none |
Number of organization items |
»» accountingKey |
string |
false |
none |
Text value for accountingKey in TaxDetail |
»» conditionKey |
string |
false |
none |
Represents the specific condition key associated with a financial entity within the organizational structure, facilitating accurate hierarchy management and reporting. |
»» taxCodeDisplayId |
string |
false |
none |
Unique identifier for the tax code display |
»» taxJurisdictionDisplayId |
string |
false |
none |
Unique identifier for the tax jurisdiction display |
»» taxCodeId |
integer(int64) |
false |
none |
Unique identifier for the tax code |
»» taxJurisdictionId |
integer(int64) |
false |
none |
Unique identifier for the tax jurisdiction |
»» itemNoAcc |
string |
false |
none |
Text value for itemNoAcc in TaxDetail |
Enumerated Values
Attribute |
Value |
|---|---|
systemType |
NAKISA, SAP |
taxCalculationType |
NET |
Calculate Basic Tax¶
HTTP Request
POST /api/v1/tax-service/calc/basic
📋 Description: This API is going to calculate simple tax and return a List of tax items based on all Available Tax configuration.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the financial entity’s hierarchical data necessary for calculating basic tax obligations within the organization’s structure. |
Body Parameters
1{
2 "requestUniqueId": "string",
3 "taxCalculationType": "NET",
4 "erpSystem": {
5 "id": 0,
6 "displayId": "string"
7 },
8 "company": {
9 "id": 0,
10 "displayId": "string"
11 },
12 "contractCurrency": {
13 "id": 0,
14 "displayId": "string"
15 },
16 "documentDate": "2019-08-24",
17 "postingDate": "2019-08-24",
18 "transactionDate": "2019-08-24"
19}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "requestUniqueId": "string",
3 "systemType": "NAKISA",
4 "taxCalculationType": "NET",
5 "success": true,
6 "errorMessage": "string",
7 "taxDetails": [
8 {
9 "taxAmount": 0,
10 "taxBaseAmount": 0,
11 "totalTaxDocumentAmount": 0,
12 "taxRate": 0,
13 "taxAccount": "string",
14 "accountingKey": "string",
15 "conditionKey": "string",
16 "taxCodeDisplayId": "string",
17 "taxJurisdictionDisplayId": "string",
18 "taxCodeId": 0,
19 "taxJurisdictionId": 0,
20 "itemNoAcc": "string"
21 }
22 ]
23}
Calculate Basic Taxes¶
HTTP Request
POST /api/v1/tax-service/calc/basic/bulk
📋 Description: This API is going to calculate taxes in bulk and return a List of tax items based on all Available Tax configuration.
Note: The Maximum number of requests is 10
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing bulk financial entity data, including organizational hierarchy and structure details, for tax calculation purposes. |
Body Parameters
1{
2 "requestUniqueId": "string",
3 "taxCalculationType": "NET",
4 "erpSystem": {
5 "id": 0,
6 "displayId": "string"
7 },
8 "company": {
9 "id": 0,
10 "displayId": "string"
11 },
12 "contractCurrency": {
13 "id": 0,
14 "displayId": "string"
15 },
16 "documentDate": "2019-08-24",
17 "postingDate": "2019-08-24",
18 "transactionDate": "2019-08-24"
19}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "requestUniqueId": "string",
4 "systemType": "NAKISA",
5 "taxCalculationType": "NET",
6 "success": true,
7 "errorMessage": "string",
8 "taxDetails": [
9 {
10 "taxAmount": 0,
11 "taxBaseAmount": 0,
12 "totalTaxDocumentAmount": 0,
13 "taxRate": 0,
14 "taxAccount": "string",
15 "accountingKey": "string",
16 "conditionKey": "string",
17 "taxCodeDisplayId": "string",
18 "taxJurisdictionDisplayId": "string",
19 "taxCodeId": 0,
20 "taxJurisdictionId": 0,
21 "itemNoAcc": "string"
22 }
23 ]
24 }
25]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the outcome of a tax calculation for a financial entity within an organization’s hierarchical structure, providing essential details for compliance and reporting.] |
|
» requestUniqueId |
string |
false |
none |
Unique identifier for the request unique |
» systemType |
string |
false |
none |
Type of the system |
» taxCalculationType |
string |
false |
none |
Type of the tax calculation |
» success |
boolean |
false |
none |
Boolean flag indicating success status |
» errorMessage |
string |
false |
none |
Text value for errorMessage in TaxCalculationResponse |
» taxDetails |
false |
none |
List of taxDetails items |
|
»» taxAmount |
number |
false |
none |
Amount of tax |
»» taxBaseAmount |
number |
false |
none |
Amount of tax base |
»» totalTaxDocumentAmount |
number |
false |
none |
Amount of total tax document |
»» taxRate |
number |
false |
none |
Rate of tax |
»» taxAccount |
string |
false |
none |
Number of organization items |
»» accountingKey |
string |
false |
none |
Text value for accountingKey in TaxDetail |
»» conditionKey |
string |
false |
none |
Represents the specific condition key associated with a financial entity within the organizational structure, facilitating accurate hierarchy management and reporting. |
»» taxCodeDisplayId |
string |
false |
none |
Unique identifier for the tax code display |
»» taxJurisdictionDisplayId |
string |
false |
none |
Unique identifier for the tax jurisdiction display |
»» taxCodeId |
integer(int64) |
false |
none |
Unique identifier for the tax code |
»» taxJurisdictionId |
integer(int64) |
false |
none |
Unique identifier for the tax jurisdiction |
»» itemNoAcc |
string |
false |
none |
Text value for itemNoAcc in TaxDetail |
Enumerated Values
Attribute |
Value |
|---|---|
systemType |
NAKISA, SAP |
taxCalculationType |
NET |
Calculate Advanced Tax¶
HTTP Request
POST /api/v1/tax-service/calc/advanced
📋 Description: This API is going to calculate Advanced tax and return a List of tax items based on all Available Tax configuration.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing detailed financial entity data, including organizational structure and hierarchy information, for advanced tax calculation. |
Body Parameters
1{
2 "requestUniqueId": "string",
3 "taxCalculationType": "NET",
4 "erpSystem": {
5 "id": 0,
6 "displayId": "string"
7 },
8 "company": {
9 "id": 0,
10 "displayId": "string"
11 },
12 "contractCurrency": {
13 "id": 0,
14 "displayId": "string"
15 },
16 "documentDate": "2019-08-24",
17 "postingDate": "2019-08-24",
18 "transactionDate": "2019-08-24"
19}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "requestUniqueId": "string",
3 "systemType": "NAKISA",
4 "taxCalculationType": "NET",
5 "success": true,
6 "errorMessage": "string",
7 "taxDetails": [
8 {
9 "taxAmount": 0,
10 "taxBaseAmount": 0,
11 "totalTaxDocumentAmount": 0,
12 "taxRate": 0,
13 "taxAccount": "string",
14 "accountingKey": "string",
15 "conditionKey": "string",
16 "taxCodeDisplayId": "string",
17 "taxJurisdictionDisplayId": "string",
18 "taxCodeId": 0,
19 "taxJurisdictionId": 0,
20 "itemNoAcc": "string"
21 }
22 ]
23}
Calculate Advanced Taxes (With Advanced)¶
HTTP Request
POST /api/v1/tax-service/calc/advanced/bulk
📋 Description: This API is going to calculate Fi Services taxes in bulk and return a List of tax items based on all Available Tax configuration.
Note: The Maximum number of requests is 10
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing a bulk array of financial entity data structured according to the organization’s hierarchy for advanced tax calculation. |
Body Parameters
1{
2 "requestUniqueId": "string",
3 "taxCalculationType": "NET",
4 "erpSystem": {
5 "id": 0,
6 "displayId": "string"
7 },
8 "company": {
9 "id": 0,
10 "displayId": "string"
11 },
12 "contractCurrency": {
13 "id": 0,
14 "displayId": "string"
15 },
16 "documentDate": "2019-08-24",
17 "postingDate": "2019-08-24",
18 "transactionDate": "2019-08-24"
19}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "requestUniqueId": "string",
4 "systemType": "NAKISA",
5 "taxCalculationType": "NET",
6 "success": true,
7 "errorMessage": "string",
8 "taxDetails": [
9 {
10 "taxAmount": 0,
11 "taxBaseAmount": 0,
12 "totalTaxDocumentAmount": 0,
13 "taxRate": 0,
14 "taxAccount": "string",
15 "accountingKey": "string",
16 "conditionKey": "string",
17 "taxCodeDisplayId": "string",
18 "taxJurisdictionDisplayId": "string",
19 "taxCodeId": 0,
20 "taxJurisdictionId": 0,
21 "itemNoAcc": "string"
22 }
23 ]
24 }
25]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the outcome of a tax calculation for a financial entity within an organization’s hierarchical structure, providing essential details for compliance and reporting.] |
|
» requestUniqueId |
string |
false |
none |
Unique identifier for the request unique |
» systemType |
string |
false |
none |
Type of the system |
» taxCalculationType |
string |
false |
none |
Type of the tax calculation |
» success |
boolean |
false |
none |
Boolean flag indicating success status |
» errorMessage |
string |
false |
none |
Text value for errorMessage in TaxCalculationResponse |
» taxDetails |
false |
none |
List of taxDetails items |
|
»» taxAmount |
number |
false |
none |
Amount of tax |
»» taxBaseAmount |
number |
false |
none |
Amount of tax base |
»» totalTaxDocumentAmount |
number |
false |
none |
Amount of total tax document |
»» taxRate |
number |
false |
none |
Rate of tax |
»» taxAccount |
string |
false |
none |
Number of organization items |
»» accountingKey |
string |
false |
none |
Text value for accountingKey in TaxDetail |
»» conditionKey |
string |
false |
none |
Represents the specific condition key associated with a financial entity within the organizational structure, facilitating accurate hierarchy management and reporting. |
»» taxCodeDisplayId |
string |
false |
none |
Unique identifier for the tax code display |
»» taxJurisdictionDisplayId |
string |
false |
none |
Unique identifier for the tax jurisdiction display |
»» taxCodeId |
integer(int64) |
false |
none |
Unique identifier for the tax code |
»» taxJurisdictionId |
integer(int64) |
false |
none |
Unique identifier for the tax jurisdiction |
»» itemNoAcc |
string |
false |
none |
Text value for itemNoAcc in TaxDetail |
Enumerated Values
Attribute |
Value |
|---|---|
systemType |
NAKISA, SAP |
taxCalculationType |
NET |