Skip to content
/Lease

Bazimo API (v1)

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

Authentications

Operations

Building

Operations

Expense

Operations

Invoice

Operations

Lease

Operations

Activate a lease

Request

Activate a lease in draft state

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

Responses

OK

Body
createdEntityIdstring or null(uuid)read-only
errorsArray of stringsread-only
isFailurebooleanread-only
isSuccessbooleanread-only
Response
No response example

Terminate a lease

Request

Terminate an active lease

Path
tenantId_pathstringrequired
Body
idstring(uuid)
exitConditioninteger or null(int32)
Enum12345678910
enumNames: ["Leave","RarLeave","AssignmentOfLease","BailiffLeave","CourtAppointedAdministrator","EndOfDerogatoryLease","EndOfIrrevocableLease","AmicableEarlyTermination","SignatureOfNewLease","SaleOfPremises","TerminationByJudgment","EvictionFollowingJudgment","Safeguard","JudicialReorganization","JudicialLiquidation","TransferOfLeaseByJudgment","LeaseRenewalSignature"]
vacationNotificationDatestring or null
endOccupationDatestring or null
transferDatestring or null
landlordVacationNotificationDatestring or null
terminationDatestring
exitConditionCommentstring or null
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/lease/terminate' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "exitCondition": 1,
    "vacationNotificationDate": "string",
    "endOccupationDate": "string",
    "transferDate": "string",
    "landlordVacationNotificationDate": "string",
    "terminationDate": "string",
    "exitConditionComment": "string"
  }'

Responses

OK

Body
object
Response
No response example

Close a lease

Request

Close a terminated lease

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

Responses

OK

Body
object
Response
No response example

Delete a lease

Request

Delete a lease in draft state

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

Responses

OK

Body
object
Response
No response example

Retrieve lease by id

Request

Retrieve lease by id

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

Responses

OK

Body
activatedAtstring or null
activitiesArray of objects
actualGuaranteeDepositnumber or null(double)
actualGuaranteeDepositDatestring or null
billedAnnualExemptionAmountnumber(double)
billedAnnualExemptionCountinteger(int32)
billedAnnualProvisionOnChargeAmountnumber(double)
billedAnnualProvisionOnChargeCountinteger(int32)
billedAnnualRentAmountnumber(double)
billedAnnualRentCountinteger(int32)
billedAnnualSecurityDepositAmountnumber(double)
billedAnnualSecurityDepositCountinteger(int32)
billingFrequenciesCountinteger(int32)
billingFrequencyinteger or null(int32)
Enum12345
enumNames: ["Punctual","Monthly","Quarterly","SemiAnnually","Annually"]
billingTerminteger or null(int32)
Enum01
enumNames: ["FallingDue","Due"]
billingTermsCountinteger(int32)
breakDatesArray of objects
buildingNamestring
canHaveDifferentInvoicingElementBankAccountboolean
closedAtstring or null
commentstring or null
durationTypeinteger or null(int32)
Enum123
enumNames: ["Daily","Monthly","Yearly"]
invoiceNotestring or null
durationValueinteger or null(int32)
earliestTerminationDatestring or null
effectiveDatestring or null
endDatestring or null
endOccupationDatestring or null
exitConditioninteger or null(int32)
Enum12345678910
enumNames: ["Leave","RarLeave","AssignmentOfLease","BailiffLeave","CourtAppointedAdministrator","EndOfDerogatoryLease","EndOfIrrevocableLease","AmicableEarlyTermination","SignatureOfNewLease","SaleOfPremises","TerminationByJudgment","EvictionFollowingJudgment","Safeguard","JudicialReorganization","JudicialLiquidation","TransferOfLeaseByJudgment","LeaseRenewalSignature"]
exitConditionCommentstring or null
firstRevisionDatestring or null
firstRevisionDatesCountinteger(int32)
formerLeaseReferencestring or null
formerLeaseValidatedOnstring or null
frequenciesOfRevisionInYearsCountinteger(int32)
frequencyOfRevisionInYearsinteger or null(int32)
hasBazimoBilledBillingScheduleLinesboolean
hasTaxSystemboolean
indexTypeinteger or null(int32)
Enum12345678910
enumNames: ["Bt01","Irl","Ilc","Ilat","Icc","Cpf6820","AverageIcc","IpcnB1","Hlth","Cpi","IpcnC1","IpcnC2","IrlDomTom"]
indexTypesCountinteger(int32)
currentExemptionAmountnumber(double)
currentExemptionCountnumber(double)
initialAnnualExemptionCountinteger(int32)
initialAnnualProvisionOnChargeAmountnumber(double)
initialAnnualProvisionOnChargeCountinteger(int32)
billedSurfacenumber or null(double)
initialAnnualRentAmountnumber(double)
initialAnnualRentCountinteger(int32)
initialAnnualSecurityDepositAmountnumber(double)
initialAnnualSecurityDepositCountinteger(int32)
initialDatestring or null
initialIndexCountinteger(int32)
initialIndexPeriodNamestring or null
initialIndexValuenumber or null(double)
invoicingEntityDefaultBillingAddressobject or null
invoicingEntityIdstring(uuid)
invoicingEntityMediaUristring or null
invoicingEntityNamestring
invoicingEntityTypeinteger(int32)
Enum12
enumNames: ["LegalOwner","InternalRenter"]
isActiveboolean
isInternalboolean
isReviewedboolean
isTacitRenewalboolean
labelstring
landlordVacationNotificationDatestring or null
lastRevisedIndexCountinteger(int32)
lastRevisedIndexPeriodNamestring or null
lastRevisedIndexValuenumber or null(double)
lastRevisionDatestring or null
lastRevisionDatesCountinteger(int32)
leaseRenterBrandsArray of objects
leaseSettlementobject or null
leaseStateinteger(int32)
Enum12345
enumNames: ["Draft","InProgress","Terminated","Closable","Closed"]
leaseTerminteger or null(int32)
Enum12345678910
enumNames: ["CommercialLease","ThreeYearsFixed","SixYearsFixed","NineYearsFixed","TenYearsFixed","TwelveYearsFixed","ThreeSixNineOrTenYears","ThreeSixNineOrTwelveYears","FourSixOrNineYears","SixNineOrTenYears","NineOrTenYears","NineOrTwelveYears","OneYear","TwoYears","ThreeYears","SixYears"]
leaseTypeinteger(int32)
Enum0123456789
enumNames: ["Unknown","Commercial","Civil","Emphyteutic","Derogatory","Precarious","Housing89","Law48","ContractualHousing","StaffHousing","Professional","Mixed","IllegalOccupancy","TemporaryOccupancy","FurnishedRental","ConstructionLease","Administrative","Parking","Other","Coworking","PropertyDeed","RentalGuarantee","ServiceProvision","SecondmentAgreement","Subletting","ChargesAgreement","AdvertisingSpace","CommonRights"]
legalOwnerBankAccountIdstring or null(uuid)
legalOwnerBankAccountLabelstring or null
lotsArray of objects
lotSurfaceSumnumber(double)
natureinteger or null(int32)
Enum0123456789
enumNames: ["Unknown","Archive","Office","Cellar","Shop","OtherWithoutSurface","Warehouse","Housing","BusinessPremises","IndustrialPremises","IndoorParking","OutdoorParking","OtherWithSurface","WarehouseWithAccessoryOffices"]
nextBreakDatestring or null
numberstring
origininteger(int32)
Enum12345678
enumNames: ["New","Renewal","RealEstateRecovery","Migration","TransferOfNewLease","TransferOfGoodwill","TransferOfLeaseholdRights","TransfertJudicial"]
parkingPlaceQuantityinteger or null(int32)
priorNoticeinteger(int32)
billingStartDateInBazimostring or null
rentalStateAnnualExemptionAmountnumber(double)
rentalStateAnnualExemptionCountinteger(int32)
rentalStateAnnualProvisionOnChargeAmountnumber(double)
rentalStateAnnualProvisionOnChargeCountinteger(int32)
rentalStateAnnualRentAmountnumber(double)
rentalStateAnnualRentCountinteger(int32)
rentalStateAnnualSecurityDepositAmountnumber(double)
rentalStateAnnualSecurityDepositCountinteger(int32)
renterCompanyNamestring
renterIdstring(uuid)
renterImageUristring or null
reviewedAtstring or null
reviewedByUserFirstNamestring or null
reviewedByUserIdstring or null(uuid)
reviewedByUserLastNamestring or null
settlementModeinteger or null(int32)
Enum123
enumNames: ["Check","Transfer","DirectDebit"]
signedDatestring or null
startOccupationDatestring or null
taxRedditionModeinteger(int32)
Enum123
enumNames: ["ProvisionWithoutTaxRedditionWithoutTax","ProvisionWithTaxRedditionWithTax","ProvisionWithTaxRedditionWithoutTax"]
taxSysteminteger or null(int32)
Enum0123456789
enumNames: ["None","Percentage1","Percentage2","Percentage3","Percentage4","Percentage5","Percentage6","Percentage7","Percentage8","Percentage9","Percentage10","Percentage11","Percentage12","Percentage13","Percentage14","Percentage15","Percentage16","Percentage17","Percentage18","Percentage19","Percentage20","Percentage21","Percentage22","Percentage23","Percentage24","Percentage25","Crl125","Crl25","Percentage3LeaseTaxRegime","Vat55","Vat85","Vat10","Vat196","Vat20","Exempt","ReverseCharge"]
canUpdateTerminationDateboolean
terminationDatestring or null
transferDatestring or null
usageinteger or null(int32)
Enum0123456789
enumNames: ["Unknown","Shop","Office","Distribution","MixedActivitiesSpace","IndustrialSpace","Housing","Parking","Mixed","Other","Storage","ConsultingRooms","WarehouseWithAccessoryOffices","Warehouse","Professional"]
vacationNotificationDatestring or null
exitInventoryDatestring or null
exitInventoryBystring or null
exitInventoryAmountnumber or null(double)
exitInventoryAmountObtainednumber or null(double)
exitInventoryEstimateDatestring or null
dataOriginobject
engagedLotsOnAnotherLeaseArray of objects
areLotsEngagedByAnotherLeasesboolean
isExcludedFromBillingSessionboolean
canBeDeletedboolean
Response
No response example

Retrieve building lease list

Request

Retrieve building lease list

Path
tenantId_pathstringrequired
Body
buildingIdstring(uuid)
datatableobject
isActiveboolean or null
leaseExpirationSignalinteger or null(int32)
Enum12310
enumNames: ["NextBreakDateClose","EndDateClose","Terminated","NotPrevisible"]
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/lease/getLeasesByBuildingId' \
  -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"
      }
    },
    "isActive": true,
    "leaseExpirationSignal": 1
  }'

Responses

OK

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

Create a lease

Request

Create a lease in draft state

Path
tenantId_pathstringrequired
Body
buildingIdstring(uuid)
canHaveDifferentInvoicingElementBankAccountboolean
durationTypeinteger(int32)
Enum123
enumNames: ["Daily","Monthly","Yearly"]
durationValueinteger(int32)
effectiveDatestring
invoicingEntityIdstring(uuid)
invoicingEntityTypeinteger(int32)
Enum12
enumNames: ["LegalOwner","InternalRenter"]
isTacitRenewalboolean
labelstring
leaseTerminteger or null(int32)
Enum12345678910
enumNames: ["CommercialLease","ThreeYearsFixed","SixYearsFixed","NineYearsFixed","TenYearsFixed","TwelveYearsFixed","ThreeSixNineOrTenYears","ThreeSixNineOrTwelveYears","FourSixOrNineYears","SixNineOrTenYears","NineOrTenYears","NineOrTwelveYears","OneYear","TwoYears","ThreeYears","SixYears"]
leaseTypeinteger(int32)
Enum0123456789
enumNames: ["Unknown","Commercial","Civil","Emphyteutic","Derogatory","Precarious","Housing89","Law48","ContractualHousing","StaffHousing","Professional","Mixed","IllegalOccupancy","TemporaryOccupancy","FurnishedRental","ConstructionLease","Administrative","Parking","Other","Coworking","PropertyDeed","RentalGuarantee","ServiceProvision","SecondmentAgreement","Subletting","ChargesAgreement","AdvertisingSpace","CommonRights"]
legalOwnerBankAccountIdstring or null(uuid)
lotsArray of objects
numberstring
origininteger(int32)
Enum12345678
enumNames: ["New","Renewal","RealEstateRecovery","Migration","TransferOfNewLease","TransferOfGoodwill","TransferOfLeaseholdRights","TransfertJudicial"]
premisesNatureinteger or null(int32)
Enum0123456789
enumNames: ["Unknown","Archive","Office","Cellar","Shop","OtherWithoutSurface","Warehouse","Housing","BusinessPremises","IndustrialPremises","IndoorParking","OutdoorParking","OtherWithSurface","WarehouseWithAccessoryOffices"]
premisesUsageinteger(int32)
Enum0123456789
enumNames: ["Unknown","Shop","Office","Distribution","MixedActivitiesSpace","IndustrialSpace","Housing","Parking","Mixed","Other","Storage","ConsultingRooms","WarehouseWithAccessoryOffices","Warehouse","Professional"]
priorNoticeinteger(int32)
billingStartDateInBazimostring or null
renterIdstring(uuid)
taxSysteminteger or null(int32)
Enum0123456789
enumNames: ["None","Percentage1","Percentage2","Percentage3","Percentage4","Percentage5","Percentage6","Percentage7","Percentage8","Percentage9","Percentage10","Percentage11","Percentage12","Percentage13","Percentage14","Percentage15","Percentage16","Percentage17","Percentage18","Percentage19","Percentage20","Percentage21","Percentage22","Percentage23","Percentage24","Percentage25","Crl125","Crl25","Percentage3LeaseTaxRegime","Vat55","Vat85","Vat10","Vat196","Vat20","Exempt","ReverseCharge"]
invoiceNotestring or null
billedSurfacenumber or null(double)
curl -i -X POST \
  'https://doc-api.bazimo.fr/api/tenant/{tenantId_path}/lease/create' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "buildingId": "fee3295a-6e55-45b0-a091-7b4de7e39de7",
    "canHaveDifferentInvoicingElementBankAccount": true,
    "durationType": 1,
    "durationValue": 0,
    "effectiveDate": "string",
    "invoicingEntityId": "c3756938-c992-4f63-9f39-dcde74d3e977",
    "invoicingEntityType": 1,
    "isTacitRenewal": true,
    "label": "string",
    "leaseTerm": 1,
    "leaseType": 0,
    "legalOwnerBankAccountId": "450dbb29-672e-4618-bf16-158f3a6d5955",
    "lots": [
      {
        "endAt": "string",
        "startAt": "string",
        "lotId": "e8c5065f-4319-4b13-ad99-eb9182a42d06"
      }
    ],
    "number": "string",
    "origin": 1,
    "premisesNature": 0,
    "premisesUsage": 0,
    "priorNotice": 0,
    "billingStartDateInBazimo": "string",
    "renterId": "5e8fd3a6-1229-4fc6-80e4-337191896d0b",
    "taxSystem": 0,
    "invoiceNote": "string",
    "billedSurface": 0.1
  }'

Responses

OK

Body
idstring(uuid)
Response
No response example

LegalOwner

Operations

Lot

Operations

RealEstateCompany

Operations

Receipt

Operations

Renter

Operations

Supplier

Operations

User

Operations