Skip to main content

ClassIT+ API Methods: AvailableForMonth

Updated
ClassIT+™

 

The AvailableForMonth method retrieves information about the number of transactions available for the current month.

Endpoints

  • Sandbox URL: https://Snbxapi-ar.nmfta.org/api/v1.0/activityreport/AvailableForMonth 
  • Production URL: https://Api-ar.classitplus.com/api/v1.0/activityreport/AvailableForMonth

Method Definition

  • Http Method: POST
  • Authorization header: Bearer JWT

Method JSON Result

Result StatusResult JSON String
Success

{
"currentCount": 5,
"allowedTotal": 1000000,
"availableTotal": 999995,
"periodStart": "2024-09-01T00:00:00",
"periodEnd": "2024-09-30T00:00:00",
"success": true,
"errorMessage ": null
}

Failure

{
"success": false,
"errorMessage ": “There was a problem with your request.”
}

Method Result Definition

JSON PropertiesDescriptionData Type
SuccessIdentifies if the method call completed successfully.
  • Boolean
PeriodStartStarting date for the month.
  • Datetime
PeriodEndEnding date for the month.
  • Datetime
AllowedTotalTotal number of allowed transactions per month.
  • Integer
CurrentCountTotal number of used transactions.
  • Integer
AvailableTotalRemaining number of transactions available for the month.
  • Integer
ErrorMessageError description.
  • String

 

 

 

All content © Copyright 2025 National Motor Freight Traffic Association, Inc.™ All Rights Reserved.

Related articles