# Online94xPINRequest

# Create

Creates Online 94X PIN requests with an unique Submission Id which is further used for all other methods referencing these requests.

POST Online94xPINRequest/Create
1

Request Body

Field Type Description
    Business object Business 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"
        SigningAuthority object Details of the person who is authorized to sign the return.
            Name string Optional Name of the signing authority
Size Range: ..35
            Phone string Optional Phone number of the signing authority
Size Range: 10
            BusinessMemberType string Optional Business title of the signing authority.
Size Range: 5..29
Allowed values: "CORPORATESECRETARY", "SECRETARYTREASURER", "PARTNER", "GENERALPARTNER", "LIMITEDPARTNER", "LLCMEMBER", "MANAGINGMEMBER", "MANAGER", "TAXMATTERPARTNER", "PRESIDENT", "VICEPRESIDENT", "CORPORATETREASURER", "TREASURER", "ASSISTANTTREASURER", "CHIEFACCOUNTINGOFFICER", "CHIEFEXECUTIVEOFFICER", "CHIEFFINANCIALOFFICER", "TAXOFFICER", "CHIEFOPERATINGOFFICER", "CORPORATEOFFICER", "EXECUTIVEDIRECTOR", "DIRECTOR", "CHAIRMAN", "EXECUTIVEADMINISTRATOR", "RECEIVER", "PASTOR", "ASSISTANTTORELIGIOUSLEADER", "REVEREND", "PRIEST", "MINISTER", "RABBI", "LEADEROFRELIGIOUSORGANIZATION", "SECRETARY", "DIRECTOROFTAXATION", "DIRECTOROFPERSONNEL", "ADMINISTRATOR", "EXECUTOR", "TRUSTEE", "FIDUCIARY", "OWNER", "SOLEPROPRIETOR", "MEMBER", "SOLEMEMBER"
        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
    PINDetails object Object to create Online PIN
        SSN string Employer's Social Security Number
Size Range: 9
        ContactNm string Employer's Contact Name
Size Range: ..27
        ContactTitle string Employer's Contact Title
Size Range: ..40
        Email string Employer's Email Address
Size Range: ..40

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.
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.
Online94xPINRecords object Pulls the Online 94X PIN request records with Success and Error statuses.
    SuccessRecords object[] It will show the detailed information about the success status of Form 941 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 string Date and time of return created.
        UpdatedTs string Date and time of return updated.
    ErrorRecords object[] It will show the detailed information about the error status of Form 941 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

{
   "Business": {
       "BusinessNm": "Eastman Kodak Company",
       "TradeNm": "Kodak",
       "IsEIN": true,
       "EINorSSN": "003333334",
       "Email": "john@gmail.com",
       "ContactNm": "John",
       "Phone": "1234567890",
       "PhoneExtn": "12345",
       "Fax": "1234567890",
       "BusinessType": "ESTE",
       "SigningAuthority": {
           "Name": "John",
           "Phone": "1234567890",
           "BusinessMemberType": "ADMINISTRATOR"
       },
       "KindOfEmployer": "FederalGovt",
       "KindOfPayer": "REGULAR941",
       "IsBusinessTerminated": true,
       "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
       }
   },
   "PINDetails": {
       "SSN": "393848037",
       "ContactNm": "John",
       "ContactTitle": "Sole Proprietor",
       "Email": "john@gmail.com"
   }
}
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

Response JSON

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "SubmissionId": "144b8a27-5802-46c5-b1f6-0510026ca46a",
   "Errors": null,
   "Online94xPINRecords": {
       "SuccessRecords": [
           {
               "Sequence": null,
               "RecordId": "e4b666b2-54a0-4753-92e0-d94d7a2a6ae0",
               "RecordStatus": "Created",
               "CreatedTs": "2019-08-02 03:40:42 -04:00",
               "UpdatedTs": "2019-08-02 03:40:42 -04:00"
           }
       ],
       "ErrorRecords": null
   }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# Delete

Deletes Online 94X PIN request records by Submission Id and Record Ids.

DELETE Online94xPINRequest/Delete
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.
Online94xPINRecords object Pulls the Online 94X PIN request records with Success and Error statuses.
    SuccessRecords object[] It will show the detailed information about the success status of Form 941 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 string Date and time of return created.
        UpdatedTs string Date and time of return updated.
    ErrorRecords object[] It will show the detailed information about the error status of Form 941 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.
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

"Online94xPINRequest/Delete?SubmissionId=a9de5911-0e00-4d98-93f2-5495b143ec01"
1

Response JSON

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "SubmissionId": "144b8a27-5802-46c5-b1f6-0510026ca46a",
   "Online94xPINRecords": {
       "SuccessRecords": [
           {
               "Sequence": null,
               "RecordId": "e4b666b2-54a0-4753-92e0-d94d7a2a6ae0",
               "RecordStatus": "DELETED",
               "CreatedTs": "2019-08-02 03:40:42 -04:00",
               "UpdatedTs": "2019-08-02 03:40:42 -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

# Get

Gets information of Online 94X PIN request records by Submission Id.

GET Online94xPINRequest/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
OnlinePINRequest94x object Pulls the Online 94X PIN request records.
    Business object Business 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
        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 signing authority
            BusinessMemberType string Optional Business title of the signing authority.
        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
    PINDetails object Object to create Online PIN
        SSN string Employer's Social Security Number
        ContactNm string Employer's Contact Name
        ContactTitle string Employer's Contact Title
        Email string Employer's Email Address
    RecordId guid Unique identifier of a record.
CreateTimeStamp DateTime Returns date and time of 94X return created
UpdateTimeStamp DateTime Returns date and time of 94X return updated
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

"Online94xPINRequest/Get?SubmissionId=144b8a27-5802-46c5-b1f6-0510026ca46a"
1

Response JSON

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "SubmissionId": "144b8a27-5802-46c5-b1f6-0510026ca46a",
   "OnlinePINRequest94x": {
       "Business": {
           "BusinessId": "1a96e2ad-8a4a-4e39-b116-76502227fda3",
           "BusinessNm": "Eastman Kodak Company",
           "TradeNm": "Kodak",
           "IsEIN": true,
           "EINorSSN": "003333334",
           "Email": "john@gmail.com",
           "ContactNm": "John",
           "Phone": "1234567890",
           "PhoneExtn": "12345",
           "Fax": "(123) 456-7890",
           "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
       },
       "PINDetails": {
           "SSN": "393-84-8037",
           "ContactNm": "John",
           "ContactTitle": "Sole Proprietor",
           "Email": "john@gmail.com"
       },
       "RecordId": "e4b666b2-54a0-4753-92e0-d94d7a2a6ae0"
   },
   "CreateTimeStamp": "2019-08-02T03:40:42.047",
   "UpdateTimeStamp": "2019-08-02T03:40:42.047",
   "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

# Status

Gets the status of the Online 94X PIN request records by Submission Id and Record Ids.

GET Online94xPINRequest/Status
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.
Online94xPINRecords object Pulls the Online 94X PIN request records with Success and Error statuses.
    SuccessRecords object[] It will show the detailed information about the success status of Form 941 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 string Date and time of return created.
        UpdatedTs string Date and time of return updated.
    ErrorRecords object[] It will show the detailed information about the error status of Form 941 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.
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

"Online94xPINRequest/Status?SubmissionId=144b8a27-5802-46c5-b1f6-0510026ca46a"
1

Response JSON

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "SubmissionId": "144b8a27-5802-46c5-b1f6-0510026ca46a",
   "Online94xPINRecords": {
       "SuccessRecords": [
           {
               "Sequence": "",
               "RecordId": "e4b666b2-54a0-4753-92e0-d94d7a2a6ae0",
               "RecordStatus": "Created",
               "CreatedTs": "2019-08-02 03:40:42 -04:00",
               "UpdatedTs": "2019-08-02 03:40:42 -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 Online 94X PIN request records to the State after validation.

POST Online94xPINRequest/Transmit
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.
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.
Online94xPINRecords object Pulls the Online 94X PIN request records with Success and Error statuses.
    SuccessRecords object[] It will show the detailed information about the success status of Form 941 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 string Date and time of return created.
        UpdatedTs string Date and time of return updated.
    ErrorRecords object[] It will show the detailed information about the error status of Form 941 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

"Online94xPINRequest/Transmit?SubmissionId=4e157f47-9c26-4a56-8a38-567eebf05163"
1

Response JSON

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "SubmissionId": "4e157f47-9c26-4a56-8a38-567eebf05163",
   "Errors": null,
   "Online94xPINRecords": {
       "SuccessRecords": [
           {
               "Sequence": null,
               "RecordId": "162684c0-6d80-4f05-8df2-edc26e2efd90",
               "RecordStatus": "Transmitted",
               "CreatedTs": "2019-08-02 04:08:20 -04:00",
               "UpdatedTs": "2019-08-02 04:10:58 -04:00"
           }
       ],
       "ErrorRecords": null
   }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# Update

Updates information of Online 94X PIN request records by Submission Id and Record Id.

PUT Online94xPINRequest/Update
1

Request Body

Field Type Description
SubmissionId guid Unique identifier of a submission.
RecordId guid Unique identifier of a record.
    Business object Business 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"
        SigningAuthority object Details of the person who is authorized to sign the return.
            Name string Optional Name of the signing authority
Size Range: ..35
            Phone string Optional Phone number of the signing authority
Size Range: 10
            BusinessMemberType string Optional Business title of the signing authority.
Size Range: 5..29
Allowed values: "CORPORATESECRETARY", "SECRETARYTREASURER", "PARTNER", "GENERALPARTNER", "LIMITEDPARTNER", "LLCMEMBER", "MANAGINGMEMBER", "MANAGER", "TAXMATTERPARTNER", "PRESIDENT", "VICEPRESIDENT", "CORPORATETREASURER", "TREASURER", "ASSISTANTTREASURER", "CHIEFACCOUNTINGOFFICER", "CHIEFEXECUTIVEOFFICER", "CHIEFFINANCIALOFFICER", "TAXOFFICER", "CHIEFOPERATINGOFFICER", "CORPORATEOFFICER", "EXECUTIVEDIRECTOR", "DIRECTOR", "CHAIRMAN", "EXECUTIVEADMINISTRATOR", "RECEIVER", "PASTOR", "ASSISTANTTORELIGIOUSLEADER", "REVEREND", "PRIEST", "MINISTER", "RABBI", "LEADEROFRELIGIOUSORGANIZATION", "SECRETARY", "DIRECTOROFTAXATION", "DIRECTOROFPERSONNEL", "ADMINISTRATOR", "EXECUTOR", "TRUSTEE", "FIDUCIARY", "OWNER", "SOLEPROPRIETOR", "MEMBER", "SOLEMEMBER"
        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
    PINDetails object Object to create Online PIN
        SSN string Employer's Social Security Number
Size Range: 9
        ContactNm string Employer's Contact Name
Size Range: ..27
        ContactTitle string Employer's Contact Title
Size Range: ..40
        Email string Employer's Email Address
Size Range: ..40
    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.
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.
Online94xPINRecords object Pulls the Online 94X PIN request records with Success and Error statuses.
    SuccessRecords object[] It will show the detailed information about the success status of Form 941 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 string Date and time of return created.
        UpdatedTs string Date and time of return updated.
    ErrorRecords object[] It will show the detailed information about the error status of Form 941 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": "144b8a27-5802-46c5-b1f6-0510026ca46a",
   "RecordId": "e4b666b2-54a0-4753-92e0-d94d7a2a6ae0",
   "Business": {
       "BusinessId": "1a96e2ad-8a4a-4e39-b116-76502227fda3",
       "BusinessNm": "Eastman Kodak Company update",
       "TradeNm": "Kodak",
       "IsEIN": true,
       "EINorSSN": "003333334",
       "Email": "john@gmail.com",
       "ContactNm": "John",
       "Phone": "1234567890",
       "PhoneExtn": "12345",
       "Fax": "1234567890",
       "BusinessType": "ESTE",
       "SigningAuthority": {
           "Name": "John",
           "Phone": "1234567890",
           "BusinessMemberType": "ADMINISTRATOR"
       },
       "KindOfEmployer": "FederalGovt",
       "KindOfPayer": "REGULAR941",
       "IsBusinessTerminated": true,
       "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
       }
   },
   "PINDetails": {
       "SSN": "393848037",
       "ContactNm": "John",
       "ContactTitle": "Sole Proprietor",
       "Email": "john@gmail.com"
   }
}
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

Request JSON

{
   "StatusCode": 200,
   "StatusName": "Ok",
   "StatusMessage": "Successful API call",
   "SubmissionId": "144b8a27-5802-46c5-b1f6-0510026ca46a",
   "Errors": null,
   "Online94xPINRecords": {
       "SuccessRecords": [
           {
               "Sequence": null,
               "RecordId": "e4b666b2-54a0-4753-92e0-d94d7a2a6ae0",
               "RecordStatus": "Created",
               "CreatedTs": "2019-08-02 03:40:42 -04:00",
               "UpdatedTs": "2019-08-02 04:01:10 -04:00"
           }
       ],
       "ErrorRecords": null
   }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19