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 
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-11 |
| string | Email address of the Business. Size Range: ..100 | |
| 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 |
| 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 |
| KindOfEmployer | string | Identifies the kind of employer. Mandatory for W-2 and optional for 1099-MISC and 94X series.Allowed values |
| KindOfPayer | string | Identifies the kind of payer. This field is mandatory in W-2 and optional in 1099-MISC and 94X series.Allowed values |
| 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: ..46 |
| Address2 | string | Optional Employer/Payer's suite or apartment Size Range: ..46 |
| City | string | Employer/Payer's city Size Range: ..50 |
| State | string | State code of the employer/payer. Refer Static values. Size Range: 2 Allowed values |
| ZipCd | string | Employer/Payer's zip code Size Range: 5..10 |
| 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: ..50 |
| Address2 | string | Optional Employer/Payer's suite or apartment Size Range: ..50 |
| City | string | Employer/Payer's city Size Range: ..50 |
| ProvinceOrStateNm | string | Employer/Payer's province or state name Size Range: ..50 |
| Country | string | Employer/Payer country code. Refer Static values. Size Range: 2 Allowed values |
| PostalCd | string | Employer/Payer's postal code Size Range: ..16 |
| PINDetails | object | Object to create Online PIN |
| SSN | string | Employer's Social Security Number Size Range: 9-11 |
| ContactNm | string | Employer's Contact Name Size Range: ..27 |
| ContactTitle | string | Employer's Contact Title Size Range: ..40 |
| string | Employer's Email Address Size Range: ..100 |
Request JSON
{
"Business": {
"BusinessId": null,
"BusinessNm": "Snowdaze LLC",
"TradeNm": "Kodak",
"IsEIN": true,
"EINorSSN": "003333334",
"Email": "sample@bodeem.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": "sample@bodeem.com"
}
}
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. |
Response JSON
Success Response - This is a sample response for successful API requests.
{
"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
}
}