Sections:

1. Description
2. Oempro Version
3. Request Parameters
4. Response Parameters
5. Error Codes

User.PaymentPeriods.Update

Description

Updates the payments period of a user

Oempro Version

4+

Request Parameters

SessionID = {string} (required)

Session ID which is needed to authenticate the access. It's optional and required for desktop applications only

Command = {User.Switch} (required)

API Command

ResponseFormat = {JSON | XML} (required)

Response format

JSONPCallBack = {bool}

Send this parameter for cross-domain. More info about JSONP can be found here: http: //en.wikipedia.org/wiki/JSON#JSONP

UserID = {integer} (required)

User to switch

LogID = {integer} (required)

Payment period to update

Discount = {double} (required)

Discount amount

IncludeTax = {Include | Exclude} (required)

To apply discount or not

PaymentStatus = {NA | Unpaid | Waiting | Paid | Waived} (required)

Payment status of the period

ReturnFormatted = {Yes | No} (required)

Returns numbers formatted or not

SendReceipt = {Yes | No} (required)

Sends receipt email to the user if set to 'Yes'

Response Parameters

Success = {true | false}

States if there is an error or not

ErrorCode = {integer}

If there is an error, error's code

ErrorText = {text}

PaymentPeriod = {array}

Returns the details of the updated payment period

Error Codes

1

User ID is missing

2

Invalid user information

3

Log ID is missing

4

Invalid payment period (log ID)

5

Invalid include tax parameter

6

Invalid payment status

99997

This is not an ESP Oempro license

99998

Authentication failure or session expired

99999

Not enough privileges

Stay connected!