TaxBandits API

# NewHireReport

# Create

Creates New Hire reports with an unique Submission Id which is further used for all other methods referencing these New Hire reports.

POST NewHireReport/Create
1

Request Body

Field Type Description
NHReports object[] Object to create New Hire reports.
    Sequence string A unique number given by an inbound application to identify failed records.
Size Range: ..60
    ReportingToStateCd string State code of the New Hire Reporting State
Size Range: 2
    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
Size Range: ..75
        TradeNm string Optional Name under which the business operates
Size Range: ..75
        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)
Size Range: 9
        Email string Email address of the Business
Size Range: ..40
        ContactNm string Optional Name of the person who can be contacted by the IRS
Size Range: ..27
        Phone string Contact number of the business with area code
Size Range: 10
        PhoneExtn string Optional Extension of the business phone number
Size Range: ..5
        Fax string Optional Fax number of the Business
Size Range: 10
        BusinessType string Type of business. Optional for W-2/1099 and mandatory for 94X series
Size Range: ..4
Allowed values: "ESTE", "PART", "CORP", "EORG", "SPRO"
        KindOfEmployer string Identifies the kind of employer. Mandatory for W-2 and optional for 1099-MISC and 94X series.
Allowed values: "FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY"
        KindOfPayer string Identifies the kind of payer. This field is mandatory in W-2 and optional in 1099-MISC and 94X series.
Allowed values: "REGULAR941", "REGULAR944", "AGRICULTURAL943", "HOUSEHOLD", "MILITARY", "MEDICAREQUALGOVEM", "RAILROADFORMCT1"
        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)
Size Range: ..35
            Address2 string Optional Employer/Payer's suite or apartment
Size Range: ..35
            City string Employer/Payer's city
Size Range: ..27
            State string State code of the employer/payer. Refer Static values.
Size Range: 2
Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
            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)
Size Range: ..35
            Address2 string Optional Employer/Payer's suite or apartment
Size Range: ..35
            City string Employer/Payer's city
Size Range: ..27
            ProvinceOrStateNm string Employer/Payer's province or state name
Size Range: ..30
                Country string Employer/Payer country code. Refer Static values.
Size Range: 2
Allowed values: "US", "CA", "MX", "AF", "AX", "XI", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "XA", "AT", "AS", "AU", "AJ", "XZ", "BF", "BA", "FQ", "BG", "BB", "BS", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "XY", "CV", "CJ", "CT", "CD", "XC", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "VP", "CS", "IV", "HR", "CU", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "UK", "EK", "ER", "EN", "ET", "EU", "FK", "FO", "FM", "FJ", "FI", "FR", "FG", "FP", "FS", "GB", "GA", "GZ", "GG", "GM", "GH", "GI", "GO", "GR", "GL", "GJ", "GP", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "JU", "KZ", "KE", "KQ", "KR", "KN", "KS", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MB", "MR", "MP", "MF", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "XM", "WA", "NR", "BQ", "NP", "NL", "NT", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "XN", "CQ", "NO", "MU", "OC", "PK", "LQ", "PS", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RE", "RO", "RS", "RW", "WS", "SM", "TP", "SA", "XS", "SG", "RI", "SE", "SL", "SN", "XR", "LO", "SI", "BP", "SO", "SF", "SX", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "XT", "TE", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UY", "UZ", "NH", "VT", "VE", "VM", "VQ", "WQ", "XW", "WF", "WE", "WI", "YM", "YI", "ZA", "ZI"
            PostalCd string Employer/Payer's postal code
    Employees object[] Object to identify the employee details
        Sequence string Employee's sequence number.
Size Range: ..60
        SSN string Employee's Social Security Number (SSN)
Size Range: 9
        FirstNm string Employee's First Name
Size Range: ..15
        MiddleNm string Employee's Middle Name
Size Range: ..15
        LastNm string Employee's Last Name
Size Range: ..20
        Suffix string Employee's Suffix.
Size Range: ..3
        Email string Employee's email address.
Size Range: ..40
        Fax string Employee's Fax number.
Size Range: 10
        Phone string Employee's phone number including area code.
Size Range: 10
        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)
Size Range: ..35
            Address2 string Optional Employee's suite or apartment
Size Range: ..35
            City string Employee's city
Size Range: ..27
            State string Employee's state code. Refer Static values.
Size Range: 2
Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
            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

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 Pulls the New Hire report records with Success and Error statuses
    SuccessRecords object[] It will show the detailed information about the success status of New Hire Report Records
        Sequence string A unique number given by an inbound application to identify failed records.
        RecordId guid Unique identifier of a record
        RecordStatus string Returns the status of the records.
        EmployeeRecords string Return status details like Created, Transmitted, Accepted, Rejected.
            Sequence string A unique number given by an inbound application to identify failed records.
            EmployeeUId guid Unique identifier of an Employee
            Status string Returns the status of the Employee details.
        CreatedTs DateTime Date and time of return created.
        UpdatedTs DateTime Date and time of return updated.
    ErrorRecords object[] It will show the detailed information about the error status of New Hire Report Records
        Sequence string A unique number given by an inbound application to identify failed records.
        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.
        EmployeeErrorRecords object[] Return status details like Created, Transmitted, Accepted, Rejected.
            Sequence string A unique number given by an inbound application to identify failed records
            EmployeeUId guid Client Record Identifier
            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.
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

{
   "NHReports": [
       {
           "Sequence": "1",
           "ReportingToStateCd": "SC",
           "EmployeeCnt": 2,
           "Employer": {
               "BusinessId": null,
               "BusinessNm": "Eastman Kodak Company",
               "TradeNm": "Kodak",
               "IsEIN": true,
               "EINorSSN": "003333330",
               "Email": "john@gmail.com",
               "ContactNm": "John",
               "Phone": "1234567890",
               "PhoneExtn": "12345",
               "Fax": "1234567890",
               "BusinessType": "ESTE",
               "SigningAuthority": {
                   "Name": "John",
                   "Phone": "1234567890",
                   "BusinessMemberType": "ADMINISTRATOR"
               },
               "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": "393848035",
                   "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-10T10:50:19.4269819-04:00",
                       "DtOfRemuneration": "2019-05-10T10:50:19.4269819-04:00"
                   },
                   "EmployeeUId": null,
                   "HireType": "NEWHIRE"
               },
               {
                   "Sequence": "2",
                   "SSN": "393848039",
                   "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-10T10:50:19.4269819-04:00",
                       "DtOfRemuneration": "2019-05-10T10:50:19.4269819-04:00"
                   },
                   "EmployeeUId": null,
                   "HireType": "NEWHIRE"
               }
           ],
           "RecordId": null
       }
   ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

Response JSON

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "SubmissionId": "31eb9b80-a935-4204-b32c-14db8d99a57e",
   "NHReports": {
       "SuccessRecords": [
           {
               "Sequence": "1",
               "RecordId": "2ffde35c-c885-45c6-ab48-424a89c838ed",
               "RecordStatus": "Created",
               "EmployeeRecords": [
                   {
                       "Sequence": "1",
                       "EmployeeUId": "b20c15ce-1ff5-44aa-a470-9876102736e4",
                       "Status": "Created"
                   },
                   {
                       "Sequence": "2",
                       "EmployeeUId": "6ee31144-c0db-48da-a82b-f798342e6e58",
                       "Status": "Created"
                   }
               ],
               "CreatedTs": "2019-08-02 08:36:04 -04:00",
               "UpdatedTs": "2019-08-02 08:36:04 -04:00"
           }
       ],
       "ErrorRecords": null
   },
   "Errors": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

# Delete

Deletes New Hire report records by Submission Id and Record Ids.

DELETE NewHireReport/Delete
1

Request Body

Field Type Description
SubmissionId guid Unique identifier of a submission
RecordIds string List of record Ids to be deleted.

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 Pulls the New Hire report records with Success and Error statuses.
    SuccessRecords object[] It will show the detailed information about the success status of New Hire Report Records.
        Sequence string A unique number given by an inbound application to identify failed records.
        RecordId guid Unique identifier of a record.
        RecordStatus string Returns the status of the records.
        EmployeeRecords string Return status details like Created, Transmitted, Accepted, Rejected.
            Sequence string A unique number given by an inbound application to identify failed records.
            EmployeeUId guid Unique identifier of an Employee.
            Status string Returns the status of the Employee details.
        CreatedTs DateTime Date and time of return created.
        UpdatedTs DateTime Date and time of return updated.
    ErrorRecords object[] It will show the detailed information about the error status of New Hire Report Records.
        Sequence string A unique number given by an inbound application to identify failed records.
        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.
        EmployeeErrorRecords object[] Return status details like Created, Transmitted, Accepted, Rejected.
            Sequence string A unique number given by an inbound application to identify failed records.
            EmployeeUId guid Client Record Identifier.
            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.
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/Delete?SubmissionId=1d87b4c6-284c-4a66-bb37-ec41d73e5d6c&RecordIds=d0cbbc56-ba8d-4457-b938-a2bedde75daf
1

Response JSON

{
 "StatusCode": 200,
 "StatusName": "Ok",
 "StatusMessage": "Successful API call",
 "SubmissionId": "1d87b4c6-284c-4a66-bb37-ec41d73e5d6c",
 "NHReports": {
   "SuccessRecords": [
     {
       "Sequence": "1",
       "RecordId": "d0cbbc56-ba8d-4457-b938-a2bedde75daf",
       "RecordStatus": "DELETED",
       "EmployeeRecords": [
         {
           "Sequence": "1",
           "EmployeeUId": "3b1ab99c-f358-490b-ae3d-3167ab035b16",
           "Status": "Success"
         }
       ],
       "CreatedTs": "7/26/2019 9:16:48 AM",
       "UpdatedTs": "7/26/2019 9:31:21 AM"
     }
   ],
   "ErrorRecords": null
 },
 "Errors": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

# Get

Gets information of New Hire report records by Submission Id.

GET NewHireReport/Get
1

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"
1

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
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

# GetPDF

Request a PDF download of New Hire report to be made available through Webhooks

GET NewHireReport/GetPDF
1

Request Body

Field Type Description
SubmissionId guid Unique identifier of a submission
RecordIds guid[] List of record Ids to be downloaded.

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.
NHReportPdf byte[] Byte array of New Hire report pdf
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

{
   "SubmissionId": "31eb9b80-a935-4204-b32c-14db8d99a57e",
   "RecordIds": [
       "2ffde35c-c885-45c6-ab48-424a89c838ed"
      
   ]
}
1
2
3
4
5
6
7

Response JSON

{
 "StatusCode": 200,
 "StatusName": "Ok",
 "StatusMessage": "Successful API call",
 "SubmissionId": "f1ed3955-1b64-408c-a730-9008a192db3f",
 "NHReportPdf": "QEA=",
 "Errors": null
}
1
2
3
4
5
6
7
8

# Status

Gets the status of the New Hire report records by Submission Id and Record Ids.

GET NewHireReport/Status
1

Request Body

Field Type Description
SubmissionId guid Unique identifier of a submission
RecordIds guid[] List of record Ids to get status.

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 Pulls the New Hire report records with Success and Error statuses.
    SuccessRecords object[] It will show the detailed information about the success status of New Hire Report Records.
        Sequence string A unique number given by an inbound application to identify failed records.
        RecordId guid Unique identifier of a record.
        RecordStatus string Returns the status of the records.
        CreatedTs DateTime Date and time of return created.
        UpdatedTs DateTime Date and time of return updated.
    ErrorRecords object[] It will show the detailed information about the error status of New Hire Report Records.
        Sequence string A unique number given by an inbound application to identify failed records.
        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

{
   "SubmissionId": "f1ed3955-1b64-408c-a730-9008a192db3f",
   "RecordIds": [
       "1ea1e55c-7175-4539-882b-f856edab1b69"
  
   ]
}
1
2
3
4
5
6
7

Response JSON

{
 "StatusCode": 200,
 "StatusName": "Ok",
 "StatusMessage": "Successful API call",
 "SubmissionId": "f1ed3955-1b64-408c-a730-9008a192db3f",
 "NHReports": {
   "SuccessRecords": [
     {
       "Sequence": "1",
       "RecordId": "1ea1e55c-7175-4539-882b-f856edab1b69",
       "RecordStatus": "Transmitted",
       "CreatedTs": "2019-07-26 07:51:16 -04:00",
       "UpdatedTs": "2019-07-26 08:14:11 -04:00"
     }
   ],
   "ErrorRecords": null
 },
 "Errors": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# Transmit

Transmits New Hire report records to the State after validation.

POST NewHireReport/Transmit
1

Request Body

Field Type Description
SubmissionId guid Unique identifier of a submission
RecordIds guid[] List of record Ids to be transmitted.

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 Pulls the New Hire report records with Success and Error statuses.
    SuccessRecords object[] It will show the detailed information about the success status of New Hire Report Records.
        Sequence string A unique number given by an inbound application to identify failed records.
        RecordId guid Unique identifier of a record.
        RecordStatus string Returns the status of the records.
        EmployeeRecords string Return status details like Created, Transmitted, Accepted, Rejected.
            Sequence string A unique number given by an inbound application to identify failed records.
            EmployeeUId guid Unique identifier of an Employee.
            Status string Returns the status of the Employee details.
        CreatedTs DateTime Date and time of return created.
        UpdatedTs DateTime Date and time of return updated.
    ErrorRecords object[] It will show the detailed information about the error status of New Hire Report Records.
        Sequence string A unique number given by an inbound application to identify failed records.
        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.
        EmployeeErrorRecords object[] Return status details like Created, Transmitted, Accepted, Rejected.
            Sequence string A unique number given by an inbound application to identify failed records.
            EmployeeUId guid Client Record Identifier.
            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.
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

{
   "SubmissionId": "31eb9b80-a935-4204-b32c-14db8d99a57e",
   "RecordIds": [
       "2ffde35c-c885-45c6-ab48-424a89c838ed"       
   ]
}
1
2
3
4
5
6

Response JSON

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "SubmissionId": "31eb9b80-a935-4204-b32c-14db8d99a57e",
   "NHReports": {
       "SuccessRecords": [
           {
               "Sequence": "1",
               "RecordId": "2ffde35c-c885-45c6-ab48-424a89c838ed",
               "RecordStatus": "TRANSMITTED",
               "EmployeeRecords": [
                   {
                       "Sequence": "1",
                       "EmployeeUId": "b20c15ce-1ff5-44aa-a470-9876102736e4",
                       "Status": "TRANSMITTED"
                   },
                   {
                       "Sequence": "2",
                       "EmployeeUId": "6ee31144-c0db-48da-a82b-f798342e6e58",
                       "Status": "TRANSMITTED"
                   }
               ],
               "CreatedTs": "8/2/2019 8:36:04 AM",
               "UpdatedTs": "8/2/2019 9:38:24 AM"
           }
       ],
       "ErrorRecords": null
   },
   "Errors": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

# Update

Updates information of New Hire report records by Submission Id and Record Id.

PUT NewHireReport/Update
1

Request Body

Field Type Description
SubmissionId guid Unique identifier of a submission
NHReports object[] Object to update New Hire reports.
    RecordId guid Unique Identifier of a record
    Sequence string A unique number given by an inbound application to identify failed records.
Size Range: ..60
    ReportingToStateCd string State code of the New Hire Reporting State
Size Range: 2
    Employer object Employer details
        BusinessId guid Unique Identifier of the business
        BusinessNm string Name of the business
Size Range: ..75
        TradeNm string Optional Name under which the business operates
Size Range: ..75
        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)
Size Range: 9
        Email string Email address of the Business
Size Range: ..40
        ContactNm string Optional Name of the person who can be contacted by the IRS
Size Range: ..27
        Phone string Contact number of the business with area code
Size Range: 10
        PhoneExtn string Optional Extension of the business phone number
Size Range: ..5
        Fax string Optional Fax number of the Business
Size Range: 10
        BusinessType string Type of business. Optional for W-2/1099 and mandatory for 94X series
Size Range: ..4
Allowed values: "ESTE", "PART", "CORP", "EORG", "SPRO"
        KindOfEmployer string Identifies the kind of employer. Mandatory for W-2 and optional for 1099-MISC and 94X series.
Allowed values: "FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY"
        KindOfPayer string Identifies the kind of payer. This field is mandatory in W-2 and optional in 1099-MISC and 94X series.
Allowed values: "REGULAR941", "REGULAR944", "AGRICULTURAL943", "HOUSEHOLD", "MILITARY", "MEDICAREQUALGOVEM", "RAILROADFORMCT1"
        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)
Size Range: ..35
            Address2 string Optional Employer/Payer's suite or apartment
Size Range: ..35
            City string Employer/Payer's city
Size Range: ..27
            State string State code of the employer/payer. Refer Static values.
Size Range: 2
Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
            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)
Size Range: ..35
            Address2 string Optional Employer/Payer's suite or apartment
Size Range: ..35
            City string Employer/Payer's city
Size Range: ..27
            ProvinceOrStateNm string Employer/Payer's province or state name
Size Range: ..30
                Country string Employer/Payer country code. Refer Static values.
Size Range: 2
Allowed values: "US", "CA", "MX", "AF", "AX", "XI", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "XA", "AT", "AS", "AU", "AJ", "XZ", "BF", "BA", "FQ", "BG", "BB", "BS", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "XY", "CV", "CJ", "CT", "CD", "XC", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "VP", "CS", "IV", "HR", "CU", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "UK", "EK", "ER", "EN", "ET", "EU", "FK", "FO", "FM", "FJ", "FI", "FR", "FG", "FP", "FS", "GB", "GA", "GZ", "GG", "GM", "GH", "GI", "GO", "GR", "GL", "GJ", "GP", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "JU", "KZ", "KE", "KQ", "KR", "KN", "KS", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MB", "MR", "MP", "MF", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "XM", "WA", "NR", "BQ", "NP", "NL", "NT", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "XN", "CQ", "NO", "MU", "OC", "PK", "LQ", "PS", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RE", "RO", "RS", "RW", "WS", "SM", "TP", "SA", "XS", "SG", "RI", "SE", "SL", "SN", "XR", "LO", "SI", "BP", "SO", "SF", "SX", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "XT", "TE", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UY", "UZ", "NH", "VT", "VE", "VM", "VQ", "WQ", "XW", "WF", "WE", "WI", "YM", "YI", "ZA", "ZI"
            PostalCd string Employer/Payer's postal code
    AddEmployees object[] Employee details
        Sequence string Employee sequence number.
Size Range: ..60
        SSN string Social Security Number (SSN).
Size Range: ..9
        FirstNm string Employee's First Name
Size Range: ..15
        MiddleNm string Employee's Middle Name
Size Range: ..15
        LastNm string Employee's Last Name
Size Range: ..20
        Suffix string Employee's Suffix.
Size Range: ..3
        Email string Employee's email address.
Size Range: ..40
        Fax string Employee's Fax number, if applicable.
Size Range: 10
        Phone string Employee's phone number including area code.
Size Range: 10
        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)
Size Range: ..35
            Address2 string Optional Employee's suite or apartment
Size Range: ..35
            City string Employer/Payer city.
Size Range: ..27
            State string State code of the employer/payer. Refer Static values.
Size Range: 2
Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
            ZipCd string Employer/Payer 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.
    UpdateEmployees object[] Employee details
        Sequence string Employer sequence number.
Size Range: ..60
        SSN string Social Security Number (SSN).
Size Range: ..9
        FirstNm string Employee's First Name
Size Range: ..15
        MiddleNm string Employee's Middle Name
Size Range: ..15
        LastNm string Employee's Last Name
Size Range: ..20
        Suffix string Employee's Suffix.
Size Range: ..3
        Email string Employee's email address.
Size Range: ..40
        Fax string Employee's Fax number, if applicable.
Size Range: 10
        Phone string Employee's phone number including area code.
Size Range: 10
        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).
Size Range: ..35
            Address2 string Optional The suite, apartment, number of the employer/payer, if applicable.
Size Range: ..35
            City string Employer/Payer city.
Size Range: ..27
            State string State code of the employer/payer. Refer Static values.
Size Range: 2
Allowed values: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
            ZipCd string Employer/Payer 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.
    DeleteEmployees guid[] Employee's Unique Identifier

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 Pulls the New Hire report records with Success and Error statuses.
    SuccessRecords object[] It will show the detailed information about the success status of New Hire Report Records.
        Sequence string A unique number given by an inbound application to identify failed records.
        RecordId guid Unique identifier of a record.
        RecordStatus string Returns the status of the records.
        EmployeeRecords string Return status details like Created, Transmitted, Accepted, Rejected.
            Sequence string A unique number given by an inbound application to identify failed records.
            EmployeeUId guid Unique identifier of an Employee.
            Status string Returns the status of the Employee details.
        CreatedTs DateTime Date and time of return created.
        UpdatedTs DateTime Date and time of return updated.
    ErrorRecords object[] It will show the detailed information about the error status of New Hire Report Records.
        Sequence string A unique number given by an inbound application to identify failed records.
        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.
        EmployeeErrorRecords object[] Return status details like Created, Transmitted, Accepted, Rejected.
            Sequence string A unique number given by an inbound application to identify failed records.
            EmployeeUId guid Client Record Identifier.
            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.
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

{
 "NHReports": [
   {
     "RecordId": "53a64158-6333-44ef-8e26-1cd20ba79f78",
     "Sequence": null,
     "ReportingToStateCd": "SC",
     "Employer": {
       "BusinessId": null,
       "BusinessNm": "Eastman Kodak Company",
       "TradeNm": null,
       "IsEIN": true,
       "EINorSSN": "003333333",
       "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": {
         "Address1": null,
         "Address2": null,
         "City": null,
         "ProvinceOrStateNm": null,
         "Country": null,
         "PostalCd": null
       }
     },
     "AddEmployees": [
       {
         "Sequence": "3",
         "SSN": "393848038",
         "FirstNm": "John",
         "MiddleNm": "F",
         "LastNm": "Kennedy",
         "Suffix": "Sr",
         "Email": "john@gmail.com",
         "Fax": "1234567890",
         "Phone": "1234567890",
         "USAddress": {
           "Address1": "1751 Kinsey Rd",
           "Address2": "Main St",
           "City": "Dothan",
           "State": "AL",
           "ZipCd": "36303"
         },
         "StateSpecifics": {
           "DOB": "1990-07-01T00:00:00",
           "DtOfRemuneration": "2019-08-01T00:00:00"
         },
         "EmployeeUId": null,
         "HireType": "NEWHIRE"
       }
     ],
     "UpdateEmployees": [
       {
         "Sequence": "1",
         "SSN": "393848035",
         "FirstNm": "John",
         "MiddleNm": "F",
         "LastNm": "Kennedy",
         "Suffix": "Jr",
         "Email": "john@gmail.com",
         "Fax": "1234567899",
         "Phone": "1234567899",
         "USAddress": {
           "Address1": "12 main st",
           "Address2": null,
           "City": "Rock HIll",
           "State": "SC",
           "ZipCd": "29730"
         },
         "StateSpecifics": {
           "DOB": "1991-07-31T00:00:00",
           "DtOfRemuneration": "2019-07-10T00:00:00"
         },
         "EmployeeUId": "bc88cd09-f537-4395-b54f-ccee2d4d6997",
         "HireType": "NEWHIRE"
       }
     ],
     "DeleteEmployees": [
       "44fd0c52-0216-4731-b088-f8faa84e0de5"
     ]
   }
 ],
 "SubmissionId": "931f8057-fe2e-4dcd-babd-5527ef098a6c"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

Response JSON

{
 "StatusCode": 200,
 "StatusName": "Ok",
 "StatusMessage": "Successful API call",
 "SubmissionId": "931f8057-fe2e-4dcd-babd-5527ef098a6c",
 "NHRecords": {
   "SuccessRecords": [
     {
       "Sequence": null,
       "RecordId": "53a64158-6333-44ef-8e26-1cd20ba79f78",
       "RecordStatus": "Created",
       "EmployeeRecords": [
         {
           "Sequence": "3",
           "EmployeeUId": "0be8f3cf-b78c-4f5b-9ee6-e4a5089d2f4a",
           "Status": "ADDED"
         },
         {
           "Sequence": "1",
           "EmployeeUId": "bc88cd09-f537-4395-b54f-ccee2d4d6997",
           "Status": "UPDATED"
         },
         {
           "Sequence": null,
           "EmployeeUId": "44fd0c52-0216-4731-b088-f8faa84e0de5",
           "Status": "DELETED"
         }
       ],
       "CreatedTs": "2019-08-06 22:02:48 -04:00",
       "UpdatedTs": "2019-08-06 22:06:07 -04:00"
     }
   ],
   "ErrorRecords": null
 },
 "Errors": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

# Validate

Runs business and data validation checks for New Hire report records.

GET NewHireReport/Validate
1

Request Body

Field Type Description
SubmissionId guid Unique identifier of a submission
RecordIds guid[] List of record Ids to be transmitted.

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 Pulls the New Hire report records with Success and Error statuses.
    SuccessRecords object[] It will show the detailed information about the success status of New Hire Report Records.
        Sequence string A unique number given by an inbound application to identify failed records.
        RecordId guid Unique identifier of a record.
        RecordStatus string Returns the status of the records.
        EmployeeRecords string Return status details like Created, Transmitted, Accepted, Rejected.
            Sequence string A unique number given by an inbound application to identify failed records.
            EmployeeUId guid Unique identifier of an Employee.
            Status string Returns the status of the Employee details.
        CreatedTs DateTime Date and time of return created.
        UpdatedTs DateTime Date and time of return updated.
    ErrorRecords object[] It will show the detailed information about the error status of New Hire Report Records.
        Sequence string A unique number given by an inbound application to identify failed records.
        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.
        EmployeeErrorRecords object[] Return status details like Created, Transmitted, Accepted, Rejected.
            Sequence string A unique number given by an inbound application to identify failed records.
            EmployeeUId guid Client Record Identifier.
            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.
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

{
   "SubmissionId": "f1ed3955-1b64-408c-a730-9008a192db3f",
   "RecordIds": [
       "1ea1e55c-7175-4539-882b-f856edab1b69"
      
   ]
}
1
2
3
4
5
6
7

Response JSON

{
 "StatusCode": 200,
 "StatusName": "Ok",
 "StatusMessage": "Successful API call",
 "SubmissionId": "f1ed3955-1b64-408c-a730-9008a192db3f",
 "NHReports": {
   "SuccessRecords": [
     {
       "Sequence": "1",
       "RecordId": "1ea1e55c-7175-4539-882b-f856edab1b69",
       "RecordStatus": "Success",
       "EmployeeRecords": [
         {
           "Sequence": "1",
           "EmployeeUId": "1f176e11-dcea-4b11-8ce9-8952c098223c",
           "Status": "Success"
         }
       ],
       "CreatedTs": "7/26/2019 7:51:16 AM",
       "UpdatedTs": "7/26/2019 7:51:16 AM"
     }
   ],
   "ErrorRecords": null
 },
 "Errors": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

← Online94xPINRequest →