UnitV2
No description
type UnitV2 implements Unit {
address: Address
archived: Boolean
archivedDate: Date
businessUnit: BusinessUnit
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
habitableRoomsCount: Int
heatingChargesDistributionType: HeatingHotWaterChargesDistributionType
heatingShareType: HeatingHotWaterShareType
hotWaterChargesDistributionType: HeatingHotWaterChargesDistributionType
hotWaterShareType: HeatingHotWaterShareType
id: UUID!
invariantNumber: String
isFurnished: Boolean
lastAplConventionCode: String
logicReference: Int
name: String
occupiedSince: Date
organizationId: UUID!
reference: String
rentReference: RentReference
rentReferenceV2: RentReferenceV2
reservataireCode: String
rooms: [Room!]!
rplsNumber: String
spaceNumber: String @deprecated
state: UnitState
taxRegime: TaxRegime
unitGroup: UnitGroup
unitManagementCategories: [UnitManagementCategory!]!
unitNumber: String
unitOwnership: [UnitOwnership!]!
unitSurfaces: [UnitSurface!]!
unitTemplate: UnitTemplate
updatedDate: DateTime!
usage: Usage
usageType: UsageType
}
Fields
| Nom | Type | Description |
|---|---|---|
| address | Address object | — |
| archived | Boolean scalar | Whether the unit is archived |
| archivedDate | Date scalar | The date the unit was archived |
| businessUnit | BusinessUnit object | — |
| comment | String scalar | — |
| computedRent | ReadOnlyUnitComputedRent! non-null object | — |
| createdDate | DateTime! non-null scalar | The creation date-time of the entity |
| currentEvent | PropertyEvent object | — |
| customReference | String scalar | — |
| description | String scalar | — |
| dimension | Dimension object | — |
| documents | UnitDocuments object | — |
| epc | Epc object | — |
| equipments | [Equipment!]! non-null object | — |
| events | [PropertyEvent!]! non-null object | — |
| externalId | String scalar | — |
| foreignId | String scalar | — |
| habitableRoomsCount | Int scalar | — |
| heatingChargesDistributionType | HeatingHotWaterChargesDistributionType enum | — |
| heatingShareType | HeatingHotWaterShareType enum | — |
| hotWaterChargesDistributionType | HeatingHotWaterChargesDistributionType enum | — |
| hotWaterShareType | HeatingHotWaterShareType enum | — |
| id | UUID! non-null scalar | Unique identifier of the entity |
| invariantNumber | String scalar | Fiscal invariant number of the unit |
| isFurnished | Boolean scalar | — |
| lastAplConventionCode | String scalar | Code of the last APL convention |
| logicReference | Int scalar | — |
| name | String scalar | — |
| occupiedSince | Date scalar | Earliest effective occupation start date among rental folders in active state for this unit. Only folders with state === active are considered; pending_entry and other states are excluded even if they already have a start date. Per active folder, the date is COALESCE(rentalContractValidity.validityStartDate, contractDetails.startDate): min(contract_start_date) of signed/expiring_soon contracts, falling back to contract_details.start_date (covers contract v2 when CD start_date is nil). Null when the unit has no active rental folder or no resolvable start date. |
| organizationId | UUID! non-null scalar | Unique identifier of the entity's parent organization. Used for tenancy separation. |
| reference | String scalar | — |
| rentReference | RentReference object | — |
| rentReferenceV2 | RentReferenceV2 object | — |
| reservataireCode | String scalar | Reservataire code identifying the financing entity |
| rooms | [Room!]! non-null object | The rooms of the unit |
| rplsNumber | String scalar | RPLS number (Répertoire du Parc Locatif Social) |
| state | UnitState object | The availability of the unit |
| taxRegime | TaxRegime enum | — |
| unitGroup | UnitGroup object | — |
| unitManagementCategories | [UnitManagementCategory!]! non-null object | — |
| unitNumber | String scalar | — |
| unitOwnership | [UnitOwnership!]! non-null object | — |
| unitSurfaces | [UnitSurface!]! non-null object | — |
| unitTemplate | UnitTemplate object | — |
| updatedDate | DateTime! non-null scalar | The last update date-time of the entity |
| usage | Usage enum | — |
| usageType | UsageType enum | — |
| Unit | — | archiveUnit createUnit createUnits deleteUnit unitV2 updateUnit PaginatedUnitsV2 UnitManagementCategory |