Skip to main content

CustomerDashboard

The customer's dashboard figures.

type CustomerDashboard {
activeOrders: Int!
availableCredit: Float
balanceUnavailable: Boolean!
outstandingBalance: Float
overdueInvoices: Int!
pendingQuotes: Int!
recentOrders: [CustomerOrder!]!
viewerEmail: String
viewerFirstName: String
}

Fields​

CustomerDashboard.activeOrders ● Int! non-null scalar​

How many orders are active.

CustomerDashboard.availableCredit ● Float scalar​

The credit still available. Empty means unlimited, unless balanceUnavailable is true, when it means unknown.

CustomerDashboard.balanceUnavailable ● Boolean! non-null scalar​

True when the account figures could not be loaded. The rest of the dashboard still loads.

CustomerDashboard.outstandingBalance ● Float scalar​

What is owed on open invoices. Empty when the account could not be read, which is never shown as 0.

CustomerDashboard.overdueInvoices ● Int! non-null scalar​

How many invoices are overdue.

CustomerDashboard.pendingQuotes ● Int! non-null scalar​

How many quotes are pending.

CustomerDashboard.recentOrders ● [CustomerOrder!]! non-null object​

The most recent orders.

CustomerDashboard.viewerEmail ● String scalar​

The signed-in person's email address.

CustomerDashboard.viewerFirstName ● String scalar​

The signed-in person's first name, for the greeting.

Returned By​

customerDashboard query