Page Comparison

User

• Username

String

Required

Provided by Debitsuccess

• Password

String

Required

Provided by Debitsuccess

RequestInitiator

String

100

Optional

Optional – allows requesting user to be logged

StartDate

DateTime

Required

Start of the reporting period

EndDate

DateTime?

Optional

End of the reporting period

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

Accounts ()

• Term

int

Length of term

• TermType

Enum

Months, Payments

• AccountCode

String

Account code from contract

• AccountNotes     

String

Free form notes field.

• AccountReferenceNo

String

Debitsuccess Reference number

• ContractPrefix

String

Provided by Debitsuccess (allows customer accounts to be split into different organisational groups if required)

• ExternalAccountReferenceNo

String

Your account identifier

• NextBillingDate

DateTime?

Next date the account is due to be billed on

• LastBillingDate

DateTime?

Last date the account was billed on

• OverdueStatus

int

0, 1, 2, 3 (0 = Not overdue, 3 = last stage before being send to debt collection or written off)

• OverdueAmount

Decimal (10, 2)

• OverdueAmountWithoutFees

Decimal (10, 2)

Overdue amount without Debitsuccess establishment or penalty fees.

• FixedTerm

Boolean

true – account will be closed at the end of the minimum term

false – account will continue to bill after the minimum term

• LastReversalReason

String

Reason for last payment failure

• CancelReason

String

Reason account was closed

• Suspended

Boolean

true – payments are suspended (the amount owing will NOT continue to accrue while payments are suspended)

• SuspensionEndDate

DateTime

Date that suspension is due to end

• PaymentsStopped

Boolean

true – payments have been stopped (the amount owing will continue to accrue while payments are stopped)

• PaymentStopEndDate

DateTime

Date that the payment stop is due to end

• CurrentInstalment

Decimal (10, 2)

Current instalment amount

• CurrentFrequency

Enum

Current payment frequency

• CatchUpAmount

Decimal (10, 2)

Catch-up amount

• CatchUpEndDate

DateTime

End date for catch-up

• PaymentInAdvanceAmount

Decimal (10, 2)

Payment in advance amount

• PaymentInAdvanceEndDate

DateTime

End date for payment in advance

• DateAccountStarted

DateTime

• DateAccountClosed

DateTime

• DateAccountLoaded

DateTime

• LastUpdatedDate

DateTime

Date that the customer account or a related record was last updated

• MinTermTotalValue

Decimal (10, 2)

Amount to be collected for the account (in terms of recurring payments) before the account is past its minimum term

• OutstandingBalance

Decimal (10, 2)

For an open account, this returns the amount remaining for the account to pay

• OutstandingBalanceWithoutFees

Decimal (10, 2)

Outstanding balance without Debitsuccess establishment or penalty fees

• AccountTemplate

Guid

OMG contract template unique-identifier

• ProjectedFinishDate

DateTime

Calculated estimated time for the account finish date. This field is being calculated overnight.

• CurrentBalance

Decimal (10, 2)

This returns the difference between what should have been paid at the current date vs the amount already paid.

A positive amount means that the customer account is overdue and a negative amount means the account is in credit.

• CurrentBalanceWithoutFees

Decimal (10, 2)

Current balance excluding Debitsuccess fees.

• DSFeeSchedules ()**

• StartDate**

DateTime?

• Installment**

Decimal? (10, 2)

• PaymentFrequency**

Enum

OneOff

• PaymentCode**

Enum

DebtCallFee

EstablishmentFee

MiscellaneousFee

PenaltyFee

Service

TransferFee

• Description**

String

• ScheduleId**

int

Unique identifier

• OneOffSchedules ()

• StartDate

DateTime?

• Installment

Decimal? (10, 2)

• PaymentFrequency

Enum

OneOff

• Description

String

Description

• ScheduleId

int

Unique identifier

• RecurringSchedules ()

• StartDate

DateTime?

• EndDate

DateTime?

• Installment

Decimal? (10, 2)

• PaymentFrequency

Enum

Weekly, Fortnightly, FourWeekly, Monthly, BiMonthly, Quarterly

• Description

String

• ScheduleId

int

Unique identifier

• SuspensionSchedules ()

• StartDate

DateTime?

• EndDate

DateTime?

• Installment

Decimal? (10, 2)

• PaymentFrequency

Enum

OneOff, Weekly, Fortnightly, FourWeekly, Monthly, BiMonthly, Quarterly

• Description

String

• ScheduleId

int

Unique identifier

• Customer

• CustomerDetail

• DateOfBirth

DateTime?

• Gender

Enum

Male, Female, Unknown

• FirstName

String

• MiddleName

String

• LastName

String

• Title

String

• Contacts

ContactDetails

• Phones ()

•  PhoneNumberType

Enum

Home, Mobile, Work, Emergency, Previous

• CountryCode

Enum

NotSpecified, Aus, NZ, USA

• StdCode

String

• Number

String

• Preferred

Boolean

• Name

String

§  Emails ()

• EmailAddress

String

• Preferred

Boolean

§  Addresses ()

• AddressType

Enum

Home, Business, Physical, Postal, Previous

• Street                       

String

• Suburb

String

• City

String

• State

Enum

See table

• Postcode    

String

• Country

Enum

NotSpecified, Australia, NewZealand, UnitedStatesOfAmerica

• Locality

String

• Preferred

Boolean

Whether the address is preferred (true or false)

• Paymethod

• AccountNo      

String

• ExpiryDate

DateTime

• AccountHolder

String

• AccountType

Enum

BankAccount, CreditCard

• CreditCardType

Enum

None, AmericanExpress, Mastercard, Visa