Charge Configuration

Default charge configuration carried by a lease type.

Get charge configuration

GET

https://api.faireplace.com/api

/lease-types/{lease_type_id}/charges/config

Retrieve the charge configuration for a lease type

Get charge configuration › path Parameters

lease_type_id

string · uuid · required

Lease type ID

Get charge configuration › Responses

Charge configuration retrieved successfully

Charge configuration for a lease type

LeaseTypeChargeConfig

id

string · uuid · required

Unique identifier of the configuration

Example: 550e8400-e29b-41d4-a716-446655440000

lease_type_id

string · uuid · required

Lease type ID

Example: 550e8400-e29b-41d4-a716-446655440001

charge_mode

LeaseChargeMode · enum · required

Charge management mode

Enum values:

PROVISION

FORFAIT

Example: PROVISION

responsible_party

LeaseResponsibleParty · enum · required

Party responsible for charges

Enum values:

TENANT

LANDLORD

NEGOTIABLE

Example: TENANT

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

DefaultCharge[]

Default charges

DistributionRule[]

Charge distribution rules

GET/lease-types/{lease_type_id}/charges/config

curl https://api.faireplace.com/api/lease-types/:lease_type_id/charges/config \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "lease_type_id": "550e8400-e29b-41d4-a716-446655440001",
  "charge_mode": "PROVISION",
  "responsible_party": "TENANT",
  "default_charges": [
    {
      "name": "Heating",
      "amount": 50,
      "is_mandatory": true,
      "calculation_method": "FIXED"
    }
  ],
  "distribution_rules": [
    {
      "charge_name": "Heating",
      "distribution_method": "SURFACE",
      "parameters": {}
    }
  ],
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Create charge configuration

POST

https://api.faireplace.com/api

/lease-types/{lease_type_id}/charges/config

Create a new charge configuration for a lease type

Create charge configuration › path Parameters

lease_type_id

string · uuid · required

Lease type ID

Create charge configuration › Request Body

Data for creating a new charge configuration

CreateLeaseTypeChargeConfig

charge_mode

LeaseChargeMode · enum · required

Charge management mode

Enum values:

PROVISION

FORFAIT

Example: PROVISION

responsible_party

LeaseResponsibleParty · enum · required

Party responsible for charges

Enum values:

TENANT

LANDLORD

NEGOTIABLE

Example: TENANT

DefaultCharge[]

Default charges

DistributionRule[]

Charge distribution rules

Create charge configuration › Responses

Charge configuration created successfully

Charge configuration for a lease type

LeaseTypeChargeConfig

id

string · uuid · required

Unique identifier of the configuration

Example: 550e8400-e29b-41d4-a716-446655440000

lease_type_id

string · uuid · required

Lease type ID

Example: 550e8400-e29b-41d4-a716-446655440001

charge_mode

LeaseChargeMode · enum · required

Charge management mode

Enum values:

PROVISION

FORFAIT

Example: PROVISION

responsible_party

LeaseResponsibleParty · enum · required

Party responsible for charges

Enum values:

TENANT

LANDLORD

NEGOTIABLE

Example: TENANT

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

DefaultCharge[]

Default charges

DistributionRule[]

Charge distribution rules

POST/lease-types/{lease_type_id}/charges/config

curl https://api.faireplace.com/api/lease-types/:lease_type_id/charges/config \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "charge_mode": "PROVISION",
  "responsible_party": "TENANT",
  "default_charges": [
    {
      "name": "Heating",
      "amount": 50,
      "is_mandatory": true,
      "calculation_method": "FIXED"
    }
  ],
  "distribution_rules": [
    {
      "charge_name": "Heating",
      "distribution_method": "SURFACE",
      "parameters": {}
    }
  ]
}'

Example Request Body

{
  "charge_mode": "PROVISION",
  "responsible_party": "TENANT",
  "default_charges": [
    {
      "name": "Heating",
      "amount": 50,
      "is_mandatory": true,
      "calculation_method": "FIXED"
    }
  ],
  "distribution_rules": [
    {
      "charge_name": "Heating",
      "distribution_method": "SURFACE",
      "parameters": {}
    }
  ]
}

json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "lease_type_id": "550e8400-e29b-41d4-a716-446655440001",
  "charge_mode": "PROVISION",
  "responsible_party": "TENANT",
  "default_charges": [
    {
      "name": "Heating",
      "amount": 50,
      "is_mandatory": true,
      "calculation_method": "FIXED"
    }
  ],
  "distribution_rules": [
    {
      "charge_name": "Heating",
      "distribution_method": "SURFACE",
      "parameters": {}
    }
  ],
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Templates Rent Payments