customerAccountSummary
Fetch a customer account summary with orders, estimates, invoices and financial totals. Requires customer:read.
Arguments
customerIdCustomerID!TypeID of the customer to summarise (cus_01K…). Must belong to the caller's tenant; otherwise the payload comes back empty with a customerId: customer not found error.
fromDateStringInclusive start of the window, as an ISO-8601 date-time with fractional seconds (e.g. "2026-01-01T00:00:00.000Z"). Filters orders by orderDate and estimates/invoices by issueDate. Omit for no lower bound; an unparseable value is ignored, not rejected.
toDateStringExclusive end of the window, in the same ISO-8601 date-time format as fromDate. Omit for no upper bound; an unparseable value is ignored, not rejected.
Returns CustomerAccountSummaryPayload!
Scalar fields at a glance
totalInvoicedFloat!totalPaidFloat!totalOutstandingFloat!Explore in a view
View exact SDL
"""
Fetch a customer account summary with orders, estimates, invoices and financial totals. Requires customer:read.
"""
customerAccountSummary(
"""
TypeID of the customer to summarise (`cus_01K…`). Must belong to the caller's tenant; otherwise the payload comes back empty with a `customerId: customer not found` error.
"""
customerId: CustomerID!
"""
Inclusive start of the window, as an ISO-8601 date-time with fractional seconds (e.g. "2026-01-01T00:00:00.000Z"). Filters orders by orderDate and estimates/invoices by issueDate. Omit for no lower bound; an unparseable value is ignored, not rejected.
"""
fromDate: String
"""
Exclusive end of the window, in the same ISO-8601 date-time format as `fromDate`. Omit for no upper bound; an unparseable value is ignored, not rejected.
"""
toDate: String
): CustomerAccountSummaryPayload! @topic(names: ["commerce"])Schema reference describes the API contract. Actual access is checked by the platform for every operation.