GET
/
api
/
external
/
v2
/
suppliers
/
{id}
Retrieve a supplier
curl --request GET \
  --url https://app.pennylane.com/api/external/v2/suppliers/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": 42,
  "name": "Pennylane",
  "establishment_no": "82762938500014",
  "reg_no": "827629385",
  "vat_number": "FR32123456789",
  "ledger_account": {
    "id": 123
  },
  "emails": [
    "[email protected]"
  ],
  "iban": "FRXXXXXXXXXXXXXXXXXXXXXXXXX",
  "postal_address": {
    "address": "<string>",
    "postal_code": "<string>",
    "city": "<string>",
    "country_alpha2": "<string>"
  },
  "supplier_payment_method": "automatic_transfer",
  "supplier_due_date_delay": 30,
  "supplier_due_date_rule": "days",
  "external_reference": "FR123",
  "created_at": "2023-08-30T10:08:08.146343Z",
  "updated_at": "2023-08-30T10:08:08.146343Z"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
id
integer
required

Supplier identifier

Response

Returns a supplier

​
id
integer
required
Example:

42

​
name
string
required
Example:

"Pennylane"

​
establishment_no
string | null
required

Supplier identification number (SIRET).

  • 14-digit number combining SIREN (9 digits) and NIC (5 digits)
  • Only applicable for French companies
Example:

"82762938500014"

​
reg_no
string | null
required

Supplier registration number (SIREN).

  • 9-digit number
  • Only applicable for French companies
Example:

"827629385"

​
vat_number
string
required
Example:

"FR32123456789"

​
ledger_account
object | null
required
​
emails
string[]
required
Example:
["[email protected]"]
​
iban
string
required

The IBAN of the supplier

Example:

"FRXXXXXXXXXXXXXXXXXXXXXXXXX"

​
postal_address
object
required
​
supplier_payment_method
enum<string> | null
required
Available options:
automatic_transfer,
manual_transfer,
automatic_debiting,
bill_of_exchange,
check,
cash,
card
​
supplier_due_date_delay
integer | null
required
Example:

30

​
supplier_due_date_rule
enum<string> | null
required
Available options:
days,
days_or_end_of_month
​
external_reference
string
required

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

Example:

"FR123"

​
created_at
string<date-time>
required
Example:

"2023-08-30T10:08:08.146343Z"

​
updated_at
string<date-time>
required
Example:

"2023-08-30T10:08:08.146343Z"