Skip to main content

Unit

No description

interface Unit {
address: Address
comment: String
computedRent: ReadOnlyUnitComputedRent!
createdDate: DateTime!
currentEvent: PropertyEvent
customReference: String
description: String
dimension: Dimension
documents: UnitDocuments
doorNumber: String @deprecated
epc: Epc
equipments: [Equipment!]!
events: [PropertyEvent!]!
externalId: String
foreignId: String
heatingChargesDistributionType: HeatingHotWaterChargesDistributionType
heatingShareType: HeatingHotWaterShareType
hotWaterChargesDistributionType: HeatingHotWaterChargesDistributionType
hotWaterShareType: HeatingHotWaterShareType
id: UUID!
invariantNumber: String
isFurnished: Boolean
lastAplConventionCode: String
logicReference: Int
name: String
organizationId: UUID!
reference: String
rentReference: RentReference
rentReferenceV2: RentReferenceV2
reservataireCode: String
rplsNumber: String
spaceNumber: String @deprecated
taxRegime: TaxRegime
unitGroup: UnitGroup
unitManagementCategories: [UnitManagementCategory!]!
unitNumber: String
unitOwnership: [UnitOwnership!]!
unitSurfaces: [UnitSurface!]!
unitTemplate: UnitTemplate
updatedDate: DateTime!
usage: Usage
usageType: UsageType
}

Fields

NomTypeDescription
addressAddress object
commentString scalar
computedRentReadOnlyUnitComputedRent! non-null object
createdDateDateTime! non-null scalarThe creation date-time of the entity
currentEventPropertyEvent object
customReferenceString scalar
descriptionString scalar
dimensionDimension object
documentsUnitDocuments object
epcEpc object
equipments[Equipment!]! non-null object
events[PropertyEvent!]! non-null object
externalIdString scalar
foreignIdString scalar
heatingChargesDistributionTypeHeatingHotWaterChargesDistributionType enum
heatingShareTypeHeatingHotWaterShareType enum
hotWaterChargesDistributionTypeHeatingHotWaterChargesDistributionType enum
hotWaterShareTypeHeatingHotWaterShareType enum
idUUID! non-null scalarUnique identifier of the entity
invariantNumberString scalarFiscal invariant number of the unit
isFurnishedBoolean scalar
lastAplConventionCodeString scalarCode of the last APL convention
logicReferenceInt scalar
nameString scalar
organizationIdUUID! non-null scalarUnique identifier of the entity's parent organization. Used for tenancy separation.
referenceString scalar
rentReferenceRentReference object
rentReferenceV2RentReferenceV2 object
reservataireCodeString scalarReservataire code identifying the financing entity
rplsNumberString scalarRPLS number (Répertoire du Parc Locatif Social)
taxRegimeTaxRegime enum
unitGroupUnitGroup object
unitManagementCategories[UnitManagementCategory!]! non-null object
unitNumberString scalar
unitOwnership[UnitOwnership!]! non-null object
unitSurfaces[UnitSurface!]! non-null object
unitTemplateUnitTemplate object
updatedDateDateTime! non-null scalarThe last update date-time of the entity
usageUsage enum
usageTypeUsageType enumgetUnitsInGroup unit PaginatedUnits ReadOnlyRentalFolderUnitRevisedRent RentalFolderUnit UnitOwnership UnitSurface UnitV2