DeluxHostAPI Reference
Invoices

List credit notes

GET
/v1/credit-notes

The documents that undo an invoice. Read these if you are syncing invoices into your books: a refund is a credit note plus a negative payment row, so an invoice list on its own counts refunded money as revenue.

totalCents is POSITIVE — the direction is the document type, not the sign. Cursor-paginated like /v1/invoices.

Authorization

apiToken invoices:read
headerAuthorizationBearer <token>

A personal API token: Authorization: Bearer dh_live_…. See Authentication for scopes.

Scope: invoices:read

Query Parameters

limit?integer
Range1 <= value <= 100
Default25
before?integer

Cursor from the previous page.

Response Body

One page of credit notes.

application/json
  1. response
items*array<>
nextCursor*integer|null
curl -X GET 'https://api.deluxhost.net/v1/credit-notes' \  -H "Authorization: Bearer $DELUXHOST_TOKEN"
Example Response
{  "items": [    {      "id": 0,      "number": "string",      "invoiceId": 0,      "invoiceNumber": "string",      "totalCents": 0,      "reason": "string",      "issuedAt": "2019-08-24T14:15:22Z"    }  ],  "nextCursor": 0}