Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Current »

Usage


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




  • 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 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

  • Code

String


  • Note

String


  • NoteType

Enum

Error, Warning, Info

Status

Enum

Failed, Succeed, Unknown


Error Messages

TypeError CodeError Message
Error02Invalid user credentials
Error14091Termination date cannot be in the past
Error12016Missing required reference number. Must provide either ExternalAccountReferenceNo or AccountReferenceNo or both
Error08There is no record found with this criteria
Error07Multiple accounts found with this criteria
Error10Account is not active

Related Pages

Filter by label

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

On this page:




  • No labels