---
title: "List invoices"
method: GET
path: "/organizations/{organization_id}/invoices"
tags: ["Invoices"]
---

# List invoices

`GET /organizations/{organization_id}/invoices`

Retrieves a list of invoices for the specified organization.

## Path parameters

- `organization_id` string, required

## Query parameters

- `filter[status]` 'paid' | 'charged_off' | 'pending' | 'refunded' | 'canceled' | 'refund_pending'
- `filter[type]` 'credit_memo' | 'invoice'
- `filter[order_id]` string
- `page` integer

## Response `200`

OK

- object
  - `items` Invoice[]
    - `id` string — The invoice id.
    - `invoice_number` string — The invoice number.
    - `type` 'invoice' | 'credit_memo' — Invoice type.
    - `order_id` string — The id of the related order.
    - `related_invoice_id` string, nullable — If the invoice is a credit memo (type=credit_memo), this field stores the id of the related/original invoice.
    - `status` 'paid' | 'charged_off' | 'pending' | 'refunded' | 'canceled' | 'refund_pending' — The invoice status.
    - `owner` string, ulid — The ULID of the owner.
    - `invoice_date` string, date-time, nullable — The invoice date.
    - `invoice_due` string, date-time, nullable — The invoice due date.
    - `created` string, date-time, nullable — The time when the invoice was created.
    - `changed` string, date-time, nullable — The time when the invoice was changed.
    - `company` string — Company name (if any).
    - `total` number, double — The invoice total.
    - `address` Address — The address of the user.
      - `country` string, ISO ALPHA-2 — Two-letter country codes are used to represent countries and states
      - `name_line` string — The full name of the user
      - `premise` string — Premise (i.e. Apt, Suite, Bldg.)
      - `sub_premise` string — Sub Premise (i.e. Suite, Apartment, Floor, Unknown.
      - `thoroughfare` string — The address of the user
      - `administrative_area` string, ISO ALPHA-2 — The administrative area of the user address
      - `sub_administrative_area` string — The sub-administrative area of the user address
      - `locality` string — The locality of the user address
      - `dependent_locality` string — The dependant_locality area of the user address
      - `postal_code` string — The postal code area of the user address
    - `notes` string — The invoice note.
    - `invoice_pdf` InvoicePDF — Invoice PDF document details.
      - `url` string — A link to the PDF invoice.
      - `status` 'ready' | 'pending' — The status of the PDF document. We generate invoice PDF asyncronously in batches. An invoice PDF document may not be immediately available to download. If status is 'ready', the PDF is ready to download. 'pending' means the PDF is not created but queued up. If you get this status, try again later.

## Other responses

- `403` — Forbidden
- `404` — Not Found

---

[API](https://skmtc.net/upsun/apis/upsun-com-rest-api.md) · [All operations](https://skmtc.net/upsun/apis/upsun-com-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/upsun/upsun-com-rest-api/revisions/6cc88fde6435/schema)