Filter invoices

You need to add a filter parameter to your GET request. This parameter has to be a JSON array of objects. Please refer to the filters main section to see how to build correctly the filter parameter.

Allowed filter combinations for invoices

FieldDescriptionValue(s)Available operators
statusThe invoice statusLook at the invoice status values beloweq
sourceThe invoice sourceLook at the invoice source values beloweq, not_eq
customer_idThe invoice customer idStringeq
currency_amountThe invoice amount in currencyStringeq, not_eq, lt, gt, lteq, gteq
currency_amount_before_taxThe invoice amount before tax in currencyStringeq, not_eq, lt, gt, lteq, gteq
amountThe invoice amount in eurosStringeq, not_eq, lt, gt, lteq, gteq
dateThe invoice issue dateString (ISO 8601)eq, not_eq, lt, gt, lteq, gteq
deadlineThe invoice deadline dateString (ISO 8601)eq, not_eq, lt, gt, lteq, gteq
invoice_numberThe invoice numberStringeq

List of invoice status values

ValueDescription
incomplete_statusAn imported invoice that does not have all its information completed
draft_statusAn invoice that is still in draft mode
upcoming_statusA finalized invoice that is not paid and for which deadline is upcoming
late_statusA finalized invoice that is not paid and for which deadline is passed
paid_statusA paid invoice
cancelled_statusA finalized invoice that is linked with credit_note and credit_note covers all the currency_amount of the original invoice.
partially_cancelled_status:A finalized invoice that is linked with credit_note and credit_note does not cover all the currency_amount of the original invoice
partially_cancelled_draft_statusA finalized invoice that is linked with a draft credit_note.
credit_note_statusA credit_note (invoice with a negative amount)

List of invoice source values

ValueDescription
quotesAn invoice coming from Pennylane invoice editor
stripeAn invoice coming from Stripe
external_api_createAn invoice created by Pennylane API
external_api_importAn invoice imported by Pennylane API
APIAn invoice coming from Pennylane API (created or imported)
otherAn invoice coming from another source