GetMonthlyAccount1 (REST)

GetMonthlyAccount1 returns top-level monthly account details for a specified location. This account can have multiple contacts and vehicles attached to it. This call can be used for all types of accounts: Monthly, Membership, Residential, and Master Accounts.

GET #

GET /api/monthly/GetMonthlyAccount1 #

securityToken: string (GUID format)
locationId: string (GUID format)
AccountNumberType: string
AccountNumber: 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)
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)
AccountNumberType	Yes	When passing through this value it will identify whether or not the Account Number being passed through is the Third Party System Generated Unique Value or the Flash Account number.	string
AccountNumber	Yes	Third Party system generated unique value for the Flash Internal account number. The Third Party Unique account number is external and different from the internal account number generated by the Flash system.	string

Response #

Example #

{
  "AccountType": "Monthly",
  "Address": "string",
  "Address2": "string",
  "AllowPassback": true,
  "Cars": [
    {
      "VehicleGuid": "00000000-0000-0000-0000-000000000000",
      "ExternalId": "string"
    }
  ],
  "City": "string",
  "CompanyCode": "string",
  "CompanyName": "string",
  "Contacts": [
    {
      "ContactGuid": "00000000-0000-0000-0000-000000000000",
      "ExternalId": "string"
    }
  ],
  "Department": "string",
  "ExternalId": "string",
  "LateFeeOnKiosk": true,
  "LocationID": "string",
  "MasterAccountNumber": 0,
  "MembershipSetting": "string",
  "MonthlyAccountGuid": "00000000-0000-0000-0000-000000000000",
  "MonthlyAccountNumber": 0,
  "Parks": 0,
  "PoolName": "string",
  "Profile": "string",
  "ReportGroup": "string",
  "State": "string",
  "Status": "Automatic",
  "ValidUntil": "2025-10-31T13:58:39.538Z",
  "Zipcode": "string",
  "Code": "Success",
  "Message": "string"
}

Parameters #

The response should include a GetMonthlyAccount1 object with the following data:

Field	Description
AccountType	‘Monthly’, ‘Resident’, ‘Membership’, ‘Master’
Address	Address associated with the monthly account.
Address2	A second line to the address associated with the monthly account.
AllowPassback	True or False. false, meaning that the account will not have passback available. true, meaning that the account will have passback available.
Cars	Car Profile.
VehicleGuid	Each vehicle has a unique GUID.
ExternalId	Car’s external ID.
City	The city that the address is located in.
CompanyCode	This allows the client to identify their own companies within some of our reports.
CompanyName	Company name associated with the monthly account.
Contacts	Contact Profile.
ContactGuid	Each contact has a unique GUID.
ExternalId	Contact’s external ID.
Department	Department assigned within the company provided as CompanyName for reporting purposes to the account.
ExternalId	Account’s External ID.
LateFeeOnKiosk	True or False. False, meaning that late fees will be applied on the account and will be billed accordingly. True, meaning that late fees will be collected from the Flash PARCS kiosk.
LocationID	Location ID, GUID format.
MasterAccountNumber	Master account number generated by the system.
MembershipSetting	Membership profile assigned to the account.
MonthlyAccountGuid	Each account has a unique GUID.
MonthlyAccountNumber	Monthly account number generated by the system.
Parks	The number of parking spaces the account is allowed to use.
PoolName	Pool Name tied to the account to an existing pool in our administrative portal for reporting purposes.
Profile	Profile name as listed in the Flash Admin portal.
ReportGroup	Report group assigned in the Flash Admin portal.
State	States whether the account is Active or Inactive.
Status	‘Automatic’, ‘Valid’, ‘Invalid’
ValidUntil	Date the account is set to expire at.
Zipcode	The zip code for the provided address.
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.