Skip to content
/Supplier

Bazimo API (v1)

Languages
Servers
https://doc-api.bazimo.fr/

Authentications

Operations

Building

Operations

Expense

Operations

Invoice

Operations

Lease

Operations

LegalOwner

Operations

Lot

Operations

RealEstateCompany

Operations

Receipt

Operations

Renter

Operations

Supplier

Operations

Retrieve suppliers by client ID

Request

Return all suppliers of a client id

Path
tenantId_pathstringrequired
Body
clientIdstring(uuid)
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/suppliers/getSuppliersByClientId' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "clientId": "5e505642-9024-474d-9434-e5a44f505cc5"
  }'

Responses

OK

Body
listArray of objects
Response
No response example

Retrieve supplier by ID

Request

Return the supplier for a given supplier id

Path
tenantId_pathstringrequired
Body
buildingIdstring or null(uuid)
idstring(uuid)
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/suppliers/getSupplierById' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "buildingId": "fee3295a-6e55-45b0-a091-7b4de7e39de7",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }'

Responses

OK

Body
contractsArray of objects
supplierobject
Response
No response example

Retrieve suppliers by building ID

Request

Return all suppliers of a building id

Path
tenantId_pathstringrequired
Body
buildingIdstring(uuid)
datatableobject
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/suppliers/getSuppliersByBuildingId' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "buildingId": "fee3295a-6e55-45b0-a091-7b4de7e39de7",
    "datatable": {
      "sort": {
        "sortBy": 1,
        "sortMode": 1
      },
      "pagination": {
        "page": 0,
        "rowsPerPage": 0
      },
      "filters": {},
      "search": {
        "value": "string"
      }
    }
  }'

Responses

OK

Body
listArray of objects
datatableobject
facetsArray of objects
Response
No response example

Create a supplier

Request

Create a new supplier

Path
tenantId_pathstringrequired
Body
bankDetailsListArray of objects
billingCitystring or null
billingCountryCodeinteger or null(int32)
Enum12345678910
enumNames: ["Af","Ax","Al","Dz","As","Ad","Ao","Ai","Aq","Ag","Ar","Am","Aw","Au","At","Az","Bs","Bh","Bd","Bb","By","Be","Bz","Bj","Bm","Bt","Bo","Bq","Ba","Bw","Bv","Br","Io","Bn","Bg","Bf","Bi","Cv","Kh","Cm","Ca","Ky","Cf","Td","Cl","Cn","Cx","Cc","Co","Km","Cg","Cd","Ck","Cr","Ci","Hr","Cu","Cw","Cy","Cz","Dk","Dj","Dm","Do","Ec","Eg","Sv","Gq","Er","Ee","Et","Fk","Fo","Fj","Fi","Fr","Gf","Pf","Tf","Ga","Gm","Ge","De","Gh","Gi","Gr","Gl","Gd","Gp","Gu","Gt","Gg","Gn","Gw","Gy","Ht","Hm","Va","Hn","Hk","Hu","Is","In","Id","Ir","Iq","Ie","Im","Il","It","Jm","Jp","Je","Jo","Kz","Ke","Ki","Kp","Kr","Kw","Kg","La","Lv","Lb","Ls","Lr","Ly","Li","Lt","Lu","Mo","Mk","Mg","Mw","My","Mv","Ml","Mt","Mh","Mq","Mr","Mu","Yt","Mx","Fm","Md","Mc","Mn","Me","Ms","Ma","Mz","Mm","Na","Nr","Np","Nl","Nc","Nz","Ni","Ne","Ng","Nu","Nf","Mp","No","Om","Pk","Pw","Ps","Pa","Pg","Py","Pe","Ph","Pn","Pl","Pt","Pr","Qa","Re","Ro","Ru","Rw","Bl","Sh","Kn","Lc","Mf","Pm","Vc","Ws","Sm","St","Sa","Sn","Rs","Sc","Sl","Sg","Sx","Sk","Si","Sb","So","Za","Gs","Ss","Es","Lk","Sd","Sr","Sj","Sz","Se","Ch","Sy","Tw","Tj","Tz","Th","Tl","Tg","Tk","To","Tt","Tn","Tr","Tm","Tc","Tv","Ug","Ua","Ae","Gb","Us","Um","Uy","Uz","Vu","Ve","Vn","Vg","Vi","Wf","Eh","Ye","Zm","Zw"]
billingRecipientLabelstring or null
billingStreet1string or null
billingStreet2string or null
billingStreet3string or null
billingZipCodestring or null
codeNafstring or null
contactListArray of objects
intraCommunityVatIdentificationNumberstring or null
isBillingAddressSameAsPostalAddressboolean
mediaIdstring or null(uuid)
namestring
phoneNumber1string or null
phoneNumber2string or null
postalCitystring or null
postalCountryCodeinteger or null(int32)
Enum12345678910
enumNames: ["Af","Ax","Al","Dz","As","Ad","Ao","Ai","Aq","Ag","Ar","Am","Aw","Au","At","Az","Bs","Bh","Bd","Bb","By","Be","Bz","Bj","Bm","Bt","Bo","Bq","Ba","Bw","Bv","Br","Io","Bn","Bg","Bf","Bi","Cv","Kh","Cm","Ca","Ky","Cf","Td","Cl","Cn","Cx","Cc","Co","Km","Cg","Cd","Ck","Cr","Ci","Hr","Cu","Cw","Cy","Cz","Dk","Dj","Dm","Do","Ec","Eg","Sv","Gq","Er","Ee","Et","Fk","Fo","Fj","Fi","Fr","Gf","Pf","Tf","Ga","Gm","Ge","De","Gh","Gi","Gr","Gl","Gd","Gp","Gu","Gt","Gg","Gn","Gw","Gy","Ht","Hm","Va","Hn","Hk","Hu","Is","In","Id","Ir","Iq","Ie","Im","Il","It","Jm","Jp","Je","Jo","Kz","Ke","Ki","Kp","Kr","Kw","Kg","La","Lv","Lb","Ls","Lr","Ly","Li","Lt","Lu","Mo","Mk","Mg","Mw","My","Mv","Ml","Mt","Mh","Mq","Mr","Mu","Yt","Mx","Fm","Md","Mc","Mn","Me","Ms","Ma","Mz","Mm","Na","Nr","Np","Nl","Nc","Nz","Ni","Ne","Ng","Nu","Nf","Mp","No","Om","Pk","Pw","Ps","Pa","Pg","Py","Pe","Ph","Pn","Pl","Pt","Pr","Qa","Re","Ro","Ru","Rw","Bl","Sh","Kn","Lc","Mf","Pm","Vc","Ws","Sm","St","Sa","Sn","Rs","Sc","Sl","Sg","Sx","Sk","Si","Sb","So","Za","Gs","Ss","Es","Lk","Sd","Sr","Sj","Sz","Se","Ch","Sy","Tw","Tj","Tz","Th","Tl","Tg","Tk","To","Tt","Tn","Tr","Tm","Tc","Tv","Ug","Ua","Ae","Gb","Us","Um","Uy","Uz","Vu","Ve","Vn","Vg","Vi","Wf","Eh","Ye","Zm","Zw"]
postalRecipientLabelstring or null
postalStreet1string or null
postalStreet2string or null
postalStreet3string or null
postalZipCodestring or null
referencestring
serviceProvidedstring or null
sirenstring or null
siretstring or null
typeinteger or null(int32)
Enum12345678910
enumNames: ["Insurer","Other","Lawyer","TaxCenter","Marketer","CoOwnership","RealEstateDiagnostician","TechnicalCompany","RealEstateExpert","WaterFluid","ElectricityFluid","GasFluid","PhoneFluid","Usher","Maintainer","Notary","ManagementCompany","Treasury"]
webSitestring or null
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/suppliers/createSupplier' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "bankDetailsList": [
      {
        "accountOwner": "string",
        "bankDomiciliation": "string",
        "bic": "string",
        "iban": "string",
        "wording": "string"
      }
    ],
    "billingCity": "string",
    "billingCountryCode": 1,
    "billingRecipientLabel": "string",
    "billingStreet1": "string",
    "billingStreet2": "string",
    "billingStreet3": "string",
    "billingZipCode": "string",
    "codeNaf": "string",
    "contactList": [
      {
        "comment": "string",
        "email": "string",
        "firstName": "string",
        "lastName": "string",
        "phoneNumber1": "string",
        "phoneNumber2": "string",
        "title": "string"
      }
    ],
    "intraCommunityVatIdentificationNumber": "string",
    "isBillingAddressSameAsPostalAddress": true,
    "mediaId": "5a8ffac5-2288-485d-b463-90c3cd9941ad",
    "name": "string",
    "phoneNumber1": "string",
    "phoneNumber2": "string",
    "postalCity": "string",
    "postalCountryCode": 1,
    "postalRecipientLabel": "string",
    "postalStreet1": "string",
    "postalStreet2": "string",
    "postalStreet3": "string",
    "postalZipCode": "string",
    "reference": "string",
    "serviceProvided": "string",
    "siren": "string",
    "siret": "string",
    "type": 1,
    "webSite": "string"
  }'

Responses

OK

Body
idstring(uuid)
Response
No response example

Update a supplier

Request

Update an existing supplier

Path
tenantId_pathstringrequired
Body
bankDetailsListArray of objects
billingCitystring or null
billingCountryCodeinteger or null(int32)
Enum12345678910
enumNames: ["Af","Ax","Al","Dz","As","Ad","Ao","Ai","Aq","Ag","Ar","Am","Aw","Au","At","Az","Bs","Bh","Bd","Bb","By","Be","Bz","Bj","Bm","Bt","Bo","Bq","Ba","Bw","Bv","Br","Io","Bn","Bg","Bf","Bi","Cv","Kh","Cm","Ca","Ky","Cf","Td","Cl","Cn","Cx","Cc","Co","Km","Cg","Cd","Ck","Cr","Ci","Hr","Cu","Cw","Cy","Cz","Dk","Dj","Dm","Do","Ec","Eg","Sv","Gq","Er","Ee","Et","Fk","Fo","Fj","Fi","Fr","Gf","Pf","Tf","Ga","Gm","Ge","De","Gh","Gi","Gr","Gl","Gd","Gp","Gu","Gt","Gg","Gn","Gw","Gy","Ht","Hm","Va","Hn","Hk","Hu","Is","In","Id","Ir","Iq","Ie","Im","Il","It","Jm","Jp","Je","Jo","Kz","Ke","Ki","Kp","Kr","Kw","Kg","La","Lv","Lb","Ls","Lr","Ly","Li","Lt","Lu","Mo","Mk","Mg","Mw","My","Mv","Ml","Mt","Mh","Mq","Mr","Mu","Yt","Mx","Fm","Md","Mc","Mn","Me","Ms","Ma","Mz","Mm","Na","Nr","Np","Nl","Nc","Nz","Ni","Ne","Ng","Nu","Nf","Mp","No","Om","Pk","Pw","Ps","Pa","Pg","Py","Pe","Ph","Pn","Pl","Pt","Pr","Qa","Re","Ro","Ru","Rw","Bl","Sh","Kn","Lc","Mf","Pm","Vc","Ws","Sm","St","Sa","Sn","Rs","Sc","Sl","Sg","Sx","Sk","Si","Sb","So","Za","Gs","Ss","Es","Lk","Sd","Sr","Sj","Sz","Se","Ch","Sy","Tw","Tj","Tz","Th","Tl","Tg","Tk","To","Tt","Tn","Tr","Tm","Tc","Tv","Ug","Ua","Ae","Gb","Us","Um","Uy","Uz","Vu","Ve","Vn","Vg","Vi","Wf","Eh","Ye","Zm","Zw"]
billingRecipientLabelstring or null
billingStreet1string or null
billingStreet2string or null
billingStreet3string or null
billingZipCodestring or null
codeNafstring or null
contactListArray of objects
idstring(uuid)
intraCommunityVatIdentificationNumberstring or null
isBillingAddressSameAsPostalAddressboolean
mediaIdstring or null(uuid)
namestring
phoneNumber1string or null
phoneNumber2string or null
postalCitystring or null
postalCountryCodeinteger or null(int32)
Enum12345678910
enumNames: ["Af","Ax","Al","Dz","As","Ad","Ao","Ai","Aq","Ag","Ar","Am","Aw","Au","At","Az","Bs","Bh","Bd","Bb","By","Be","Bz","Bj","Bm","Bt","Bo","Bq","Ba","Bw","Bv","Br","Io","Bn","Bg","Bf","Bi","Cv","Kh","Cm","Ca","Ky","Cf","Td","Cl","Cn","Cx","Cc","Co","Km","Cg","Cd","Ck","Cr","Ci","Hr","Cu","Cw","Cy","Cz","Dk","Dj","Dm","Do","Ec","Eg","Sv","Gq","Er","Ee","Et","Fk","Fo","Fj","Fi","Fr","Gf","Pf","Tf","Ga","Gm","Ge","De","Gh","Gi","Gr","Gl","Gd","Gp","Gu","Gt","Gg","Gn","Gw","Gy","Ht","Hm","Va","Hn","Hk","Hu","Is","In","Id","Ir","Iq","Ie","Im","Il","It","Jm","Jp","Je","Jo","Kz","Ke","Ki","Kp","Kr","Kw","Kg","La","Lv","Lb","Ls","Lr","Ly","Li","Lt","Lu","Mo","Mk","Mg","Mw","My","Mv","Ml","Mt","Mh","Mq","Mr","Mu","Yt","Mx","Fm","Md","Mc","Mn","Me","Ms","Ma","Mz","Mm","Na","Nr","Np","Nl","Nc","Nz","Ni","Ne","Ng","Nu","Nf","Mp","No","Om","Pk","Pw","Ps","Pa","Pg","Py","Pe","Ph","Pn","Pl","Pt","Pr","Qa","Re","Ro","Ru","Rw","Bl","Sh","Kn","Lc","Mf","Pm","Vc","Ws","Sm","St","Sa","Sn","Rs","Sc","Sl","Sg","Sx","Sk","Si","Sb","So","Za","Gs","Ss","Es","Lk","Sd","Sr","Sj","Sz","Se","Ch","Sy","Tw","Tj","Tz","Th","Tl","Tg","Tk","To","Tt","Tn","Tr","Tm","Tc","Tv","Ug","Ua","Ae","Gb","Us","Um","Uy","Uz","Vu","Ve","Vn","Vg","Vi","Wf","Eh","Ye","Zm","Zw"]
postalRecipientLabelstring or null
postalStreet1string or null
postalStreet2string or null
postalStreet3string or null
postalZipCodestring or null
referencestring
serviceProvidedstring or null
sirenstring or null
siretstring or null
typeinteger or null(int32)
Enum12345678910
enumNames: ["Insurer","Other","Lawyer","TaxCenter","Marketer","CoOwnership","RealEstateDiagnostician","TechnicalCompany","RealEstateExpert","WaterFluid","ElectricityFluid","GasFluid","PhoneFluid","Usher","Maintainer","Notary","ManagementCompany","Treasury"]
webSitestring or null
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/suppliers/updateSupplier' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "bankDetailsList": [
      {
        "accountOwner": "string",
        "bankDomiciliation": "string",
        "bic": "string",
        "iban": "string",
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "wording": "string"
      }
    ],
    "billingCity": "string",
    "billingCountryCode": 1,
    "billingRecipientLabel": "string",
    "billingStreet1": "string",
    "billingStreet2": "string",
    "billingStreet3": "string",
    "billingZipCode": "string",
    "codeNaf": "string",
    "contactList": [
      {
        "comment": "string",
        "email": "string",
        "firstName": "string",
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "lastName": "string",
        "phoneNumber1": "string",
        "phoneNumber2": "string",
        "title": "string"
      }
    ],
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "intraCommunityVatIdentificationNumber": "string",
    "isBillingAddressSameAsPostalAddress": true,
    "mediaId": "5a8ffac5-2288-485d-b463-90c3cd9941ad",
    "name": "string",
    "phoneNumber1": "string",
    "phoneNumber2": "string",
    "postalCity": "string",
    "postalCountryCode": 1,
    "postalRecipientLabel": "string",
    "postalStreet1": "string",
    "postalStreet2": "string",
    "postalStreet3": "string",
    "postalZipCode": "string",
    "reference": "string",
    "serviceProvided": "string",
    "siren": "string",
    "siret": "string",
    "type": 1,
    "webSite": "string"
  }'

Responses

OK

Body
object
Response
No response example

Delete a supplier

Request

Delete an existing supplier

Path
tenantId_pathstringrequired
Body
idstring(uuid)
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/suppliers/deleteSupplier' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }'

Responses

OK

Body
object
Response
No response example

User

Operations