List all estimates

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

This endpoint returns a list of estimates corresponding to the filter provided.

Responses

Response body

object

total_pages

integer

current_page

integer

estimates

array of objects

estimates

object

string

Estimate identifier

label

string | null

currency

string

Estimate currency code (ISO 4217)

amount

string

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

currency_amount

string

Estimate currency amount (total value of the estimate in the currency of the estimate)

currency_amount_before_tax

string

Estimate currency amount before tax (total value before tax of the estimate in the currency of the estimate)

estimate_number

string

Invoice number

estimate_type

string

invoice proforma estimate shipping_order purchasing_order purchase_request

exchange_rate

number

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

date

date | null

Estimate issue date

deadline

date | null

Estimate expiration date

currency_tax

string

Estimate taxable amount (in estimate currency)

language

string

Estimate Language

discount

string

Estimate discount Amount (total discounted amount on the estimate. Set to 0.0 if the estimate does not have any discount. If the discount is relative, set as a percentage value between 0 and 1)

discount_type

string

Estimate discount Type (relative if it is a percentage of the total or absolute if it is an amount)

file_url

string

This is the link of the file attached to the estimate

updated_at

date-time

The last time the estimate has been updated

source

string

Where the estimate is coming from. The only possible value is 'quotes' for now.

quotes: Created directly from the editor

pdf_invoice_subject

string

Invoice title

pdf_invoice_free_text

string

For example, the contact details of the person to contact

customer

object | null

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

Price before tax in currency

currency_tax

string

Tax amount in currency

raw_currency_unit_price

string

Unit price (excluding tax)

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.

status

string

The status of the estimate

pending accepted denied invoiced expired

related_invoices

array of objects

related_invoices

object

string

Invoice identifier

label

string | null

quote_group_uuid

string

Two invoices having the same quote_group_uuid are linked together

currency

string

Invoice currency code (ISO 4217)

currency_amount

string

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

amount

string

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

paid

boolean

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

v2_id

integer

v2_id

integer

Language

Credentials

OAuth2


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


xxxxxxxxxx
97
}
1
{
2
  "total_pages": 5,
3
  "current_page": 1,
4
  "estimates": [
5
    {
6
      "id": "jHgtAKntoW",
7
      "label": "Estimate label",
8
      "currency": "EUR",
9
      "amount": "230.32",
10
      "currency_amount": "230.32",
11
      "currency_amount_before_tax": "196.32",
12
      "estimate_number": "PLERYGTXYOIMZZ",
13
      "estimate_type": "invoice",
14
      "exchange_rate": 1,
15
      "date": "2020-01-01",
16
      "deadline": "2020-12-31",
17
      "currency_tax": "34.0",
18
      "language": "fr_FR",
19
      "discount": "50.1",
20
      "discount_type": "relative",
21
      "file_url": "https://app.pennylane.com/.../file.pdf",
22
      "updated_at": "2023-08-30T10:08:08.146343Z",
23
      "source": "quotes",
24
      "pdf_invoice_subject": "Invoice title",
25
      "pdf_invoice_free_text": "Some text describing the invoice",

200Returns a list of estimates

400Bad Request

401Access token is missing or invalid

403Forbidden