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 4 Current »

Usage


Allows the Next Billing Date to be altered within the Debitsuccess Billing System. This will override any existing Payment Schedule in terms of the next date of Payment. Payments owing will continue to accrue based on payment schedules irrespective of a change to the Next Billing Date.
The next payment date must be within 1 week if it’s a weekly schedule and within 2 weeks for any other schedule frequency.

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 account reference

ExternalAccountReferenceNo

String

50

Optional*

External account reference

NextPaymentDate

DateTime


Required

New date of next payment. Date must be greater than the current date and/or account start date.

Must be formatted as YYYY-MM-DD

* 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

  • Code

String


  • Note

String


  • NoteType

Enum

Error, Warning, Info

Status

Enum

Failed, Succeed, Unknown


Error Messages

TypeError CodeError Message
Error12016Missing required reference number. Must provide either ExternalAccountReferenceNo or AccountReferenceNo or both.
Error12031Missing NextPaymentDate parameter
Error13120NextPaymentDate must not be today or in the past
Warning14020DateTime field '{0}' contains time part, but the time is ignored by message.
Error02Invalid user credentials
Error08There is no record found with this criteria
Error10Account is not active
Error07Multiple accounts found with this criteria
Error13123NextPaymentDate must not be before the account start date
Error13121NextPaymentDate must not be more than 7 days later than current payment date
Error13122NextPaymentDate must not be more than 14 days later than current payment date
Info00Success

Related Pages

Filter by label

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

On this page:




  • No labels

0 Comments

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.