GET
/
api
/
external
/
v2
/
commercial_documents
{
  "has_more": true,
  "items": [
    {
      "amount": "230.32",
      "appendices": {
        "url": "https://app.pennylane.com/api/external/v2/commercial_documents/42/appendices"
      },
      "archived_at": "2023-08-30T10:08:08.146343Z",
      "commercial_document_template": {
        "id": -92789113
      },
      "created_at": "2023-08-30T10:08:08.146343Z",
      "currency": "EUR",
      "currency_amount": "230.32",
      "currency_amount_before_tax": "196.32",
      "currency_tax": "34.0",
      "customer": {
        "id": 42,
        "url": "https://app.pennylane.com/api/external/v2/customers/42"
      },
      "date": "2020-01-01",
      "deadline": "2020-12-31",
      "discount": {
        "type": "relative",
        "value": "25"
      },
      "document_number": "PLERYGTXYOIMZZ",
      "document_type": "proforma",
      "exchange_rate": "1.0",
      "external_reference": "FR123",
      "filename": "my_file.pdf",
      "id": 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"
      },
      "label": "Commercial document label",
      "language": "fr_FR",
      "pdf_description": "Document description",
      "pdf_invoice_free_text": "Document details",
      "pdf_invoice_subject": "Document subject",
      "public_file_url": "https://app.pennylane.com/.../file.pdf",
      "quote": {
        "id": 201,
        "url": "https://app.pennylane.com/api/external/v2/quotes/201"
      },
      "special_mention": "Additional details",
      "tax": "34.0",
      "updated_at": "2023-08-30T10:08:08.146343Z"
    },
    {
      "amount": "230.32",
      "appendices": {
        "url": "https://app.pennylane.com/api/external/v2/commercial_documents/42/appendices"
      },
      "archived_at": "2023-08-30T10:08:08.146343Z",
      "commercial_document_template": {
        "id": 37666794
      },
      "created_at": "2023-08-30T10:08:08.146343Z",
      "currency": "EUR",
      "currency_amount": "230.32",
      "currency_amount_before_tax": "196.32",
      "currency_tax": "34.0",
      "customer": {
        "id": 42,
        "url": "https://app.pennylane.com/api/external/v2/customers/42"
      },
      "date": "2020-01-01",
      "deadline": "2020-12-31",
      "discount": {
        "type": "relative",
        "value": "25"
      },
      "document_number": "PLERYGTXYOIMZZ",
      "document_type": "proforma",
      "exchange_rate": "1.0",
      "external_reference": "FR123",
      "filename": "my_file.pdf",
      "id": 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"
      },
      "label": "Commercial document label",
      "language": "fr_FR",
      "pdf_description": "Document description",
      "pdf_invoice_free_text": "Document details",
      "pdf_invoice_subject": "Document subject",
      "public_file_url": "https://app.pennylane.com/.../file.pdf",
      "quote": {
        "id": 201,
        "url": "https://app.pennylane.com/api/external/v2/quotes/201"
      },
      "special_mention": "Additional details",
      "tax": "34.0",
      "updated_at": "2023-08-30T10:08:08.146343Z"
    }
  ],
  "next_cursor": "dXBkYXRlZF9hdDoxNjc0MTIzNDU2"
}

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
string

Number of items to return per request. Defaults to 20 if not specified. Must be between 1 and 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
  • purchase_order
Example:

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

​
sort
string

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

Example:

"-id"

Response

200
application/json

A list of Commercial Documents

The response is of type object.