form2290

GET form2290/Get

Request (URI)

Name Type Description Condition
SubmissionId globally unique identifier

Required

Response

Name Type Description
SubmissionId globally unique identifier

Form2290Records Collection of Form2290Response

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

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",
  "SubmissionId": "bdf0f09c-5fd8-43af-b1cd-0d5a2492a296",
  "Form2290Records": [
    {
      "RecordId": "a72d27a0-2d35-4308-8ec3-582a59211224",
      "ReturnHeader": {
        "BusinessDetails": null
      },
      "ReturnData": {
        "Form2290": {
          "IsFinalReturn": true,
          "IsAddressChange": true,
          "FUM": "072019",
          "TotalTax": null,
          "Credits": null,
          "BalanceDue": null,
          "ReportingVehicles": [
            null,
            {
              "VehSeqId": null,
              "VehicleId": "aae0ba87-eb2a-43cf-a220-f23138e9135e",
              "VIN": null,
              "WeightCategory": "V",
              "IsLogging": true,
              "IsAgriculture": true,
              "VehicleTax": 0.0,
              "IsPrivatelyPurchased": false,
              "PurchasedMonth": null
            }
          ],
          "PriorYearSuspendedVehicles": [
            {
              "VehSeqId": null,
              "VehicleId": "d8077646-e8c7-46be-9a2a-90f92adea2ce",
              "VIN": null,
              "SuspendedType": "SOLDORTRANSFERRED",
              "SoldTo": "Wiliamson",
              "SoldDate": "09/29/2019"
            },
            {
              "VehSeqId": null,
              "VehicleId": "d8077646-e8c7-46be-9a2a-90f92adea2ce",
              "VIN": null,
              "SuspendedType": "SOLDORTRANSFERRED",
              "SoldTo": "Wiliamson",
              "SoldDate": "09/29/2019"
            }
          ],
          "CreditVehicles": [
            {
              "VehSeqId": null,
              "VehicleId": "b18170e9-d75b-4c19-82c8-aa410d8bc85a",
              "VIN": null,
              "CreditType": "SOLD",
              "PrevFiledTaxYear": "2019",
              "PrevFiledFUM": "072019",
              "PrevFiledGW": "F",
              "IsLogging": true,
              "IRSExplaination": "Vehicle has been sold",
              "CreditAmount": 3.0,
              "SoldDetails": {
                "SoldDate": "12/12/2019",
                "SoldTo": "George",
                "IsForeign": true,
                "USAddress": {
                  "Address": "12 main st",
                  "City": "Denver",
                  "State": "CO",
                  "ZipCode": "80011"
                },
                "ForeignAddress": {
                  "Address": "857  th Avenue",
                  "City": "Whitecourt",
                  "ProvinceOrStateNm": "Alberta",
                  "Country": "CA",
                  "PostalCd": "T7S 1A1"
                },
                "Email": "george@gmail.com",
                "Phone": "9176394319"
              },
              "DestroyedDetails": {
                "DestroyedDate": "12/12/2019"
              },
              "StolenDetails": {
                "StolenDate": "12/12/2019"
              }
            },
            {
              "VehSeqId": null,
              "VehicleId": "b18170e9-d75b-4c19-82c8-aa410d8bc85a",
              "VIN": null,
              "CreditType": "SOLD",
              "PrevFiledTaxYear": "2019",
              "PrevFiledFUM": "072019",
              "PrevFiledGW": "F",
              "IsLogging": true,
              "IRSExplaination": "Vehicle has been sold",
              "CreditAmount": 3.0,
              "SoldDetails": {
                "SoldDate": "12/12/2019",
                "SoldTo": "George",
                "IsForeign": true,
                "USAddress": {
                  "Address": "12 main st",
                  "City": "Denver",
                  "State": "CO",
                  "ZipCode": "80011"
                },
                "ForeignAddress": {
                  "Address": "857  th Avenue",
                  "City": "Whitecourt",
                  "ProvinceOrStateNm": "Alberta",
                  "Country": "CA",
                  "PostalCd": "T7S 1A1"
                },
                "Email": "george@gmail.com",
                "Phone": "9176394319"
              },
              "DestroyedDetails": {
                "DestroyedDate": "12/12/2019"
              },
              "StolenDetails": {
                "StolenDate": "12/12/2019"
              }
            }
          ],
          "IRSPaymentType": null,
          "IRSPayments": {
            "BankRoutingNum": "147258963",
            "AccountType": "Checking",
            "BankAccountNum": "1234567893692",
            "Phone": "9176394319"
          },
          "ConsentToDisclosure": {
            "IsConsentToDisclose": true,
            "ConsentPin": "26153"
          },
          "IsThirdPartyDesignee": true,
          "ThirdPartyDesigneeDetails": {
            "Name": "joe",
            "Phone": "9962104274",
            "DesigneePIN": "12456"
          },
          "Signature": {
            "SignatureType": "TaxPayerPIN",
            "TaxPayerPIN": "78945"
          }
        }
      }
    },
    {
      "RecordId": "a72d27a0-2d35-4308-8ec3-582a59211224",
      "ReturnHeader": {
        "BusinessDetails": null
      },
      "ReturnData": {
        "Form2290": {
          "IsFinalReturn": true,
          "IsAddressChange": true,
          "FUM": "072019",
          "TotalTax": null,
          "Credits": null,
          "BalanceDue": null,
          "ReportingVehicles": [
            null,
            {
              "VehSeqId": null,
              "VehicleId": "aae0ba87-eb2a-43cf-a220-f23138e9135e",
              "VIN": null,
              "WeightCategory": "V",
              "IsLogging": true,
              "IsAgriculture": true,
              "VehicleTax": 0.0,
              "IsPrivatelyPurchased": false,
              "PurchasedMonth": null
            }
          ],
          "PriorYearSuspendedVehicles": [
            {
              "VehSeqId": null,
              "VehicleId": "d8077646-e8c7-46be-9a2a-90f92adea2ce",
              "VIN": null,
              "SuspendedType": "SOLDORTRANSFERRED",
              "SoldTo": "Wiliamson",
              "SoldDate": "09/29/2019"
            },
            {
              "VehSeqId": null,
              "VehicleId": "d8077646-e8c7-46be-9a2a-90f92adea2ce",
              "VIN": null,
              "SuspendedType": "SOLDORTRANSFERRED",
              "SoldTo": "Wiliamson",
              "SoldDate": "09/29/2019"
            }
          ],
          "CreditVehicles": [
            {
              "VehSeqId": null,
              "VehicleId": "b18170e9-d75b-4c19-82c8-aa410d8bc85a",
              "VIN": null,
              "CreditType": "SOLD",
              "PrevFiledTaxYear": "2019",
              "PrevFiledFUM": "072019",
              "PrevFiledGW": "F",
              "IsLogging": true,
              "IRSExplaination": "Vehicle has been sold",
              "CreditAmount": 3.0,
              "SoldDetails": {
                "SoldDate": "12/12/2019",
                "SoldTo": "George",
                "IsForeign": true,
                "USAddress": {
                  "Address": "12 main st",
                  "City": "Denver",
                  "State": "CO",
                  "ZipCode": "80011"
                },
                "ForeignAddress": {
                  "Address": "857  th Avenue",
                  "City": "Whitecourt",
                  "ProvinceOrStateNm": "Alberta",
                  "Country": "CA",
                  "PostalCd": "T7S 1A1"
                },
                "Email": "george@gmail.com",
                "Phone": "9176394319"
              },
              "DestroyedDetails": {
                "DestroyedDate": "12/12/2019"
              },
              "StolenDetails": {
                "StolenDate": "12/12/2019"
              }
            },
            {
              "VehSeqId": null,
              "VehicleId": "b18170e9-d75b-4c19-82c8-aa410d8bc85a",
              "VIN": null,
              "CreditType": "SOLD",
              "PrevFiledTaxYear": "2019",
              "PrevFiledFUM": "072019",
              "PrevFiledGW": "F",
              "IsLogging": true,
              "IRSExplaination": "Vehicle has been sold",
              "CreditAmount": 3.0,
              "SoldDetails": {
                "SoldDate": "12/12/2019",
                "SoldTo": "George",
                "IsForeign": true,
                "USAddress": {
                  "Address": "12 main st",
                  "City": "Denver",
                  "State": "CO",
                  "ZipCode": "80011"
                },
                "ForeignAddress": {
                  "Address": "857  th Avenue",
                  "City": "Whitecourt",
                  "ProvinceOrStateNm": "Alberta",
                  "Country": "CA",
                  "PostalCd": "T7S 1A1"
                },
                "Email": "george@gmail.com",
                "Phone": "9176394319"
              },
              "DestroyedDetails": {
                "DestroyedDate": "12/12/2019"
              },
              "StolenDetails": {
                "StolenDate": "12/12/2019"
              }
            }
          ],
          "IRSPaymentType": null,
          "IRSPayments": {
            "BankRoutingNum": "147258963",
            "AccountType": "Checking",
            "BankAccountNum": "1234567893692",
            "Phone": "9176394319"
          },
          "ConsentToDisclosure": {
            "IsConsentToDisclose": true,
            "ConsentPin": "26153"
          },
          "IsThirdPartyDesignee": true,
          "ThirdPartyDesigneeDetails": {
            "Name": "joe",
            "Phone": "9962104274",
            "DesigneePIN": "12456"
          },
          "Signature": {
            "SignatureType": "TaxPayerPIN",
            "TaxPayerPIN": "78945"
          }
        }
      }
    }
  ],
  "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/Get

Request (URI)

Name Type Description Condition
SubmissionId globally unique identifier

Required

Response

Name Type Description
SubmissionId globally unique identifier

Form2290Records Collection of Form2290Response

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

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",
  "SubmissionId": "bdf0f09c-5fd8-43af-b1cd-0d5a2492a296",
  "Form2290Records": [
    {
      "RecordId": "a72d27a0-2d35-4308-8ec3-582a59211224",
      "ReturnHeader": {
        "BusinessDetails": null
      },
      "ReturnData": {
        "Form2290": {
          "IsFinalReturn": true,
          "IsAddressChange": true,
          "FUM": "072019",
          "TotalTax": null,
          "Credits": null,
          "BalanceDue": null,
          "ReportingVehicles": [
            null,
            {
              "VehSeqId": null,
              "VehicleId": "aae0ba87-eb2a-43cf-a220-f23138e9135e",
              "VIN": null,
              "WeightCategory": "V",
              "IsLogging": true,
              "IsAgriculture": true,
              "VehicleTax": 0.0,
              "IsPrivatelyPurchased": false,
              "PurchasedMonth": null
            }
          ],
          "PriorYearSuspendedVehicles": [
            {
              "VehSeqId": null,
              "VehicleId": "d8077646-e8c7-46be-9a2a-90f92adea2ce",
              "VIN": null,
              "SuspendedType": "SOLDORTRANSFERRED",
              "SoldTo": "Wiliamson",
              "SoldDate": "09/29/2019"
            },
            {
              "VehSeqId": null,
              "VehicleId": "d8077646-e8c7-46be-9a2a-90f92adea2ce",
              "VIN": null,
              "SuspendedType": "SOLDORTRANSFERRED",
              "SoldTo": "Wiliamson",
              "SoldDate": "09/29/2019"
            }
          ],
          "CreditVehicles": [
            {
              "VehSeqId": null,
              "VehicleId": "b18170e9-d75b-4c19-82c8-aa410d8bc85a",
              "VIN": null,
              "CreditType": "SOLD",
              "PrevFiledTaxYear": "2019",
              "PrevFiledFUM": "072019",
              "PrevFiledGW": "F",
              "IsLogging": true,
              "IRSExplaination": "Vehicle has been sold",
              "CreditAmount": 3.0,
              "SoldDetails": {
                "SoldDate": "12/12/2019",
                "SoldTo": "George",
                "IsForeign": true,
                "USAddress": {
                  "Address": "12 main st",
                  "City": "Denver",
                  "State": "CO",
                  "ZipCode": "80011"
                },
                "ForeignAddress": {
                  "Address": "857  th Avenue",
                  "City": "Whitecourt",
                  "ProvinceOrStateNm": "Alberta",
                  "Country": "CA",
                  "PostalCd": "T7S 1A1"
                },
                "Email": "george@gmail.com",
                "Phone": "9176394319"
              },
              "DestroyedDetails": {
                "DestroyedDate": "12/12/2019"
              },
              "StolenDetails": {
                "StolenDate": "12/12/2019"
              }
            },
            {
              "VehSeqId": null,
              "VehicleId": "b18170e9-d75b-4c19-82c8-aa410d8bc85a",
              "VIN": null,
              "CreditType": "SOLD",
              "PrevFiledTaxYear": "2019",
              "PrevFiledFUM": "072019",
              "PrevFiledGW": "F",
              "IsLogging": true,
              "IRSExplaination": "Vehicle has been sold",
              "CreditAmount": 3.0,
              "SoldDetails": {
                "SoldDate": "12/12/2019",
                "SoldTo": "George",
                "IsForeign": true,
                "USAddress": {
                  "Address": "12 main st",
                  "City": "Denver",
                  "State": "CO",
                  "ZipCode": "80011"
                },
                "ForeignAddress": {
                  "Address": "857  th Avenue",
                  "City": "Whitecourt",
                  "ProvinceOrStateNm": "Alberta",
                  "Country": "CA",
                  "PostalCd": "T7S 1A1"
                },
                "Email": "george@gmail.com",
                "Phone": "9176394319"
              },
              "DestroyedDetails": {
                "DestroyedDate": "12/12/2019"
              },
              "StolenDetails": {
                "StolenDate": "12/12/2019"
              }
            }
          ],
          "IRSPaymentType": null,
          "IRSPayments": {
            "BankRoutingNum": "147258963",
            "AccountType": "Checking",
            "BankAccountNum": "1234567893692",
            "Phone": "9176394319"
          },
          "ConsentToDisclosure": {
            "IsConsentToDisclose": true,
            "ConsentPin": "26153"
          },
          "IsThirdPartyDesignee": true,
          "ThirdPartyDesigneeDetails": {
            "Name": "joe",
            "Phone": "9962104274",
            "DesigneePIN": "12456"
          },
          "Signature": {
            "SignatureType": "TaxPayerPIN",
            "TaxPayerPIN": "78945"
          }
        }
      }
    },
    {
      "RecordId": "a72d27a0-2d35-4308-8ec3-582a59211224",
      "ReturnHeader": {
        "BusinessDetails": null
      },
      "ReturnData": {
        "Form2290": {
          "IsFinalReturn": true,
          "IsAddressChange": true,
          "FUM": "072019",
          "TotalTax": null,
          "Credits": null,
          "BalanceDue": null,
          "ReportingVehicles": [
            null,
            {
              "VehSeqId": null,
              "VehicleId": "aae0ba87-eb2a-43cf-a220-f23138e9135e",
              "VIN": null,
              "WeightCategory": "V",
              "IsLogging": true,
              "IsAgriculture": true,
              "VehicleTax": 0.0,
              "IsPrivatelyPurchased": false,
              "PurchasedMonth": null
            }
          ],
          "PriorYearSuspendedVehicles": [
            {
              "VehSeqId": null,
              "VehicleId": "d8077646-e8c7-46be-9a2a-90f92adea2ce",
              "VIN": null,
              "SuspendedType": "SOLDORTRANSFERRED",
              "SoldTo": "Wiliamson",
              "SoldDate": "09/29/2019"
            },
            {
              "VehSeqId": null,
              "VehicleId": "d8077646-e8c7-46be-9a2a-90f92adea2ce",
              "VIN": null,
              "SuspendedType": "SOLDORTRANSFERRED",
              "SoldTo": "Wiliamson",
              "SoldDate": "09/29/2019"
            }
          ],
          "CreditVehicles": [
            {
              "VehSeqId": null,
              "VehicleId": "b18170e9-d75b-4c19-82c8-aa410d8bc85a",
              "VIN": null,
              "CreditType": "SOLD",
              "PrevFiledTaxYear": "2019",
              "PrevFiledFUM": "072019",
              "PrevFiledGW": "F",
              "IsLogging": true,
              "IRSExplaination": "Vehicle has been sold",
              "CreditAmount": 3.0,
              "SoldDetails": {
                "SoldDate": "12/12/2019",
                "SoldTo": "George",
                "IsForeign": true,
                "USAddress": {
                  "Address": "12 main st",
                  "City": "Denver",
                  "State": "CO",
                  "ZipCode": "80011"
                },
                "ForeignAddress": {
                  "Address": "857  th Avenue",
                  "City": "Whitecourt",
                  "ProvinceOrStateNm": "Alberta",
                  "Country": "CA",
                  "PostalCd": "T7S 1A1"
                },
                "Email": "george@gmail.com",
                "Phone": "9176394319"
              },
              "DestroyedDetails": {
                "DestroyedDate": "12/12/2019"
              },
              "StolenDetails": {
                "StolenDate": "12/12/2019"
              }
            },
            {
              "VehSeqId": null,
              "VehicleId": "b18170e9-d75b-4c19-82c8-aa410d8bc85a",
              "VIN": null,
              "CreditType": "SOLD",
              "PrevFiledTaxYear": "2019",
              "PrevFiledFUM": "072019",
              "PrevFiledGW": "F",
              "IsLogging": true,
              "IRSExplaination": "Vehicle has been sold",
              "CreditAmount": 3.0,
              "SoldDetails": {
                "SoldDate": "12/12/2019",
                "SoldTo": "George",
                "IsForeign": true,
                "USAddress": {
                  "Address": "12 main st",
                  "City": "Denver",
                  "State": "CO",
                  "ZipCode": "80011"
                },
                "ForeignAddress": {
                  "Address": "857  th Avenue",
                  "City": "Whitecourt",
                  "ProvinceOrStateNm": "Alberta",
                  "Country": "CA",
                  "PostalCd": "T7S 1A1"
                },
                "Email": "george@gmail.com",
                "Phone": "9176394319"
              },
              "DestroyedDetails": {
                "DestroyedDate": "12/12/2019"
              },
              "StolenDetails": {
                "StolenDate": "12/12/2019"
              }
            }
          ],
          "IRSPaymentType": null,
          "IRSPayments": {
            "BankRoutingNum": "147258963",
            "AccountType": "Checking",
            "BankAccountNum": "1234567893692",
            "Phone": "9176394319"
          },
          "ConsentToDisclosure": {
            "IsConsentToDisclose": true,
            "ConsentPin": "26153"
          },
          "IsThirdPartyDesignee": true,
          "ThirdPartyDesigneeDetails": {
            "Name": "joe",
            "Phone": "9962104274",
            "DesigneePIN": "12456"
          },
          "Signature": {
            "SignatureType": "TaxPayerPIN",
            "TaxPayerPIN": "78945"
          }
        }
      }
    }
  ],
  "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"
    }
  ]
}