Skip to content

CustomerAccountSummaryPayload ​

Type: Object

A customer's trading position over a date window: their orders, estimates and invoices, plus invoiced/paid/outstanding money totals derived from those invoices.

Fields ​

NameTypeArgsDescriptionDeprecated
customerCustomerStateThe requested customer. Null only when no customer with that id exists in the caller's tenant, in which case errors explains why.
errors[FieldError!]!Field-level lookup errors; empty on success. Carries customerId: customer not found when no such customer exists for the tenant.
estimates[EstimateState!]!The customer's estimates whose issueDate falls in the requested window, most recent first.
invoices[InvoiceState!]!The customer's invoices whose issueDate falls in the requested window, most recent first. Includes credit notes as well as invoices.
orders[OrderState!]!The customer's orders whose orderDate falls in the requested window, most recent first.
totalInvoicedFloat!Sum of totalAmount over the returned invoices of kind invoice; credit notes are excluded. Reflects the requested date window only.
totalOutstandingFloat!totalInvoiced minus totalPaid — what the customer still owes on invoices in the window. Can go negative if an invoice is overpaid.
totalPaidFloat!Sum of paidAmount over the same invoices counted by totalInvoiced (credit notes excluded).

Relationships ​

Connect machines, automate workflows, and build custom apps for print production.