# Bazimo API Version: v1 ## Download OpenAPI description [Bazimo API](https://doc-api.bazimo.fr/_bundle/Documentation/swagger.yaml) ## Authentications ### Authenticate a user - [POST /api/tenant/{tenantId_path}/authentications/login](https://doc-api.bazimo.fr/documentation/swagger/authentications/authentications_login.md): Returns a Bearer token that can be used to authenticate a user on other API endpoints. ## Building ### Retrieve building data by id - [POST /api/tenant/{tenantId_path}/buildings/getBuildingById](https://doc-api.bazimo.fr/documentation/swagger/building/building_getbuildingbyid.md): Return all building data ### Retrieve real estate building list - [POST /api/tenant/{tenantId_path}/buildings/getRealEstateBuildings](https://doc-api.bazimo.fr/documentation/swagger/building/building_getrealestatebuildings.md): Return a list of buildings that the user is allowed to view. ### Retrieve all buildings - [POST /api/tenant/{tenantId_path}/buildings/GetAllBuildings](https://doc-api.bazimo.fr/documentation/swagger/building/building_getallbuildings.md): Return all buildings that the used is allowed to view. ### Retrieve buildings by legal owner id - [POST /api/tenant/{tenantId_path}/buildings/getBuildingsByLegalOwnerId](https://doc-api.bazimo.fr/documentation/swagger/building/building_getbuildingsbylegalownerid.md): Retrieve a list of building of a specific legal owner. ## Expense ### Create a new expense - [POST /api/tenant/{tenantId_path}/expense/createExpense](https://doc-api.bazimo.fr/documentation/swagger/expense/expense_createexpense.md): Create a new expense on a building. ### Update an existing expense - [POST /api/tenant/{tenantId_path}/expense/updateExpense](https://doc-api.bazimo.fr/documentation/swagger/expense/expense_updateexpense.md): Update an expense if this is allowed. ### Pay an expense - [POST /api/tenant/{tenantId_path}/expense/payExpense](https://doc-api.bazimo.fr/documentation/swagger/expense/expense_payexpense.md): Mark an expense as paid. ### Set an expense as ready to pay - [POST /api/tenant/{tenantId_path}/expense/setAsReadyToPayExpense](https://doc-api.bazimo.fr/documentation/swagger/expense/expense_setasreadytopayexpense.md): Mark an expense as ready to pay. ### Retrieve expenses by building id - [POST /api/tenant/{tenantId_path}/expense/getExpensesByBuildingId](https://doc-api.bazimo.fr/documentation/swagger/expense/expense_getexpensesbybuildingid.md): Return a list of expenses of the building. ### Retrieve all expenses - [POST /api/tenant/{tenantId_path}/expense/getAllExpenses](https://doc-api.bazimo.fr/documentation/swagger/expense/expense_getallexpenses.md): Return all expenses of all buildings that the user is allowed to see. ### Retrieve expense by id - [POST /api/tenant/{tenantId_path}/expense/getExpenseById](https://doc-api.bazimo.fr/documentation/swagger/expense/expense_getexpensebyid.md): Return expense data. ### Retrieve building data by id - [POST /api/tenant/{tenantId_path}/expense/setExpenseMediaId](https://doc-api.bazimo.fr/documentation/swagger/expense/expense_setexpensemediaid.md): Upload file linked to the expense. ## Invoice ### Get Invoices By Building Id - [POST /api/tenant/{tenantId_path}/invoice/getInvoicesByBuildingId](https://doc-api.bazimo.fr/documentation/swagger/invoice/invoice_getinvoicesbybuildingid.md): Return invoices for a specific building. ### Get Invoice By Id - [POST /api/tenant/{tenantId_path}/invoice/getInvoiceById](https://doc-api.bazimo.fr/documentation/swagger/invoice/invoice_getinvoicebyid.md): Return a specific invoice by its Id. ### Download Invoice (Should be Validated) - [POST /api/tenant/{tenantId_path}/invoice/downloadInvoice](https://doc-api.bazimo.fr/documentation/swagger/invoice/invoice_downloadinvoice.md): Download the PDF of a specific invoice by its Id. The invoice should be validated. ## Lease ### Activate a lease - [POST /api/tenant/{tenantId_path}/lease/activate](https://doc-api.bazimo.fr/documentation/swagger/lease/lease_activatelease.md): Activate a lease in draft state ### Terminate a lease - [POST /api/tenant/{tenantId_path}/lease/terminate](https://doc-api.bazimo.fr/documentation/swagger/lease/lease_terminatelease.md): Terminate an active lease ### Close a lease - [POST /api/tenant/{tenantId_path}/lease/close](https://doc-api.bazimo.fr/documentation/swagger/lease/lease_closelease.md): Close a terminated lease ### Delete a lease - [POST /api/tenant/{tenantId_path}/lease/deleteLease](https://doc-api.bazimo.fr/documentation/swagger/lease/lease_deletelease.md): Delete a lease in draft state ### Retrieve lease by id - [POST /api/tenant/{tenantId_path}/lease/getLeaseById](https://doc-api.bazimo.fr/documentation/swagger/lease/lease_getleasebyid.md): Retrieve lease by id ### Retrieve building lease list - [POST /api/tenant/{tenantId_path}/lease/getLeasesByBuildingId](https://doc-api.bazimo.fr/documentation/swagger/lease/lease_getleasesbybuildingid.md): Retrieve building lease list ### Create a lease - [POST /api/tenant/{tenantId_path}/lease/create](https://doc-api.bazimo.fr/documentation/swagger/lease/lease_createlease.md): Create a lease in draft state ## LegalOwner ### Retrieve all legal owners - [POST /api/tenant/{tenantId_path}/legalOwners/GetAllLegalOwners](https://doc-api.bazimo.fr/documentation/swagger/legalowner/legalowner_getalllegalowners.md): Return all legal owners that the user has access to ### Retrieve legal owner by client Id - [POST /api/tenant/{tenantId_path}/legalOwners/GetLegalOwnersByClientId](https://doc-api.bazimo.fr/documentation/swagger/legalowner/legalowner_getlegalownersbyclientid.md): Return all legal owners for a given client id ### Retrieve legal owner by Id - [POST /api/tenant/{tenantId_path}/legalOwners/GetLegalOwnerById](https://doc-api.bazimo.fr/documentation/swagger/legalowner/legalowner_getlegalownerbyid.md): Return the legal owner for a given legal owner id ### Retrieve legal owner bank accounts by legal owner Id - [POST /api/tenant/{tenantId_path}/legalOwners/GetLegalOwnerBankAccountsByLegalOwnerId](https://doc-api.bazimo.fr/documentation/swagger/legalowner/legalowner_getlegalownerbankaccountsbylegalownerid.md): Return all bank accounts for a given legal owner id ## Lot ### Retrieve lot by Id - [POST /api/tenant/{tenantId_path}/lot/getLotById](https://doc-api.bazimo.fr/documentation/swagger/lot/lot_getlotbyid.md): Return the lot for a given lot id ### Retrieve all lot of user - [POST /api/tenant/{tenantId_path}/lot/getRealEstateLots](https://doc-api.bazimo.fr/documentation/swagger/lot/lot_getrealestatelots.md): Return all lot of user ### Retrieve lot by building Id - [POST /api/tenant/{tenantId_path}/lot/getLotsByBuildingId](https://doc-api.bazimo.fr/documentation/swagger/lot/lot_getlotsbybuildingid.md): Return all lot for a given building id ### Retrieve lot by lease Id - [POST /api/tenant/{tenantId_path}/lot/getLotsByLeaseId](https://doc-api.bazimo.fr/documentation/swagger/lot/lot_getlotsbyleaseid.md): Return all lot for a given lease id ### Retrieve lot by Renter Id - [POST /api/tenant/{tenantId_path}/lot/getLotsByRenterId](https://doc-api.bazimo.fr/documentation/swagger/lot/lot_getlotsbyrenterid.md): Return all lot for a given renter id ## RealEstateCompany ### Retrieve all real estate companies. - [POST /api/tenant/{tenantId_path}/realEstateCompanies/GetAllRealEstateCompanies](https://doc-api.bazimo.fr/documentation/swagger/realestatecompany/realestatecompany_getallrealestatecompanies.md): Returns a list of all real estate companies. ### Retrieve real estate company by Id - [POST /api/tenant/{tenantId_path}/realEstateCompanies/GetRealEstateCompanyById](https://doc-api.bazimo.fr/documentation/swagger/realestatecompany/realestatecompany_getrealestatecompanybyid.md): Return the details of a specific real estate company by its unique identifier. ## Receipt ### Retrieve receipts and refunds by building id - [POST /api/tenant/{tenantId_path}/receipts/GetReceiptsAndRefundsByBuildingId](https://doc-api.bazimo.fr/documentation/swagger/receipt/receipt_getreceiptsandrefundsbybuildingid.md): Return a list of receipts and refunds for a specific building ### Retrieve receipt by id - [POST /api/tenant/{tenantId_path}/receipts/getReceiptById](https://doc-api.bazimo.fr/documentation/swagger/receipt/receipt_getreceiptbyid.md): Return a receipt by its unique identifier ### Retrieve next receipt number - [POST /api/tenant/{tenantId_path}/receipts/GetNextReceiptNumber](https://doc-api.bazimo.fr/documentation/swagger/receipt/receipt_getnextreceiptnumber.md): Get the next available receipt number ### Create a new receipt - [POST /api/tenant/{tenantId_path}/receipts/createReceipt](https://doc-api.bazimo.fr/documentation/swagger/receipt/receipt_createreceipt.md): Create a new receipt for a specific building ### Create a validated refund - [POST /api/tenant/{tenantId_path}/receipts/CreateValidatedRefund](https://doc-api.bazimo.fr/documentation/swagger/receipt/receipt_createvalidatedrefund.md): Create a validated refund ### Update an existing receipt - [POST /api/tenant/{tenantId_path}/receipts/updateReceipt](https://doc-api.bazimo.fr/documentation/swagger/receipt/receipt_updatereceipt.md): Update details of an existing receipt that is not validated ### Validate a receipt before processing - [POST /api/tenant/{tenantId_path}/receipts/validateReceipt](https://doc-api.bazimo.fr/documentation/swagger/receipt/receipt_validatereceipt.md): Validate a receipt in draft state ### Cancel a receipt - [POST /api/tenant/{tenantId_path}/receipts/cancelReceipt](https://doc-api.bazimo.fr/documentation/swagger/receipt/receipt_cancelreceipt.md): Cancel a receipt that has been previously validated ### Cancel a refund - [POST /api/tenant/{tenantId_path}/receipts/cancelRefund](https://doc-api.bazimo.fr/documentation/swagger/receipt/receipt_cancelrefund.md): Cancel a refund that has been previously validated ### Delete a receipt - [POST /api/tenant/{tenantId_path}/receipts/deleteReceipt](https://doc-api.bazimo.fr/documentation/swagger/receipt/receipt_deletereceipt.md): Delete a receipt in draft state ## Renter ### Retrieve renter by id - [POST /api/tenant/{tenantId_path}/renter/getRenterById](https://doc-api.bazimo.fr/documentation/swagger/renter/renter_getrenterbyid.md): Return the renter for a given renter id ### Retrieve renters by building id - [POST /api/tenant/{tenantId_path}/renter/getRentersByBuildingId](https://doc-api.bazimo.fr/documentation/swagger/renter/renter_getrentersbybuildingid.md): Return all renters for a given building id ## Supplier ### Retrieve suppliers by client ID - [POST /api/tenant/{tenantId_path}/suppliers/getSuppliersByClientId](https://doc-api.bazimo.fr/documentation/swagger/supplier/supplier_getsuppliersbyclientid.md): Return all suppliers of a client id ### Retrieve supplier by ID - [POST /api/tenant/{tenantId_path}/suppliers/getSupplierById](https://doc-api.bazimo.fr/documentation/swagger/supplier/supplier_getsupplierbyid.md): Return the supplier for a given supplier id ### Retrieve suppliers by building ID - [POST /api/tenant/{tenantId_path}/suppliers/getSuppliersByBuildingId](https://doc-api.bazimo.fr/documentation/swagger/supplier/supplier_getsuppliersbybuildingid.md): Return all suppliers of a building id ### Create a supplier - [POST /api/tenant/{tenantId_path}/suppliers/createSupplier](https://doc-api.bazimo.fr/documentation/swagger/supplier/supplier_createsupplier.md): Create a new supplier ### Update a supplier - [POST /api/tenant/{tenantId_path}/suppliers/updateSupplier](https://doc-api.bazimo.fr/documentation/swagger/supplier/supplier_updatesupplier.md): Update an existing supplier ### Delete a supplier - [POST /api/tenant/{tenantId_path}/suppliers/deleteSupplier](https://doc-api.bazimo.fr/documentation/swagger/supplier/supplier_deletesupplier.md): Delete an existing supplier ## User ### Retrieve user by email - [POST /api/tenant/{tenantId_path}/user/GetUserByEmail](https://doc-api.bazimo.fr/documentation/swagger/user/user_getuserbyemail.md): Return user details by email ### Retrieve users for select by building ID - [POST /api/tenant/{tenantId_path}/user/GetUsersForSelectByBuildingId](https://doc-api.bazimo.fr/documentation/swagger/user/user_getusersforselectbybuildingid.md): Return users for select by building ID ### Retrieve users by building ID - [POST /api/tenant/{tenantId_path}/user/GetUsersByBuildingId](https://doc-api.bazimo.fr/documentation/swagger/user/user_getusersbybuildingid.md): Return all users of a building id ### Retrieve users by renter ID - [POST /api/tenant/{tenantId_path}/user/GetUsersByRenterId](https://doc-api.bazimo.fr/documentation/swagger/user/user_getusersbyrenterid.md): Return all users of a renter id ### Retrieve responsibles by client ID - [POST /api/tenant/{tenantId_path}/user/GetResponsiblesByClientId](https://doc-api.bazimo.fr/documentation/swagger/user/user_getresponsiblesbyclientid.md): Return all responsibles of a client id