Get contact financial summary

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

Returns a contact's core identity alongside aggregated invoice statistics: total invoices raised, open (unpaid) invoices, total amount invoiced, and outstanding balance. All monetary values are in minor units (pence).

Useful for contact detail pages and credit control dashboards.

Path parameters

id string required
Contact ID (e.g. cont_3). Must use the contact prefix.

Response

200 Returns contact summary with invoice counts and outstanding balance in pence (minor units).
Show response fields
contact object
Show child attributes
company string
contactType string
email string
id string
isActive boolean
name string
phone string
openInvoices integer
outstanding integer
totalInvoiced integer
totalInvoices integer

Error codes

400 Invalid contact ID format.
404 Contact not found.