List credit notes
GET
https://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
contactIdstringoptionalfromstringoptionalpageintegeroptionalperPageintegeroptionalstatusstringoptionaldraftissuedvoidedtostringoptionaltypestringoptionalsalespurchaseResponse
200Default Response
Show response fields
creditNotesarray<object>Show child attributes
contactobjectShow child attributes
idstringnamestringcreditNoteNumbernullstringcreditNoteTypestringidstringissueDatestringsettlementobjectShow child attributes
allocatedTotalintegerremainingintegerstatusstringsubtotalintegertotalintegervatAmountintegerError codes
400Default Response