CustomerSummaryModel
Less than to read
Contains summarized data for a customer
Methods
The following API methods use this data model.
- Query Customer Summary
Required Fields
groupKey
The GroupKey uniquely identifies a single Sage Network 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.
companyId
The unique ID of this company.
modified
The modified date of the customer.
Optional Fields
companyName
string, nullable
The name of the company.
primaryContact
string, nullable
The name of the primary contact.
appEnrollmentId
uuid, nullable
The app enrollment ID this Customer is associated with
outstandingInvoices
int32, nullable
The number of outstanding invoices for this customer.
totalInvoicesOpen
int32, nullable
The number of open invoices.
totalInvoicesPastDue
int32, nullable
The number of past due invoices.
closedInvoices
int32, nullable
The number of closed invoices for this customer.
closedInvoicesPastThirtyDays
int32, nullable
The number of closed invoices for this customer in the past thirty days.
amountCollected
double, nullable
The total from collected payments.
amountCollectedPastThirtyDays
double, nullable
The total from collected payments in the past thirty days.
outstandingAmount
double, nullable
The total balance of outstanding invoices.
invoicedAmountPastThirtyDays
double, nullable
The total amount invoiced in the past thirty days.
outstandingAmountPastThirtyDays
double, nullable
The total amount outstanding from the invoices invoiced in the past thirty days.
invoicesPastThirtyDays
int32, nullable
The number of invoices invoiced in the past thirty days.
amountPastDue
double, nullable
The total amount past due for this customer.
unappliedPayments
double, nullable
The total value of unapplied Payments for this Customer.
unappliedAmountPastThirtyDays
double, nullable
The total value of unapplied Payments for this Customer in the past thirty days.
percentOfTotalAr
double, nullable
Portion of Total AR for this Customer that is Past due. (TotalPastDue / Total AR).
dso
double, nullable
Daily sales outstanding value for this Customer.
Deprecated Fields
Deprecated fields are maintained for backwards compatibility with previous versions of the API. Deprecated fields may be removed in a future release of the API.
newestActivity
date, nullable
The date stamp for the newest Activity on this Customer.