RequestPostalByRecordId

RequestPostalByRecordId

Use this endpoint to enable postal mailing for 1099 / W2 forms that have already been transmitted to the IRS. Your request must contain the ‘RecordId’ of the transmitted forms.

POST Utility/RequestPostalByRecordId 

Request Body

Field	Type	Description
RecordIds	object[]	Contains the object of RecordId. Note: Postal order cannot be completed for returns that have not been transmitted

Response Body

Field	Type	Description
TotalRecords	string	Returns the count of total records.
TotalSuccess	string	Returns the count of success records.
TotalErrors	string	Returns the count of error records.
SuccessRecords	object[]	Shows information about success records.
RecordId	Guid	Unique identifier of a record.
Status	string	Returns status of the postal mailing status.
StatusTs	string	Returns the date and time of the postal order created.
Info	string	Returns the information about Postal mailing service.
ErrorRecords	object[]	Shows information about error records.
RecordId	Guid	Unique identifier of a record.
Status	string	Returns status of the postal mailing status.
StatusTs	string	Returns the date and time of the postal mailing status. Note: By default StatusTs will be null for records listed in ErrorRecords object
Info	string	Returns the information about the record for which we are not postal mailing service.
Errors	object[]	Shows detailed error information.
Id	string	Returns the validation error Id.
Name	string	Name of the validation error.
Message	string	Description of the validation error.

Request JSON

{
    "RecordIds": [
    "31ea464a-ff03-46db-92ce-14e355a132bb"
    ]
}

Response JSON

200

Success Response - This is a sample response for successful API requests.

{
  "TotalRecords": "1",
  "TotalSuccess": "1",
  "TotalErrors": "0",
  "SuccessRecords": [
      {
          "RecordId": "31ea464a-ff03-46db-92ce-14e355a132bb",
          "Status": "Order Created",
          "StatusTs": "2024-11-11 02:13:12 -05:00",
          "Info": "Postal Order has been created"
      }
  ],
  "ErrorRecords": null,
  "Errors": null
}

300

Multi-status Response - You'll get the below response when multiple statuses are included.

{
  "TotalRecords": "6",
  "TotalSuccess": "5",
  "TotalErrors": "1",
  "SuccessRecords": [
      {
          "RecordId": "59839550-b1d0-4431-968e-5f0662a23968",
          "Status": "Order Created",
          "StatusTs": "2024-11-11 02:25:25 -05:00",
          "Info": "Postal Order has been created"
      },
      {
          "RecordId": "ec6735f7-f549-483f-b559-60f1cd21667f",
          "Status": "Order Created",
          "StatusTs": "2024-11-11 02:25:25 -05:00",
          "Info": "Postal Order has been created"
      },
      {
          "RecordId": "702c2e46-10ad-404c-9368-91f6eb3a6dde",
          "Status": "Order Created",
          "StatusTs": "2024-11-11 02:25:25 -05:00",
          "Info": "Postal Order has been created"
      },
      {
          "RecordId": "4d0787e0-1fde-454b-8d78-bfe0724567df",
          "Status": "Order Created",
          "StatusTs": "2024-11-11 02:25:25 -05:00",
          "Info": "Postal Order has been created"
      },
      {
          "RecordId": "aeef50a8-b2fb-4a0a-a74f-b48ce6573f4e",
          "Status": "Order Created",
          "StatusTs": "2024-11-11 02:25:25 -05:00",
          "Info": "Postal Order has been created"
      }
  ],
  "ErrorRecords": [
      {
          "RecordId": "bffd3fef-69e7-4efa-91e9-0fddca607e7e",
          "Status": "NOTCREATED",
          "StatusTs": null,
          "Info": "Invalid RecordId"
      }
  ],
  "Errors": [
      {
          "Id": "F00-100155",
          "Name": "Error Records",
          "Message": "Some of the records are errored. Please read the Error Records for more details."
      }
  ]
}

400

Bad Request Response - You'll get the below response when your API requests contain any validation errors.

{
  "TotalRecords": "1",
  "TotalSuccess": "0",
  "TotalErrors": "1",
  "SuccessRecords": null,
  "ErrorRecords": [
      {
          "RecordId": "c094a43c-57e2-4bfa-bee6-8db6a069707e",
          "Status": "NOTCREATED",
          "StatusTs": null,
          "Info": "Postal order cannot be completed for returns that have not been transmitted"
      }
  ],
  "Errors": null
}