Services

List charge distribution keys, filtered

Same resource as GET /charges/distributions, with server-side filtering and paging.

Returns a plain JSON array: there is no pagination envelope, so the total count is not returned. Ask for limit + 1 items if you need to know whether another page exists.

Note page is zero-based: the first page is page=0.

get/charges/distributions/filtered

Request

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

Query parameters

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

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
Example:SURFACE

Keep only keys using this distribution type.

name_containsstring

Keep only keys whose name contains this substring.

pageinteger

Zero-based page index. Defaults to 0.

limitinteger

Items per page. Defaults to 50.

Response

Filtered distribution keys retrieved

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.