This MonthlyAccount call includes a childMonthlyAccountType field that allows the Child Account Group to be set for a Master Account.
Updated Delete Logic – If an account is Deleted you CAN’T restore it, a new account will need to be created. The difference with using MonthlyAccount5 is MA5 restore a previously Deleted account if an Update call is sent.
POST #
POST /api/monthly/MonthlyAccount6 #
securityToken: “string”
{
"AccountNumber": "string",
"AccountType": "Monthly",
"ActionType": "string",
"Address": "string",
"Address2": "string",
"AllowPassback": true,
"ChildMonthlyAccountType": "Monthly",
"City": "string",
"CompanyCode": "string",
"CompanyName": "string",
"Department": "string",
"LateFeeOnKiosks": true,
"MasterAccountNumber": "string",
"MemberSetting": "string",
"Parks": 0,
"PoolName": "string",
"Profile": "string",
"ReportGroup": "string",
"ReservedParking": true,
"StartDate": "string",
"State": "string",
"Status": "Active",
"ValidUntil": "string",
"ZipCode": "string",
"LocationId": "string"
}
Parameters #
| Value | Required Field | Description | Data Type |
securityToken | Yes | We provide you with a security token in GUID format Note that this security token will differ from location to location. Your security token for the Monthly API is not used globally across all locations. We will provide you with a different security token per each location you create monthly accounts for. | string (GUID format) |
AccountNumber | Yes | Third Party system generated unique value. This can match the account number in your system. This account number is external and different from the internal account number generated by the Flash system. In order, to delete or update a monthly account generated by a third party system, this external AccountNumber will be required in the API request. | string |
AccountType | Yes | The account type can be one of four values: Monthly, Resident, Membership or Master (case-sensitive)
| string (Monthly, Resident, Membership, Master) |
ActionType | Yes | The action type can be one of three values: Add, Update, or Delete (case-sensitive)Add will create a new monthly account with the details you provideUpdate will update the details of the monthly accountDelete will deactivate the monthly account and clear access information as AVI Tag, Prox Card/RFID, The ID Card, the ID Tag, Decal, and PIN. | string (Add, Update, or Delete) |
Address | Yes | An address to associate with the monthly account. | string |
Address2 | A second line to the address to associate with the monthly account. | string | |
AllowPassback | Yes | AllowPassback can be one of two values: true or falsefalse, meaning that the account will not have passback availabletrue, meaning that the account will have passback available.Note that if this field is set to true, the number of PARKS will be automatically increased to 999 and no further action is required for Passback to be enabled. When Passback is turned on do not manually change the PARKS value. | boolean (true or false) |
ChildMonthlyAccountType | You can assign the dedicated Child Account Group when the Account Type is set to Master. | string( Monthly) | |
City | Yes | The city that the address is located in. | string |
CompanyCode | Optional value to reference a company by its code in your system. This allows the client to identify their own companies within some of our reports. | string | |
CompanyName | A company name to associate with the monthly account. | string | |
Department | You can assign a department within the company provided as | string | |
LateFeeOnKiosks | Yes | true or false
| boolean (true or false) |
MasterAccountNumber | Yes | Do not use unless directed by Flash Parking. | string |
MemberSetting | You can assign a Membership Profile within the membership profiles provided for membership profile setting purposes to the account. | string | |
Parks | Yes | The number of parking spaces the account is allowed to use. The minimum value for this field is 1. | integer (must be equal to or greater than 1) |
PoolName | If applicable, we will provide you with a value for the PoolName to tie the account to an existing pool in our administrative portal for reporting purposes. | string | |
Profile | If applicable, to apply a profile to the account add the profile name as listed in the Flash portal. | string | |
ReportGroup | You can assign a report group within the report groups provided as ReportGroup for reporting purposes to the account | string | |
ReservedParking | Yes | A true or false value that indicates if the monthly parkers has Reserved Parking. | boolean (true or false) |
StartDate | If the account is expected to start parking on a specific date (such as the beginning of next month) you can provide a datetime value in the UTC timezone, and of the following format:yyyy-mm-ddThh:mm:ssFor example, March 11, 2025 at 11:00:00 PM UTC would be provided as: 2025-03-12T05:00:00 | datetime (yyyy-mm-ddThh:mm:ss) | |
State | Yes | The two letter abbreviation for state that the address is located in. | string |
Status | Yes | The status can be one of two values: Active or Inactive.If the status is set to Inactive, this will set the parks value to 0. The opposite transition does not have the opposite effect; updating from Inactive to Active will not update the parks field to its original value – that must be done manually. | string (Active or Inactive) |
ValidUntil | If the account is expected to expire at a specific date (such as in the case of hotel reservations) you can provide a datetime value in the UTC timezone, and of the following format:yyyy-mm-ddThh:mm:ssFor example, March 11, 2025 at 11:00:00 PM CST would be provided as: 2025-03-12T05:00:00 | datetime (yyyy-mm-ddThh:mm:ss) | |
ZipCode | Yes | The zip code for the provided address. | string |
LocationId | Yes | We provide you with a location ID in GUID format. The location ID corresponds with the location you are creating monthly accounts for. | string (GUID format) |
Response #
Example #
{
"Code": "Success",
"Message": "string",
"LocationProfiles": [
{
"UniqueID": "00000000-0000-0000-0000-000000000000",
"Name": "string"
}
]
}
Parameters #
The response should include a MonthlyAccount6Result object with the following data:
| Field | Description |
Code | If the request succeeded, the value of RESULT_CODE will be Success. If the request failed, a relevant error code will be provided. |
Message | A message with clarifying information about the result is provided in this field. |
FAQ #
Will this allow the same RFID card number to be used on more than one contact in the same location? #
This call will not allow the use of the same RFID Card number on more than one contact on the same location. The Code in the response will be GeneralFailure and the Message will read RFID Tag already exists.