Skip to main content

Évolutions API - Juillet 2026

À partir du 20 juillet 2026, plusieurs évolutions seront disponibles sur l'API du flux financier et des RentalAccount.

Ces évolutions introduisent de nouvelles mutations en version V2, ainsi qu'une séparation plus claire des opérations de mise à jour d'un compte de location.

Les mutations existantes restent disponibles et conservent leur comportement actuel.

La dépréciation de la v1 est planifiée en janvier 2027.


Mutations financières V2

Nouveau format de réponse

De nouvelles versions des mutations du flux financier sont introduites.

Contrairement aux mutations existantes qui retournent l'entité complète RentalAccount ou RentalAccountRefund, les mutations V2 retournent un objet financialObjectPayload contenant uniquement les informations nécessaires pour identifier la ressource concernée.

Response Payload

Response Payload
{
"id": "UUID-1234-5679",
"rentalAccountId": "UUID-1234-9876"
}

Le payload contient :

  • id : l'identifiant de la ressource créée ou modifiée.
  • rentalAccountId : l'identifiant du RentalAccount associé.

Exemple

Mutation existante

La mutation existante retourne l'entité complète :

mutation DeleteRentalAccountInvoice($id: UUID!, $accountId: UUID!) {
deleteRentalAccountInvoice($id: uuid_1234, $accountId: uuid_account) {
id
invoices {
id
iotTotalAmount
}
}
}

Mutation V2

La version V2 retourne uniquement les identifiants nécessaires :

mutation DeleteRentalAccountInvoiceV2($id: UUID!, $accountId: UUID!) {
deleteRentalAccountInvoiceV2($id: uuid_1234, $accountId: uuid_account) {
id
rentalAccountId
}
}

Mutations disponibles en V2

Les mutations suivantes sont disponibles en version V2 :

  • createRentalAccountInvoiceV2
  • updateRentalAccountInvoiceV2
  • freezeRentalAccountInvoiceV2
  • updateInvoiceTransactionsV2
  • lockPaidInvoiceV2
  • deleteInvoiceV2
  • createTransactionV2
  • deleteTransactionV2
  • createDraftRefundV2
  • updateDraftRefundV2
  • deleteDraftRefundV2
  • emitRefundOperationV2
  • confirmRefundOperationV2

Modèle de cohérence des mutations V2

Les mutations V2 utilisent un modèle de cohérence éventuelle (eventual consistency).

Une mutation confirme uniquement que l'opération a été acceptée et enregistrée.

La mise à jour des modèles de lecture est effectuée de manière asynchrone.

En conséquence, la ressource créée ou modifiée peut ne pas être immédiatement disponible via une requête (query) après l'exécution de la mutation.

Si votre application a besoin de récupérer la ressource mise à jour, elle devra effectuer une requête ultérieure en utilisant l'identifiant retourné par la mutation.

[!NOTE] Les mutations existantes conservent leur comportement actuel. Le modèle de cohérence éventuelle s'applique uniquement aux mutations V2.


Mise à jour des informations RentalAccount

À partir de janvier 2027, la mutation updateRentalFolder ne prendra plus en charge les modifications liées au RentalAccount.

Les mises à jour du compte de location doivent désormais être effectuées via les mutations dédiées suivantes.


updateRentalAccountRentItems

Cette mutation permet de mettre à jour les éléments de loyer d'un dossier de location.

mutation UpdateRentalAccountRentItems($rentalAccountId: UUID!, $rentalAccountRentItems: rentalAccountRentItemsInput!) {
updateRentalAccountRentItems(
rentalAccountId: uuid,
rentalAccountRentItems: {}
) {
rentalAccountId
}
}

updateRentRevision

Cette mutation permet de mettre à jour le paramétrage de révision de loyer d'un dossier de location.

mutation UpdateRentRevision($rentalAccountId: UUID!, $rentRevision: rentalAccountRentRevisionInput!) {
updateRentRevision(
rentalAccountId: uuid,
rentRevision: {}
) {
rentalAccountId
}
}

updateProcurementOrder

Cette mutation permet de mettre à jour la configuration Chorus Pro d'un dossier de location.

mutation UpdateProcurementOrder($rentalAccountId: UUID!, $procurementOrderInput: procurementOrderInput!) {
updateProcurementOrder(
rentalAccountId: uuid,
procurementOrderInput: {}
) {
rentalAccountId
}
}

setBalanceOffset

Cette mutation permet de créer ou mettre à jour le solde initial d'un dossier de location.

mutation SetBalanceOffset($rentalAccountId: UUID!, $setBalanceOffsetInput: setBalanceOffsetInput!) {
setBalanceOffset(
rentalAccountId: uuid,
setBalanceOffsetInput: {}
) {
rentalAccountId
}
}