PEpennylane
Suppliers

Retrieve a supplier

Changed on

This endpoint returns a supplier.

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

get/api/external/v2/suppliers/{id}

Request

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

Path parameters

idinteger required

Supplier identifier

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

Returns a supplier

idinteger required
namestring required
establishment_nostring nullable required

Supplier identification number (SIRET).

  • 14-digit number combining SIREN (9 digits) and NIC (5 digits)
  • Only applicable for French companies
reg_nostring nullable required

Supplier registration number (SIREN).

  • 9-digit number
  • Only applicable for French companies
vat_numberstring required
emailsstring[] required
ibanstring required

The IBAN of the supplier

supplier_payment_method'automatic_transfer' | 'manual_transfer' | 'automatic_debiting' | 'bill_of_exchange' | 'check' | 'cash' | 'card' | 'other' nullable required
supplier_due_date_delayinteger nullable required
supplier_due_date_rule'days' | 'days_or_end_of_month' nullable required
external_referencestring required

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

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "id": 42,
  "name": "Pennylane",
  "establishment_no": "82762938500014",
  "reg_no": "827629385",
  "vat_number": "FR32123456789",
  "emails": [
    "hello@example.org"
  ],
  "iban": "FRXXXXXXXXXXXXXXXXXXXXXXXXX",
  "supplier_due_date_delay": 30,
  "external_reference": "FR123",
  "created_at": "2023-08-30T10:08:08.146343Z",
  "updated_at": "2023-08-30T10:08:08.146343Z"
}

Changes