---
title: "List invoices"
method: GET
path: "/invoices"
tags: ["Invoices"]
---

# List invoices

`GET /invoices`

## Request

- Base URL: `https://www.ruddr.io/api/workspace`
- URL: `https://www.ruddr.io/api/workspace/invoices`
- 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
- `issuedOn` string, date
- `issuedOnAfter` string, date
- `issuedOnOnAfter` string, date
- `issuedOnBefore` string, date
- `issuedOnOnBefore` string, date

## Response `200`

200

- object
  - `results` Invoice[]: The list of results for the current page.
    - `id` string: The unique identifier for the object.
    - `companyName` string, nullable: The company name displayed on the invoice.
    - `companyStreetAddress` string, nullable: The company street address displayed on the invoice.
    - `number` string: The invoice number.
    - `statusId` 'draft' | 'open' | 'sent' | 'viewed' | 'partially_paid' | 'paid' | 'overdue' | 'void' | 'write_off': The current status of the invoice.
    - `billTo` string, nullable: The bill-to text displayed on the invoice.
    - `invoiceFor` string, nullable: A description of the products or services being invoiced.
    - `issuedOn` string, date, nullable: The date the invoice was issued (`YYYY-MM-DD`).
    - `servicesThrough` string, date, nullable: The services-through date (`YYYY-MM-DD`).
    - `dueOn` string, date, nullable: The date the invoice is due (`YYYY-MM-DD`).
    - `poNumber` string, nullable: The purchase order number.
    - `notes` string, nullable: Notes displayed on the invoice.
    - `emailSubject` string, nullable: The email subject used when sending the invoice.
    - `emails` string[]: The email addresses the invoice is sent to.
    - `ccEmails` string[]: The CC email addresses when sending the invoice.
    - `emailBody` string, nullable: The email body used when sending the invoice.
    - `emailFromName` string, nullable: The from name used when sending the invoice.
    - `replyTo` string, nullable: The reply-to email address used when sending the invoice.
    - `sendBcc` boolean: Whether to send a BCC copy when the invoice is sent.
    - `sentOn` string, date, nullable: The date the invoice was sent (`YYYY-MM-DD`).
    - `currency` string: The 3-letter currency code for the invoice.
    - `subtotal` number: The subtotal of all line items before discounts and taxes.
    - `totalDiscount` number, nullable: The total discount amount applied to the invoice.
    - `taxRate` number: The tax rate as a decimal (e.g., 0.05 for 5%).
    - `totalTax` number: The total tax amount on the invoice.
    - `total` number: The total amount of the invoice including tax.
    - `amountPaid` number: The total amount paid on the invoice.
    - `amountCredited` number: The total amount credited on the invoice.
    - `amountDue` number: The remaining balance due on the invoice.
    - `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 associated with this invoice.
      - `id` string: The unique identifier for the object.
      - `name` string: The name of the client.
    - `projects` object[]: The projects associated with this invoice.
      - `id` string: The unique identifier for the object.
      - `name` string: The name of the project.
    - `lines` object[]: The line items on the invoice.
      - `id` string: The unique identifier for the object.
      - `lineNumber` integer: The line number.
      - `item` string, nullable: The line item name. For draft invoices, this is derived from the invoice item name.
      - `description` string, nullable: The line item description.
      - `quantity` number, nullable: The quantity for the line item.
      - `rate` number, nullable: The rate for the line item.
      - `amount` number: The total amount for the line item.
      - `taxable` boolean: Whether the line item is taxable.
      - `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.
    - `payments` object[]: Payments applied to this invoice.
      - `id` string: The unique identifier for the object.
      - `referenceNumber` string, nullable: The payment reference number.
      - `amount` number: The payment amount applied to this invoice.
    - `creditNotes` object[]: Credit notes applied to this invoice.
      - `id` string: The unique identifier for the object.
      - `number` string: The credit note number.
      - `amount` number: The credit note amount applied to this invoice.
    - `paymentTerm` object, nullable: The payment term for the invoice.
      - `id` string: The unique identifier for the object.
      - `name` string: The name of the payment term.
      - `type` string: The payment term type (e.g., "net", "eom").
      - `days` integer: The number of days for the payment term.
  - `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)