form2290

GET form2290/List

Request (URI)

Name Type Description Condition
BusinessId globally unique identifier

Required

EIN string

Required

Page integer

Required

PageSize integer

Required

EfileStatus string

Required

FromDate string

Required

ToDate string

Required

Response

Name Type Description
Form2290RecordList Collection of Form2290ListDetails

A detailed information about the Business, Employees and Form 941 records.

TotalRecords integer

Total number of Businesses

TotalPages integer

Total number of pages

Page integer

Page number

PageSize integer

Range: 10, 25, 50, 100

Errors Collection of Error

It will show the detailed information about the error.

StatusCode integer

It will return the status codes like 200, 300, etc., Refer Status Codes.

StatusName string

It will return the name of status code.

StatusMessage string

It will return the detailed message of status code.

Response Formats

application/json, text/json

Sample:
{
  "StatusCode": 200,
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "Form2290RecordList": [
    null,
    {
      "SubmissionId": "b4a635a5-ace2-47e2-9d0f-f90ae0bd609b",
      "RecordId": "bd54c1f5-db22-42a1-97ec-a4156b018e96",
      "BusinessId": null,
      "BusinessName": null,
      "EIN": null,
      "FUM": null,
      "TotalTax": null,
      "Credits": null,
      "BalanceDue": null,
      "ReportingVehicles": null,
      "PriorYearSuspended": null,
      "CreditVehicles": null,
      "IRSPaymentType": null,
      "EFileStatus": null
    }
  ],
  "TotalRecords": 1,
  "TotalPages": 2,
  "Page": 3,
  "PageSize": 4,
  "Errors": [
    {
      "Code": "404",
      "SeqId": "1",
      "Name": "NotFound",
      "UserMessage": "Record not found",
      "APIMessage": "Record not found",
      "Type": "Error"
    },
    {
      "Code": "404",
      "SeqId": "1",
      "Name": "NotFound",
      "UserMessage": "Record not found",
      "APIMessage": "Record not found",
      "Type": "Error"
    }
  ]
}

form2290

GET form2290/List

Request (URI)

Name Type Description Condition
BusinessId globally unique identifier

Required

EIN string

Required

Page integer

Required

PageSize integer

Required

EfileStatus string

Required

FromDate string

Required

ToDate string

Required

Response

Name Type Description
Form2290RecordList Collection of Form2290ListDetails

A detailed information about the Business, Employees and Form 941 records.

TotalRecords integer

Total number of Businesses

TotalPages integer

Total number of pages

Page integer

Page number

PageSize integer

Range: 10, 25, 50, 100

Errors Collection of Error

It will show the detailed information about the error.

StatusCode integer

It will return the status codes like 200, 300, etc., Refer Status Codes.

StatusName string

It will return the name of status code.

StatusMessage string

It will return the detailed message of status code.

Response Formats

application/json, text/json

Sample:
{
  "StatusCode": 200,
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "Form2290RecordList": [
    null,
    {
      "SubmissionId": "b4a635a5-ace2-47e2-9d0f-f90ae0bd609b",
      "RecordId": "bd54c1f5-db22-42a1-97ec-a4156b018e96",
      "BusinessId": null,
      "BusinessName": null,
      "EIN": null,
      "FUM": null,
      "TotalTax": null,
      "Credits": null,
      "BalanceDue": null,
      "ReportingVehicles": null,
      "PriorYearSuspended": null,
      "CreditVehicles": null,
      "IRSPaymentType": null,
      "EFileStatus": null
    }
  ],
  "TotalRecords": 1,
  "TotalPages": 2,
  "Page": 3,
  "PageSize": 4,
  "Errors": [
    {
      "Code": "404",
      "SeqId": "1",
      "Name": "NotFound",
      "UserMessage": "Record not found",
      "APIMessage": "Record not found",
      "Type": "Error"
    },
    {
      "Code": "404",
      "SeqId": "1",
      "Name": "NotFound",
      "UserMessage": "Record not found",
      "APIMessage": "Record not found",
      "Type": "Error"
    }
  ]
}