Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Usage
Excerpt |
---|
Changes the start date of an account. |
This cannot be called for an account that has already started.
Parameters
Name | Data Type | Length | Description | |
---|---|---|---|---|
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 account reference |
ExternalAccountReferenceNo | String | 50 | Optional* | External account reference |
NewStartDate | DateTime | Required | Date that the account should start |
* At least one of the following parameters must be supplied: AccountReferenceNo, ExternalAccountReferenceNo
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
Type | Error Code | Error Message |
---|---|---|
Error | 13104 | Account is already active |
Error | 13100 | New start date must not be in the past |
Error | 13102 | The new start date must not be more than 1 year in the future |
Error | 12005 | Invalid Account.StartDate.The date must be in the future |
Error | 12002 | Missing client first name |
Warning | 14020 | DateTime field '{0}' contains time part, but the time is ignored by message. |
Error | 13200 | Title field cannot be more than 10 characters long. |
Error | 02 | Invalid user credentials |
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 | 10 | Account is not active |
Error | 07 | Multiple accounts found with this criteria |
Info | 00 | Success |
Related Pages
Filter by label (Content by label) | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Panel | |
---|---|
On this page:
|