Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Usage
| Excerpt |
|---|
Allows you to set or modify the termination date for a customer account. |
This method will not recalculate the total contract value of the account, only the expected end date.
Parameters
Name | Data Type | Length | Description | |
|---|---|---|---|---|
User | | |||
| String | | Required | Provided by Debitsuccess |
| String | | Required | Provided by Debitsuccess |
RequestInitiator | String | 100 | Optional | Optional – allows requesting user to be logged |
AccountReferenceNo | String | 15 | Optional* | Debitsuccess Reference number |
ExternalAccountReferenceNo | String | 50 | Optional* | Your account identifier |
TerminationDate | DateTime | Required | The expected end date of the account. Note: if the account already has a ‘Final Bill Date’ |
*At least one of the following parameters must be supplied: AccountReferenceNo, ExternalAccountReferenceNo. If either account is not active, then error 10 will be returned.
Response
Name | Data Type | Description |
|---|---|---|
DateCreated | DateTime | Date/time message was processed |
Id | String | Unique ID for the message |
ResponseNotes () | Collection of validation messages | |
| String | |
| String | |
| Enum | Error, Warning, Info |
Status | Enum | Failed, Succeed, Unknown |
Error Messages
Need info
Type | Error Code | Error Message |
|---|---|---|
Error | 02 | Invalid user credentials |
Error | 14091 | Termination date cannot be in the past |
Error | 12016 | Missing required reference number. Must provide either ExternalAccountReferenceNo or AccountReferenceNo or both |
Error | 08 | There is no record found with this criteria |
Error | 07 | Multiple accounts found with this criteria |
Error | 10 | Account is not active |
Related Pages
| Filter by label (Content by label) | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| Panel | |
|---|---|
On this page:
|