API Reference
Start typing to search…

List all invoices

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

This endpoint returns a list of invoices corresponding to the filter provided.Please refer to the filters page to learn how to correctly build the filter parameter.

Log in to see full request history
Query Params
integer

Invoices are paginated, this is the current page which will be returned. The page index is starting at 1.

integer

Invoices are paginated. By default, you get 20 invoices by page. You can specify another number of invoices by page.

string

You can choose to filter invoices on a specific attributes (status, date, deadline, amount, etc).

Please refer to the filters page to learn how to correctly build the filter parameter.

For instance, you can select the invoices that have the status late_status by using the following filter: [{"field": "status", "operator": "scope", "value": "late_status"}].

Responses

Response body
object
integer

The total number of pages available

integer

The current page returned

integer

The total number of invoices

invoices
array of objects

The list of invoices

invoices
object
string

Invoice identifier

string | null
string | null
string

Two invoices having the same quote_group_uuid are linked together

boolean

Invoice draft status (set to True if the invoice is a draft)

boolean

Invoice estimate status (set to True if the document is an estimate, False if it's an invoice)

string

Invoice currency code (ISO 4217)

string

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

string

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

string

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

number

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

date | null

Invoice issue date (ISO 8601)

string | null

Invoice payment deadline (ISO 8601)

string

Invoice taxable amount (in invoice currency)

string

Language of the invoice. The locale region is separated by an underscore like in "fr_FR".

fr_FR en_GB

boolean

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

string | null

Invoice status

string

Invoice discount (which is a percentage if the discount_type is "relative", or an amount if the discount_type is "absolute")

string
Defaults to relative

Discount type.

  • absolute if it is an amount
  • relative if it is a percentage

absolute relative

string

Public url of the invoice

string | null

If there's a file attached to the invoice, this is the link of the file

string

Name of the file attached to the invoice

string

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

string

Where the invoice is coming from, here are the different values:

  • quotes: Created directly from the editor
  • stripe: Imported from Stripe
  • other: Other cases
string | null

Additional details

date-time

The last time the invoice has been updated

object | null
required
line_items_sections_attributes
array of objects
line_items_sections_attributes
object
string | null

Title of the line items section

string | null

Description of the line items section

integer

Defines the order in which sections will be displayed on the invoice. Each section has to have a different rank, starting from 1 and incrementing next values by 1

line_items
array of objects
line_items
object
number

Line item id

string

Line item label

string | null

The kind of unit which applies to the amount

string

Line item quantity (number of items)

string

The total amount of the document items in euros including taxes and deducting discounts

string

The total amount of the document items in the document's currency including taxes and deducting discounts.
If the currency is euro, amount and currencyAmount are identical.

string

Line item description

string | null

Line item product id

integer | null

The corresponding identifier for the product in the V2 API.
This field is provided to facilitate migration from V1 to V2 API by allowing mapping
between V1 and V2 identifiers. When transitioning to V2 endpoints, use this value
instead of the V1 id or source_id.

string

Product VAT rate. A 20% VAT in France is FR_200.

FR_1_05 FR_1_75 FR_09 FR_21 FR_40 FR_55 FR_60 FR_65 FR_85 FR_92 FR_100 FR_130 FR_15_385 FR_196 FR_200 AD_10 AD_45 AD_95 AT_100 AT_130 AT_200 BE_60 BE_120 BE_210 BG_90 BG_200 CH_25 CH_26 CH_37 CH_38 CH_77 CH_81 CY_50 CY_90 CY_190 CZ_100 CZ_120 CZ_150 CZ_210 DE_70 DE_190 DK_250 EE_90 EE_200 EE_220 ES_40 ES_100 ES_210 FI_100 FI_140 FI_240 FI_255 GB_50 GB_200 GR_60 GR_130 GR_240 HR_50 HR_130 HR_250 HU_50 HU_180 HU_270 IE_48 IE_90 IE_135 IE_210 IE_230 IT_40 IT_50 IT_100 IT_220 LT_50 LT_90 LT_210 LU_30 LU_70 LU_80 LU_130 LU_140 LU_160 LU_170 LV_50 LV_120 LV_210 MC_09 MC_21 MC_55 MC_85 MC_100 MC_200 MT_50 MT_70 MT_180 MU_150 NL_90 NL_210 PL_50 PL_80 PL_230 PT_60 PT_130 PT_230 RO_50 RO_90 RO_190 SE_60 SE_120 SE_250 SI_50 SI_95 SI_220 SK_100 SK_200 exempt extracom intracom_21 intracom_55 intracom_85 intracom_100 crossborder FR_100_construction FR_200_construction

string

Total amount before tax in currency

string

Total tax amount in currency

string

Unit price (excluding tax)

string

Line item discount (which is a percentage if the discount_type is "relative", or an amount if the discount_type is "absolute")

string
Defaults to relative

Discount type.

  • absolute if it is an amount
  • relative if it is a percentage

absolute relative

integer | null

Defines the order in which line items will be displayed on the invoice. Each line item has to have a different rank, starting from 1 and incrementing next values by 1

integer

The corresponding identifier for this resource in the V2 API.
This field is provided to facilitate migration from V1 to V2 API by allowing mapping
between V1 and V2 identifiers. When transitioning to V2 endpoints, use this value
instead of the V1 id or source_id.

categories
array of objects
categories
object
string
required

Category identifier (is unique)

string
required

Category weight (0.8 means 80%)

string
required

Category name (is unique per group of categories)

string | null
required

cash_in cash_out

date-time
required

Category created date

date-time
required

Category created date

integer
required

The corresponding identifier for this resource in the V2 API.
This field is provided to facilitate migration from V1 to V2 API by allowing mapping
between V1 and V2 identifiers. When transitioning to V2 endpoints, use this value
instead of the V1 id or source_id.

object | null

By adding this field you can automatically reconciliate the newly created (or imported) invoice with a transaction using transactions payment reference (Currently only stripe and invoice_number matching is supported)

array of objects | null
required
payments*
object
string

Payment label

date-time

Payment created date

string

Payment amount

array of objects | null
matched_transactions
object
string | null

Transaction Label

string | null
string
date | null
string | null
string
string
string
object | null
array of objects | null
credit_notes
object
string
required

An id you can use to refer to the credit note from outside of pennylane

string
required

Credit note amount (total value of the credit note in euros. If the currency is euro, Currency Amount and credit note Amount are identical)

string
required

Credit note taxable amount (in euros. If the currency is euro, Credit note taxable amount and credit note amount are identical)

string
required

Invoice currency code (ISO 4217)

string
required

Credit note currency amount (total value of the credit note in the currency of the invoice)

string
required

Credit note taxable amount (in invoice currency)

string
required

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

string | null
required
boolean
required

Credit note draft status (set to True if the credit note is a draft)

integer

The corresponding identifier for this resource in the V2 API.
This field is provided to facilitate migration from V1 to V2 API by allowing mapping
between V1 and V2 identifiers. When transitioning to V2 endpoints, use this value
instead of the V1 id or source_id.

integer

The corresponding identifier for this resource in the V2 API.
This field is provided to facilitate migration from V1 to V2 API by allowing mapping
between V1 and V2 identifiers. When transitioning to V2 endpoints, use this value
instead of the V1 id or source_id.

Updated 2 months ago

Language
Credentials
OAuth2

Updated 2 months ago