Get

Gets information of New Hire report records by Submission Id.

GET NewHireReport/Get

Request Body

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission

Response Body

Field	Type	Description
StatusCode	number	Returns the HTTP status codes like 200,300 etc.
StatusName	string	Name of the status code.
StatusMessage	string	Detailed status message.
SubmissionId	Guid	Unique identifier of a submission
NHReports	object[]	Object to create New Hire reports.
Sequence	string	A unique number given by an inbound application to identify failed records.
ReportingToStateCd	string	State code of the New Hire Reporting State
EmployeeCnt	number	Number of Employees for New Hire Reporting
Employer	object	Employer details
BusinessId	Guid	Unique Identifier of the business
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)
Email	string	Email address of the Business
ContactNm	string	Optional Name of the person who can be contacted by the IRS
Phone	string	Contact number of the business with area code
PhoneExtn	string	Optional Extension 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
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. This field is mandatory in W-2 and optional in 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	Employer/Payer's US address (street address or post office box of that locality)
Address2	string	Optional Employer/Payer's suite or apartment
City	string	Employer/Payer's city
State	string	State code of the employer/payer. Refer Static values.
ZipCd	string	Employer/Payer's zip code
ForeignAddress	object	if IsForeign is true, pass foreign address of the business
Address1	string	Employer/Payer's foreign address (street address or post office box of that locality)
Address2	string	Optional Employer/Payer's suite or apartment
City	string	Employer/Payer's city
ProvinceOrStateNm	string	Employer/Payer's province or state name
Country	string	Employer/Payer country code. Refer Static values.
PostalCd	string	Employer/Payer's postal code
Employees	object[]	Object to identify the employee details
Sequence	string	Employee's sequence number.
SSN	string	Employee's Social Security Number (SSN)
FirstNm	string	Employee's First Name
MiddleNm	string	Employee's Middle Name
LastNm	string	Employee's Last Name
Suffix	string	Employee's Suffix.
Email	string	Employee's email address.
Fax	string	Employee's Fax number.
Phone	string	Employee's phone number including area code.
USAddress	object	Object to identify the employee's US address
Address1	string	Employee's US address (street address or post office box of that locality)
Address2	string	Optional Employee's suite or apartment
City	string	Employee's city
State	string	Employee's state code. Refer Static values.
ZipCd	string	Employee's zip code.
StateSpecifics	number	State specified information for New Hire reporting.
DOB	DateTime	Employee's Date of Birth
DtOfRemuneration	DateTime	Employee's Date of Remuneration
EmployeeUId	Guid	Unique Identifier of an Employee
HireType	string	Hire type of an employee. Applicable only for New Hires.
RecordId	Guid	Unique Identifier of a record
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.

Request JSON

"NewHireReport/Get?SubmissionId=31eb9b80-a935-4204-b32c-14db8d99a57e"

Response JSON

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "SubmissionId": "31eb9b80-a935-4204-b32c-14db8d99a57e",
   "NHReports": [
       {
           "Sequence": "1",
           "ReportingToStateCd": "SC",
           "EmployeeCnt": 2,
           "Employer": {
               "BusinessId": "28460b29-61ed-4fe6-857e-304214ce7c8f",
               "BusinessNm": "Eastman Kodak Company",
               "TradeNm": null,
               "IsEIN": true,
               "EINorSSN": "00-3333330",
               "Email": "john@gmail.com",
               "ContactNm": "John",
               "Phone": "1234567890",
               "PhoneExtn": "12345",
               "Fax": "1234567890",
               "BusinessType": null,
               "SigningAuthority": null,
               "KindOfEmployer": null,
               "KindOfPayer": null,
               "IsBusinessTerminated": false,
               "IsForeign": false,
               "USAddress": {
                   "Address1": "1751 Kinsey Rd",
                   "Address2": "Main St",
                   "City": "Dothan",
                   "State": "AL",
                   "ZipCd": "36303"
               },
               "ForeignAddress": null
           },
           "Employees": [
               {
                   "Sequence": "1",
                   "SSN": "393-84-8035",
                   "FirstNm": "John",
                   "MiddleNm": "F",
                   "LastNm": "Kennedy",
                   "Suffix": "Mr",
                   "Email": "john@gmail.com",
                   "Fax": "1234567890",
                   "Phone": "1234567890",
                   "USAddress": {
                       "Address1": "1751 Kinsey Rd",
                       "Address2": "Main St",
                       "City": "Dothan",
                       "State": "AL",
                       "ZipCd": "36303"
                   },
                   "StateSpecifics": {
                       "DOB": "1992-05-10T00:00:00",
                       "DtOfRemuneration": "2019-05-10T10:50:19.427"
                   },
                   "EmployeeUId": "b20c15ce-1ff5-44aa-a470-9876102736e4",
                   "HireType": "NEWHIRE"
               },
               {
                   "Sequence": "2",
                   "SSN": "393-84-8039",
                   "FirstNm": "Fred",
                   "MiddleNm": "F",
                   "LastNm": "Thomas",
                   "Suffix": "Mr",
                   "Email": "john@gmail.com",
                   "Fax": "1234567890",
                   "Phone": "1234567890",
                   "USAddress": {
                       "Address1": "1751 Kinsey Rd",
                       "Address2": "Main St",
                       "City": "Dothan",
                       "State": "AL",
                       "ZipCd": "36303"
                   },
                   "StateSpecifics": {
                       "DOB": "1992-05-10T00:00:00",
                       "DtOfRemuneration": "2019-05-10T10:50:19.427"
                   },
                   "EmployeeUId": "6ee31144-c0db-48da-a82b-f798342e6e58",
                   "HireType": "NEWHIRE"
               }
           ],
           "RecordId": "2ffde35c-c885-45c6-ab48-424a89c838ed"
       }
   ],
   "Errors": null
}