CustomerDetailsModel

Contains customer details data

Methods

The following API methods use this data model.

• Retrieve Customer Detail

Required Fields

groupKey

uuid

The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
account will share the same GroupKey value. GroupKey values cannot be changed once created.

For more information, see Accounts and GroupKeys.

customerId

uuid

The unique ID of this customer

contactId

uuid

Customer primary contact id

outstandingInvoices

int32

Customer number of outstanding invoices

outstandingAmount

double

Customer total outstanding invoice amount

amountPastDue

double

Customer total past due amount

Optional Fields

name

string, nullable

The unique ID of this customer

address1

string, nullable

Customer address info

address2

string, nullable

Customer address info

address3

string, nullable

Customer address info

city

string, nullable

Customer address info

state

string, nullable

Customer address info

postalCode

string, nullable

Customer address info

country

string, nullable

Customer address country

phoneNumber

string, nullable

Customer phone number

faxNumber

string, nullable

Customer fax number

email

string, nullable

Customer AR email address

contactName

string, nullable

Customer primary contact name

contactEmail

string, nullable

Customer primary contact email address

payments

CustomerDetailsPaymentModel[], nullable

Customer payments collected