API Reference
Start typing to search…

List suppliers

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

List suppliers

⚠️ ALPHA STATUS NOTICE
This endpoint is currently in alpha. It is part of an early testing phase, and its functionality may change or be removed in future updates.
We welcome your feedback to help us improve. Please use this endpoint with caution, especially in production environments, as backward compatibility is not guaranteed and functionality may change frequently.
This feature is best suited for developers interested in testing and providing input on upcoming capabilities.

ℹ️

This endpoint requires one of the following scopes: suppliers:all, suppliers:readonly

Log in to see full request history
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

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

  • id: lt, lteq, gt, gteq, eq, not_eq, in, not_in
  • ledger_account_id: eq, not_eq
  • name: start_with
  • external_reference: eq, not_eq, in, not_in
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

Responses

Response body
object
boolean
required

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

string | null
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
array of objects
required

The list of items returned

items*
object
integer
required
string
required
string | null
required

Supplier identification number (SIRET).

  • 14-digit number combining SIREN (9 digits) and NIC (5 digits)
  • Only applicable for French companies
string
required
object | null
required
emails
array of strings
required
emails*
string
required

The IBAN of the supplier

postal_address
object
required
string | null
required

automatic_transfer manual_transfer automatic_debiting bill_of_exchange check cash card

integer | null
required
string | null
required

days days_or_end_of_month

string
required

The unique external reference that was assigned during creation either by you or Pennylane

date-time
required
date-time
required

Updated 2 months ago

Language
Credentials
OAuth2

Updated 2 months ago