Skip to main content
POST
/
v1
/
vendors:search
Fetches Vendors by search criteria
curl --request POST \
  --url https://external.pleo.io/v1/vendors:search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --data '
{
  "accountingSystems": [
    "<string>"
  ],
  "codes": [
    "<string>"
  ],
  "countries": [
    "DK"
  ],
  "externalIds": [
    "<string>"
  ],
  "ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "name": "Pleo",
  "states": [
    "DRAFT"
  ],
  "taxRegistrationNumbers": [
    "<string>"
  ]
}
'
{
  "data": [
    {
      "companyId": "c082afd8-c1d2-46ee-8f56-1512638f0e67",
      "defaultCurrency": "DKK",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Pleo",
      "state": "DRAFT",
      "accountingSystem": "<string>",
      "code": "<string>",
      "country": "DK",
      "createdAt": "2023-11-07T05:31:56Z",
      "externalId": "<string>",
      "registrationNumber": "<string>",
      "taxRegistrationNumber": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "currentRequestPagination": {
      "parameters": {},
      "after": "<string>",
      "before": "<string>",
      "limit": 123,
      "offset": 123,
      "sortingKeys": [
        "<string>"
      ],
      "sortingOrder": [
        "ASC"
      ]
    },
    "hasNextPage": true,
    "hasPreviousPage": true,
    "endCursor": "<string>",
    "startCursor": "<string>",
    "total": 123
  }
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token authentication. Include the token in the Authorization header as: Bearer <token>

Query Parameters

​
company_id
string<uuid>
required

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

​
before
string

Lower bound of the page of data to return (cannot be used together with [after] or [offset]).

​
after
string

Upper bound of the page of data to return (cannot be used together with [before] or [offset]).

​
offset
integer<int64>

Offset of the page of data to return (cannot be used together with [before] or [after]).

​
limit
integer<int32>

The maximum amount of items to return.

​
sorting_keys
string[]

The keys to sort the results by.

​
sorting_order
enum<string>[]

The order to sort the results by. Must be the same length as [sortingKeys]; one order per key.

Available options:
ASC,
ASC_NULLS_FIRST,
ASC_NULLS_LAST,
DESC,
DESC_NULLS_FIRST,
DESC_NULLS_LAST

Body

application/json;charset=UTF-8
​
accountingSystems
string[]

Only return Vendors linked to the given target ERP/accounting systems.

Maximum array length: 100

The target ERP/accounting system the Vendor is associated with.

​
codes
string[]

Only return Vendors with the given vendor codes.

Maximum array length: 100

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

​
countries
enum<string>[]

Only return Vendors with the given country codes.

Maximum array length: 100

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
​
externalIds
string[]

Only return Vendors with the given vendor external ids.

Maximum array length: 100

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.

​
ids
string<uuid>[]

Only return Vendors with the given Vendor Ids.

Maximum array length: 100

Pleo's internal identifier of the vendor.

​
name
string

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"

​
states
enum<string>[]

Only return Vendors with the given states.

Maximum array length: 4

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
​
taxRegistrationNumbers
string[]

Only return Vendors with the given Tax Registration Numbers.

Maximum array length: 100

VAT/GST/TaxId number of the Vendor.

Response

200 - application/json;charset=UTF-8

Fetches vendors by search criteria

​
data
object[]
required
​
pagination
object
required