GetCustomerAccountByAccountId / GetCustomerAccountWithFeesByAccountID

• Username

String

Required

Provided by Debitsuccess

• Password

String

Required

Provided by Debitsuccess

String

100

Optional

Optional – allows requesting user to be logged

String

15

Optional*

Debitsuccess account reference

String

50

Optional*

External account reference

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)

Total overdue amount for the account (including any Debitsuccess fees)

Note: this value can also include uncleared payments which may subsequently reverse

·      OverdueAmountWithoutFees

Decimal (10, 2)

Overdue amount without Debitsuccess establishment or penalty fees.

Note: this value can also include uncleared payments which may subsequently reverse

·      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 ()**

o  StartDate**

DateTime?

o  Installment**

Decimal? (10, 2)

o  PaymentFrequency**

Enum

OneOff

o  PaymentCode**

Enum

DebtCallFee

EstablishmentFee

MiscellaneousFee

PenaltyFee

Service

TransferFee

o  Description**

String

o  ScheduleId**

int

Unique identifier

·      OneOffSchedules ()

o  StartDate

DateTime?

o  Installment

Decimal? (10, 2)

o  PaymentFrequency

Enum

OneOff

o  Description

String

Description

o  ScheduleId

int

Unique identifier

·      RecurringSchedules ()

o  StartDate

DateTime?

o  EndDate

DateTime?

o  Installment

Decimal? (10, 2)

o  PaymentFrequency

Enum

Weekly, Fortnightly, FourWeekly, Monthly, BiMonthly, Quarterly

o  Description

String

o  ScheduleId

int

Unique identifier

·      SuspensionSchedules ()

o  StartDate

DateTime?

o  EndDate

DateTime?

o  Installment

Decimal? (10, 2)

o  PaymentFrequency

Enum

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

o  Description

String

o  ScheduleId

int

Unique identifier

·      Customer

o  CustomerDetail

§  DateOfBirth

DateTime?

§  Gender

Enum

Male, Female, Unknown

§  FirstName

String

§  MiddleName

String

§  LastName

String

§  Title

String

o  Contacts

ContactDetails

§  Phones ()

·      PhoneNumberType

Enum

Home, Mobile, Work, Emergency, Previous