GetAllMonthlies (REST)

GetAllMonthlies returns an array of all top-level monthly accounts for a specified location. It includes Monthly, Membership, Residential, and Master Accounts. This endpoint has a few filters to return Valid, Invalid, Deleted based on a boolean value true or false.

GET #

GET /api/monthly/GetAllMonthlies #

securityToken: string (GUID format)
locationId: "string"
includeValid: boolean (true or false)
includeInvalid: boolean (true or false)
includeDeleted: boolean (true or false)

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)
includeValid	Yes	IncludeVALID can be one of two values: true or false false, meaning that the response will exclude Valid Accounts in the Flash PARCS db. true, meaning that the response will include Valid / Active Accounts in the Flash PARCS db.	boolean (true or false)
includeInvalid	Yes	IncludeINVALID can be one of two values: 0 or 1 false, meaning that the response will exclude Invalid Accounts in the Flash PARCS db. true, meaning that the response will include Invalid / Inactive Accounts in the Flash PARCS db.	boolean (true or false)
includeDeleted	Yes	IncludeDELETED can be one of two values: 0 or 1 false, meaning that the response will exclude Deleted Accounts in the Flash PARCS db. true, meaning that the response will include Deleted Accounts in the Flash PARCS db.	boolean (true or false)

Response #

Example #

{
  "Code": "Success",
  "Message": "string",
  "Accounts": [
    {
      "MonthlyAccountType": "string",
      "AccountNumber": "string",
      "Status": "string",
      "FlashAccountNumber": 0,
      "IsDeleted": true
    }
  ]
}

Parameters #

The response should include a Accounts object with the following data per each monthly account:

Field	Description
MonthlyAccountType	Whether the account is a Monthly, Membership, or Resident parker.
AccountNumber	The account number as shown on your platform.
Status	Whether the account is valid or invalid.
FlashAccountNumber	The account number as shown in the Flash database.
IsDeleted	If the account is deleted, this value is true. If the account is not deleted, this value is false.