GET
/
api
/
external
/
v2
/
commercial_documents
List commercial documents
curl --request GET \
  --url https://app.pennylane.com/api/external/v2/commercial_documents \
  --header 'Authorization: Bearer <token>'
{
  "has_more": true,
  "next_cursor": "dXBkYXRlZF9hdDoxNjc0MTIzNDU2",
  "items": [
    {
      "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.

Query Parameters

​
cursor
string

Cursor for pagination. Use this to fetch the next set of results. The cursor is an opaque string returned in the previous response's metadata. Leave empty for the first request.

Example:

"dXBkYXRlZF9hdDoxNjc0MTIzNDU2"

​
limit
integer

Number of items to return per request. Defaults to 20 if not specified. Must be between 1 and 100.

Required range: 1 <= x <= 100
Example:

20

​
filter
string

You can choose to filter items on specific fields. Available fields and operators:

  • id, customer_id: lt, lteq, gt, gteq, eq, not_eq, in, not_in
  • document_type: eq, not_eq, in, not_in

Available document_types:

  • proforma
  • shipping_order
  • purchasing_order
Example:

"[{\"field\": \"id\", \"operator\": \"eq\", \"value\": \"42\"}]"

​
sort
string
default:-id

You can choose to sort items on specific attributes Sort field may be prefixed with - for descending order. Example : id will sort by ascending order, -id will sort by descending order. Available fields : id

Response

200
application/json

A list of Commercial Documents

The response is of type object.