View Categories

MonthlyAccount (REST)

4 min read

MonthlyAccount creates a top-level monthly account for a specified location. This account can have multiple contacts and vehicles attached to it.

Request #

Example #

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://kleverlogic.com/webservices/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:MonthlyAccount>
      <web:securityToken>YOUR_SECURITY_TOKEN</web:securityToken>
      <web:locationID>LOCATION_ID</web:locationID>
      <web:actionType>ACTION_TYPE</web:actionType>
      <web:accountType>ACCOUNT_TYPE</web:accountType>
      <web:accountNumber>ACCOUNT_NUMBER</web:accountNumber>
      <web:masterAccountNumber>MASTER_ACCOUNT_NUMBER</web:masterAccountNumber>
      <web:companyName>COMPANY_NAME</web:companyName>
      <web:companyCode>COMPANY_CODE</web:companyCode>
      <web:address>ADDRESS</web:address>
      <web:address2>ADDRESS_2</web:address2>
      <web:city>CITY</web:city>
      <web:state>STATE</web:state>
      <web:zipcode>ZIPCODE</web:zipcode>
      <web:validUntil>VALID_UNTIL</web:validUntil>
      <web:status>STATUS</web:status>
      <web:parks>PARKS</web:parks>
      <web:profile>PROFILE</web:profile>
      <web:allowPassback>ALLOW_PASSBACK</web:allowPassback>
      <web:startDate>START_DATE</web:startDate>
      <web:lateFeeOnKiosk>LATE_FEE_ON_KIOSK</web:lateFeeOnKiosk>
      <web:department>DEPARTMENT</web:department>
    </web:MonthlyAccount>
  </soapenv:Body>
</soapenv:Envelope>

Parameters #

ValueRequired FieldDescriptionData Type
YOUR_SECURITY_TOKENYesWe 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)
LOCATION_IDYesWe provide you with a location ID in GUID format. The location ID corresponds with the location you are creating monthly accounts forstring (GUID format)
ACTION_TYPEYesThe 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 provide
Update will update the details of the monthly account
Delete will deactivate the monthly account and clear access information as Prox Card/RFID, The ID Card, the ID Tag, Decal, and PIN.		string (Add, Update, or Delete)
ACCOUNT_TYPEYesThe account type can be one of four values: Monthly, Resident, Membership or Master (case-sensitive)
  • Monthly
  • Resident
  • Membership
  • Master
string (Monthly, Resident, Membership, Master)
ACCOUNT_NUMBERYesThird 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 Flashparking system. In order, to delete or update a monthly account generated by a third party sytem, this external Account_Number will be required in the api request.string
MASTER_ACCOUNT_NUMBERDo not use unless instructed by Flashstring
COMPANY_NAMEA company name to associate with the monthly accountstring
COMPANY_CODEOptional 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
ADDRESSYesAn address to associate with the monthly accountstring
ADDRESS_2A second line to the address to associate with the monthly accountstring
CITYYesThe city that the address is located instring
STATEYesThe two letter abbreviation for state that the address is located instring
ZIPCODEYesThe zip code for the provided addressstring
VALID_UNTILIf 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, military time, and of the following format:

yyyy-mm-ddThh:mm:ss

For example, March 11, 2019 at 11:00:00 PM CST would be provided as:

2019-03-12T05:00:00		datetimeutc
STATUSYesThe 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)
PARKSYesThe number of parking spaces the account is allowed to use. The minimum value for this field is 1integer (must be equal to or greater than 1)
PROFILEIf applicable, we will provide you with a GUID corresponding to the profile to be applied to the monthly accountProfile Name
ALLOW_PASSBACKYesALLOW_PASSBACK can be one of two values: 0 or 1

  • 0 is interpreted as false, meaning that the account will not have passback available.

  • 1 is interpreted as true, meaning that the account will have passback available. Note that if this field is set to 1, 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.
integer (0 or 1)
START_DATEYesIf 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:ss

For example, March 11, 2019 at 11:00:00 PM UTC would be provided as:

2019-03-12T05:00:00		datetime
LATE_FEE_ON_KIOSKYesLATE_FEE_ON_KIOSK can be one of two values: 0 or 1
  • 0 is interpreted as false, meaning that late fees will be applied on the account and will be billed accordingly1 is interpreted as true, meaning that late fees will be collected from the FlashPARCS kiosk
integer (0 or 1)
DEPARTMENTYou can assigned a department within the company provided as COMPANY_NAME for reporting purposes to the accountstring
POOL_NAMEIf applicable, we will provide you with a value for the POOL_NAME to tie the account to an existing pool in our administrative portal for reporting purposesstring

Response #

Example #

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <MonthlyAccountResponse xmlns="http://kleverlogic.com/webservices/">
      <MonthlyAccountResult>
        <Code>RESULT_CODE</Code>
        <Message>RESULT_MESSAGE</Message>
      </MonthlyAccountResult>
    </MonthlyAccountResponse>
  </soap:Body>
</soap:Envelope>

Parameters #

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

FieldDescription
CodeIf the request succeeded, the value of RESULT_CODE will be Success. If the request failed, a relevant error code will be provided.
MessageA message with clarifying information about the result is provided in this field

Did you find this article helpful?