SaveTaxMaster (POST)

  • Overview
  • Request
  • Response
  • Examples
  • Data Elements
Overview

This POST API can be used to capture new additions in Tax Master details from ERP into GEP SMART to be used as reference in P2P transactions.

 

URL Format: https://<Instance>/SmartInterfaceAPI/api/TaxMaster/TaxMasterDetails

Request 
[
   {
      "taxCode": "String",
      "taxType": "String",
      "taxDescription": "String ",
      "taxPercentage": 0,
      "countryCode": "String",
      "stateCode": "String",
      "taxJurisdictions": [
         {
            "jurisdictionCode": "String",
            "jurisdictionName": "String",
            "orgEntities": [
               {
                  "entityCode": " String ",
                  "isDefault": true,
                  "entityType": " String ",
                  "lobEntityCode": " String"
               }
            ],
            "shiptoLocationNumber": [
               "String"
            ]
         }
      ],
      "isDeleted": false
   }
]

 

Response 
{
   "data": null,
   "statusCode": "String",
   "errorDetails": [
      {
         "key": "string",
         "errors": [
            {
               "errorCode": "string",
               "errorDescription": "string"
            }
         ]
      }
   ],
   "successDetails": [
      {
         "key": "String"
      }
   ]
}

 

Examples

Success Scenario - Request
Below request only contains the mandatory attribute(s): 

[
   {
      "taxCode": "City Tax",
      "taxType": "Sales",
      "taxDescription": "City Tax ",
      "taxPercentage": 25,
      "countryCode": "US",
      "taxJurisdictions": [
         {
            "jurisdictionCode": "string",
            "jurisdictionName": "string",
            "orgEntities": [
               {
                  "entityCode": "string",
                  "entityType": "string"
               }
            ],
            "shiptoLocationNumber": [
               ""
            ]
         }
      ]
   }
]

Success Scenario – Response

{
   "data": null,
   "statusCode": "200",
   "errorDetails": [],
   "successDetails": [
      {
         "key": "City Tax"
      }
   ]
}

Error Scenario 1 - Request
Below request contains a missing value of the mandatory attribute – taxCode:

[
   {
      "taxType": "Sales",
      "taxDescription": "City Tax ",
      "taxPercentage": 25,
      "countryCode": "US",
      "taxJurisdictions": [
         {
            "jurisdictionCode": "string",
            "jurisdictionName": "string",
            "orgEntities": [
               {
                  "entityCode": "string",
                  "entityType": "string"
               }
            ],
            "shiptoLocationNumber": [
               ""
            ]
         }
      ]
   }
]

Error Scenario 1 – Response

{
   "data": null,
   "statusCode": "400",
   "errorDetails": [
      {
         "key": "",
         "errors": [
            {
               "errorCode": "MandatoryField",
               "errorDescription": "Missing Tax Code"
            }
         ]
      }
   ],
   "successDetails": []
}

Error Scenario 2 - Request
Below request contains the invalid values of CountryCode and StateCode:

[
   {
      "taxCode": "City Tax",
      "taxType": "Sales",
      "taxDescription": "City Tax ",
      "taxPercentage": 0,
      "countryCode": "US2343",
      "stateCode": "CA2343",
      "taxJurisdictions": [
         {
            "jurisdictionCode": "Sales",
            "jurisdictionName": "Sales",
            "orgEntities": [
               {
                  "entityCode": "Sales",
                  "isDefault": true,
                  "entityType": "Sales",
                  "lobEntityCode": "Sales"
               }
            ],
            "shiptoLocationNumber": [
               ""
            ]
         }
      ],
      "isDeleted": false
   }
]

Error Scenario 2 – Response

{
   "data": null,
   "statusCode": "400",
   "errorDetails": [
      {
         "key": "",
         "errors": [
            {
               "errorCode": "InvalidData",
               "errorDescription": " Invalid Country Code "
            }
         ]
      }
   ],
   "successDetails": []
}

 

Data Elements
 

Save Tax Master

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1

TaxCode

Yes

String(50)

Code of Tax

  • Missing tax code

  • Duplicate tax code

2

TaxType

No

String(50)

Type of Tax

  

3

TaxDescription

No

String(100)

Description of Tax

  

4

TaxPercentage

No

Decimal(36,6)

Percentage of Tax

  

5

CountryCode

No

String(50)

Code of Country

  

6

StateCode

No

String(50)

Code of State

  

7

TaxJurisdictions

No

List of TaxJurisdiction object

    

8

IsDeleted

No

Boolean

Status of Tax master

  
 

TaxJurisdictions

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

7.1

JurisdictionCode

Yes

String(30)

Code of Tax Jurisdiction

  • Missing Tax Jurisdiction Code

7.2

JurisdictionName

No

String(100)

Name of Tax Jurisdiction

  

7.3

OrgEntities

No

List of OrgEntity object

    

7.4

ShiptoLocationNumber

No

List of String

List of Ship to Location numbers

  
 

OrgEntities

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

7.3.1

EntityCode

Yes

String(100)

Code of Org Entity

  • Missing Tax Jurisdiction Org Entity Code for Jurisdiction Code :\"Sales\"

7.3.2

EntityType

Yes

String(200)

Type of Org Entity

  • Missing Tax Jurisdiction Org Entity Type for Jurisdiction Code :\"Sales\"

7.3.3

IsDefault

No

Boolean

Status of the Org Entity if this Org Entity is default or not

  

7.3.4

LobEntityCode

No

String

Code of Line of Business Entity