---
title: "List document numberings"
method: GET
path: "/api/external/v2/numberings"
tags: ["Numberings"]
---

# List document numberings

`GET /api/external/v2/numberings`

## Request

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

List the document numbering configuration of the company.

Numbering is configured per document type, and a document type that has never been
configured is absent from this list. Use this endpoint to check before calling the
endpoints below:

- `invoice` gates `PUT /api/external/v2/customer_invoices/{id}/finalize`. Finalizing fails when it is missing.
- `quote` gates `POST /api/external/v2/quotes`. Creation succeeds without it, and the quote then has no number.
- `proforma`, `shipping_order` and `purchasing_order` gate `POST /api/external/v2/commercial_documents`. Creation fails when the matching numbering is missing.

Numbering can only be configured from the Pennylane application.


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

## Query parameters

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

## Headers

- `X-Company-Id` string

## Response `200`

Returns the document numbering configuration of the company

- 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: The list of items returned
    - `id` integer, required
    - `kind` 'invoice' | 'credit_note' | 'quote' | 'proforma' | 'shipping_order' | 'purchasing_order', required: Type of document a numbering configuration applies to. - invoice: customer invoices - credit_note: credit notes - quote: quotes - proforma: proforma commercial documents - shipping_order: shipping order commercial documents - purchasing_order: purchasing order commercial documents
    - `number_prefix` string, nullable, required: Prefix prepended to the number of the next document of this type. It may embed the date variables `%Y` (four digit year), `%y` (two digit year), `%m` (month) and `%d` (day), which are expanded against the date of the document.
    - `next_number` integer, required: Number that the next document of this type will be given.

## Other responses

- `400`: Bad request
- `401`: Access token is missing or invalid
- `403`: Access to this resource forbidden

## Changes

- **2026-11-03** `871f863307e5`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/pennylane/apis/company-v2/changes/api/external/v2/numberings/get.md)

---

[API](https://skmtc.dev/pennylane/apis/company-v2.md) - [All operations](https://skmtc.dev/pennylane/apis/company-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/pennylane/apis/company-v2/revisions/871f863307e5?raw)