Get
This method will return the Business information based on the given parameters. In Request JSON, using the Get method, supply the BusinessID or EIN or PayerRef.
The response will have the Business Information such as the BusinessName, Address, Contact details along with its status message.
GET Business/Get
Request Params
Field | Type | Description |
---|---|---|
BusinessId | string | Unique Identifier of the business. |
TIN | string | Taxpayer Identification Number of business. |
PayerRef | string | Optional Unique identifier of the payer. Set by the client in the endpoint Business/RequestByUrl. |
Request Params
Get the Business data of an Employer/Payer using BusinessID along with TIN and PayerRef.
"Business/Get?BusinessId=7289099A-E20F-4271-AB29-06865CECCB03&TIN=12-3456767&PayerRef=B123"
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 |
BusinessId | Guid | Unique Identifier of the business. |
PayerRef | string | Unique identifier of the payer. Set by the client. |
BusinessNm | string | Name of the business |
TradeNm | string | Optional Name under which the business operates |
IsEIN | Boolean | When true, identifies the business with an EIN. |
EINorSSN | string | When IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN) |
string | Optional Email address of the Business | |
ContactNm | string | Optional Name of the person who can be contacted by the IRS |
Phone | string | Optional Contact number of the business with area code |
PhoneExtn | string | Optional Extension number of the business phone number |
Fax | string | Optional Fax number of the Business |
BusinessType | string | Type of business. Optional for W-2/1099 and mandatory for 94X series |
SigningAuthority | object | Details of the person who is authorized to sign the return. |
Name | string | Optional Name of the signing authority. |
Phone | string | Optional Phone number of the authorized signatory. |
BusinessMemberType | string | Optional Business title of the authorized signatory. |
KindOfEmployer | string | Identifies the kind of employer. Mandatory for W-2 and optional for 1099-MISC and 94X series |
KindOfPayer | string | Identifies the kind of payer. Mandatory for W-2 and optional for 1099-MISC and 94X series |
IsBusinessTerminated | Boolean | When true, identifies the business as terminated. |
IsForeign | Boolean | When true, identifies the business address with a foreign address. |
USAddress | object | if IsForeign is false, pass US address of the business |
Address1 | string | Address of the Employer/Payer (street address or post office box of that locality) |
Address2 | string | Optional Suite or apartment number of the Employer/Payer. |
City | string | City where the Employer/Payer is based out of |
State | string | Name of the state where the Employer/Payer is based out of |
ZipCd | string | Zip Code the State where the Employer/Payer is based out of. Size Range: 5..10 |
ForeignAddress | object | if IsForeign is true, pass foreign address of the business. |
Address1 | string | Address of the Employer/Payer (street address or post office box of that locality) |
Address2 | string | Optional Suite or apartment number of the Employer/Payer. |
City | string | City where the Employer/Payer is based out of |
ProvinceOrStateNm | string | Name of the province or state where the Employer/Payer is based out of. |
Country | string | Country of the Employer/Payer. |
PostalCd | string | Postal Code the State where the Employer/Payer is based out of |
Errors | object[] | Shows detailed error information. |
Code | string | Returns the validation error code. |
Name | string | Name of the validation error. |
Message | string | Description of the validation error. |
Type | string | Type of validation error. |
Response JSON
The response will have the completed Business information for the given PayerRef corresponding to the BusinessId and TIN.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"Business": {
"BusinessId": "17e1efa1-37b8-4ace-89e9-877fe749b64e",
"PayerRef": "B123",
"BusinessNm": "Eastman Kodak Company",
"TradeNm": "Kodak",
"IsEIN": true,
"EINorSSN": "003313330",
"Email": "sample@bodeem.com",
"ContactNm": "John",
"Phone": "1234567890",
"PhoneExtn": "12345",
"Fax": "(123) 456-7890",
"BusinessType": "ESTE",
"SigningAuthority": {
"Name": "John",
"Phone": "1234567890",
"BusinessMemberType": "ADMINISTRATOR"
},
"KindOfEmployer": "FEDERALGOVT",
"KindOfPayer": "REGULAR941",
"IsBusinessTerminated": false,
"IsForeign": true,
"USAddress": {
"Address1": null,
"Address2": null,
"City": null,
"State": null,
"ZipCd": null
},
"ForeignAddress": {
"Address1": "22 St",
"Address2": "Clair Ave E",
"City": "Toronto",
"ProvinceOrStateNm": " Ontario",
"Country": "CA",
"PostalCd": "M1R 0E9"
}
},
"Errors": null
}