Skip to main content
Version: 1.7.0

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

FieldTypeDescription
PageintSelected page number to be listed.
PageSizeintNumber of businesses to be listed in each page.
FromDatestringList Businesses created from
ToDatestringList Businesses created upto

Response Body

FieldTypeDescription
StatusCodenumberReturns the status codes like 200,300 etc.
StatusNamestringName of the status code.
StatusMessagestringDetailed status message
Businessobject[]Business Details of all the business
    BusinessIdGuidBusiness Identifier (Autogenerated)
    PayerRefstringUnique identifier of the payer. Set by the client.
    BusinessNmstringName of the Business.
    EINorSSNstringEmployer Identification Number or Social Security Number
    EmailstringOptional Employer's email address.
    ContactNmstringOptional Name of a person who could be contacted by the IRS if needed.
    BusinessTypestringType of business entity.
    IsBusinessTerminatedBooleanWhen true, identifies the business as terminated.
PagenumberRequested Page Number.
TotalRecordsnumberTotal number of records returned in the response.
TotalPagesnumberNumber of pages with the records.
PageSizenumberRequested 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}