Skip to main content
PUT
/
v1
/
vendors
/
{id}
Update a Vendor
curl --request PUT \
  --url https://external.pleo.io/v1/vendors/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --data '
{
  "companyId": "c082afd8-c1d2-46ee-8f56-1512638f0e67",
  "defaultCurrency": "DKK",
  "externalId": "<string>",
  "name": "Pleo",
  "state": "DRAFT",
  "code": "<string>",
  "country": "DK",
  "registrationNumber": "<string>",
  "taxRegistrationNumber": "<string>"
}
'
{
  "data": {
    "companyId": "c082afd8-c1d2-46ee-8f56-1512638f0e67",
    "defaultCurrency": "DKK",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Pleo",
    "state": "DRAFT",
    "code": "<string>",
    "country": "UNDEFINED",
    "createdAt": "2023-11-07T05:31:56Z",
    "externalId": "<string>",
    "registrationNumber": "<string>",
    "taxRegistrationNumber": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

Pleo's internal identifier of the vendor.

Example:

"123e4567-e89b-12d3-a456-426614174000"

Body

application/json;charset=UTF-8
​
companyId
string<uuid>
required

Pleo's internal identifier for the company the Vendor is associated with.

Example:

"c082afd8-c1d2-46ee-8f56-1512638f0e67"

​
defaultCurrency
string
required

Default currency in which the vendor's financial operations,such as purchases, payments, or invoices, are primarily conducted. (ISO 4217 currency code (3 letters))

Example:

"DKK"

​
externalId
string
required

Unique external identifier of the vendor, assigned by the target ERP/accounting system, used by the client for identification. Can be the same as code if no other identifier is available.

​
name
string
required

The name field represents the official name of the Vendor as it is recorded in the target ERP/accounting system. This name is used to uniquely identify the vendor within the accounting workflow and is visible to the Pleo bookkeeper.

Example:

"Pleo"

​
state
enum<string>
required

Current state of the Vendor. ACTIVE means the vendor is in-sync with target ERP/accounting system. DRAFT means the vendor needs to be created in the target ERP/accounting system.

Available options:
DRAFT,
ACTIVE,
ARCHIVED
​
code
string

Unique identifier assigned to the vendor in the target ERP/accounting system for aiding users in identifying the correct record.

​
country
enum<string>

Country of registration of the Vendor (ISO 3166-1 alpha-2 country code (2 letters))

Available options:
UNDEFINED,
AC,
AD,
AE,
AF,
AG,
AI,
AL,
AM,
AN,
AO,
AQ,
AR,
AS,
AT,
AU,
AW,
AX,
AZ,
BA,
BB,
BD,
BE,
BF,
BG,
BH,
BI,
BJ,
BL,
BM,
BN,
BO,
BQ,
BR,
BS,
BT,
BU,
BV,
BW,
BY,
BZ,
CA,
CC,
CD,
CF,
CG,
CH,
CI,
CK,
CL,
CM,
CN,
CO,
CP,
CR,
CS,
CU,
CV,
CW,
CX,
CY,
CZ,
DE,
DG,
DJ,
DK,
DM,
DO,
DZ,
EA,
EC,
EE,
EG,
EH,
ER,
ES,
ET,
EU,
EZ,
FI,
FJ,
FK,
FM,
FO,
FR,
FX,
GA,
GB,
GD,
GE,
GF,
GG,
GH,
GI,
GL,
GM,
GN,
GP,
GQ,
GR,
GS,
GT,
GU,
GW,
GY,
HK,
HM,
HN,
HR,
HT,
HU,
IC,
ID,
IE,
IL,
IM,
IN,
IO,
IQ,
IR,
IS,
IT,
JE,
JM,
JO,
JP,
KE,
KG,
KH,
KI,
KM,
KN,
KP,
KR,
KW,
KY,
KZ,
LA,
LB,
LC,
LI,
LK,
LR,
LS,
LT,
LU,
LV,
LY,
MA,
MC,
MD,
ME,
MF,
MG,
MH,
MK,
ML,
MM,
MN,
MO,
MP,
MQ,
MR,
MS,
MT,
MU,
MV,
MW,
MX,
MY,
MZ,
NA,
NC,
NE,
NF,
NG,
NI,
NL,
NO,
NP,
NR,
NT,
NU,
NZ,
OM,
PA,
PE,
PF,
PG,
PH,
PK,
PL,
PM,
PN,
PR,
PS,
PT,
PW,
PY,
QA,
RE,
RO,
RS,
RU,
RW,
SA,
SB,
SC,
SD,
SE,
SF,
SG,
SH,
SI,
SJ,
SK,
SL,
SM,
SN,
SO,
SR,
SS,
ST,
SU,
SV,
SX,
SY,
SZ,
TA,
TC,
TD,
TF,
TG,
TH,
TJ,
TK,
TL,
TM,
TN,
TO,
TP,
TR,
TT,
TV,
TW,
TZ,
UA,
UG,
UK,
UM,
US,
UY,
UZ,
VA,
VC,
VE,
VG,
VI,
VN,
VU,
WF,
WS,
XI,
XU,
XK,
YE,
YT,
YU,
ZA,
ZM,
ZR,
ZW
Example:

"DK"

​
registrationNumber
string

Unique identification of a registered vendor in a country.

​
taxRegistrationNumber
string

VAT/GST/TaxId number of the Vendor.

Response

Vendor updated

​
data
object
required