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ération | Description |
|---|---|
rentalFolders | Liste les dossiers locatifs (filtres, tris). |
rentalFoldersPaginated | Liste paginée des dossiers locatifs. |
rentalFolder | Récupère un dossier locatif par ID. |
tenantRentalFolders | Dossiers accessibles au locataire connecté. |
tenantRentalFolder | Un dossier locatif par ID pour le locataire. |
getAnnexesFolder | Récupère le dossier des annexes d'un dossier. |
topTenHighestLatePayment | Top 10 des dossiers avec le plus d'impayés. |
rentalFolderAddressOptions | Options d'adresse pour un dossier (destinataire, etc.). |
rentalFolderUnitsPaginated | Liste paginée des lots/unités d'un dossier. |
Mutations
| Opération | Description |
|---|---|
createRentalFolder | Crée un dossier locatif (avec compte, contrat, profils, unités, etc.). |
updateRentalFolder | Met à jour un dossier locatif. |
updateRentalFolderUnits | Met à jour les unités/lots du dossier. |
deleteRentalFolder | Supprime un dossier locatif. |
changeStateToActive | Passe le dossier à l'état « actif ». |
cancelRentalExit | Annule une sortie prévue. |
changeStateToPendingEntry | Passe en « entrée en cours ». |
changeStateToPendingExit | Passe en « sortie prévue » (avec date de fin). |
changeStateToExited | Passe en « sorti ». |
changeStateToArchived | Archive le dossier. |
changeStateToInactive | Passe en « inactif ». |
uploadAnnexesFolder | Met à jour le dossier des annexes. |
updateRentalFolderCategories | Met à 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ération | Description |
|---|---|
rentalAccount | Récupère un compte de facturation locataire par ID. |
rentalAccountAutomationConfig | Récupère la config d'automatisation des comptes pour l'organisation. |
rentalAccountTransactions | Liste les écritures d'un compte (filtres, tris). |
rentalAccountTransaction | Récupère une écriture par ID. |
initiateReport | Lance la génération d'un rapport d'export. |
getRentalAccountInvoice | Récupère une facture par ID. |
getLatestAutoInvoiceDraft | Récupère le dernier brouillon de facture auto pour un compte. |
rentalAccountInvoices | Liste les factures (paginated). |
invoicesPaginated | Liste les factures avec pagination et filtres. |
rentalAccountBalanceOffsets | Liste les soldes intermédiaires de gestion d'un compte. |
rentalAccountBalanceOffset | Récupère un solde intermédiaire par ID. |
transactionsPaginated | Liste les écritures avec pagination et filtres. |
revisionHistory | Historique des révisions de loyer. |
getRentalAccountRefund | Récupère un remboursement par ID. |
rentalAccountPlannedRevision | Prochaine révision de loyer planifiée. |
tenantUnpaidRecoveryActionEmail | Aperçu du template d'email de relance impayés. |
rentalAccountStatement | Relevé de compte (mouvements, soldes). |
getPaginatedRentVariations | Liste paginée des variations de loyer. |
rentVariation | Récupère une variation de loyer par ID. |
rentVariationPreview | Aperçu des factures impactées par une variation. |
rentalAccountOldestOperationsDates | Dates des plus anciennes opérations du compte. |
Mutations
| Opération | Description |
|---|---|
createRentalAccount | Crée un compte de facturation locataire. |
createRentalAccountAutomationConfig | Crée la config d'automatisation des comptes. |
toggleRentalAccountAutomationConfigAutoInvoicePayment | Active/désactive le paiement auto des factures. |
toggleRentalAccountAutomationConfigAutoReceiptGeneration | Active/désactive la génération auto des reçus. |
adjustBalanceOffset | Ajuste le solde intermédiaire (écritures d'ajustement). |
createDraftRefund | Crée un brouillon de remboursement. |
updateDraftRefund | Met à jour un brouillon de remboursement. |
deleteDraftRefund | Supprime un brouillon de remboursement. |
emitRefundOperation | Émet un remboursement. |
confirmRefundOperation | Confirme un remboursement. |
createRentalAccountInvoice | Crée une facture. |
updateRentalAccountInvoice | Met à jour une facture. |
deleteRentalAccountInvoice | Supprime un brouillon de facture. |
freezeRentalAccountInvoice | Figer une facture. |
createTransaction | Crée une écriture (paiement manuel). |
excludeIncomingPayment | Exclut un paiement entrant de la réconciliation. |
revertIncomingPaymentExclusion | Annule l'exclusion d'un paiement entrant. |
validateIncomingPayment | Valide un paiement entrant et l'associe à des factures. |
deleteTransaction | Supprime une écriture non rapprochée. |
updateInvoiceTransactions | Met à jour les lignes de rapprochement reçu (receipt). |
lockPaidInvoice | Verrouille une facture payée. |
deleteInvoice | Supprime une facture. |
planRevision | Planifie une révision annuelle de loyer. |
setBalanceOffset | Définit le solde intermédiaire (preuve, dossier). |
closeBalanceOffset | Clôture le solde intermédiaire en cours. |
createRentalAccountBalanceOffset | Crée un solde intermédiaire de gestion. |
updateRentalAccountBalanceOffset | Met à jour un solde intermédiaire. |
updateRentalAccountBalanceOffsetProof | Met à jour la preuve (dossier, commentaire). |
deleteRentalAccountBalanceOffset | Supprime un solde intermédiaire. |
closeRentalAccountBalanceOffset | Clôture un solde intermédiaire. |
createRentVariation | Crée une variation de loyer (exceptionnelle ou évolutive). |
disableRentVariation | Désactive une variation de loyer. |
deleteRentVariation | Supprime une variation de loyer. |
RentalContract
Contrat de location : création, documents, signature dématérialisée et import.
Queries
| Opération | Description |
|---|---|
rentalContract | Récupère un contrat de location par ID. |
documentPreview | URL de prévisualisation d'un document de contrat. |
Mutations
| Opération | Description |
|---|---|
createRentalContract | Crée un contrat pour un dossier. |
uploadContractDocumentFile | Envoie un fichier de contrat. |
generateDigitalRentalContract | Génère un contrat dématérialisé (provider). |
sendDigitalRentalContract | Envoie le contrat dématérialisé à signer. |
cancelDigitalRentalContract | Annule un contrat dématérialisé. |
deleteRentalContractDocuments | Supprime les documents d'un contrat. |
deleteRentalContractUploadedDocument | Supprime un document uploadé par ID. |
uploadImportedContractDocumentFile | Import : upload d'un contrat signé. |
updateImportedRentalContract | Import : met à jour un contrat importé. |
deleteRentalContract | Supprime un contrat et ses documents/signataires. |
archiveRentalContract | Archive un contrat (état completed). |
Owner
Propriétaires : liste et fiche.
Queries
| Opération | Description |
|---|---|
owners | Liste les propriétaires (filtres, tris). |
owner | Récupère un propriétaire par ID. |
Mutations
| Opération | Description |
|---|---|
createOwner | Crée un propriétaire. |
updateOwner | Met à jour un propriétaire. |
deleteOwner | Supprime un propriétaire. |
MoralProfile
Profil moral (société, SCI, etc.) : fiche et documents.
Queries
| Opération | Description |
|---|---|
moralProfiles | Liste les profils moraux (paginated). |
moralProfile | Récupère un profil moral par ID. |
Mutations
| Opération | Description |
|---|---|
createMoralProfile | Crée un profil moral. |
updateMoralProfile | Met à jour un profil moral. |
deleteMoralProfile | Supprime un profil moral. |
updateMoralProfileDocumentsAddressProof | Met à jour les justificatifs de domicile. |
updateMoralProfileDocumentsIdentityFile | Met à jour les pièces d'identité. |
updateMoralProfileDocumentsOther | Met à jour les autres documents. |
PersonalProfile
Profil physique (personne) : fiche, justificatifs et documents.
Queries
| Opération | Description |
|---|---|
personalProfiles | Liste les profils physiques (paginated). |
personalProfile | Récupère un profil physique par ID. |
getTenantContext | Prochaine référence locataire par défaut et toutes les refs. |
Mutations
| Opération | Description |
|---|---|
createPersonalProfile | Crée un profil physique. |
updatePersonalProfile | Met à jour un profil physique. |
updatePersonalProfileDocumentsAddressProof | Met à jour les justificatifs de domicile. |
updatePersonalProfileDocumentsIdentityProof | Met à jour les pièces d'identité. |
updatePersonalProfileDocumentsResidencePermitProof | Met à jour le justificatif de titre de séjour. |
updatePersonalProfileDocumentsProfessionalStatusProof | Met à jour le justificatif de situation pro. |
updatePersonalProfileDocumentsTaxNoticeProof | Met à jour l'avis d'imposition. |
updatePersonalProfileDocumentsResourceProof | Met à jour les justificatifs de ressources. |
updatePersonalProfileDocumentsOther | Met à jour les autres documents. |
deletePersonalProfile | Supprime un profil physique. |
ExternalReference
Référence externe : résolution d'ID interne à partir d'un identifiant externe.
Queries
| Opération | Description |
|---|---|
getInternalId | Retourne l'ID interne à partir d'un external_id (profil, unité, dossier). |
Aucune mutation racine.
RentalFolderConfig
Configuration du nommage des dossiers locatifs.
Queries
| Opération | Description |
|---|---|
rentalFolderConfig | Config de nommage des dossiers de l'organisation. |
rentalFolderNamingOptions | Variables et séparateurs disponibles pour le nommage. |
generateRentalFolderName | Génère un nom de dossier selon le motif configuré. |
Mutations
| Opération | Description |
|---|---|
createRentalFolderConfig | Crée une config de nommage. |
updateRentalFolderConfig | Met à jour la config. |
deleteRentalFolderConfig | Supprime la config. |
RentalFolderAccess
Accès au dossier par le locataire (email ou téléphone).
Mutations
| Opération | Description |
|---|---|
grantRentalFolderAccessByEmail | Donne l'accès à un dossier par email. |
grantRentalFolderAccessByPhoneNumber | Donne l'accès à un dossier par numéro de téléphone. |
deleteRentalFolderAccess | Supprime 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).