Skip to main content
GET
/
api
/
external
/
v2
/
commercial_documents
/
{id}
Retrieve a commercial document
curl --request GET \
  --url https://app.pennylane.com/api/external/v2/commercial_documents/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": 42,
  "label": "Commercial document label",
  "document_number": "PLERYGTXYOIMZZ",
  "document_type": "proforma",
  "currency": "EUR",
  "amount": "230.32",
  "currency_amount": "230.32",
  "currency_amount_before_tax": "196.32",
  "exchange_rate": "1.0",
  "date": "2020-01-01",
  "deadline": "2020-12-31",
  "currency_tax": "34.0",
  "tax": "34.0",
  "language": "fr_FR",
  "discount": {
    "type": "absolute",
    "value": "25"
  },
  "public_file_url": "https://app.pennylane.com/.../file.pdf",
  "filename": "my_file.pdf",
  "special_mention": "Additional details",
  "customer": {
    "id": 42,
    "url": "https://app.pennylane.com/api/external/v2/customers/42"
  },
  "invoice_line_sections": {
    "url": "https://app.pennylane.com/api/external/v2/commercial_documents/42/invoice_line_sections"
  },
  "invoice_lines": {
    "url": "https://app.pennylane.com/api/external/v2/commercial_documents/42/invoice_lines"
  },
  "quote": {
    "id": 201,
    "url": "https://app.pennylane.com/api/external/v2/quotes/201"
  },
  "pdf_invoice_free_text": "Document details",
  "pdf_invoice_subject": "Document subject",
  "pdf_description": "Document description",
  "commercial_document_template": {
    "id": 123
  },
  "appendices": {
    "url": "https://app.pennylane.com/api/external/v2/commercial_documents/42/appendices"
  },
  "external_reference": "FR123",
  "archived_at": "2023-08-30T10:08:08.146343Z",
  "created_at": "2023-08-30T10:08:08.146343Z",
  "updated_at": "2023-08-30T10:08:08.146343Z"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
id
integer
required

Response

A Commercial Document

​
id
integer
required

Commercial document identifier

Example:

42

​
label
string | null
required
Example:

"Commercial document label"

​
document_number
string
required
Example:

"PLERYGTXYOIMZZ"

​
document_type
enum<string>
required
Available options:
proforma,
shipping_order,
purchasing_order
​
currency
enum<string>
default:EUR
required
Available options:
EUR,
USD,
GBP,
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BTN,
BWP,
BYN,
BYR,
BZD,
CAD,
CDF,
CHF,
CLF,
CLP,
CNY,
COP,
CRC,
CUC,
CUP,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ERN,
ETB,
FJD,
FKP,
GEL,
GGP,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HRK,
HTG,
HUF,
IDR,
ILS,
IMP,
INR,
IQD,
IRR,
ISK,
JEP,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LTL,
LVL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRO,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SDG,
SEK,
SGD,
SHP,
SLL,
SOS,
SRD,
STD,
SVC,
SYP,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
UYU,
UZS,
VEF,
VND,
VUV,
WST,
XAF,
XCD,
XDR,
XOF,
XPF,
YER,
ZAR,
ZMK,
ZMW,
ZWL
​
amount
string
required

Document amount (total value of the document in euros. If the currency is euro, currency_amount and amount are identical)

Example:

"230.32"

​
currency_amount
string
required

Document currency amount (total value of the document in the currency of the document)

Example:

"230.32"

​
currency_amount_before_tax
string
required

Document currency amount before tax (total value before tax of the document in the currency of the document)

Example:

"196.32"

​
exchange_rate
string
required

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

Example:

"1.0"

​
date
string<date> | null
required

Document issue date (ISO 8601)

Example:

"2020-01-01"

​
deadline
string | null
required

Document deadline (ISO 8601)

Example:

"2020-12-31"

​
currency_tax
string
required

Document taxable amount (in document currency)

Example:

"34.0"

​
tax
string
required

Document taxable amount (in document currency)

Example:

"34.0"

​
language
enum<string>
default:fr_FR
required
Available options:
fr_FR,
en_GB
​
discount
object
required
​
public_file_url
string | null
required

Public URL of the document file. The URL will expire after 30 minutes.

Example:

"https://app.pennylane.com/.../file.pdf"

​
filename
string | null
required

Name of the file attached to the document

Example:

"my_file.pdf"

​
special_mention
string | null
required

Additional details

Example:

"Additional details"

​
customer
object | null
required
​
invoice_line_sections
object
required
​
invoice_lines
object
required
​
quote
object | null
required
​
pdf_invoice_free_text
string
required
Example:

"Document details"

​
pdf_invoice_subject
string
required
Example:

"Document subject"

​
pdf_description
string | null
required
Example:

"Document description"

​
commercial_document_template
object | null
required
​
appendices
object
required
​
external_reference
string
required

The unique external reference that was assigned during creation either by you or Pennylane. (Same attribute as external_id in the API v1)

Example:

"FR123"

​
archived_at
string<date-time> | null
required

The time the document has been archived

Example:

"2023-08-30T10:08:08.146343Z"

​
created_at
string<date-time>
required

The time the document has been created

Example:

"2023-08-30T10:08:08.146343Z"

​
updated_at
string<date-time>
required

The last time the document has been updated

Example:

"2023-08-30T10:08:08.146343Z"

⌘I