API Reference

List document numberings

get
https://app.pennylane.com/api/external/v2/numberings

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
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.

integer
1 to 100

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

string
Defaults to -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

Headers
string

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.

Responses

Updated 14 days ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 14 days ago