Skip to main content

Rental

Dossiers locatifs, comptes de location, contrats, profils (physique/moral), contacts et états de dossier.

RentalFolder

Dossiers locatifs : liste, détail, états de dossier, annexes et unités.

Queries

OpérationDescription
rentalFoldersListe les dossiers locatifs (filtres, tris).
rentalFoldersPaginatedListe paginée des dossiers locatifs.
rentalFolderRécupère un dossier locatif par ID.
tenantRentalFoldersDossiers accessibles au locataire connecté.
tenantRentalFolderUn dossier locatif par ID pour le locataire.
getAnnexesFolderRécupère le dossier des annexes d'un dossier.
topTenHighestLatePaymentTop 10 des dossiers avec le plus d'impayés.
rentalFolderAddressOptionsOptions d'adresse pour un dossier (destinataire, etc.).
rentalFolderUnitsPaginatedListe paginée des lots/unités d'un dossier.

Mutations

OpérationDescription
createRentalFolderCrée un dossier locatif (avec compte, contrat, profils, unités, etc.).
updateRentalFolderMet à jour un dossier locatif.
updateRentalFolderUnitsMet à jour les unités/lots du dossier.
deleteRentalFolderSupprime un dossier locatif.
changeStateToActivePasse le dossier à l'état « actif ».
cancelRentalExitAnnule une sortie prévue.
changeStateToPendingEntryPasse en « entrée en cours ».
changeStateToPendingExitPasse en « sortie prévue » (avec date de fin).
changeStateToExitedPasse en « sorti ».
changeStateToArchivedArchive le dossier.
changeStateToInactivePasse en « inactif ».
uploadAnnexesFolderMet à jour le dossier des annexes.
updateRentalFolderCategoriesMet à jour les catégories d'entité du dossier.

RentalAccount

Compte de facturation locataire : facturation, écritures, soldes intermédiaires, remboursements et révisions de loyer.

Queries

OpérationDescription
rentalAccountRécupère un compte de facturation locataire par ID.
rentalAccountAutomationConfigRécupère la config d'automatisation des comptes pour l'organisation.
rentalAccountTransactionsListe les écritures d'un compte (filtres, tris).
rentalAccountTransactionRécupère une écriture par ID.
initiateReportLance la génération d'un rapport d'export.
getRentalAccountInvoiceRécupère une facture par ID.
getLatestAutoInvoiceDraftRécupère le dernier brouillon de facture auto pour un compte.
rentalAccountInvoicesListe les factures (paginated).
invoicesPaginatedListe les factures avec pagination et filtres.
rentalAccountBalanceOffsetsListe les soldes intermédiaires de gestion d'un compte.
rentalAccountBalanceOffsetRécupère un solde intermédiaire par ID.
transactionsPaginatedListe les écritures avec pagination et filtres.
revisionHistoryHistorique des révisions de loyer.
getRentalAccountRefundRécupère un remboursement par ID.
rentalAccountPlannedRevisionProchaine révision de loyer planifiée.
tenantUnpaidRecoveryActionEmailAperçu du template d'email de relance impayés.
rentalAccountStatementRelevé de compte (mouvements, soldes).
getPaginatedRentVariationsListe paginée des variations de loyer.
rentVariationRécupère une variation de loyer par ID.
rentVariationPreviewAperçu des factures impactées par une variation.
rentalAccountOldestOperationsDatesDates des plus anciennes opérations du compte.

Mutations

OpérationDescription
createRentalAccountCrée un compte de facturation locataire.
createRentalAccountAutomationConfigCrée la config d'automatisation des comptes.
toggleRentalAccountAutomationConfigAutoInvoicePaymentActive/désactive le paiement auto des factures.
toggleRentalAccountAutomationConfigAutoReceiptGenerationActive/désactive la génération auto des reçus.
adjustBalanceOffsetAjuste le solde intermédiaire (écritures d'ajustement).
createDraftRefundCrée un brouillon de remboursement.
updateDraftRefundMet à jour un brouillon de remboursement.
deleteDraftRefundSupprime un brouillon de remboursement.
emitRefundOperationÉmet un remboursement.
confirmRefundOperationConfirme un remboursement.
createRentalAccountInvoiceCrée une facture.
updateRentalAccountInvoiceMet à jour une facture.
deleteRentalAccountInvoiceSupprime un brouillon de facture.
freezeRentalAccountInvoiceFiger une facture.
createTransactionCrée une écriture (paiement manuel).
excludeIncomingPaymentExclut un paiement entrant de la réconciliation.
revertIncomingPaymentExclusionAnnule l'exclusion d'un paiement entrant.
validateIncomingPaymentValide un paiement entrant et l'associe à des factures.
deleteTransactionSupprime une écriture non rapprochée.
updateInvoiceTransactionsMet à jour les lignes de rapprochement reçu (receipt).
lockPaidInvoiceVerrouille une facture payée.
deleteInvoiceSupprime une facture.
planRevisionPlanifie une révision annuelle de loyer.
setBalanceOffsetDéfinit le solde intermédiaire (preuve, dossier).
closeBalanceOffsetClôture le solde intermédiaire en cours.
createRentalAccountBalanceOffsetCrée un solde intermédiaire de gestion.
updateRentalAccountBalanceOffsetMet à jour un solde intermédiaire.
updateRentalAccountBalanceOffsetProofMet à jour la preuve (dossier, commentaire).
deleteRentalAccountBalanceOffsetSupprime un solde intermédiaire.
closeRentalAccountBalanceOffsetClôture un solde intermédiaire.
createRentVariationCrée une variation de loyer (exceptionnelle ou évolutive).
disableRentVariationDésactive une variation de loyer.
deleteRentVariationSupprime une variation de loyer.

RentalContract

Contrat de location : création, documents, signature dématérialisée et import.

Queries

OpérationDescription
rentalContractRécupère un contrat de location par ID.
documentPreviewURL de prévisualisation d'un document de contrat.

Mutations

OpérationDescription
createRentalContractCrée un contrat pour un dossier.
uploadContractDocumentFileEnvoie un fichier de contrat.
generateDigitalRentalContractGénère un contrat dématérialisé (provider).
sendDigitalRentalContractEnvoie le contrat dématérialisé à signer.
cancelDigitalRentalContractAnnule un contrat dématérialisé.
deleteRentalContractDocumentsSupprime les documents d'un contrat.
deleteRentalContractUploadedDocumentSupprime un document uploadé par ID.
uploadImportedContractDocumentFileImport : upload d'un contrat signé.
updateImportedRentalContractImport : met à jour un contrat importé.
deleteRentalContractSupprime un contrat et ses documents/signataires.
archiveRentalContractArchive un contrat (état completed).

Owner

Propriétaires : liste et fiche.

Queries

OpérationDescription
ownersListe les propriétaires (filtres, tris).
ownerRécupère un propriétaire par ID.

Mutations

OpérationDescription
createOwnerCrée un propriétaire.
updateOwnerMet à jour un propriétaire.
deleteOwnerSupprime un propriétaire.

MoralProfile

Profil moral (société, SCI, etc.) : fiche et documents.

Queries

OpérationDescription
moralProfilesListe les profils moraux (paginated).
moralProfileRécupère un profil moral par ID.

Mutations

OpérationDescription
createMoralProfileCrée un profil moral.
updateMoralProfileMet à jour un profil moral.
deleteMoralProfileSupprime un profil moral.
updateMoralProfileDocumentsAddressProofMet à jour les justificatifs de domicile.
updateMoralProfileDocumentsIdentityFileMet à jour les pièces d'identité.
updateMoralProfileDocumentsOtherMet à jour les autres documents.

PersonalProfile

Profil physique (personne) : fiche, justificatifs et documents.

Queries

OpérationDescription
personalProfilesListe les profils physiques (paginated).
personalProfileRécupère un profil physique par ID.
getTenantContextProchaine référence locataire par défaut et toutes les refs.

Mutations

OpérationDescription
createPersonalProfileCrée un profil physique.
updatePersonalProfileMet à jour un profil physique.
updatePersonalProfileDocumentsAddressProofMet à jour les justificatifs de domicile.
updatePersonalProfileDocumentsIdentityProofMet à jour les pièces d'identité.
updatePersonalProfileDocumentsResidencePermitProofMet à jour le justificatif de titre de séjour.
updatePersonalProfileDocumentsProfessionalStatusProofMet à jour le justificatif de situation pro.
updatePersonalProfileDocumentsTaxNoticeProofMet à jour l'avis d'imposition.
updatePersonalProfileDocumentsResourceProofMet à jour les justificatifs de ressources.
updatePersonalProfileDocumentsOtherMet à jour les autres documents.
deletePersonalProfileSupprime un profil physique.

ExternalReference

Référence externe : résolution d'ID interne à partir d'un identifiant externe.

Queries

OpérationDescription
getInternalIdRetourne l'ID interne à partir d'un external_id (profil, unité, dossier).

Aucune mutation racine.

RentalFolderConfig

Configuration du nommage des dossiers locatifs.

Queries

OpérationDescription
rentalFolderConfigConfig de nommage des dossiers de l'organisation.
rentalFolderNamingOptionsVariables et séparateurs disponibles pour le nommage.
generateRentalFolderNameGénère un nom de dossier selon le motif configuré.

Mutations

OpérationDescription
createRentalFolderConfigCrée une config de nommage.
updateRentalFolderConfigMet à jour la config.
deleteRentalFolderConfigSupprime la config.

RentalFolderAccess

Accès au dossier par le locataire (email ou téléphone).

Mutations

OpérationDescription
grantRentalFolderAccessByEmailDonne l'accès à un dossier par email.
grantRentalFolderAccessByPhoneNumberDonne l'accès à un dossier par numéro de téléphone.
deleteRentalFolderAccessSupprime un accès au dossier.

Aucune query racine dédiée.


Note : Contact et OfficialContact ne définissent que des types et inputs (pas de queries ni mutations racine).