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 0 or 1 (False=0 or True=1).

Request #

Example #

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://kleverlogic.com/webservices/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:GetAllMonthlies>
         <web:securityToken>YOUR_SECURITY_TOKEN</web:securityToken>
         <web:locationID>LOCATION_ID</web:locationID>
         <web:includeValid>VALID</web:includeValid>
         <web:includeInvalid>INVALID</web:includeInvalid>
         <web:includeDeleted>DELETED</web:includeDeleted>
      </web:GetAllMonthlies>
   </soapenv:Body>
</soapenv:Envelope>

Parameters #

Value	Required Field	Description	Data Type
YOUR_SECURITY_TOKEN	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)
LOCATION_ID	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: 0 or 1 0 is interpreted as false, meaning that the response will exclude Valid Accounts in the Flash PARCS db. 1 is interpreted as true, meaning that the response will include Valid / Active Accounts in the Flash PARCS db.	integer (0 or 1)
IncludeINVALID	Yes	IncludeINVALID can be one of two values: 0 or 1 0 is interpreted as false, meaning that the response will exclude Invalid Accounts in the Flash PARCS db. 1 is interpreted as true, meaning that the response will include Invalid / Inactive Accounts in the Flash PARCS db.	integer (0 or 1)
IncludeDELETED	Yes	IncludeDELETED can be one of two values: 0 or 1 0 is interpreted as false, meaning that the response will exclude Deleted Accounts in the Flash PARCS db.1 is interpreted as true, meaning that the response will include Deleted Accounts in the FlashPARCS db.	integer (0 or 1)

Response #

Example #

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <GetAllMonthliesResponse xmlns="http://kleverlogic.com/webservices/">
         <GetAllMonthliesResult
<GetAllMonthliesResult>
        <Code>Success or GeneralFailure or InvalidLogin or InvalidLocation or NotFound</Code>
        <Message>string</Message>
        <Accounts>
          <MonthlyAccountLite>
            <AccountNumber>string</AccountNumber>
            <Status>string</Status>
            <FlashAccountNumber>int</FlashAccountNumber>
            <IsDeleted>boolean</IsDeleted>
          </MonthlyAccountLite>
          <MonthlyAccountLite>
            <AccountNumber>string</AccountNumber>
            <Status>string</Status>
            <FlashAccountNumber>int</FlashAccountNumber>
            <IsDeleted>boolean</IsDeleted>
          </MonthlyAccountLite>
        </Accounts>
      </GetAllMonthliesResult>
    </GetAllMonthliesResponse>
  </soap:Body>
</soap:Envelope>

Parameters #

The response should include a MonthlyAccountResult 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