List all the suppliers.
Return a list of all suppliers in the system.
- 200
- application/json
- Schema
- Example (from schema)
Schema array
- id uuid
- name string
Possible values:
<= 256 characters billing_address object
Serializer for an Address.
line1 stringline2 stringcity stringpostal_code stringcountry_code stringshipping_address object
Serializer for an Address.
line1 stringline2 stringcity stringpostal_code stringcountry_code string- country string
Possible values: [
AW,AF,AO,AI,AX,AL,AD,AE,AR,AM,AS,AQ,TF,AG,AU,AT,AZ,BI,BE,BJ,BQ,BF,BD,BG,BH,BS,BA,BL,BY,BZ,BM,BO,BR,BB,BN,BT,BV,BW,CF,CA,CC,CH,CL,CN,CI,CM,CD,CG,CK,CO,KM,CV,CR,CU,CW,CX,KY,CY,CZ,DE,DJ,DM,DK,DO,DZ,EC,EG,ER,EH,ES,EE,ET,FI,FJ,FK,FR,FO,FM,GA,GB,GE,GG,GH,GI,GN,GP,GM,GW,GQ,GR,GD,GL,GT,GF,GU,GY,HK,HM,HN,HR,HT,HU,ID,IM,IN,IO,IE,IR,IQ,IS,IL,IT,JM,JE,JO,JP,KZ,KE,KG,KH,KI,KN,KR,KW,LA,LB,LR,LY,LC,LI,LK,LS,LT,LU,LV,MO,MF,MA,MC,MD,MG,MV,MX,MH,MK,ML,MT,MM,ME,MN,MP,MZ,MR,MS,MQ,MU,MW,MY,YT,NA,NC,NE,NF,NG,NI,NU,NL,NO,NP,NR,NZ,OM,PK,PA,PN,PE,PH,PW,PG,PL,PR,KP,PT,PY,PS,PF,QA,RE,RO,RU,RW,SA,SD,SN,SG,GS,SH,SJ,SB,SL,SV,SM,SO,PM,RS,SS,ST,SR,SK,SI,SE,SZ,SX,SC,SY,TC,TD,TG,TH,TJ,TK,TM,TL,TO,TT,TN,TR,TV,TW,TZ,UG,UA,UM,UY,US,UZ,VA,VC,VE,VG,VI,VN,VU,WF,WS,YE,ZA,ZM,ZW] - default_language string
Possible values: [
aa,ab,af,ak,am,ar,an,as,av,ae,ay,az,ba,bm,be,bn,bi,bo,bs,br,bg,ca,cs,ch,ce,cu,cv,kw,co,cr,cy,da,de,dv,dz,el,en,eo,et,eu,ee,fo,fa,fj,fi,fr,fy,ff,gd,ga,gl,gv,gn,gu,ht,ha,sh,he,hz,hi,ho,hr,hu,hy,ig,io,ii,iu,ie,ia,id,ik,is,it,jv,ja,kl,kn,ks,ka,kr,kk,km,ki,rw,ky,kv,kg,ko,kj,ku,lo,la,lv,li,ln,lt,lb,lu,lg,mh,ml,mr,mk,mg,mt,mn,mi,ms,my,na,nv,nr,nd,ng,ne,nl,nn,nb,no,ny,oc,oj,or,om,os,pa,pi,pl,pt,ps,qu,rm,ro,rn,ru,sg,sa,si,sk,sl,se,sm,sn,sd,so,st,es,sq,sc,sr,ss,su,sw,sv,ty,ta,tt,te,tg,tl,th,ti,to,tn,ts,tk,tr,tw,ug,uk,ur,uz,ve,vi,vo,wa,wo,xh,yi,yo,za,zh,zu] - tax_number string
Possible values:
<= 256 characters - vat_number string
Possible values:
<= 256 characters - business_type object
- external_id string
Possible values:
<= 256 characters - email_address email
Possible values:
<= 254 characters - phone_number string
Possible values:
<= 256 characters - notes string
contacts object[]
first_name stringlast_name stringemail stringdescription stringphone_number stringinclude_in_emails booleanDefault value:
falsebank_accounts object[]
id uuidcountry stringPossible values: [
AW,AF,AO,AI,AX,AL,AD,AE,AR,AM,AS,AQ,TF,AG,AU,AT,AZ,BI,BE,BJ,BQ,BF,BD,BG,BH,BS,BA,BL,BY,BZ,BM,BO,BR,BB,BN,BT,BV,BW,CF,CA,CC,CH,CL,CN,CI,CM,CD,CG,CK,CO,KM,CV,CR,CU,CW,CX,KY,CY,CZ,DE,DJ,DM,DK,DO,DZ,EC,EG,ER,EH,ES,EE,ET,FI,FJ,FK,FR,FO,FM,GA,GB,GE,GG,GH,GI,GN,GP,GM,GW,GQ,GR,GD,GL,GT,GF,GU,GY,HK,HM,HN,HR,HT,HU,ID,IM,IN,IO,IE,IR,IQ,IS,IL,IT,JM,JE,JO,JP,KZ,KE,KG,KH,KI,KN,KR,KW,LA,LB,LR,LY,LC,LI,LK,LS,LT,LU,LV,MO,MF,MA,MC,MD,MG,MV,MX,MH,MK,ML,MT,MM,ME,MN,MP,MZ,MR,MS,MQ,MU,MW,MY,YT,NA,NC,NE,NF,NG,NI,NU,NL,NO,NP,NR,NZ,OM,PK,PA,PN,PE,PH,PW,PG,PL,PR,KP,PT,PY,PS,PF,QA,RE,RO,RU,RW,SA,SD,SN,SG,GS,SH,SJ,SB,SL,SV,SM,SO,PM,RS,SS,ST,SR,SK,SI,SE,SZ,SX,SC,SY,TC,TD,TG,TH,TJ,TK,TM,TL,TO,TT,TN,TR,TV,TW,TZ,UG,UA,UM,UY,US,UZ,VA,VC,VE,VG,VI,VN,VU,WF,WS,YE,ZA,ZM,ZW]name stringPossible values:
<= 256 charactersaccount_number stringPossible values:
<= 256 charactersbic stringPossible values:
<= 256 characterstype stringPossible values: [
IBAN]description stringPossible values:
<= 256 characterslabels object
property name*stringlabels object
property name*string- vat_validation_status object
[
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"billing_address": {
"line1": "string",
"line2": "string",
"city": "string",
"postal_code": "string",
"country_code": "string"
},
"shipping_address": {
"line1": "string",
"line2": "string",
"city": "string",
"postal_code": "string",
"country_code": "string"
},
"country": "AW",
"default_language": "aa",
"tax_number": "string",
"vat_number": "string",
"business_type": "COMPANY",
"external_id": "string",
"email_address": "user@example.com",
"phone_number": "string",
"notes": "string",
"contacts": [
{
"first_name": "string",
"last_name": "string",
"email": "string",
"description": "string",
"phone_number": "string",
"include_in_emails": false
}
],
"bank_accounts": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"country": "AW",
"name": "string",
"account_number": "string",
"bic": "string",
"type": "IBAN",
"description": "string",
"labels": {}
}
],
"labels": {},
"vat_validation_status": "PENDING"
}
]