Business

DELETE Business/Delete

Request (URI)

Name Type Description Condition
BusinessId globally unique identifier

Required

EIN string

isForceDelete boolean

Default value is False

Response

Name Type Description
BusinessId globally unique identifier

Unique Business Identifier

Errors Collection of Error

It will show the detailed information about the error.

StatusCode integer

It will return the status codes like 200, 300, etc., Refer Status Codes.

StatusName string

It will return the name of status code.

StatusMessage string

It will return the detailed message of status code.

Response Formats

application/json, text/json

Sample:
{
  "StatusCode": 200,
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "BusinessId": "cbccdfde-4a1a-492b-91da-89375c6c64b7",
  "Errors": [
    {
      "Code": "404",
      "SeqId": "1",
      "Name": "NotFound",
      "UserMessage": "Record not found",
      "APIMessage": "Record not found",
      "Type": "Error"
    },
    {
      "Code": "404",
      "SeqId": "1",
      "Name": "NotFound",
      "UserMessage": "Record not found",
      "APIMessage": "Record not found",
      "Type": "Error"
    }
  ]
}

Business

DELETE Business/Delete

Request (URI)

Name Type Description Condition
BusinessId globally unique identifier

Required

EIN string

isForceDelete boolean

Default value is False

Response

Name Type Description
BusinessId globally unique identifier

Unique Business Identifier

Errors Collection of Error

It will show the detailed information about the error.

StatusCode integer

It will return the status codes like 200, 300, etc., Refer Status Codes.

StatusName string

It will return the name of status code.

StatusMessage string

It will return the detailed message of status code.

Response Formats

application/json, text/json

Sample:
{
  "StatusCode": 200,
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "BusinessId": "cbccdfde-4a1a-492b-91da-89375c6c64b7",
  "Errors": [
    {
      "Code": "404",
      "SeqId": "1",
      "Name": "NotFound",
      "UserMessage": "Record not found",
      "APIMessage": "Record not found",
      "Type": "Error"
    },
    {
      "Code": "404",
      "SeqId": "1",
      "Name": "NotFound",
      "UserMessage": "Record not found",
      "APIMessage": "Record not found",
      "Type": "Error"
    }
  ]
}