Skip to main content

Customer Profile

Customer profile including personal details, contact information, address, and account dates.

abnstring

Australian Business Number.

address object

Customer postal address.

address1stringrequired

Address line 1.

address2string

Address line 2.

countrystringrequired

Country.

Max length: <= 100 characters

postcodestringrequired

Postcode.

statestringrequired

State / province.

Max length: <= 50 characters

suburbstringrequired

Suburb / city.

Max length: <= 50 characters

bPayReferencestring

BPay reference number for the customer.

companyNamestring

Name of the customer company.

customerCodestring

Unique code assigned to the customer.

customerReferencestring

Unique reference identifier for the customer.

customerStatusstring

Current status of the customer account.

dateClosedstring<date-time>

Date the customer account was closed.

dateOfBirthstring<date-time>

Customer date of birth.

emailstring

Customer email address.

enableBPayOptionboolean

Whether BPay payment option is enabled for this customer.

faxstring

Customer fax number.

firstNamestring

Customer first name.

lastNamestring

Customer last name.

merchantStaffMemberstring

Staff member assigned to the customer.

mobilestring

Customer mobile phone number.

openDatestring<date-time>

Date the customer account was opened.

phonestring

Customer phone number.

titlestring

Customer title (e.g. Mr, Mrs, Ms).

Customer Profile
{
"abn": "string",
"address": {
"address1": "string",
"address2": "string",
"country": "string",
"postcode": "string",
"state": "string",
"suburb": "string"
},
"bPayReference": "string",
"companyName": "string",
"customerCode": "string",
"customerReference": "string",
"customerStatus": "string",
"dateClosed": "2024-07-29T15:51:28.071Z",
"dateOfBirth": "2024-07-29T15:51:28.071Z",
"email": "string",
"enableBPayOption": true,
"fax": "string",
"firstName": "string",
"lastName": "string",
"merchantStaffMember": "string",
"mobile": "string",
"openDate": "2024-07-29T15:51:28.071Z",
"phone": "string",
"title": "string"
}