API Reference
Start typing to search…

List customer invoices

get https://app.pennylane.com/api/external/v2/customer_invoices

List customer invoices

🚧

Deprecated behavior

By default this endpoint only returns finalized invoices.
From may 15th 2025, draft invoices will also be included by default.

⚠️ ALPHA STATUS NOTICE

This endpoint is currently in alpha. It is part of an early testing phase, and its functionality may change or be removed in future updates.
We welcome your feedback to help us improve. Please use this endpoint with caution, especially in production environments, as backward compatibility is not guaranteed and functionality may change frequently.
This feature is best suited for developers interested in testing and providing input on upcoming capabilities.

ℹ️

This endpoint requires one of the following scopes: customer_invoices:all, customer_invoices:readonly

Log in to see full request history
Query Params
string

Cursor for pagination. Use this to fetch the next set of results.
The cursor is an opaque string returned in the previous response's metadata.
Leave empty for the first request.

integer
1 to 100

Number of items to return per request.
Defaults to 20 if not specified.
Must be between 1 and 100.

string

You can choose to filter items on specific fields.
Available fields and values:

  • id, date, customer_id, billing_subscription_id, estimate_id: lt, lteq, gt, gteq, eq, not_eq, in, not_in
  • invoice_number: eq, not_eq, in, not_in
  • draft: eq
  • category_id: in
string
Defaults to -id

You can choose to sort items on specific attributes
Sort field may be prefixed with - for descending order.
Example : id will sort by ascending order, -id will sort by descending order.
Available fields : id, date

Responses

Response body
object
boolean
required

Indicates whether additional results are available beyond this set.
Use this flag to determine if another request is needed.

string | null
required

Cursor to retrieve the next set of results.
Include this value in the cursor parameter of your next request to fetch subsequent items.
A null next_cursor in the response indicates no further results.

items
array of objects
required
items*
object
integer
required

Invoice identifier

string | null
required
string
required
string
required
Defaults to EUR

EUR USD GBP AED AFN ALL AMD ANG AOA ARS AUD AWG AZN BAM BBD BDT BGN BHD BIF BMD BND BOB BRL BSD BTN BWP BYN BYR BZD CAD CDF CHF CLF CLP CNY COP CRC CUC CUP CVE CZK DJF DKK DOP DZD EGP ERN ETB FJD FKP GEL GGP GHS GIP GMD GNF GTQ GYD HKD HNL HRK HTG HUF IDR ILS IMP INR IQD IRR ISK JEP JMD JOD JPY KES KGS KHR KMF KPW KRW KWD KYD KZT LAK LBP LKR LRD LSL LTL LVL LYD MAD MDL MGA MKD MMK MNT MOP MRO MUR MVR MWK MXN MYR MZN NAD NGN NIO NOK NPR NZD OMR PAB PEN PGK PHP PKR PLN PYG QAR RON RSD RUB RWF SAR SBD SCR SDG SEK SGD SHP SLL SOS SRD STD SVC SYP SZL THB TJS TMT TND TOP TRY TTD TWD TZS UAH UGX UYU UZS VEF VND VUV WST XAF XCD XDR XOF XPF YER ZAR ZMK ZMW ZWL

string
required

Invoice amount (total value of the invoice in euros. If the currency is euro, currency_amount and amount are identical)

string
required

Invoice currency amount (total value of the invoice in the currency of the invoice)

string
required

Invoice currency amount before tax (total value before tax of the invoice in the currency of the invoice)

string
required

Invoice exchange rate (used to convert the invoice to euros. If the invoice currency is euro it will be 1.0)

date | null
required

Invoice issue date (ISO 8601)

string | null
required

Invoice payment deadline (ISO 8601)

string
required

Invoice taxable amount (in euros. If the currency is euro, currency_amount and amount are identical)

string
required

Invoice taxable amount (in invoice currency)

string
required
Defaults to fr_FR

fr_FR en_GB

boolean
required

Invoice paid status (set to True if the invoice is paid)

string
required

archived incomplete cancelled paid partially_cancelled upcoming late draft credit_note

discount
object
required
ledger_entry
object
required
string | null
required

Public URL of the invoice file. The URL will expire after 30 minutes.

string | null
required

Name of the file attached to the invoice

string | null
required

The remaining amount with VAT to pay for the invoice to be considered paid

string | null
required

The remaining amount without VAT to pay for the invoice to be considered paid

boolean
required

Indicates if the invoice is in draft (has not been finalized)

string | null
required

Additional details

object | null
required
invoice_line_sections
object
required
invoice_lines
object
required
categories
object
required
string
required
string
required
string | null
required
object | null
required
object | null
required

The credited invoice if the invoice is a credit note.

object | null
required
object | null
required

This reconciles the invoice with a transaction. See documentation about automatic payment matching.

payments
object
required
matched_transactions
object
required
appendices
object
required
integer | null
required
deprecated

The ID of the estimate at the origin of the invoice

object | null
required

The estimate at the origin of the invoice

string
required

The unique external reference that was assigned during creation either by you or Pennylane. (Same attribute as external_id in the API v1)

date-time | null
required

The time the invoice has been archived

date-time
required

The time the invoice has been created

date-time
required

The last time the invoice has been updated

Updated 14 days ago

Language
Credentials
OAuth2

Updated 14 days ago