Services

Create a charge distribution key

Create a new charge distribution key

post/charges/distributions

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/charges/distributions
  • Auth: HTTP bearer

Request body

namestring required

Name of the distribution key

descriptionstring nullable

Description of the distribution key

calculation_type'SURFACE' | 'OCCUPANT' | 'CONSOMMATION_MESUREE' | 'NOMBRE_EQUIPEMENTS' | 'MILLIEME' | 'PARTS_EGALES' | 'FORMULE_PERSONNALISEE' required

Type of charge distribution among tenants (distribution technique).

Compatibility rules with the billing mode:

  • CONSOMMATION_MESUREE requires RELEVE_DIRECT or PROVISION (not FORFAIT)
  • Other types can be used with PROVISION or FORFAIT
formulastring nullable

Custom calculation formula

Example request

{
  "calculation_type": "SURFACE",
  "parameters": {
    "surface_m2": 75.5,
    "occupant_count": 3,
    "equipment_count": 2,
    "millieme_value": 125.5
  },
  "validation_rules": {
    "max_value": 10000,
    "required_parameters": [
      "surface_m2"
    ]
  }
}

Response

Distribution key created successfully

idstring uuid required

Unique identifier of the distribution key

namestring required

Name of the distribution key

descriptionstring nullable

Description of the distribution key

calculation_type'SURFACE' | 'OCCUPANT' | 'CONSOMMATION_MESUREE' | 'NOMBRE_EQUIPEMENTS' | 'MILLIEME' | 'PARTS_EGALES' | 'FORMULE_PERSONNALISEE' required

Type of charge distribution among tenants (distribution technique).

Compatibility rules with the billing mode:

  • CONSOMMATION_MESUREE requires RELEVE_DIRECT or PROVISION (not FORFAIT)
  • Other types can be used with PROVISION or FORFAIT
formulastring nullable

Custom calculation formula (required if calculation_type = FORMULE_PERSONNALISEE)

created_atstring date-time

Creation date

updated_atstring date-time

Last modification date

Example response

{
  "calculation_type": "SURFACE",
  "parameters": {
    "surface_m2": 75.5,
    "occupant_count": 3,
    "equipment_count": 2,
    "millieme_value": 125.5
  },
  "validation_rules": {
    "max_value": 10000,
    "required_parameters": [
      "surface_m2"
    ]
  }
}

Changes

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