Retrieve a supplier

get https://app.pennylane.com/api/external/v1/suppliers/{id}

This endpoint returns a specific supplier.

Responses

Response body

object

supplier

object

name

string

Company name (present only when type is company)

reg_no

string | null

Supplier identification number (SIRET).

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

vat_number

string

Supplier's VAT number

plan_item

object

updated_at

date-time

The last time the supplier has been updated

source_id

string

supplier identifier (is unique)

emails

array of strings

emails

iban

string

The IBAN of the supplier.

billing_iban

string | null

deprecated

This field is deprecated. Please use "iban" instead.

address

string

supplier address (billing address)

postal_code

string

Postal code (billing address)

city

string

City (billing address)

country_alpha2

string

Country alpha code (billing address)

payment_conditions

string

supplier payment conditions

upon_receipt custom 15_days 30_days 45_days 60_days

phone

string

supplier phone number

reference

string

This reference doesn't appear on the invoice

notes

string

Notes about the supplier

recipient

string

Recipient displayed in the invoice

billing_address

object

v2_id

integer

The corresponding identifier for this resource in the V2 API.
This field is provided to facilitate migration from V1 to V2 API by allowing mapping
between V1 and V2 identifiers. When transitioning to V2 endpoints, use this value
instead of the V1 id or source_id.

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request GET \
2
     --url https://app.pennylane.com/api/external/v1/suppliers/id \
3
     --header 'accept: application/json'


xxxxxxxxxx
38
}
1
{
2
  "supplier": {
3
    "name": "Pennylane",
4
    "reg_no": "82762938500014",
5
    "vat_number": "FR12345678910",
6
    "plan_item": {
7
      "number": "string",
8
      "label": "string",
9
      "enabled": true,
10
      "vat_rate": "string",
11
      "country_alpha2": "string",
12
      "description": "string",
13
      "v2_id": 1234
14
    },
15
    "updated_at": "2023-08-30T10:08:08.146343Z",
16
    "source_id": "38a1f19a-256d-4692-a8fe-0a16403f59ff",
17
    "emails": [
18
      "hello@example.org"
19
    ],
20
    "iban": "FRXX XXXX XXXX XXXX XXXX XXXX XXX",
21
    "address": "4 rue du faubourg saint martin",
22
    "postal_code": "75010",
23
    "city": "Paris",
24
    "country_alpha2": "FR",
25
    "payment_conditions": "upon_receipt",

200OK

401Access token is missing or invalid

403Forbidden

404Not found