PostCustomerAccount

Usage

Allows customer and account details to be loaded into the Debitsuccess system for billing. This call can also be used to create B2B (business) type accounts.

Notes:

If the parameters in the Customer Details section are passed without MiddleName, LastName, and Title, the account will be considered as a Business account. Use the FirstName parameter for the name of the business.
If an account is created using PostCustomerAccount to start on a non-working day, the customer will be billed on the next working day.

Parameters

Name	Data Type	Length		Description
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
ContractPrefix	String	6	Required	Provided by Debitsuccess (allows customer accounts to be split into different organisational groups if required)
Customer Details
FirstName	String	40	Required	Maximum length 40 characters
MiddleName	String	40	Optional
LastName	String	40	Optional	Maximum length 40 characters
Title	String	10	Optional
DateOfBirth	DateTime
Gender	Enum		Optional	Male, Female, Unknown
Account Details
DateAccountStarted	DateTime		Required	Account Start Date (date establishment fee will be taken if applicable)
Term	Int		Required	Minimum term in months or payments
TermType	Enum		Required	Months, Payments
AccountCode	String	50	Optional	Maximum 50 characters. Allowed characters are a-zA-Z0-9_-
AccountNotes	String	10000	Optional	Free form notes field. Maximum length of 10000 characters
ExternalAccountReferenceNo	String	50	Optional	Your account identifier
FixedTerm	Bool		Required	true – account will be closed at the end of the minimum term false – account will continue to bill after the minimum term
AccountCountry	Enum		Required	Australia, NewZealand, UnitedStatesOfAmerica
FixTotalValue	Bool		Required	false – the total value of the account will be calculated based on the value of the recurring schedule and the term true – the total value of the account will be set to the value passed in the TotalValue property
TotalValue	Decimal (10, 2)		Required if FixTotalValue is true	Total value of recurring payments to be collected for account, For Term Value 'Payments', the value cannot exceed the number of payments in the term ^* the instalment and must be greater than (the number of payments in the term-1) ^* the instalment For Term Value 'Months', the value cannot exceed the number of payments in the term * the instalment and must be greater than 1 * the instalment. If the term type is specified in ‘Months’ the term starts on the account start date, not the recurring payments start date. e.g. if the account's term is 12 payments and the weekly recurring schedule has an instalment of $100 then 1100 <Total value <= 1200 e.g. if the account term is 2 months and the weekly recurring schedule has an instalment of $100 then 100 < Total value <= 900
WaiveEstFee	Bool		Optional	Can be used to override the establishment fee payer in case it is set to client by default and should be waived so that the facility pays the establishment fee.
Payment Method Details
AccountNo	String	35	Required	Bank account number (preceded by BSB for Australia), Credit card number. No spaces, dashes or any other non-alphanumeric character should be entered into the AccountNo property.
ExpiryDate	DateTime		Required if credit card	Credit card expiry date
AccountHolder	String	50	Required	Name of account, card holder. Maximum length of 50 characters
AccountType	Enum		Required	BankAccount, CreditCard
CreditCardType	Enum		Required	None, AmericanExpress, Mastercard, Visa
Payment Details
InitialOneOffScheduleStartDate	DateTime		Required if One off instalment > 0	Date initial one-off payment should be taken on. The account can be billed on the day of submission as long as the call is made before the Debitsuccess cut-off time. If the day of submission is provided after the cut-off time, this date will be set to the next available working date.
InitialOneOffScheduleInstalment	Decimal (10, 2)		Optional^*	Amount of initial one-off payment
InitialOneOffScheduleDescription	String	50	Optional	Optional description of the one-off payment
InitialScheduleExternalIdentifier	Varchar	50	Optional	Use this if you require an additional reference number to be associated with the schedule itself. For example: If you wish to test that all schedules are unique and are generating your own reference number.
RecurringScheduleStartDate	DateTime		Required if recurring instalment > 0	Regular payment start date
RecurringScheduleInstalment	Decimal (10, 2)		Optional^*	Regular payment amount
RecurringScheduleFrequency	Enum		Required if recurring instalment > 0	Weekly, Fortnightly, FourWeekly, Monthly, BiMonthly, Quarterly (Note: OneOff frequency is part of the enumeration but is not valid for a recurring schedule)
RecurringScheduleDescription	String	50	Optional	Optional description of regular payment
RecurringScheduleExternalIdentifier				Use this if you require an additional reference number to be associated with the schedule itself. For example: If you wish to test that all schedules are unique and are generating your own reference number.
Address Details
PhysicalAddress	String	60	Optional^****	Physical Address line 1. Maximum length of 60 characters
PhysicalLocality	String	50	Optional^*****	Physical Address line 2
PhysicalSuburb	String	50	Required (Australia)	Maximum length of 50 characters
PhysicalCity	String	50	Required (NZ, USA)	Maximum length of 50 characters
PhysicalState	State		Required (Australia, USA)	State Codes
PhysicalCountry	Enum		Required	NotSpecified, Australia, NewZealand, UnitedStatesOfAmerica
PhysicalPostcode	String	10	Required	Maximum length of 10 characters
BillingAddress	String	60	Optional^****	Billing Address line 1
BillingLocality	String	50	Optional^*****	Billing Address line 2
BillingSuburb	String	50	Required for Australia if Billing Address line 1 is supplied
BillingCity	String	50	Required for NZ and UnitedStatesOfAmerica If Billing Address line 1 is supplied
BillingState	Enum		Required for Australia and UnitedStatesOfAmerica if Billing Address line 1 is supplied	State Codes
BillingCountry	Enum		Required if Billing Address line 1 is supplied	NotSpecified, Australia, NewZealand, UnitedStatesOfAmerica
BillingPostcode	String	10	Required if Billing Address line 1 is supplied
Other Contact Details
EmailAddress	String	75	Required	Email Address. Maximum length of 75 characters
HomeNumber	String