Important!
This documentation has been deprecated. We are migrating Oempro help articles to our new help portal. Take a look at more detailed help articles on our new help portal.
Sections:
- Description
- Oempro Version
- Request Parameters
- Response Parameters
- Error Codes
User.PaymentPeriods
Description
Returns the list of payments periods for a user (includes totals)
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
- PaymentStatus = {NA | Unpaid | Waiting | Paid | Waived} (required)
- Enter one of the options to filter the list
- ReturnFormatted = {Yes | No} (required)
- Returns numbers formatted or not
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}
-
- PaymentPeriods = {array}
- List of payment periods
Error Codes
- 1
- User ID is missing
- 2
- Invalid user information
- 3
- Invalid payment status value
- 99997
- This is not an ESP Oempro license
- 99998
- Authentication failure or session expired
- 99999
- Not enough privileges
Stay connected!
