ClassIT+ API Methods: AvailableForMonth

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

Method Definition

Http Method: POST

Authorization header: Bearer JWT

URL: <Environment URL>/Account/AvailableForMonth 

AvailableForMonth Method JSON Result

Result Status	Result 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.” }

 

AvailableForMonth Method Result Definition

JSON Properties	Description	Data Type
Success	Identifies if the method call completed successfully.	Boolean
PeriodStart	Starting date for the month.	Datetime
PeriodEnd	Ending date for the month.	Datetime
AllowedTotal	Total number of allowed transactions per month.	Integer
CurrentCount	Total number of used transactions.	Integer
AvailableTotal	Remaining number of transactions available for the month.	Integer
ErrorMessage	Error description.	String