Services

Get service charge category

get/charges/categories/{id}

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/charges/categories/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Response

OK

idstring uuid required

Unique identifier of the category

namestring required

Category name (e.g., Building employee, Collective heating)

descriptionstring nullable

Detailed description of the category

legal_referencestring nullable

Legal reference (e.g., Article 23-1 of decree no. 87-713)

category_type'EMPLOYEE' | 'MAINTENANCE' | 'CLEANING' | 'ELEVATOR' | 'HEATING' | 'WATER' | 'COMMON_AREAS' | 'TAXES' | 'INDIVIDUAL_EQUIPMENT' | 'ELECTRICITY_COMMON_AREAS' | 'GLOBAL_PROVISION' required

Nature de la dépense d'une charge récupérable.

Les dix premières valeurs sont des natures de dépense, au sens de l'annexe du Décret 87-713. GLOBAL_PROVISION n'en est pas une : c'est l'absence de ventilation, et elle se traite différemment partout où l'on raisonne par nature de dépense.

recovery_ratenumber required

Recovery rate from the tenant (as a percentage, 0-100)

notification_thresholdnumber nullable

Notification threshold for alerts (0-100)

notification_frequencystring

Notification frequency in 'X unit' format (e.g., '30 days', '1 month')

created_atstring date-time required

Creation date

updated_atstring date-time required

Last modification date

Example response

{
  "category_type": "MAINTENANCE",
  "maintenance_details": {
    "maintenance_type": "Preventive",
    "description": "Annual preventive maintenance of the boiler",
    "frequency": "Annual",
    "estimated_cost": 250,
    "last_maintenance_date": "2024-01-15",
    "next_maintenance_date": "2025-01-15",
    "additional_info": {
      "provider": "Maintenance Pro",
      "contract_number": "MAINT-2024-001"
    }
  },
  "recovery_rate": 100,
  "notification_threshold": 15,
  "notification_frequency": "30 days"
}

Changes

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