---
title: "List credit notes"
method: GET
path: "/credit-notes"
tags: ["Credit Notes"]
---

# List credit notes

`GET /credit-notes`

## Request

- Base URL: `https://www.ruddr.io/api/workspace`
- URL: `https://www.ruddr.io/api/workspace/credit-notes`
- Auth: HTTP bearer

## Query parameters

- `startingAfter` string
- `endingBefore` string
- `limit` integer
- `modifiedAtAfter` union
  - string, date
  - string, date-time
- `modifiedAtOnAfter` union
  - string, date
  - string, date-time
- `modifiedAtBefore` union
  - string, date
  - string, date-time
- `modifiedAtOnBefore` union
  - string, date
  - string, date-time
- `clientId` string

## Response `200`

200

- object
  - `results` CreditNote[]: The list of results for the current page.
    - `id` string: The unique identifier for the object.
    - `companyName` string, nullable: The company name printed on the credit note.
    - `companyStreetAddress` string, nullable: The company street address printed on the credit note.
    - `number` string: The credit note number (e.g. `CN-0042`).
    - `statusId` 'draft' | 'open' | 'applied': The current status of the credit note.
    - `adjustEarnedRevenue` boolean: Whether publishing this credit note reduced the earned revenue of the credited projects.
    - `billTo` string: The billing address or recipient text printed on the credit note.
    - `creditNoteFor` string, nullable: A brief description of what the credit note is for.
    - `issuedOn` string, date: The date the credit note was issued (`YYYY-MM-DD`).
    - `poNumber` string, nullable: The purchase order number associated with the credit note.
    - `notes` string, nullable: Internal or external notes on the credit note.
    - `emailSubject` string, nullable: The email subject used when sending the credit note.
    - `emails` string[]: The list of recipient email addresses.
    - `ccEmails` string[]: The list of CC email addresses.
    - `emailBody` string, nullable: The email body used when sending the credit note.
    - `emailFromName` string, nullable: The sender display name used when sending the credit note.
    - `replyTo` string, nullable: The reply-to email address used when sending the credit note.
    - `sendBcc` boolean: Whether the workspace is BCC'd when the credit note is sent.
    - `sentOn` string, date, nullable: The date the credit note was sent (`YYYY-MM-DD`).
    - `currency` string: The ISO 4217 currency code for the credit note (e.g. `USD`).
    - `subtotal` number: The sum of all line item amounts before tax.
    - `taxRate` number: The tax rate applied to taxable line items, expressed as a decimal (e.g. `0.0775` for 7.75%).
    - `totalTax` number: The total tax amount calculated from taxable line items.
    - `total` number: The total amount of the credit note including tax.
    - `appliedCredit` number: The total amount of credit that has been applied to invoices or payments.
    - `remainingCredit` number: The remaining unapplied credit balance.
    - `createdAt` string, date-time: The timestamp when the object was created.
    - `modifiedAt` string, date-time: The timestamp when the object was last modified.
    - `client` object: The client the credit note belongs to.
      - `id` string: The unique identifier for the object.
      - `name` string: The name of the client.
    - `projects` object[]: The projects associated with this credit note.
      - `id` string: The unique identifier for the object.
      - `name` string: The name of the project.
    - `lines` object[]: The line items on the credit note.
      - `id` string: The unique identifier for the object.
      - `lineNumber` integer: The display order of the line item.
      - `item` string, nullable: The name of the line item. For draft credit notes, this is derived from the associated invoice item name.
      - `description` string, nullable: The description for the line item.
      - `quantity` number, nullable: The quantity for the line item.
      - `rate` number, nullable: The unit rate for the line item.
      - `amount` number, nullable: The total amount for the line item (quantity × rate).
      - `taxable` boolean: Whether the line item is subject to tax.
      - `invoiceItem` object, nullable: The invoice item category for this line item.
        - `id` string: The unique identifier for the object.
        - `name` string: The name of the invoice item.
      - `project` object, nullable: The project associated with this line item.
        - `id` string: The unique identifier for the object.
        - `name` string: The name of the project.
    - `invoices` object[]: The invoices this credit note has been applied to.
      - `id` string: The unique identifier for the object.
      - `number` string: The invoice number.
      - `amount` number: The amount of credit applied to this invoice.
  - `hasMore` boolean: Whether there are more results available after this page.

## Other responses

- `400`: 400

---

[API](https://skmtc.dev/ruddr/apis/ruddr-api.md) · [All operations](https://skmtc.dev/ruddr/apis/ruddr-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ruddr/apis/ruddr-api/revisions/01c3f2a969ba?raw)