List credit notes

GEThttps://app.speybooks.com/api/v1/credit-notes/

A paginated list of credit notes, filtered by type (sales or purchase, default sales), status, contactId, and an issue-date range (from, to).

The collection is wrapped under a named key, data.creditNotes, and meta carries page, perPage, total and pages. Each row is the lighter projection: header totals in integer pence, the contact summary, the status, and the live allocatedTotal and remaining under settlement. Lines and the allocation entries are on the single-note object, not the list.

Amounts are integer pence. The settlement summary is the live (non-reversed) set.

Query parameters

contactIdstringoptional
fromstringoptional
pageintegeroptional
min: 1
perPageintegeroptional
min: 1 · max: 100
statusstringoptional
draftissuedvoided
tostringoptional
typestringoptional
salespurchase

Response

200Default Response
Show response fields
creditNotesarray<object>
Show child attributes
contactobject
Show child attributes
idstring
namestring
creditNoteNumbernullstring
creditNoteTypestring
idstring
issueDatestring
settlementobject
Show child attributes
allocatedTotalinteger
remaininginteger
statusstring
subtotalinteger
totalinteger
vatAmountinteger

Error codes

400Default Response