AdjustSuspensionEndDate

Usage

Changes the end date of an existing suspension to any date after the suspension start date when equal or larger than today.

If no value for the new end date is given, the suspension will change to an open-ended suspension.

Name	Data Type	Length		Description
User
Username	String		Required	Provided by Debitsuccess
Password	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
PayScheduleId	Integer		Required	Schedule Id of suspension
NewEndDate	DateTime		Optional	New end date of suspension

_{* At least one of the following parameters must be supplied:}AccountReferenceNo, ExternalAccountReferenceNo

Name	Data Type	Description
DateCreated	DateTime	Date/time message was processed
Id	String	Unique ID for the message
ResponseNotes ()		Collection of validation messages
Code	String
Note	String
NoteType	Enum	Error, Warning, Info
Status	Enum	Failed, Succeed, Unknown

Type	Error Code	Error Message
Error	13141	Suspension for given PayScheduleId not found
Error	13142	Suspension already finished
Error	13143	Adjusted suspension is overlapping with existing one
Error	13144	New suspension end date must not be before suspension start date
Error	13145	New suspension end date must not be in the past
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

There are no items with the selected labels at this time.

On this page:

REST API

PATCH Schedule (Suspension)