Skip to content

List credit notes

GET/documents/credit_notes

Costs 1 rate-limit point · Rate limits

The credit notes the Credit notes tab lists, newest first, as list rows: credit note number, the invoice and Shopify order it credits, customer, total, and when it was sent or printed. q matches the credit note number and the credited invoice number. Read-only.

financial_status values: pending (Payment pending), authorized (Authorized), partially_paid (Partially paid), paid (Paid), partially_refunded (Partially refunded), refunded (Refunded), voided (Voided), expired (Expired), cancelled (Cancelled).

Also searched aslist credit notesshow credit notesfind a credit notecredit notes for an invoicerefund documentscredit notes this month

Query parameters

  • pageinteger

    1-based page number.

  • per_pageinteger

    Rows per page, default 25, max 100.

  • qstring

    Free text over the credit note number, the credited invoice number and the customer email.

  • fromstring

    Created on or after this date (ISO 8601).

  • tostring

    Created on or before this date (ISO 8601).

Returns

  • itemsarray of objects
    Show 20 child attributesHide child attributes
    • idinteger
      Example: 980191085
    • document_typestring
      Example: credit_note
    • invoice_numberstring
      Example: 1
    • titlestring
      Example: Credit Note
    • orderobject, nullable
    • customerobject
      Show 3 child attributesHide child attributes
      • idinteger
        Example: 49
      • namestring
        Example: Customer 1
      • emailstring
        Example: cus1@gmail.com
    • financial_statusstring
      Example: paid
    • currencystring
      Example: USD
    • totalstring
      Example: 1100.22
    • issued_onstring
      Example: 2026-11-10
    • due_onstring, nullable
    • sent_atstring, nullable
    • printed_atstring, nullable
    • reminder_sent_atstring, nullable
    • paidboolean
      Example: true
    • editedboolean
      Example: false
    • trashedboolean
      Example: false
    • e_invoice_statusstring, nullable
    • created_atstring
      Example: 2026-11-10T09:56:58Z
    • creditedobject
      Show 3 child attributesHide child attributes
      • invoice_numberstring
        Example: #1001
      • invoice_idinteger
        Example: 980191084
      • shopify_order_idstring
        Example: gid://shopify/Order/12213474623569
  • pageobject

    Offset paging of a list (page, per_page query params).

    Show 4 child attributesHide child attributes
    • numberinteger

      1-based page number.

    • sizeinteger

      Rows per page, max 100.

    • totalinteger

      Rows across all pages.

    • total_pagesinteger
      Example: 1

Errors

401

Missing or unknown X-Auth-Token, or the shop uninstalled the app.

403

v3_required: the shop still runs the previous dashboard. paid_plan_required: API access needs a paid plan.

422

The request failed validation. Nothing was saved.

429

Rate limited: cost-weighted per key (reads cost less than writes). Wait Retry-After seconds; see X-RateLimit-* headers.

Every error has the same shape: see Errors.

GET/documents/credit_notes
curl "https://app.invoicefalcon.com/api/v3/external/documents/credit_notes" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY"
Response
{
  "items": [
    {
      "id": 980191085,
      "document_type": "credit_note",
      "invoice_number": "1",
      "title": "Credit Note",
      "order": null,
      "customer": {
        "id": 49,
        "name": "Customer 1",
        "email": "cus1@gmail.com"
      },
      "financial_status": "paid",
      "currency": "USD",
      "total": "1100.22",
      "issued_on": "2026-11-10",
      "due_on": null,
      "sent_at": null,
      "printed_at": null,
      "reminder_sent_at": null,
      "paid": true,
      "edited": false,
      "trashed": false,
      "e_invoice_status": null,
      "created_at": "2026-11-10T09:56:58Z",
      "credited": {
        "invoice_number": "#1001",
        "invoice_id": 980191084,
        "shopify_order_id": "gid://shopify/Order/12213474623569"
      }
    }
  ],
  "page": {
    "number": 1,
    "size": 25,
    "total": 1,
    "total_pages": 1
  }
}