Leases

Update lease charge

Update the information of an existing charge.

Validations performed:

service_place / lease compatibility: The service must be attached to the same place as the lease's estate
Automatic resolution of the distribution key: If distribution_key_id is not provided, uses default_distribution_key_id from the service_place or the existing value
Distribution / billing consistency: Checks that the distribution is compatible with the billing method
Method / basis consistency: Checks that the billing method is compatible with the calculation basis
Lease type compatibility: Checks that the category and billing method are allowed for this lease type
Period validation: Checks that billing periods are within the lease boundaries and respect max_provisional_months if applicable
Category x basis compatibility: Checks that personnel calculation bases are only used with the EMPLOYEE category

put/leases/{lease_id}/charges/{charge_id}

Request

Base URL: https://api.faireplace.com/api
URL: https://api.faireplace.com/api/leases/{lease_id}/charges/{charge_id}
Auth: HTTP bearer

Path parameters

lease_idstring uuid required

Lease ID

charge_idstring uuid required

Charge ID

Request body

service_place_idstring uuid nullable

Service ID. If modified, the service must be attached to the same place as the lease's estate and must be chargeable

category_idstring uuid nullable

Category ID. If modified, the category must be allowed for the lease type

calculation_method'FORFAIT' | 'PROVISION' | 'DEPENSE_REELLE' | 'RELEVE_DIRECT'

Charge billing mode to the tenant (provision/fixed/actual expense).

Compatibility rules:

CONSOMMATION_MESUREE (distribution) requires RELEVE_DIRECT or PROVISION
FORFAIT requires FORFAIT as calculation basis
DEPENSE_REELLE requires DEPENSE_REELLE or a staff basis as calculation basis
PROVISION can be used with all calculation bases
The mode must be allowed for the lease type (allow_provisional, allow_fixed)

calculation_basis'DEPENSE_REELLE' | 'FORFAIT' | 'PERSONNEL_75_POURCENT' | 'PERSONNEL_40_POURCENT' | 'PERSONNEL_100_POURCENT'

Base de calcul d'une charge récupérable (art. 23-1).

Les trois valeurs PERSONNEL_… s'écrivent avec un underscore après PERSONNEL, exactement comme en base: c'est la même orthographe partout.

amountnumber nullable

billing_period_startstring date nullable

Billing period start date. If modified, must respect the lease boundaries

billing_period_endstring date nullable

Billing period end date. If modified, must respect the lease boundaries and max_provisional_months if applicable

last_regularization_datestring date nullable

Last regularization date

distribution_key_idstring uuid nullable

Distribution key ID. If modified, must be compatible with calculation_method

notesstring nullable

Example request

{
  "calculation_method": "PROVISION",
  "calculation_basis": "FORFAIT"
}

Response

Charge updated successfully

idstring uuid required

Unique identifier of the charge

lease_idstring uuid required

Lease ID

service_place_idstring uuid nullable

Place service ID

category_idstring uuid nullable

Charge category ID

calculation_method'FORFAIT' | 'PROVISION' | 'DEPENSE_REELLE' | 'RELEVE_DIRECT' required

Charge billing mode to the tenant (provision/fixed/actual expense).

Compatibility rules:

CONSOMMATION_MESUREE (distribution) requires RELEVE_DIRECT or PROVISION
FORFAIT requires FORFAIT as calculation basis
DEPENSE_REELLE requires DEPENSE_REELLE or a staff basis as calculation basis
PROVISION can be used with all calculation bases
The mode must be allowed for the lease type (allow_provisional, allow_fixed)

calculation_basis'DEPENSE_REELLE' | 'FORFAIT' | 'PERSONNEL_75_POURCENT' | 'PERSONNEL_40_POURCENT' | 'PERSONNEL_100_POURCENT' required

Base de calcul d'une charge récupérable (art. 23-1).

Les trois valeurs PERSONNEL_… s'écrivent avec un underscore après PERSONNEL, exactement comme en base: c'est la même orthographe partout.

amountnumber required

Charge amount

billing_period_startstring date nullable

Billing period start date

billing_period_endstring date nullable

Billing period end date

last_regularization_datestring date nullable

Last regularization date

distribution_key_idstring uuid nullable

Distribution key ID

notesstring nullable

Notes about the charge

created_atstring date-time required

Creation date

updated_atstring date-time required

Last modification date

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "lease_id": "550e8400-e29b-41d4-a716-446655440001",
  "calculation_method": "PROVISION",
  "calculation_basis": "FORFAIT",
  "amount": 150
}

Changes

No recorded changes to this operation across all 1 revision of this API.