---
title: "List commercial documents"
method: GET
path: "/api/external/v2/commercial_documents"
tags: ["Commercial Documents"]
---

# List commercial documents

`GET /api/external/v2/commercial_documents`

This endpoint lists commercial documents.

> ℹ️
> This endpoint requires one of the following scopes: `commercial_documents:all`, `commercial_documents:readonly`

## Query parameters

- `cursor` string
- `limit` integer
- `filter` string
- `sort` string

## Response `200`

A list of Commercial Documents

- object
  - `has_more` boolean, required — Indicates whether additional results are available beyond this set. Use this flag to determine if another request is needed.
  - `next_cursor` string, nullable, required — Cursor to retrieve the next set of results. Include this value in the cursor parameter of your next request to fetch subsequent items. A `null` `next_cursor` in the response indicates no further results.
  - `items` object[], required
    - `id` integer, required — Commercial document identifier
    - `label` string, nullable, required
    - `document_number` string, required
    - `document_type` 'proforma' | 'shipping_order' | 'purchasing_order', required
    - `currency` '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' | 'CHE' | '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' | 'MRU' | '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' | 'SLE' | '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', required
    - `amount` string, required — Document amount (total value of the document in euros. If the currency is euro, `currency_amount` and `amount` are identical)
    - `currency_amount` string, required — Document currency amount (total value of the document in the currency of the document)
    - `currency_amount_before_tax` string, required — Document currency amount before tax (total value before tax of the document in the currency of the document)
    - `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)
    - `date` string, date, nullable, required — Document issue date (ISO 8601)
    - `deadline` string, date, nullable, required — Document deadline (ISO 8601)
    - `currency_tax` string, required — Document taxable amount (in document currency)
    - `tax` string, required — Document taxable amount (in document currency)
    - `language` 'fr_FR' | 'en_GB' | 'de_DE', required — The local default is based on the thirdparty (customer / supplier ) billing_language . In case the customer is not present, we will default to the company locale.
    - `discount` object, required
      - `type` 'absolute' | 'relative', required — Discount type. - absolute if it is an amount - relative if it is a percentage
      - `value` string, nullable, required — Discount value on the total amount before tax of the line
    - `public_file_url` string, nullable, required — Public URL of the document file. The URL will expire after 30 minutes.
    - `filename` string, nullable, required — Name of the file attached to the document
    - `special_mention` string, nullable, required — Additional details
    - `customer` object, nullable, required
      - `id` integer, required
      - `url` string, required — URL to get the customer.
    - `invoice_line_sections` object, required
      - `url` string, required — URL to get the invoice line sections of the document.
    - `invoice_lines` object, required
      - `url` string, required — URL to get the invoice lines of the document.
    - `quote` object, nullable, required
      - `id` integer, required
      - `url` string, required — URL to get the quote.
    - `pdf_invoice_free_text` string, required
    - `pdf_invoice_subject` string, required
    - `pdf_description` string, nullable, required
    - `commercial_document_template` object, nullable, required
      - `id` integer, required
    - `appendices` object, required
      - `url` string, required — URL to get the appendices of the document.
    - `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)
    - `archived_at` string, date-time, nullable, required — The time the document has been archived
    - `created_at` string, date-time, required — The time the document has been created
    - `updated_at` string, date-time, required — The last time the document has been updated

## Other responses

- `400` — Bad request
- `401` — Access token is missing or invalid
- `403` — Access to this resource forbidden
- `404` — The resource was not found

---

[API](https://skmtc.net/pennylane/apis/company-v2.md) · [All operations](https://skmtc.net/pennylane/apis/company-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pennylane/company-v2/versions/a5b7236473c6/schema)