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

# GET /api/invoices/

`GET /api/invoices/`

## Query parameters

- `customer_id` string, nullable
- `payment_status` string[]

## Response `200`

- Invoice[]
  - `invoice_id` string, required
  - `invoice_number` string, required
  - `cost_due` number, double, required
  - `currency` PricingUnit, required
    - `code` string, required
    - `name` string, required
    - `symbol` string, required
  - `issue_date` string, date-time, required
  - `payment_status` 'draft' | 'voided' | 'paid' | 'unpaid', required
  - `external_payment_obj_id` string, nullable, required
  - `external_payment_obj_type` 'stripe' | 'braintree' | 'null', nullable, required
  - `line_items` InvoiceLineItem[], required
    - `name` string, required
    - `start_date` string, date-time, required
    - `end_date` string, date-time, required
    - `quantity` number, double, nullable, required
    - `subtotal` number, double, required
    - `billing_type` 'in_arrears' | 'in_advance' | 'one_time' | 'null', nullable, required
    - `metadata` object, nullable, required
    - `plan` LightweightPlanVersion, required
      - `plan_name` string, required
      - `plan_id` string, required
      - `version` integer, required
      - `version_id` string, required
    - `subscription_filters` SubscriptionCategoricalFilter[], nullable, required
      - `value` string, required
      - `property_name` string, required — The string name of the property to filter on. Example: 'product_id'
  - `customer` LightweightCustomerSerializerForInvoice, required
    - `customer_name` string, nullable, required — The display name of the customer
    - `email` string, email, nullable, required — The primary email address of the customer, must be the same as the email address used to create the customer in the payment provider
    - `customer_id` string, nullable, required — The id provided when creating the customer, we suggest matching with your internal customer id in your backend
    - `address` Address
      - `city` string, required — City, district, suburb, town, or village
      - `country` 'AW' | 'AF' | 'AO' | 'AI' | 'AX' | 'AL' | 'AD' | 'AE' | 'AR' | 'AM' | 'AS' | 'AQ' | 'TF' | 'AG' | 'AU' | 'AT' | 'AZ' | 'BI' | 'BE' | 'BJ' | 'BQ' | 'BF' | 'BD' | 'BG' | 'BH' | 'BS' | 'BA' | 'BL' | 'BY' | 'BZ' | 'BM' | 'BO' | 'BR' | 'BB' | 'BN' | 'BT' | 'BV' | 'BW' | 'CF' | 'CA' | 'CC' | 'CH' | 'CL' | 'CN' | 'CI' | 'CM' | 'CD' | 'CG' | 'CK' | 'CO' | 'KM' | 'CV' | 'CR' | 'CU' | 'CW' | 'CX' | 'KY' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DM' | 'DK' | 'DO' | 'DZ' | 'EC' | 'EG' | 'ER' | 'EH' | 'ES' | 'EE' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FR' | 'FO' | 'FM' | 'GA' | 'GB' | 'GE' | 'GG' | 'GH' | 'GI' | 'GN' | 'GP' | 'GM' | 'GW' | 'GQ' | 'GR' | 'GD' | 'GL' | 'GT' | 'GF' | 'GU' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IM' | 'IN' | 'IO' | 'IE' | 'IR' | 'IQ' | 'IS' | 'IL' | 'IT' | 'JM' | 'JE' | 'JO' | 'JP' | 'KZ' | 'KE' | 'KG' | 'KH' | 'KI' | 'KN' | 'KR' | 'KW' | 'LA' | 'LB' | 'LR' | 'LY' | 'LC' | 'LI' | 'LK' | 'LS' | 'LT' | 'LU' | 'LV' | 'MO' | 'MF' | 'MA' | 'MC' | 'MD' | 'MG' | 'MV' | 'MX' | 'MH' | 'MK' | 'ML' | 'MT' | 'MM' | 'ME' | 'MN' | 'MP' | 'MZ' | 'MR' | 'MS' | 'MQ' | 'MU' | 'MW' | 'MY' | 'YT' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NU' | 'NL' | 'NO' | 'NP' | 'NR' | 'NZ' | 'OM' | 'PK' | 'PA' | 'PN' | 'PE' | 'PH' | 'PW' | 'PG' | 'PL' | 'PR' | 'KP' | 'PT' | 'PY' | 'PS' | 'PF' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SA' | 'SD' | 'SN' | 'SG' | 'GS' | 'SH' | 'SJ' | 'SB' | 'SL' | 'SV' | 'SM' | 'SO' | 'PM' | 'RS' | 'SS' | 'ST' | 'SR' | 'SK' | 'SI' | 'SE' | 'SZ' | 'SX' | 'SC' | 'SY' | 'TC' | 'TD' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TM' | 'TL' | 'TO' | 'TT' | 'TN' | 'TR' | 'TV' | 'TW' | 'TZ' | 'UG' | 'UA' | 'UM' | 'UY' | 'US' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'ZA' | 'ZM' | 'ZW', required — Two-letter country code (ISO 3166-1 alpha-2)
      - `line1` string, required — Address line 1 (e.g., street, PO Box, or company name)
      - `line2` string, nullable — Address line 2 (e.g., apartment, suite, unit, or building)
      - `postal_code` string, required — ZIP or postal code
      - `state` string, nullable — State, county, province, or region
  - `due_date` string, date-time, nullable, required
  - `start_date` string, date, required
  - `end_date` string, date, required
  - `seller` Seller, required
    - `name` string, required
    - `address` Address
      - `city` string, required — City, district, suburb, town, or village
      - `country` 'AW' | 'AF' | 'AO' | 'AI' | 'AX' | 'AL' | 'AD' | 'AE' | 'AR' | 'AM' | 'AS' | 'AQ' | 'TF' | 'AG' | 'AU' | 'AT' | 'AZ' | 'BI' | 'BE' | 'BJ' | 'BQ' | 'BF' | 'BD' | 'BG' | 'BH' | 'BS' | 'BA' | 'BL' | 'BY' | 'BZ' | 'BM' | 'BO' | 'BR' | 'BB' | 'BN' | 'BT' | 'BV' | 'BW' | 'CF' | 'CA' | 'CC' | 'CH' | 'CL' | 'CN' | 'CI' | 'CM' | 'CD' | 'CG' | 'CK' | 'CO' | 'KM' | 'CV' | 'CR' | 'CU' | 'CW' | 'CX' | 'KY' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DM' | 'DK' | 'DO' | 'DZ' | 'EC' | 'EG' | 'ER' | 'EH' | 'ES' | 'EE' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FR' | 'FO' | 'FM' | 'GA' | 'GB' | 'GE' | 'GG' | 'GH' | 'GI' | 'GN' | 'GP' | 'GM' | 'GW' | 'GQ' | 'GR' | 'GD' | 'GL' | 'GT' | 'GF' | 'GU' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IM' | 'IN' | 'IO' | 'IE' | 'IR' | 'IQ' | 'IS' | 'IL' | 'IT' | 'JM' | 'JE' | 'JO' | 'JP' | 'KZ' | 'KE' | 'KG' | 'KH' | 'KI' | 'KN' | 'KR' | 'KW' | 'LA' | 'LB' | 'LR' | 'LY' | 'LC' | 'LI' | 'LK' | 'LS' | 'LT' | 'LU' | 'LV' | 'MO' | 'MF' | 'MA' | 'MC' | 'MD' | 'MG' | 'MV' | 'MX' | 'MH' | 'MK' | 'ML' | 'MT' | 'MM' | 'ME' | 'MN' | 'MP' | 'MZ' | 'MR' | 'MS' | 'MQ' | 'MU' | 'MW' | 'MY' | 'YT' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NU' | 'NL' | 'NO' | 'NP' | 'NR' | 'NZ' | 'OM' | 'PK' | 'PA' | 'PN' | 'PE' | 'PH' | 'PW' | 'PG' | 'PL' | 'PR' | 'KP' | 'PT' | 'PY' | 'PS' | 'PF' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SA' | 'SD' | 'SN' | 'SG' | 'GS' | 'SH' | 'SJ' | 'SB' | 'SL' | 'SV' | 'SM' | 'SO' | 'PM' | 'RS' | 'SS' | 'ST' | 'SR' | 'SK' | 'SI' | 'SE' | 'SZ' | 'SX' | 'SC' | 'SY' | 'TC' | 'TD' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TM' | 'TL' | 'TO' | 'TT' | 'TN' | 'TR' | 'TV' | 'TW' | 'TZ' | 'UG' | 'UA' | 'UM' | 'UY' | 'US' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'ZA' | 'ZM' | 'ZW', required — Two-letter country code (ISO 3166-1 alpha-2)
      - `line1` string, required — Address line 1 (e.g., street, PO Box, or company name)
      - `line2` string, nullable — Address line 2 (e.g., apartment, suite, unit, or building)
      - `postal_code` string, required — ZIP or postal code
      - `state` string, nullable — State, county, province, or region
    - `phone` string, nullable
    - `email` string, email, nullable
  - `invoice_pdf` string, uri, nullable, required

## Changes

- **2023-02-20** `d246ebbb528d` — 1 breaking
  - the response property `items/customer/customer_id` became nullable for the status `200`
- **2023-02-19** `33a8ac13f9bf` — 1 info
  - the `items/customer/customer_id` response's property pattern `^[-a-zA-Z0-9_]+$` was removed for the status `200`
- **2023-02-17** `ecc2be015e66` — 8 breaking, 498 warning
  - the response property `items/customer/address/allOf[#/components/schemas/Address]/state` became nullable for the status `200`
  - the response property `items/seller/address/allOf[#/components/schemas/Address]/state` became nullable for the status `200`
  - the response property `items/customer/address/allOf[#/components/schemas/Address]/state` became optional for the status `200`
  - the response property `items/seller/address/allOf[#/components/schemas/Address]/state` became optional for the status `200`
  - …502 more
- **2023-02-15** `ff677a692b91` — 1 warning
  - added the new `braintree` enum value to the `items/external_payment_obj_type` response property for the response status `200`
- **2023-02-03** `fe43d7855824` — 1 breaking, 2 warning
  - the `items/payment_status` response's property type changed from `string` to no type for status `200`
  - added the new `draft` enum value to the `items/payment_status` response property for the response status `200`
  - added the new `voided` enum value to the `items/payment_status` response property for the response status `200`

[Full history](https://skmtc.dev/uselotus/apis/lotus-api/changes/api/invoices/get.md)

---

[API](https://skmtc.dev/uselotus/apis/lotus-api.md) · [All operations](https://skmtc.dev/uselotus/apis/lotus-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/uselotus/lotus-api/revisions/d246ebbb528d/schema)