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.
| Field | Description | Value(s) | Available operators |
|---|
| status | The invoice status | Look at the invoice status values below | eq |
| source | The invoice source | Look at the invoice source values below | eq, not_eq |
| customer_id | The invoice customer id | String | eq |
| supplier_id | The invoice supplier id | String | eq |
| currency_amount | The invoice amount in currency | String | eq, not_eq, lt, gt, lteq, gteq |
| currency_amount_before_tax | The invoice amount before tax in currency | String | eq, not_eq, lt, gt, lteq, gteq |
| amount | The invoice amount in euros | String | eq, not_eq, lt, gt, lteq, gteq |
| date | The invoice issue date | String (ISO 8601) | eq, not_eq, lt, gt, lteq, gteq |
| deadline | The invoice deadline date | String (ISO 8601) | eq, not_eq, lt, gt, lteq, gteq |
| invoice_number | The invoice number | String | eq |
| quote_group_uuid | The invoice quote group | String | eq, not_eq |
| Value | Description |
|---|
incomplete_status | An imported invoice that does not have all its information completed |
draft_status | An invoice that is still in draft mode |
upcoming_status | A finalized invoice that is not paid and for which deadline is upcoming |
late_status | A finalized invoice that is not paid and for which deadline is passed |
paid_status | A paid invoice |
cancelled_status | A 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 |
credit_note_status | A credit_note (invoice with a negative amount) |
| Value | Description |
|---|
quotes | An invoice coming from Pennylane invoice editor |
stripe | An invoice coming from Stripe |
external_api_create | An invoice created by Pennylane API |
external_api_import | An invoice imported by Pennylane API |
API | An invoice coming from Pennylane API (created or imported) |
other | An invoice coming from another source |
