Utility

POST Utility/CalculateVehicleTax

This API method Calculates the vehicle tax for the given vehicle details.

Request

Name Type Description Condition
FUM string

ReportingVehicles Collection of VehicleTaxReq

CreditVehicles Collection of CreditVehicleTaxRequest

Request Formats

application/json, text/json

Sample:
{
  "FUM": null,
  "ReportingVehicles": [
    {
      "VehSeqId": null,
      "VIN": null,
      "WeightCategory": null,
      "WeightCategoryId": 64,
      "IsSuspended": true,
      "IsLogging": true,
      "IsAgriculture": true
    },
    {
      "VehSeqId": null,
      "VIN": null,
      "WeightCategory": null,
      "WeightCategoryId": 64,
      "IsSuspended": true,
      "IsLogging": true,
      "IsAgriculture": true
    }
  ],
  "CreditVehicles": [
    {
      "VehSeqId": null,
      "CreditType": null,
      "PrevFiledTaxYear": null,
      "PrevFiledFUM": null,
      "PrevFiledGW": null,
      "IsLogging": true,
      "SoldDetails": {
        "SoldDate": null
      },
      "DestroyedDetails": {
        "DestroyedDate": "12/12/2019"
      },
      "StolenDetails": {
        "StolenDate": "12/12/2019"
      }
    },
    {
      "VehSeqId": null,
      "CreditType": null,
      "PrevFiledTaxYear": null,
      "PrevFiledFUM": null,
      "PrevFiledGW": null,
      "IsLogging": true,
      "SoldDetails": {
        "SoldDate": null
      },
      "DestroyedDetails": {
        "DestroyedDate": "12/12/2019"
      },
      "StolenDetails": {
        "StolenDate": "12/12/2019"
      }
    }
  ]
}

Response

Name Type Description
StatusCode integer

StatusName string

StatusMessage string

TotTaxAmt decimal number

TotCreditAmt decimal number

TotVehCnt integer

SuccessRecords CalculateTaxSuccessResponse

ErrorRecords CalculateTaxFailureResponse

Errors Collection of Error

Response Formats

application/json, text/json

Sample:
{
  "StatusCode": 200,
  "StatusName": null,
  "StatusMessage": null,
  "TotTaxAmt": 1.0,
  "TotCreditAmt": 2.0,
  "TotVehCnt": 3,
  "SuccessRecords": {
    "ReportingVehiclesDetails": [
      {
        "VehSeqId": null,
        "WeightCategory": null,
        "TaxAmount": 1.0
      },
      {
        "VehSeqId": null,
        "WeightCategory": null,
        "TaxAmount": 1.0
      }
    ],
    "CreditVehiclesDetails": [
      {
        "VehSeqId": null,
        "PrevFiledFUM": null,
        "PrevFiledGW": null,
        "CreditAmount": 1.0
      },
      {
        "VehSeqId": null,
        "PrevFiledFUM": null,
        "PrevFiledGW": null,
        "CreditAmount": 1.0
      }
    ]
  },
  "ErrorRecords": {
    "ReportingVehicles": [
      {
        "Errors": [
          {
            "VehSeqId": "1",
            "Code": "404",
            "Name": "NotFound",
            "UserMessage": "Record not found",
            "APIMessage": "Record not found",
            "Type": "Error"
          },
          {
            "VehSeqId": "1",
            "Code": "404",
            "Name": "NotFound",
            "UserMessage": "Record not found",
            "APIMessage": "Record not found",
            "Type": "Error"
          }
        ]
      },
      {
        "Errors": [
          {
            "VehSeqId": "1",
            "Code": "404",
            "Name": "NotFound",
            "UserMessage": "Record not found",
            "APIMessage": "Record not found",
            "Type": "Error"
          },
          {
            "VehSeqId": "1",
            "Code": "404",
            "Name": "NotFound",
            "UserMessage": "Record not found",
            "APIMessage": "Record not found",
            "Type": "Error"
          }
        ]
      }
    ],
    "CreditVehicles": [
      {
        "Errors": [
          {
            "VehSeqId": "1",
            "Code": "404",
            "Name": "NotFound",
            "UserMessage": "Record not found",
            "APIMessage": "Record not found",
            "Type": "Error"
          },
          {
            "VehSeqId": "1",
            "Code": "404",
            "Name": "NotFound",
            "UserMessage": "Record not found",
            "APIMessage": "Record not found",
            "Type": "Error"
          }
        ]
      },
      {
        "Errors": [
          {
            "VehSeqId": "1",
            "Code": "404",
            "Name": "NotFound",
            "UserMessage": "Record not found",
            "APIMessage": "Record not found",
            "Type": "Error"
          },
          {
            "VehSeqId": "1",
            "Code": "404",
            "Name": "NotFound",
            "UserMessage": "Record not found",
            "APIMessage": "Record not found",
            "Type": "Error"
          }
        ]
      }
    ]
  },
  "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"
    }
  ]
}

Utility

POST Utility/CalculateVehicleTax

This API method Calculates the vehicle tax for the given vehicle details.

Request

Name Type Description Condition
FUM string

ReportingVehicles Collection of VehicleTaxReq

CreditVehicles Collection of CreditVehicleTaxRequest

Request Formats

application/json, text/json

Sample:
{
  "FUM": null,
  "ReportingVehicles": [
    {
      "VehSeqId": null,
      "VIN": null,
      "WeightCategory": null,
      "WeightCategoryId": 64,
      "IsSuspended": true,
      "IsLogging": true,
      "IsAgriculture": true
    },
    {
      "VehSeqId": null,
      "VIN": null,
      "WeightCategory": null,
      "WeightCategoryId": 64,
      "IsSuspended": true,
      "IsLogging": true,
      "IsAgriculture": true
    }
  ],
  "CreditVehicles": [
    {
      "VehSeqId": null,
      "CreditType": null,
      "PrevFiledTaxYear": null,
      "PrevFiledFUM": null,
      "PrevFiledGW": null,
      "IsLogging": true,
      "SoldDetails": {
        "SoldDate": null
      },
      "DestroyedDetails": {
        "DestroyedDate": "12/12/2019"
      },
      "StolenDetails": {
        "StolenDate": "12/12/2019"
      }
    },
    {
      "VehSeqId": null,
      "CreditType": null,
      "PrevFiledTaxYear": null,
      "PrevFiledFUM": null,
      "PrevFiledGW": null,
      "IsLogging": true,
      "SoldDetails": {
        "SoldDate": null
      },
      "DestroyedDetails": {
        "DestroyedDate": "12/12/2019"
      },
      "StolenDetails": {
        "StolenDate": "12/12/2019"
      }
    }
  ]
}

Response

Name Type Description
StatusCode integer

StatusName string

StatusMessage string

TotTaxAmt decimal number

TotCreditAmt decimal number

TotVehCnt integer

SuccessRecords CalculateTaxSuccessResponse

ErrorRecords CalculateTaxFailureResponse

Errors Collection of Error

Response Formats

application/json, text/json

Sample:
{
  "StatusCode": 200,
  "StatusName": null,
  "StatusMessage": null,
  "TotTaxAmt": 1.0,
  "TotCreditAmt": 2.0,
  "TotVehCnt": 3,
  "SuccessRecords": {
    "ReportingVehiclesDetails": [
      {
        "VehSeqId": null,
        "WeightCategory": null,
        "TaxAmount": 1.0
      },
      {
        "VehSeqId": null,
        "WeightCategory": null,
        "TaxAmount": 1.0
      }
    ],
    "CreditVehiclesDetails": [
      {
        "VehSeqId": null,
        "PrevFiledFUM": null,
        "PrevFiledGW": null,
        "CreditAmount": 1.0
      },
      {
        "VehSeqId": null,
        "PrevFiledFUM": null,
        "PrevFiledGW": null,
        "CreditAmount": 1.0
      }
    ]
  },
  "ErrorRecords": {
    "ReportingVehicles": [
      {
        "Errors": [
          {
            "VehSeqId": "1",
            "Code": "404",
            "Name": "NotFound",
            "UserMessage": "Record not found",
            "APIMessage": "Record not found",
            "Type": "Error"
          },
          {
            "VehSeqId": "1",
            "Code": "404",
            "Name": "NotFound",
            "UserMessage": "Record not found",
            "APIMessage": "Record not found",
            "Type": "Error"
          }
        ]
      },
      {
        "Errors": [
          {
            "VehSeqId": "1",
            "Code": "404",
            "Name": "NotFound",
            "UserMessage": "Record not found",
            "APIMessage": "Record not found",
            "Type": "Error"
          },
          {
            "VehSeqId": "1",
            "Code": "404",
            "Name": "NotFound",
            "UserMessage": "Record not found",
            "APIMessage": "Record not found",
            "Type": "Error"
          }
        ]
      }
    ],
    "CreditVehicles": [
      {
        "Errors": [
          {
            "VehSeqId": "1",
            "Code": "404",
            "Name": "NotFound",
            "UserMessage": "Record not found",
            "APIMessage": "Record not found",
            "Type": "Error"
          },
          {
            "VehSeqId": "1",
            "Code": "404",
            "Name": "NotFound",
            "UserMessage": "Record not found",
            "APIMessage": "Record not found",
            "Type": "Error"
          }
        ]
      },
      {
        "Errors": [
          {
            "VehSeqId": "1",
            "Code": "404",
            "Name": "NotFound",
            "UserMessage": "Record not found",
            "APIMessage": "Record not found",
            "Type": "Error"
          },
          {
            "VehSeqId": "1",
            "Code": "404",
            "Name": "NotFound",
            "UserMessage": "Record not found",
            "APIMessage": "Record not found",
            "Type": "Error"
          }
        ]
      }
    ]
  },
  "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"
    }
  ]
}