FairePlace Property Management API

Services

Endpointhttps://api.faireplace.com/api

Building-related services

List service charge categories

GET

https://api.faireplace.com/api

/charges/categories

List service charge categories › Responses

object[]

Charge category for services (Article 23 of decree no. 87-713)

id

string · uuid · required

Unique identifier of the category

name

string · minLength: 1 · maxLength: 255 · required

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

category_type

string · enum · required

Type of charge category

Enum values:

EMPLOYEE

MAINTENANCE

CLEANING

ELEVATOR

HEATING

WATER

COMMON_AREAS

TAXES

Example: MAINTENANCE

recovery_rate

number · decimal · min: 0 · max: 100 · required

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

Example: 100

Default: 100

created_at

string · date-time · required

Creation date

updated_at

string · date-time · required

Last modification date

description

string | null · maxLength: 1000

Detailed description of the category

legal_reference

string | null

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

object

Maintenance details for a charge category

notification_threshold

number | null · decimal · min: 0 · max: 100

Notification threshold for alerts (0-100)

Example: 15

notification_frequency

string · pattern: ^\d+\s+(day|week|mon…

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

Example: 30 days

GET/charges/categories

curl --request GET \
  --url https://api.faireplace.com/api/charges/categories

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "description": {},
    "legal_reference": {},
    "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",
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Create service charge category

POST

https://api.faireplace.com/api

/charges/categories

Create service charge category › Request Body

Data for creating a charge category (Article 23 of decree no. 87-713)

name

string · minLength: 1 · maxLength: 255 · required

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

Example: Collective heating

category_type

string · enum · required

Type of charge category

Enum values:

EMPLOYEE

MAINTENANCE

CLEANING

ELEVATOR

HEATING

WATER

COMMON_AREAS

TAXES

Example: MAINTENANCE

description

string | null · maxLength: 1000

Detailed description of the category

Example: Charges related to the building's collective heating

legal_reference

string | null

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

Example: Article 23-1 paragraph 3 of decree no. 87-713

object

Maintenance details for a charge category

recovery_rate

number | null · decimal · min: 0 · max: 100

Recovery rate from the tenant (as a percentage, 0-100). Default value: 100

Example: 100

Default: 100

notification_threshold

number | null · decimal · min: 0 · max: 100

Notification threshold for alerts (0-100)

Example: 15

notification_frequency

string · pattern: ^\d+\s+(day|week|mon…

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

Example: 30 days

Create service charge category › Responses

Created

Charge category for services (Article 23 of decree no. 87-713)

id

string · uuid · required

Unique identifier of the category

name

string · minLength: 1 · maxLength: 255 · required

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

category_type

string · enum · required

Type of charge category

Enum values:

EMPLOYEE

MAINTENANCE

CLEANING

ELEVATOR

HEATING

WATER

COMMON_AREAS

TAXES

Example: MAINTENANCE

recovery_rate

number · decimal · min: 0 · max: 100 · required

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

Example: 100

Default: 100

created_at

string · date-time · required

Creation date

updated_at

string · date-time · required

Last modification date

description

string | null · maxLength: 1000

Detailed description of the category

legal_reference

string | null

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

object

Maintenance details for a charge category

notification_threshold

number | null · decimal · min: 0 · max: 100

Notification threshold for alerts (0-100)

Example: 15

notification_frequency

string · pattern: ^\d+\s+(day|week|mon…

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

Example: 30 days

POST/charges/categories

curl --request POST \
  --url https://api.faireplace.com/api/charges/categories \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "name": "Collective heating",
  "description": "Charges related to the building's collective heating",
  "legal_reference": "Article 23-1 paragraph 3 of decree no. 87-713",
  "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"
}
EOF

shell

Example Request Body

{
  "name": "Collective heating",
  "description": "Charges related to the building's collective heating",
  "legal_reference": "Article 23-1 paragraph 3 of decree no. 87-713",
  "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"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": {},
  "legal_reference": {},
  "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",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Get service charge category

GET

https://api.faireplace.com/api

/charges/categories/{id}

Get service charge category › path Parameters

id

string · uuid · required

Get service charge category › Responses

Charge category for services (Article 23 of decree no. 87-713)

id

string · uuid · required

Unique identifier of the category

name

string · minLength: 1 · maxLength: 255 · required

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

category_type

string · enum · required

Type of charge category

Enum values:

EMPLOYEE

MAINTENANCE

CLEANING

ELEVATOR

HEATING

WATER

COMMON_AREAS

TAXES

Example: MAINTENANCE

recovery_rate

number · decimal · min: 0 · max: 100 · required

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

Example: 100

Default: 100

created_at

string · date-time · required

Creation date

updated_at

string · date-time · required

Last modification date

description

string | null · maxLength: 1000

Detailed description of the category

legal_reference

string | null

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

object

Maintenance details for a charge category

notification_threshold

number | null · decimal · min: 0 · max: 100

Notification threshold for alerts (0-100)

Example: 15

notification_frequency

string · pattern: ^\d+\s+(day|week|mon…

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

Example: 30 days

GET/charges/categories/{id}

curl --request GET \
  --url https://api.faireplace.com/api/charges/categories/:id

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": {},
  "legal_reference": {},
  "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",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Update service charge category

PUT

https://api.faireplace.com/api

/charges/categories/{id}

Update service charge category › path Parameters

id

string · uuid · required

Update service charge category › Request Body

Data for updating a charge category

name

string · minLength: 1 · maxLength: 255 · required

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

Example: Collective heating

category_type

string · enum · required

Type of charge category

Enum values:

EMPLOYEE

MAINTENANCE

CLEANING

ELEVATOR

HEATING

WATER

COMMON_AREAS

TAXES

Example: MAINTENANCE

description

string | null · maxLength: 1000

Detailed description of the category

Example: Charges related to the building's collective heating

legal_reference

string | null

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

Example: Article 23-1 paragraph 3 of decree no. 87-713

object

Maintenance details for a charge category

recovery_rate

number | null · decimal · min: 0 · max: 100

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

Example: 100

notification_threshold

number | null · decimal · min: 0 · max: 100

Notification threshold for alerts (0-100)

Example: 15

notification_frequency

string · pattern: ^\d+\s+(day|week|mon…

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

Example: 30 days

Update service charge category › Responses

Charge category for services (Article 23 of decree no. 87-713)

id

string · uuid · required

Unique identifier of the category

name

string · minLength: 1 · maxLength: 255 · required

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

category_type

string · enum · required

Type of charge category

Enum values:

EMPLOYEE

MAINTENANCE

CLEANING

ELEVATOR

HEATING

WATER

COMMON_AREAS

TAXES

Example: MAINTENANCE

recovery_rate

number · decimal · min: 0 · max: 100 · required

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

Example: 100

Default: 100

created_at

string · date-time · required

Creation date

updated_at

string · date-time · required

Last modification date

description

string | null · maxLength: 1000

Detailed description of the category

legal_reference

string | null

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

object

Maintenance details for a charge category

notification_threshold

number | null · decimal · min: 0 · max: 100

Notification threshold for alerts (0-100)

Example: 15

notification_frequency

string · pattern: ^\d+\s+(day|week|mon…

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

Example: 30 days

PUT/charges/categories/{id}

curl --request PUT \
  --url https://api.faireplace.com/api/charges/categories/:id \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "name": "Collective heating",
  "description": "Charges related to the building's collective heating",
  "legal_reference": "Article 23-1 paragraph 3 of decree no. 87-713",
  "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"
}
EOF

shell

Example Request Body

{
  "name": "Collective heating",
  "description": "Charges related to the building's collective heating",
  "legal_reference": "Article 23-1 paragraph 3 of decree no. 87-713",
  "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"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": {},
  "legal_reference": {},
  "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",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Delete service charge category

DELETE

https://api.faireplace.com/api

/charges/categories/{id}

Delete service charge category › path Parameters

id

string · uuid · required

Delete service charge category › Responses

No Content

No data returned

DELETE/charges/categories/{id}

curl --request DELETE \
  --url https://api.faireplace.com/api/charges/categories/:id

shell

Example Responses

No example specified for this content type

List charge distribution keys

GET

https://api.faireplace.com/api

/charges/distributions

Retrieve the list of charge distribution keys with pagination and filters

List charge distribution keys › query Parameters

page

integer · min: 1

Page number (default: 1)

Default: 1

limit

integer · min: 1 · max: 100

Number of items per page (default: 20, max: 100)

Default: 20

search

string

Search by name or description

calculation_type

string · enum

Filter by distribution type

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

Enum values:

SURFACE

OCCUPANT

CONSOMMATION_MESUREE

NOMBRE_EQUIPEMENTS

MILLIEME

PARTS_EGALES

FORMULE_PERSONNALISEE

Example: SURFACE

List charge distribution keys › Responses

Distribution keys retrieved successfully

object[]

object

GET/charges/distributions

curl --request GET \
  --url https://api.faireplace.com/api/charges/distributions

shell

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "description": {},
      "calculation_type": "SURFACE",
      "formula": {},
      "parameters": {
        "surface_m2": 75.5,
        "occupant_count": 3,
        "meter_id": "00000000-0000-0000-0000-000000000000",
        "equipment_count": 2,
        "millieme_value": 125.5,
        "formula_parameters": {}
      },
      "validation_rules": {
        "min_value": 0,
        "max_value": 10000,
        "required_parameters": [
          "surface_m2"
        ],
        "custom_validation": {}
      },
      "created_at": "2024-08-25T15:00:00Z",
      "updated_at": "2024-08-25T15:00:00Z"
    }
  ],
  "pagination": {
    "current_page": 0,
    "per_page": 0,
    "total": 0,
    "total_pages": 0,
    "has_next": true,
    "has_prev": true
  }
}

json

application/json

Create a charge distribution key

POST

https://api.faireplace.com/api

/charges/distributions

Create a new charge distribution key

Create a charge distribution key › Request Body

Data for creating a new charge distribution key

name

string · minLength: 1 · required

Name of the distribution key

calculation_type

string · enum · 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

Enum values:

SURFACE

OCCUPANT

CONSOMMATION_MESUREE

NOMBRE_EQUIPEMENTS

MILLIEME

PARTS_EGALES

FORMULE_PERSONNALISEE

Example: SURFACE

description

string | null

Description of the distribution key

formula

string | null

Custom calculation formula

object

Charge distribution parameters based on the chosen calculation type

object

Validation rules for distribution calculations

Create a charge distribution key › Responses

Distribution key created successfully

Charge distribution key. **When used in a rental charge:** - The `calculation_type` must be compatible with the charge's `calculation_method` - `CONSOMMATION_MESUREE` requires `RELEVE_DIRECT` or `PROVISION` as billing mode - Other types can be used with `PROVISION` or `FORFAIT`

id

string · uuid · required

Unique identifier of the distribution key

name

string · required

Name of the distribution key

calculation_type

string · enum · 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

Enum values:

SURFACE

OCCUPANT

CONSOMMATION_MESUREE

NOMBRE_EQUIPEMENTS

MILLIEME

PARTS_EGALES

FORMULE_PERSONNALISEE

Example: SURFACE

description

string | null

Description of the distribution key

formula

string | null

Custom calculation formula (required if calculation_type = FORMULE_PERSONNALISEE)

object

Charge distribution parameters based on the chosen calculation type

object

Validation rules for distribution calculations

created_at

string · date-time

Creation date

updated_at

string · date-time

Last modification date

POST/charges/distributions

curl --request POST \
  --url https://api.faireplace.com/api/charges/distributions \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "description": {},
  "calculation_type": "SURFACE",
  "formula": {},
  "parameters": {
    "surface_m2": 75.5,
    "occupant_count": 3,
    "meter_id": "00000000-0000-0000-0000-000000000000",
    "equipment_count": 2,
    "millieme_value": 125.5,
    "formula_parameters": {}
  },
  "validation_rules": {
    "min_value": 0,
    "max_value": 10000,
    "required_parameters": [
      "surface_m2"
    ],
    "custom_validation": {}
  }
}
'

shell

Example Request Body

{
  "name": "name",
  "description": {},
  "calculation_type": "SURFACE",
  "formula": {},
  "parameters": {
    "surface_m2": 75.5,
    "occupant_count": 3,
    "meter_id": "00000000-0000-0000-0000-000000000000",
    "equipment_count": 2,
    "millieme_value": 125.5,
    "formula_parameters": {}
  },
  "validation_rules": {
    "min_value": 0,
    "max_value": 10000,
    "required_parameters": [
      "surface_m2"
    ],
    "custom_validation": {}
  }
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": {},
  "calculation_type": "SURFACE",
  "formula": {},
  "parameters": {
    "surface_m2": 75.5,
    "occupant_count": 3,
    "meter_id": "00000000-0000-0000-0000-000000000000",
    "equipment_count": 2,
    "millieme_value": 125.5,
    "formula_parameters": {}
  },
  "validation_rules": {
    "min_value": 0,
    "max_value": 10000,
    "required_parameters": [
      "surface_m2"
    ],
    "custom_validation": {}
  },
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Get charge distribution key

GET

https://api.faireplace.com/api

/charges/distributions/{id}

Retrieve a charge distribution key by its ID

Get charge distribution key › path Parameters

id

string · uuid · required

Distribution key ID

Get charge distribution key › Responses

Distribution key retrieved successfully

id

string · uuid · required

Unique identifier of the distribution key

name

string · required

Name of the distribution key

calculation_type

string · enum · 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

Enum values:

SURFACE

OCCUPANT

CONSOMMATION_MESUREE

NOMBRE_EQUIPEMENTS

MILLIEME

PARTS_EGALES

FORMULE_PERSONNALISEE

Example: SURFACE

description

string | null

Description of the distribution key

formula

string | null

Custom calculation formula (required if calculation_type = FORMULE_PERSONNALISEE)

object

Charge distribution parameters based on the chosen calculation type

object

Validation rules for distribution calculations

created_at

string · date-time

Creation date

updated_at

string · date-time

Last modification date

GET/charges/distributions/{id}

curl --request GET \
  --url https://api.faireplace.com/api/charges/distributions/:id

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": {},
  "calculation_type": "SURFACE",
  "formula": {},
  "parameters": {
    "surface_m2": 75.5,
    "occupant_count": 3,
    "meter_id": "00000000-0000-0000-0000-000000000000",
    "equipment_count": 2,
    "millieme_value": 125.5,
    "formula_parameters": {}
  },
  "validation_rules": {
    "min_value": 0,
    "max_value": 10000,
    "required_parameters": [
      "surface_m2"
    ],
    "custom_validation": {}
  },
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Update charge distribution key

PUT

https://api.faireplace.com/api

/charges/distributions/{id}

Update an existing charge distribution key

Update charge distribution key › path Parameters

id

string · uuid · required

Distribution key ID

Update charge distribution key › Request Body

Data for updating a charge distribution key

name

string · minLength: 1

Name of the distribution key

description

string | null

Description of the distribution key

calculation_type

string · enum

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

Enum values:

SURFACE

OCCUPANT

CONSOMMATION_MESUREE

NOMBRE_EQUIPEMENTS

MILLIEME

PARTS_EGALES

FORMULE_PERSONNALISEE

Example: SURFACE

formula

string | null

Custom calculation formula

object

Charge distribution parameters based on the chosen calculation type

object

Validation rules for distribution calculations

Update charge distribution key › Responses

Distribution key updated successfully

id

string · uuid · required

Unique identifier of the distribution key

name

string · required

Name of the distribution key

calculation_type

string · enum · 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

Enum values:

SURFACE

OCCUPANT

CONSOMMATION_MESUREE

NOMBRE_EQUIPEMENTS

MILLIEME

PARTS_EGALES

FORMULE_PERSONNALISEE

Example: SURFACE

description

string | null

Description of the distribution key

formula

string | null

Custom calculation formula (required if calculation_type = FORMULE_PERSONNALISEE)

object

Charge distribution parameters based on the chosen calculation type

object

Validation rules for distribution calculations

created_at

string · date-time

Creation date

updated_at

string · date-time

Last modification date

PUT/charges/distributions/{id}

curl --request PUT \
  --url https://api.faireplace.com/api/charges/distributions/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "description": {},
  "calculation_type": "SURFACE",
  "formula": {},
  "parameters": {
    "surface_m2": 75.5,
    "occupant_count": 3,
    "meter_id": "00000000-0000-0000-0000-000000000000",
    "equipment_count": 2,
    "millieme_value": 125.5,
    "formula_parameters": {}
  },
  "validation_rules": {
    "min_value": 0,
    "max_value": 10000,
    "required_parameters": [
      "surface_m2"
    ],
    "custom_validation": {}
  }
}
'

shell

Example Request Body

{
  "name": "name",
  "description": {},
  "calculation_type": "SURFACE",
  "formula": {},
  "parameters": {
    "surface_m2": 75.5,
    "occupant_count": 3,
    "meter_id": "00000000-0000-0000-0000-000000000000",
    "equipment_count": 2,
    "millieme_value": 125.5,
    "formula_parameters": {}
  },
  "validation_rules": {
    "min_value": 0,
    "max_value": 10000,
    "required_parameters": [
      "surface_m2"
    ],
    "custom_validation": {}
  }
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": {},
  "calculation_type": "SURFACE",
  "formula": {},
  "parameters": {
    "surface_m2": 75.5,
    "occupant_count": 3,
    "meter_id": "00000000-0000-0000-0000-000000000000",
    "equipment_count": 2,
    "millieme_value": 125.5,
    "formula_parameters": {}
  },
  "validation_rules": {
    "min_value": 0,
    "max_value": 10000,
    "required_parameters": [
      "surface_m2"
    ],
    "custom_validation": {}
  },
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Delete charge distribution key

DELETE

https://api.faireplace.com/api

/charges/distributions/{id}

Delete a charge distribution key

Delete charge distribution key › path Parameters

id

string · uuid · required

Distribution key ID

Delete charge distribution key › Responses

Distribution key deleted successfully

No data returned

DELETE/charges/distributions/{id}

curl --request DELETE \
  --url https://api.faireplace.com/api/charges/distributions/:id

shell

Example Responses

No example specified for this content type

Calculate charge distribution

POST

https://api.faireplace.com/api

/charges/distributions/{id}/calculate

Calculate the charge distribution according to the specified distribution key

Calculate charge distribution › path Parameters

id

string · uuid · required

Distribution key ID

Calculate charge distribution › Request Body

Charge distribution calculation request

place_id

string · uuid · required

ID of the place for which to calculate the distribution

total_amount

number · float · required

Total amount to distribute

calculation_date

string · date

Calculation date

object

Additional parameters for the calculation

Calculate charge distribution › Responses

Distribution calculation completed successfully

Result of the charge distribution calculation

distribution_key_id

string · uuid · required

ID of the distribution key used

total_amount

number · float · required

Total amount distributed

object[] · required

List of calculated distributions

calculation_date

string · date-time · required

Date and time of the calculation

object

Calculation metadata

POST/charges/distributions/{id}/calculate

curl --request POST \
  --url https://api.faireplace.com/api/charges/distributions/:id/calculate \
  --header 'Content-Type: application/json' \
  --data '
{
  "place_id": "00000000-0000-0000-0000-000000000000",
  "total_amount": 0,
  "calculation_date": "2024-08-25",
  "parameters": {}
}
'

shell

Example Request Body

{
  "place_id": "00000000-0000-0000-0000-000000000000",
  "total_amount": 0,
  "calculation_date": "2024-08-25",
  "parameters": {}
}

json

Example Responses

{
  "distribution_key_id": "00000000-0000-0000-0000-000000000000",
  "total_amount": 0,
  "distributions": [
    {
      "unit_id": "00000000-0000-0000-0000-000000000000",
      "unit_name": "unit_name",
      "amount": 0,
      "percentage": 0,
      "calculation_details": {}
    }
  ],
  "calculation_date": "2024-08-25T15:00:00Z",
  "metadata": {}
}

json

application/json

Check distribution key name uniqueness

GET

https://api.faireplace.com/api

/charges/distributions/check-name/{name}

Check whether a distribution key name is already in use

Check distribution key name uniqueness › path Parameters

name

string · minLength: 1 · required

Distribution key name to check

Check distribution key name uniqueness › Responses

Verification result

is_unique

boolean · required

true if the name is unique, false otherwise

Example: true

GET/charges/distributions/check-name/{name}

curl --request GET \
  --url https://api.faireplace.com/api/charges/distributions/check-name/:name

shell

Example Responses

{
  "is_unique": true
}

json

application/json

Estate Diagnostics Credits