List

Use this method to list all the businesses created by Employer/Payer based on a date range. In the Request JSON, provide the From and To date. Also, specify the page size(Number of businesses to be listed on each page).

GET Business/List

Request Body

Field	Type	Description
Page	int	Selected page number to be listed.
PageSize	int	Number of businesses to be listed in each page.
FromDate	string	List Businesses created from
ToDate	string	List Businesses created upto

Response Body

Field	Type	Description
StatusCode	number	Returns the status codes like 200,300 etc.
StatusName	string	Name of the status code.
StatusMessage	string	Detailed status message
Business	object[]	Business Details of all the business
BusinessId	Guid	Business Identifier (Autogenerated)
PayerRef	string	Unique identifier of the payer. Set by the client.
BusinessNm	string	Name of the Business.
EINorSSN	string	Employer Identification Number or Social Security Number
Email	string	Optional Employer's email address.
ContactNm	string	Optional Name of a person who could be contacted by the IRS if needed.
BusinessType	string	Type of business entity.
IsBusinessTerminated	Boolean	When true, identifies the business as terminated.
Page	number	Requested Page Number.
TotalRecords	number	Total number of records returned in the response.
TotalPages	number	Number of pages with the records.
PageSize	number	Requested Page Size.

Request JSON: List all the businesses created between the specified date range based on the page size.

"Business/List?Page=1&PageSize=10&FromDate=08/01/2019&ToDate=08/02/2019"

Response JSON: Response will display all the businesses created between FROM and TO date along with the Page size.

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"Businesses": [
  {
    "BusinessId": "17e1efa1-37b8-4ace-89e9-877fe749b64e",
    "PayerRef": "B123",
    "BusinessNm": "Eastman Kodak Company",
    "EINorSSN": "00-3313330",
    "Email": "john@gmail.com",
    "ContactNm": "John",
    "BusinessType": "ESTE",
    "IsBusinessTerminated": false
  },
  {
    "BusinessId": "5b0aedcc-96f5-44ea-8643-c1fd1515398c",
    "PayerRef": "B124",
    "BusinessNm": "Ante Solutions",
    "EINorSSN": "12-1222877",
    "Email": "smith@gmail.com",
    "ContactNm": "Smith",
    "BusinessType": "PART",
    "IsBusinessTerminated": false
  },
  {
    "BusinessId": "c71a0eab-93a3-4df4-b67d-c2f33a9851c3",
    "PayerRef": "B126",
    "BusinessNm": "FloriTech Solutions",
    "EINorSSN": "15-4023615",
    "Email": "charleskenny@gmail.com",
    "ContactNm": "Charles Kennedy",
    "BusinessType": "CORP",
    "IsBusinessTerminated": false
  }
],
"Page": 1,
"TotalRecords": 3,
"TotalPages": 1,
"PageSize": 10
}