SureTax Config API

PUT LegalEntities

OVERVIEWREQUESTRESPONSETRY IT OUT

Overview

The PUT LegalEntities API endpoint facilitates the process of modifying a legal entity.

OperationId: PUT LegalEntities

Authorization Method(s): OAuth

Verb: PUT

End Point: /api/v1/Account/LegalEntities/{entitycode}

Request Body

OVERVIEWEXAMPLE

Request Model

Display Name	Field Name	Field Type
Entity Name *	entityName	string
Is Active	isActive	bool
Fein *	fein	string
Website	website	string
Notification Business Email *	notificationBusinessEmail	string
Entity Description *	entityDescription	string
Entity Address *	entityAddress	entityAddress
Contact Numbers *	contactNumbers	array[contactNumber]
Contact Persons *	contactPersons	array[contactPerson]

entityAddress

Display Name	Field Name	Field Type
Address1 *	address1	string
Address2	address2	string
City *	city	string
State *	state	string
Country *	country	string
Zipcode *	zipcode	string
Plus4	plus4	string

contactNumber

Display Name	Field Name	Field Type
Contact Number Type *	contactNumberType	string
Contact Phone Number *	contactPhoneNumber	string

contactPerson

Display Name	Field Name	Field Type
Person Type *	personType	string
Person Name *	personName	string
Email Address *	emailAddress	string

Example Request

The following is an json request for this operation.

{
  "entityName": "testentity",
  "isActive": true,
  "contactNumbers": [
    {
      "contactNumberType": "BusinessOther2",
      "contactPhonenumber": "8148128234"
    }
  ],
  "entityAddress": {
    "address1": "address1",
    "address2": "string",
    "city": "city",
    "state": "TX",
    "country": "US",
    "zipcode": "12345",
    "plus4": "1234"
  },
  "contactPersons": [
    {
      "personType": "Primary",
      "personName": "testname",
      "emailAddress": "test@test.com"
    }
  ],
  "fein": "1234567890",
  "website": "www.test.com",
  "notificationBusinessEmail": "business@wk.com",
  "entityDescription": "entity description"
}

*Mandatory parameter

Response Codes

Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.

code	description
200	Successful API response.
400	Bad request. Invalid parameters or missing required information.
401	Unauthorized access. The request requires user authentication.
500	Internal server error. An error occurred while processing the request.

To execute a web service call for API Key Enabled APIs, Select an environment and enter the client number and validation api key corresponding to that environment.

Select Environment:End Point:

/api/v1/Account/LegalEntities/{entitycode}

Add Request Headers:

{
  "entityName": "testentity",
  "isActive": true,
  "contactNumbers": [
    {
      "contactNumberType": "BusinessOther2",
      "contactPhonenumber": "8148128234"
    }
  ],
  "entityAddress": {
    "address1": "address1",
    "address2": "string",
    "city": "city",
    "state": "TX",
    "country": "US",
    "zipcode": "12345",
    "plus4": "1234"
  },
  "contactPersons": [
    {
      "personType": "Primary",
      "personName": "testname",
      "emailAddress": "test@test.com"
    }
  ],
  "fein": "1234567890",
  "website": "www.test.com",
  "notificationBusinessEmail": "business@wk.com",
  "entityDescription": "entity description"
}