Retrieve an invoice

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

This endpoint returns a specific invoice.

Responses

Response body

object

invoice

object

string

Invoice identifier

label

string | null

invoice_number

string | null

quote_group_uuid

string

Two invoices having the same quote_group_uuid are linked together

is_draft

boolean

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

is_estimate

boolean

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

currency

string

Invoice currency code (ISO 4217)

amount

string

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

currency_amount

string

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

currency_amount_before_tax

string

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

exchange_rate

number

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

date

date | null

Invoice issue date (ISO 8601)

deadline

date | null

Invoice payment deadline (ISO 8601)

currency_tax

string

Invoice taxable amount (in invoice currency)

language

string

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

fr_FR en_GB

paid

boolean

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

fully_paid_at

date | null

Invoice payment date

status

string | null

Invoice status

discount

string

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

discount_type

string

Defaults to relative

Discount type.

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

absolute relative

public_url

string

Public url of the invoice

file_url

string | null

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

filename

string

Name of the file attached to the invoice

remaining_amount

string

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

source

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

special_mention

string | null

Additional details

updated_at

date-time

The last time the invoice has been updated

imputation_dates

object | null

required

customer

line_items_sections_attributes

array of objects

line_items_sections_attributes

object

title

string | null

Title of the line items section

description

string | null

Description of the line items section

rank

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

label

string

Line item label

unit

string | null

The kind of unit which applies to the amount

quantity

string

Line item quantity (number of items)

amount

string

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

currency_amount

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.

description

string

Line item description

product_id

string | null

Line item product id

product_v2_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.

vat_rate

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

currency_price_before_tax

string

Total amount before tax in currency

currency_tax

string

Total tax amount in currency

raw_currency_unit_price

string

Unit price (excluding tax)

discount

string

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

discount_type

string

Defaults to relative

Discount type.

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

absolute relative

section_rank

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

v2_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.

categories

object

source_id

string

required

Category identifier (is unique)

weight

string

required

Category weight (0.8 means 80%)

label

string

required

Category name (is unique per group of categories)

direction

string | null

required

cash_in cash_out

created_at

date-time

required

Category created date

updated_at

date-time

required

Category created date

v2_id

integer

required

transactions_reference

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)

payments

array of objects | null

payments

object

label

string

Payment label

created_at

date-time

Payment created date

currency_amount

string

Payment amount

matched_transactions

array of objects | null

matched_transactions

object

label

string | null

Transaction Label

amount

string | null

group_uuid

string

date

date | null

fee

string | null

currency

string

pdf_invoice_free_text

string

pdf_invoice_subject

string

billing_subscription

object | null

v2_id

integer

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request GET \
2
     --url https://app.pennylane.com/api/external/v1/customer_invoices/id \
3
     --header 'accept: application/json'


xxxxxxxxxx
103
}
1
{
2
  "invoice": {
3
    "id": "wMoOACctiA",
4
    "label": "Invoice label",
5
    "invoice_number": "Invoice number",
6
    "quote_group_uuid": "b50b8fe6-48ce-4380-b9b3-52eec688fc04",
7
    "is_draft": true,
8
    "is_estimate": true,
9
    "currency": "EUR",
10
    "amount": "230.32",
11
    "currency_amount": "230.32",
12
    "currency_amount_before_tax": "196.32",
13
    "exchange_rate": 1,
14
    "date": "2020-01-01",
15
    "deadline": "2020-09-30",
16
    "currency_tax": "34.0",
17
    "language": "fr_FR",
18
    "paid": false,
19
    "fully_paid_at": "2023-08-30",
20
    "status": "upcoming",
21
    "discount": "50.1",
22
    "discount_type": "relative",
23
    "public_url": "https://app.pennylane.com/...",
24
    "file_url": "https://app.pennylane.com/.../file.pdf",
25
    "filename": "my_file.pdf",

200Returns an invoice

401Access token is missing or invalid

403Forbidden

404Not found