Get contact financial summary

GEThttps://app.speybooks.com/api/v1/contacts/{id}/summary

Returns a contact's core identity alongside aggregated invoice figures for this contact's invoices only (not quotes or transactions). The figures count by status: totalInvoices is every invoice; openInvoices and outstanding cover invoices not yet paid, cancelled, or written off, which includes drafts; and totalInvoiced is the sum of every invoice total across all statuses, including drafts and cancelled ones. All monetary values are in minor units (pence).

Useful for contact detail pages and credit control dashboards, bearing in mind the status coverage above.

Path parameters

idstringrequired
Contact ID (e.g. cont_3). Must use the contact prefix.

Response

200Returns contact summary with invoice counts and outstanding balance in pence (minor units).
Show response fields
contactobject
Show child attributes
companystring
contactTypestring
emailstring
idstring
isActiveboolean
namestring
phonestring
openInvoicesinteger
outstandinginteger
totalInvoicedinteger
totalInvoicesinteger

Error codes

400Invalid contact ID format.
404Contact not found.