PEpennylane
Commercial Documents

List commercial documents

Changed on

This endpoint lists commercial documents.

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

get/api/external/v2/commercial_documents

Request

  • Base URL
    https://app.pennylane.com
  • URL
    https://app.pennylane.com/api/external/v2/commercial_documents
  • Auth
    OAuth 2
    Authorization code: https://app.pennylane.com/oauth/authorize
    Token URL: https://app.pennylane.com/oauth/oauth/token scopes: commercial_documents:all, commercial_documents:readonly

Query parameters

cursorstring
Example:dXBkYXRlZF9hdDoxNjc0MTIzNDU2

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.

limitinteger
Example:20

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

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

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
sortstring

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

Headers

X-Company-Idstring
Example:12345

Numeric ID of the company to act on. Required when authenticating with a firm token. Ignored when the token is already bound to a company.

Response

A list of Commercial Documents

has_moreboolean required

Indicates whether additional results are available beyond this set. Use this flag to determine if another request is needed.

next_cursorstring 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.

Example response

{
  "has_more": true,
  "next_cursor": "dXBkYXRlZF9hdDoxNjc0MTIzNDU2",
  "items": [
    {
      "id": 42,
      "label": "Commercial document label",
      "document_number": "PLERYGTXYOIMZZ",
      "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",
      "discount": {
        "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",
      "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"
    }
  ]
}

Changes

  • 871f863307e5Revision changes
    • warning

      added the new VES enum value to the // response property for the response status

    • warning

      added the new es_ES enum value to the // response property for the response status

    • info

      added the new optional header request parameter X-Company-Id