SetMonthlyAccountExternalID is an enhancement to our Monthly API to allow for Manually created accounts to be converted and controlled by the Monthly APIs. This allows customers to associate external IDs with existing Flash Accounts
Request #
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>
<SetMonthlyAccountExternalID xmlns="http://kleverlogic.com/webservices/">
<securityToken>YOUR_SECURITY_TOKEN</securityToken>
<locationID>LOCATION_ID</locationID>
<flashAccountNumber>FLASH_ACCOUNT_NUMBER</flashAccountNumber>
<accountGUID>ACCOUNT_GUID</accountGUID>
<accountNumber>ACCOUNT_NUMBER</accountNumber>
</SetMonthlyAccountExternalID>
</soap:Body>
</soap: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) |
FLASH_ACCOUNT_NUMBER | Yes | Flash system generated account number. | string |
ACCOUNT_GUID | Yes | Flash generated unique value in GUID format. | string (GUID format) |
ACCOUNT_NUMBER | Yes | Third Party system generated unique value or 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 #
<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>
<SetMonthlyAccountExternalIDResponse xmlns="http://kleverlogic.com/webservices/">
<SetMonthlyAccountExternalIDResult>
<Code>Success or GeneralFailure or InvalidLogin or InvalidLocation or NotFound</Code>
<Message>string</Message>
</SetMonthlyAccountExternalIDResult>
</SetMonthlyAccountExternalIDResponse>
</soap:Body>
</soap:Envelope>
Parameters #
The response should include a SetMonthlyAccountExternalID 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 |