FairePlace Property Management API

Lease Types

Endpointhttps://api.faireplace.com/api

Lease types and their configurations

List all lease types

GET

https://api.faireplace.com/api

/lease-types

Retrieve the list of all lease types for the current tenant

List all lease types › query Parameters

legislative_zone_id

string · uuid

Filter by legislative zone

List all lease types › Responses

Lease types retrieved successfully

object[]

Complete lease type

id

string · uuid · required

Unique identifier of the lease type

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

legislative_zone_id

string · uuid · required

Legislative zone ID

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

name

string · maxLength: 255 · required

Lease type name

Example: Furnished lease 3 years

is_furnished

boolean · required

Indicates whether the lease is furnished

Example: true

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

description

string | null · maxLength: 1000

Lease type description

Example: Furnished lease for a duration of 3 years with annual revision

GET/lease-types

curl --request GET \
  --url https://api.faireplace.com/api/lease-types

shell

Example Responses

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "legislative_zone_id": "550e8400-e29b-41d4-a716-446655440001",
    "name": "Furnished lease 3 years",
    "description": "Furnished lease for a duration of 3 years with annual revision",
    "is_furnished": true,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
]

json

application/json

Create a new lease type

POST

https://api.faireplace.com/api

/lease-types

Create a new lease type with the provided parameters

Create a new lease type › Request Body

Data for creating a new lease type

legislative_zone_id

string · uuid · required

Legislative zone ID

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

name

string · minLength: 1 · maxLength: 255 · required

Lease type name

Example: Furnished lease 3 years

is_furnished

boolean · required

Indicates whether the lease is furnished

Example: true

description

string | null · maxLength: 1000

Lease type description

Example: Furnished lease for a duration of 3 years with annual revision

Create a new lease type › Responses

Lease type created successfully

Complete lease type

id

string · uuid · required

Unique identifier of the lease type

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

legislative_zone_id

string · uuid · required

Legislative zone ID

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

name

string · maxLength: 255 · required

Lease type name

Example: Furnished lease 3 years

is_furnished

boolean · required

Indicates whether the lease is furnished

Example: true

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

description

string | null · maxLength: 1000

Lease type description

Example: Furnished lease for a duration of 3 years with annual revision

POST/lease-types

curl --request POST \
  --url https://api.faireplace.com/api/lease-types \
  --header 'Content-Type: application/json' \
  --data '
{
  "legislative_zone_id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Furnished lease 3 years",
  "description": "Furnished lease for a duration of 3 years with annual revision",
  "is_furnished": true
}
'

shell

Example Request Body

{
  "legislative_zone_id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Furnished lease 3 years",
  "description": "Furnished lease for a duration of 3 years with annual revision",
  "is_furnished": true
}

json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "legislative_zone_id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Furnished lease 3 years",
  "description": "Furnished lease for a duration of 3 years with annual revision",
  "is_furnished": true,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Get lease type by ID

GET

https://api.faireplace.com/api

/lease-types/{id}

Retrieve the details of a specific lease type

Get lease type by ID › path Parameters

id

string · uuid · required

Lease type ID

Get lease type by ID › Responses

Lease type retrieved successfully

Complete lease type

id

string · uuid · required

Unique identifier of the lease type

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

legislative_zone_id

string · uuid · required

Legislative zone ID

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

name

string · maxLength: 255 · required

Lease type name

Example: Furnished lease 3 years

is_furnished

boolean · required

Indicates whether the lease is furnished

Example: true

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

description

string | null · maxLength: 1000

Lease type description

Example: Furnished lease for a duration of 3 years with annual revision

GET/lease-types/{id}

curl --request GET \
  --url https://api.faireplace.com/api/lease-types/:id

shell

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "legislative_zone_id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Furnished lease 3 years",
  "description": "Furnished lease for a duration of 3 years with annual revision",
  "is_furnished": true,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Update lease type

PUT

https://api.faireplace.com/api

/lease-types/{id}

Update the information of an existing lease type

Update lease type › path Parameters

id

string · uuid · required

Lease type ID

Update lease type › Request Body

Data for updating a lease type

name

string · minLength: 1 · maxLength: 255

Lease type name

Example: Furnished lease 3 years

description

string | null · maxLength: 1000

Lease type description

Example: Furnished lease for a duration of 3 years with annual revision

is_furnished

boolean

Indicates whether the lease is furnished

Example: true

Update lease type › Responses

Lease type updated successfully

Complete lease type

id

string · uuid · required

Unique identifier of the lease type

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

legislative_zone_id

string · uuid · required

Legislative zone ID

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

name

string · maxLength: 255 · required

Lease type name

Example: Furnished lease 3 years

is_furnished

boolean · required

Indicates whether the lease is furnished

Example: true

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

description

string | null · maxLength: 1000

Lease type description

Example: Furnished lease for a duration of 3 years with annual revision

PUT/lease-types/{id}

curl --request PUT \
  --url https://api.faireplace.com/api/lease-types/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Furnished lease 3 years",
  "description": "Furnished lease for a duration of 3 years with annual revision",
  "is_furnished": true
}
'

shell

Example Request Body

{
  "name": "Furnished lease 3 years",
  "description": "Furnished lease for a duration of 3 years with annual revision",
  "is_furnished": true
}

json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "legislative_zone_id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Furnished lease 3 years",
  "description": "Furnished lease for a duration of 3 years with annual revision",
  "is_furnished": true,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Delete lease type

DELETE

https://api.faireplace.com/api

/lease-types/{id}

Delete a lease type and all its associated configurations

Delete lease type › path Parameters

id

string · uuid · required

Lease type ID

Delete lease type › Responses

Lease type deleted successfully

No data returned

DELETE/lease-types/{id}

curl --request DELETE \
  --url https://api.faireplace.com/api/lease-types/:id

shell

Example Responses

No example specified for this content type

List configurations for a lease type

GET

https://api.faireplace.com/api

/lease-types/{lease_type_id}/configurations

Retrieve all configurations associated with a lease type

List configurations for a lease type › path Parameters

lease_type_id

string · uuid · required

Lease type ID

List configurations for a lease type › Responses

Configurations retrieved successfully

object[]

Lease type configuration

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

name

string · maxLength: 255 · required

Configuration name

Example: Standard configuration

min_duration_months

integer · min: 1 · required

Minimum duration in months

Example: 12

is_renewable

boolean · required

Indicates whether the lease is renewable

Example: true

requires_furnished

boolean · required

Indicates whether the lease requires a furnished property

Example: false

deposit_months

integer · min: 0 · required

Number of deposit months

Example: 1

charge_mode

string · enum · required

Charge management mode

Enum values:

PROVISION

FORFAIT

Example: PROVISION

requires_inventory

boolean · required

Indicates whether an inventory is required

Example: true

requires_professional_insurance

boolean · required

Indicates whether professional insurance is required

Example: false

requires_guarantor

boolean · required

Indicates whether a guarantor is required

Example: true

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

max_duration_months

integer | null · min: 1

Maximum duration in months

Example: 36

rent_revision_frequency

string · enum

Rent payment frequency

Enum values:

MONTHLY

QUARTERLY

ANNUALLY

Example: MONTHLY

rent_index_type

string · enum

Rent revision index type

Enum values:

ILC

ILAT

IRL

ICC

NONE

Example: IRL

GET/lease-types/{lease_type_id}/configurations

curl --request GET \
  --url https://api.faireplace.com/api/lease-types/:lease_type_id/configurations

shell

Example Responses

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "lease_type_id": "550e8400-e29b-41d4-a716-446655440001",
    "name": "Standard configuration",
    "min_duration_months": 12,
    "max_duration_months": 36,
    "is_renewable": true,
    "requires_furnished": false,
    "deposit_months": 1,
    "rent_revision_frequency": "MONTHLY",
    "rent_index_type": "IRL",
    "charge_mode": "PROVISION",
    "requires_inventory": true,
    "requires_professional_insurance": false,
    "requires_guarantor": true,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
]

json

application/json

Create a configuration for a lease type

POST

https://api.faireplace.com/api

/lease-types/{lease_type_id}/configurations

Create a new configuration for a lease type

Create a configuration for a lease type › path Parameters

lease_type_id

string · uuid · required

Lease type ID

Create a configuration for a lease type › Request Body

Data for creating a new lease type configuration

name

string · minLength: 1 · maxLength: 255 · required

Configuration name

Example: Standard configuration

min_duration_months

integer · min: 1 · required

Minimum duration in months

Example: 12

is_renewable

boolean · required

Indicates whether the lease is renewable

Example: true

requires_furnished

boolean · required

Indicates whether the lease requires a furnished property

Example: false

deposit_months

integer · min: 0 · required

Number of deposit months

Example: 1

charge_mode

string · enum · required

Charge management mode

Enum values:

PROVISION

FORFAIT

Example: PROVISION

requires_inventory

boolean · required

Indicates whether an inventory is required

Example: true

requires_professional_insurance

boolean · required

Indicates whether professional insurance is required

Example: false

requires_guarantor

boolean · required

Indicates whether a guarantor is required

Example: true

max_duration_months

integer | null · min: 1

Maximum duration in months

Example: 36

rent_revision_frequency

string · enum

Rent payment frequency

Enum values:

MONTHLY

QUARTERLY

ANNUALLY

Example: MONTHLY

rent_index_type

string · enum

Rent revision index type

Enum values:

ILC

ILAT

IRL

ICC

NONE

Example: IRL

Create a configuration for a lease type › Responses

Configuration created successfully

Lease type configuration

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

name

string · maxLength: 255 · required

Configuration name

Example: Standard configuration

min_duration_months

integer · min: 1 · required

Minimum duration in months

Example: 12

is_renewable

boolean · required

Indicates whether the lease is renewable

Example: true

requires_furnished

boolean · required

Indicates whether the lease requires a furnished property

Example: false

deposit_months

integer · min: 0 · required

Number of deposit months

Example: 1

charge_mode

string · enum · required

Charge management mode

Enum values:

PROVISION

FORFAIT

Example: PROVISION

requires_inventory

boolean · required

Indicates whether an inventory is required

Example: true

requires_professional_insurance

boolean · required

Indicates whether professional insurance is required

Example: false

requires_guarantor

boolean · required

Indicates whether a guarantor is required

Example: true

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

max_duration_months

integer | null · min: 1

Maximum duration in months

Example: 36

rent_revision_frequency

string · enum

Rent payment frequency

Enum values:

MONTHLY

QUARTERLY

ANNUALLY

Example: MONTHLY

rent_index_type

string · enum

Rent revision index type

Enum values:

ILC

ILAT

IRL

ICC

NONE

Example: IRL

POST/lease-types/{lease_type_id}/configurations

curl --request POST \
  --url https://api.faireplace.com/api/lease-types/:lease_type_id/configurations \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Standard configuration",
  "min_duration_months": 12,
  "max_duration_months": 36,
  "is_renewable": true,
  "requires_furnished": false,
  "deposit_months": 1,
  "rent_revision_frequency": "MONTHLY",
  "rent_index_type": "IRL",
  "charge_mode": "PROVISION",
  "requires_inventory": true,
  "requires_professional_insurance": false,
  "requires_guarantor": true
}
'

shell

Example Request Body

{
  "name": "Standard configuration",
  "min_duration_months": 12,
  "max_duration_months": 36,
  "is_renewable": true,
  "requires_furnished": false,
  "deposit_months": 1,
  "rent_revision_frequency": "MONTHLY",
  "rent_index_type": "IRL",
  "charge_mode": "PROVISION",
  "requires_inventory": true,
  "requires_professional_insurance": false,
  "requires_guarantor": true
}

json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "lease_type_id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Standard configuration",
  "min_duration_months": 12,
  "max_duration_months": 36,
  "is_renewable": true,
  "requires_furnished": false,
  "deposit_months": 1,
  "rent_revision_frequency": "MONTHLY",
  "rent_index_type": "IRL",
  "charge_mode": "PROVISION",
  "requires_inventory": true,
  "requires_professional_insurance": false,
  "requires_guarantor": true,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Get specific configuration

GET

https://api.faireplace.com/api

/lease-types/{lease_type_id}/configurations/{config_id}

Retrieve the details of a specific configuration for a lease type

Get specific configuration › path Parameters

lease_type_id

string · uuid · required

Lease type ID

config_id

string · uuid · required

Configuration ID

Get specific configuration › Responses

Configuration retrieved successfully

Lease type configuration

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

name

string · maxLength: 255 · required

Configuration name

Example: Standard configuration

min_duration_months

integer · min: 1 · required

Minimum duration in months

Example: 12

is_renewable

boolean · required

Indicates whether the lease is renewable

Example: true

requires_furnished

boolean · required

Indicates whether the lease requires a furnished property

Example: false

deposit_months

integer · min: 0 · required

Number of deposit months

Example: 1

charge_mode

string · enum · required

Charge management mode

Enum values:

PROVISION

FORFAIT

Example: PROVISION

requires_inventory

boolean · required

Indicates whether an inventory is required

Example: true

requires_professional_insurance

boolean · required

Indicates whether professional insurance is required

Example: false

requires_guarantor

boolean · required

Indicates whether a guarantor is required

Example: true

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

max_duration_months

integer | null · min: 1

Maximum duration in months

Example: 36

rent_revision_frequency

string · enum

Rent payment frequency

Enum values:

MONTHLY

QUARTERLY

ANNUALLY

Example: MONTHLY

rent_index_type

string · enum

Rent revision index type

Enum values:

ILC

ILAT

IRL

ICC

NONE

Example: IRL

GET/lease-types/{lease_type_id}/configurations/{config_id}

curl --request GET \
  --url https://api.faireplace.com/api/lease-types/:lease_type_id/configurations/:config_id

shell

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "lease_type_id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Standard configuration",
  "min_duration_months": 12,
  "max_duration_months": 36,
  "is_renewable": true,
  "requires_furnished": false,
  "deposit_months": 1,
  "rent_revision_frequency": "MONTHLY",
  "rent_index_type": "IRL",
  "charge_mode": "PROVISION",
  "requires_inventory": true,
  "requires_professional_insurance": false,
  "requires_guarantor": true,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Update configuration

PUT

https://api.faireplace.com/api

/lease-types/{lease_type_id}/configurations/{config_id}

Update an existing configuration for a lease type

Update configuration › path Parameters

lease_type_id

string · uuid · required

Lease type ID

config_id

string · uuid · required

Configuration ID

Update configuration › Request Body

Data for updating a lease type configuration

name

string · minLength: 1 · maxLength: 255

Configuration name

Example: Standard configuration

min_duration_months

integer · min: 1

Minimum duration in months

Example: 12

max_duration_months

integer | null · min: 1

Maximum duration in months

Example: 36

is_renewable

boolean

Indicates whether the lease is renewable

Example: true

requires_furnished

boolean

Indicates whether the lease requires a furnished property

Example: false

deposit_months

integer · min: 0

Number of deposit months

Example: 1

rent_revision_frequency

string · enum

Rent payment frequency

Enum values:

MONTHLY

QUARTERLY

ANNUALLY

Example: MONTHLY

rent_index_type

string · enum

Rent revision index type

Enum values:

ILC

ILAT

IRL

ICC

NONE

Example: IRL

charge_mode

string · enum

Charge management mode

Enum values:

PROVISION

FORFAIT

Example: PROVISION

requires_inventory

boolean

Indicates whether an inventory is required

Example: true

requires_professional_insurance

boolean

Indicates whether professional insurance is required

Example: false

requires_guarantor

boolean

Indicates whether a guarantor is required

Example: true

Update configuration › Responses

Configuration updated successfully

Lease type configuration

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

name

string · maxLength: 255 · required

Configuration name

Example: Standard configuration

min_duration_months

integer · min: 1 · required

Minimum duration in months

Example: 12

is_renewable

boolean · required

Indicates whether the lease is renewable

Example: true

requires_furnished

boolean · required

Indicates whether the lease requires a furnished property

Example: false

deposit_months

integer · min: 0 · required

Number of deposit months

Example: 1

charge_mode

string · enum · required

Charge management mode

Enum values:

PROVISION

FORFAIT

Example: PROVISION

requires_inventory

boolean · required

Indicates whether an inventory is required

Example: true

requires_professional_insurance

boolean · required

Indicates whether professional insurance is required

Example: false

requires_guarantor

boolean · required

Indicates whether a guarantor is required

Example: true

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

max_duration_months

integer | null · min: 1

Maximum duration in months

Example: 36

rent_revision_frequency

string · enum

Rent payment frequency

Enum values:

MONTHLY

QUARTERLY

ANNUALLY

Example: MONTHLY

rent_index_type

string · enum

Rent revision index type

Enum values:

ILC

ILAT

IRL

ICC

NONE

Example: IRL

PUT/lease-types/{lease_type_id}/configurations/{config_id}

curl --request PUT \
  --url https://api.faireplace.com/api/lease-types/:lease_type_id/configurations/:config_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Standard configuration",
  "min_duration_months": 12,
  "max_duration_months": 36,
  "is_renewable": true,
  "requires_furnished": false,
  "deposit_months": 1,
  "rent_revision_frequency": "MONTHLY",
  "rent_index_type": "IRL",
  "charge_mode": "PROVISION",
  "requires_inventory": true,
  "requires_professional_insurance": false,
  "requires_guarantor": true
}
'

shell

Example Request Body

{
  "name": "Standard configuration",
  "min_duration_months": 12,
  "max_duration_months": 36,
  "is_renewable": true,
  "requires_furnished": false,
  "deposit_months": 1,
  "rent_revision_frequency": "MONTHLY",
  "rent_index_type": "IRL",
  "charge_mode": "PROVISION",
  "requires_inventory": true,
  "requires_professional_insurance": false,
  "requires_guarantor": true
}

json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "lease_type_id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Standard configuration",
  "min_duration_months": 12,
  "max_duration_months": 36,
  "is_renewable": true,
  "requires_furnished": false,
  "deposit_months": 1,
  "rent_revision_frequency": "MONTHLY",
  "rent_index_type": "IRL",
  "charge_mode": "PROVISION",
  "requires_inventory": true,
  "requires_professional_insurance": false,
  "requires_guarantor": true,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Delete configuration

DELETE

https://api.faireplace.com/api

/lease-types/{lease_type_id}/configurations/{config_id}

Delete a configuration for a lease type

Delete configuration › path Parameters

lease_type_id

string · uuid · required

Lease type ID

config_id

string · uuid · required

Configuration ID

Delete configuration › Responses

Configuration deleted successfully

No data returned

DELETE/lease-types/{lease_type_id}/configurations/{config_id}

curl --request DELETE \
  --url https://api.faireplace.com/api/lease-types/:lease_type_id/configurations/:config_id

shell

Example Responses

No example specified for this content type

List templates for a lease type

GET

https://api.faireplace.com/api

/lease-types/{lease_type_id}/templates

Retrieve all templates associated with a lease type

List templates for a lease type › path Parameters

lease_type_id

string · uuid · required

Lease type ID

List templates for a lease type › Responses

Templates retrieved successfully

object[]

Lease type template

id

string · uuid · required

Unique identifier of the template

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

lease_type_id

string · uuid · required

Lease type ID

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

name

string · maxLength: 255 · required

Template name

Example: Standard furnished lease template

content

string · required

Template content (Typst)

Example: #= Furnished lease Lease entered into between...

template_type

string · enum · required

Template type

Enum values:

lease

amendment

termination

inventory

Example: lease

version

string · maxLength: 50 · required

Template version

Example: 1.0.0

is_active

boolean · required

Indicates whether the template is active

Example: true

is_default

boolean · required

Indicates whether the template is the default

Example: false

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

description

string | null · maxLength: 1000

Template description

Example: Standard template for furnished leases

GET/lease-types/{lease_type_id}/templates

curl --request GET \
  --url https://api.faireplace.com/api/lease-types/:lease_type_id/templates

shell

Example Responses

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "lease_type_id": "550e8400-e29b-41d4-a716-446655440001",
    "name": "Standard furnished lease template",
    "description": "Standard template for furnished leases",
    "content": "#= Furnished lease\n\nLease entered into between...",
    "template_type": "lease",
    "version": "1.0.0",
    "is_active": true,
    "is_default": false,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
]

json

application/json

Create a template for a lease type

POST

https://api.faireplace.com/api

/lease-types/{lease_type_id}/templates

Create a new template for a lease type

Create a template for a lease type › path Parameters

lease_type_id

string · uuid · required

Lease type ID

Create a template for a lease type › Request Body

Data for creating a new lease type template

name

string · minLength: 1 · maxLength: 255 · required

Template name

Example: Standard furnished lease template

content

string · minLength: 1 · required

Template content (Typst)

Example: #= Furnished lease Lease entered into between...

template_type

string · enum · required

Template type

Enum values:

lease

amendment

termination

inventory

Example: lease

version

string · minLength: 1 · maxLength: 50 · required

Template version

Example: 1.0.0

is_active

boolean · required

Indicates whether the template is active

Example: true

is_default

boolean · required

Indicates whether the template is the default

Example: false

description

string | null · maxLength: 1000

Template description

Example: Standard template for furnished leases

Create a template for a lease type › Responses

Template created successfully

Lease type template

id

string · uuid · required

Unique identifier of the template

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

lease_type_id

string · uuid · required

Lease type ID

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

name

string · maxLength: 255 · required

Template name

Example: Standard furnished lease template

content

string · required

Template content (Typst)

Example: #= Furnished lease Lease entered into between...

template_type

string · enum · required

Template type

Enum values:

lease

amendment

termination

inventory

Example: lease

version

string · maxLength: 50 · required

Template version

Example: 1.0.0

is_active

boolean · required

Indicates whether the template is active

Example: true

is_default

boolean · required

Indicates whether the template is the default

Example: false

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

description

string | null · maxLength: 1000

Template description

Example: Standard template for furnished leases

POST/lease-types/{lease_type_id}/templates

curl --request POST \
  --url https://api.faireplace.com/api/lease-types/:lease_type_id/templates \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Standard furnished lease template",
  "description": "Standard template for furnished leases",
  "content": "#= Furnished lease\n\nLease entered into between...",
  "template_type": "lease",
  "version": "1.0.0",
  "is_active": true,
  "is_default": false
}
'

shell

Example Request Body

{
  "name": "Standard furnished lease template",
  "description": "Standard template for furnished leases",
  "content": "#= Furnished lease\n\nLease entered into between...",
  "template_type": "lease",
  "version": "1.0.0",
  "is_active": true,
  "is_default": false
}

json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "lease_type_id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Standard furnished lease template",
  "description": "Standard template for furnished leases",
  "content": "#= Furnished lease\n\nLease entered into between...",
  "template_type": "lease",
  "version": "1.0.0",
  "is_active": true,
  "is_default": false,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

List templates by type

GET

https://api.faireplace.com/api

/lease-types/{lease_type_id}/templates/type/{type}

Retrieve all templates of a specific type for a lease type

List templates by type › path Parameters

lease_type_id

string · uuid · required

Lease type ID

type

string · enum · required

Template type

Enum values:

lease

amendment

termination

inventory

List templates by type › Responses

Templates retrieved successfully

object[]

Lease type template

id

string · uuid · required

Unique identifier of the template

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

lease_type_id

string · uuid · required

Lease type ID

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

name

string · maxLength: 255 · required

Template name

Example: Standard furnished lease template

content

string · required

Template content (Typst)

Example: #= Furnished lease Lease entered into between...

template_type

string · enum · required

Template type

Enum values:

lease

amendment

termination

inventory

Example: lease

version

string · maxLength: 50 · required

Template version

Example: 1.0.0

is_active

boolean · required

Indicates whether the template is active

Example: true

is_default

boolean · required

Indicates whether the template is the default

Example: false

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

description

string | null · maxLength: 1000

Template description

Example: Standard template for furnished leases

GET/lease-types/{lease_type_id}/templates/type/{type}

curl --request GET \
  --url https://api.faireplace.com/api/lease-types/:lease_type_id/templates/type/:type

shell

Example Responses

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "lease_type_id": "550e8400-e29b-41d4-a716-446655440001",
    "name": "Standard furnished lease template",
    "description": "Standard template for furnished leases",
    "content": "#= Furnished lease\n\nLease entered into between...",
    "template_type": "lease",
    "version": "1.0.0",
    "is_active": true,
    "is_default": false,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
]

json

application/json

Get active template by type

GET

https://api.faireplace.com/api

/lease-types/{lease_type_id}/templates/active/{type}

Retrieve the active template of a specific type for a lease type

Get active template by type › path Parameters

lease_type_id

string · uuid · required

Lease type ID

type

string · enum · required

Template type

Enum values:

lease

amendment

termination

inventory

Get active template by type › Responses

Active template retrieved successfully

Lease type template

id

string · uuid · required

Unique identifier of the template

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

lease_type_id

string · uuid · required

Lease type ID

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

name

string · maxLength: 255 · required

Template name

Example: Standard furnished lease template

content

string · required

Template content (Typst)

Example: #= Furnished lease Lease entered into between...

template_type

string · enum · required

Template type

Enum values:

lease

amendment

termination

inventory

Example: lease

version

string · maxLength: 50 · required

Template version

Example: 1.0.0

is_active

boolean · required

Indicates whether the template is active

Example: true

is_default

boolean · required

Indicates whether the template is the default

Example: false

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

description

string | null · maxLength: 1000

Template description

Example: Standard template for furnished leases

GET/lease-types/{lease_type_id}/templates/active/{type}

curl --request GET \
  --url https://api.faireplace.com/api/lease-types/:lease_type_id/templates/active/:type

shell

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "lease_type_id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Standard furnished lease template",
  "description": "Standard template for furnished leases",
  "content": "#= Furnished lease\n\nLease entered into between...",
  "template_type": "lease",
  "version": "1.0.0",
  "is_active": true,
  "is_default": false,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Get default template by type

GET

https://api.faireplace.com/api

/lease-types/{lease_type_id}/templates/default/{type}

Retrieve the default template of a specific type for a lease type

Get default template by type › path Parameters

lease_type_id

string · uuid · required

Lease type ID

type

string · enum · required

Template type

Enum values:

lease

amendment

termination

inventory

Get default template by type › Responses

Default template retrieved successfully

Lease type template

id

string · uuid · required

Unique identifier of the template

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

lease_type_id

string · uuid · required

Lease type ID

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

name

string · maxLength: 255 · required

Template name

Example: Standard furnished lease template

content

string · required

Template content (Typst)

Example: #= Furnished lease Lease entered into between...

template_type

string · enum · required

Template type

Enum values:

lease

amendment

termination

inventory

Example: lease

version

string · maxLength: 50 · required

Template version

Example: 1.0.0

is_active

boolean · required

Indicates whether the template is active

Example: true

is_default

boolean · required

Indicates whether the template is the default

Example: false

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

description

string | null · maxLength: 1000

Template description

Example: Standard template for furnished leases

GET/lease-types/{lease_type_id}/templates/default/{type}

curl --request GET \
  --url https://api.faireplace.com/api/lease-types/:lease_type_id/templates/default/:type

shell

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "lease_type_id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Standard furnished lease template",
  "description": "Standard template for furnished leases",
  "content": "#= Furnished lease\n\nLease entered into between...",
  "template_type": "lease",
  "version": "1.0.0",
  "is_active": true,
  "is_default": false,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Get specific template

GET

https://api.faireplace.com/api

/lease-types/{lease_type_id}/templates/{template_id}

Retrieve the details of a specific template

Get specific template › path Parameters

lease_type_id

string · uuid · required

Lease type ID

template_id

string · uuid · required

Template ID

Get specific template › Responses

Template retrieved successfully

Lease type template

id

string · uuid · required

Unique identifier of the template

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

lease_type_id

string · uuid · required

Lease type ID

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

name

string · maxLength: 255 · required

Template name

Example: Standard furnished lease template

content

string · required

Template content (Typst)

Example: #= Furnished lease Lease entered into between...

template_type

string · enum · required

Template type

Enum values:

lease

amendment

termination

inventory

Example: lease

version

string · maxLength: 50 · required

Template version

Example: 1.0.0

is_active

boolean · required

Indicates whether the template is active

Example: true

is_default

boolean · required

Indicates whether the template is the default

Example: false

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

description

string | null · maxLength: 1000

Template description

Example: Standard template for furnished leases

GET/lease-types/{lease_type_id}/templates/{template_id}

curl --request GET \
  --url https://api.faireplace.com/api/lease-types/:lease_type_id/templates/:template_id

shell

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "lease_type_id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Standard furnished lease template",
  "description": "Standard template for furnished leases",
  "content": "#= Furnished lease\n\nLease entered into between...",
  "template_type": "lease",
  "version": "1.0.0",
  "is_active": true,
  "is_default": false,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Update template

PUT

https://api.faireplace.com/api

/lease-types/{lease_type_id}/templates/{template_id}

Update an existing template

Update template › path Parameters

lease_type_id

string · uuid · required

Lease type ID

template_id

string · uuid · required

Template ID

Update template › Request Body

Data for updating a lease type template

name

string · minLength: 1 · maxLength: 255

Template name

Example: Standard furnished lease template

description

string | null · maxLength: 1000

Template description

Example: Standard template for furnished leases

content

string · minLength: 1

Template content (Typst)

Example: #= Furnished lease Lease entered into between...

template_type

string · enum

Template type

Enum values:

lease

amendment

termination

inventory

Example: lease

version

string · minLength: 1 · maxLength: 50

Template version

Example: 1.0.0

is_active

boolean

Indicates whether the template is active

Example: true

is_default

boolean

Indicates whether the template is the default

Example: false

Update template › Responses

Template updated successfully

Lease type template

id

string · uuid · required

Unique identifier of the template

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

lease_type_id

string · uuid · required

Lease type ID

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

name

string · maxLength: 255 · required

Template name

Example: Standard furnished lease template

content

string · required

Template content (Typst)

Example: #= Furnished lease Lease entered into between...

template_type

string · enum · required

Template type

Enum values:

lease

amendment

termination

inventory

Example: lease

version

string · maxLength: 50 · required

Template version

Example: 1.0.0

is_active

boolean · required

Indicates whether the template is active

Example: true

is_default

boolean · required

Indicates whether the template is the default

Example: false

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

description

string | null · maxLength: 1000

Template description

Example: Standard template for furnished leases

PUT/lease-types/{lease_type_id}/templates/{template_id}

curl --request PUT \
  --url https://api.faireplace.com/api/lease-types/:lease_type_id/templates/:template_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Standard furnished lease template",
  "description": "Standard template for furnished leases",
  "content": "#= Furnished lease\n\nLease entered into between...",
  "template_type": "lease",
  "version": "1.0.0",
  "is_active": true,
  "is_default": false
}
'

shell

Example Request Body

{
  "name": "Standard furnished lease template",
  "description": "Standard template for furnished leases",
  "content": "#= Furnished lease\n\nLease entered into between...",
  "template_type": "lease",
  "version": "1.0.0",
  "is_active": true,
  "is_default": false
}

json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "lease_type_id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Standard furnished lease template",
  "description": "Standard template for furnished leases",
  "content": "#= Furnished lease\n\nLease entered into between...",
  "template_type": "lease",
  "version": "1.0.0",
  "is_active": true,
  "is_default": false,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Delete template

DELETE

https://api.faireplace.com/api

/lease-types/{lease_type_id}/templates/{template_id}

Delete a template

Delete template › path Parameters

lease_type_id

string · uuid · required

Lease type ID

template_id

string · uuid · required

Template ID

Delete template › Responses

Template deleted successfully

No data returned

DELETE/lease-types/{lease_type_id}/templates/{template_id}

curl --request DELETE \
  --url https://api.faireplace.com/api/lease-types/:lease_type_id/templates/:template_id

shell

Example Responses

No example specified for this content 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

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

string · enum · required

Charge management mode

Enum values:

PROVISION

FORFAIT

Example: PROVISION

responsible_party

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

object[]

Default charges

object[]

Charge distribution rules

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

curl --request GET \
  --url https://api.faireplace.com/api/lease-types/:lease_type_id/charges/config

shell

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

Update charge configuration

PUT

https://api.faireplace.com/api

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

Update the charge configuration for a lease type

Update charge configuration › path Parameters

lease_type_id

string · uuid · required

Lease type ID

Update charge configuration › Request Body

Data for updating a charge configuration

charge_mode

string · enum

Charge management mode

Enum values:

PROVISION

FORFAIT

Example: PROVISION

responsible_party

string · enum

Party responsible for charges

Enum values:

TENANT

LANDLORD

NEGOTIABLE

Example: TENANT

object[]

Default charges

object[]

Charge distribution rules

Update charge configuration › Responses

Charge configuration updated successfully

Charge configuration for a lease type

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

string · enum · required

Charge management mode

Enum values:

PROVISION

FORFAIT

Example: PROVISION

responsible_party

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

object[]

Default charges

object[]

Charge distribution rules

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

curl --request PUT \
  --url https://api.faireplace.com/api/lease-types/:lease_type_id/charges/config \
  --header 'Content-Type: application/json' \
  --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": {}
    }
  ]
}
'

shell

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

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

charge_mode

string · enum · required

Charge management mode

Enum values:

PROVISION

FORFAIT

Example: PROVISION

responsible_party

string · enum · required

Party responsible for charges

Enum values:

TENANT

LANDLORD

NEGOTIABLE

Example: TENANT

object[]

Default charges

object[]

Charge distribution rules

Create charge configuration › Responses

Charge configuration created successfully

Charge configuration for a lease type

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

string · enum · required

Charge management mode

Enum values:

PROVISION

FORFAIT

Example: PROVISION

responsible_party

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

object[]

Default charges

object[]

Charge distribution rules

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

curl --request POST \
  --url https://api.faireplace.com/api/lease-types/:lease_type_id/charges/config \
  --header 'Content-Type: application/json' \
  --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": {}
    }
  ]
}
'

shell

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

Delete charge configuration

DELETE

https://api.faireplace.com/api

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

Delete the charge configuration for a lease type

Delete charge configuration › path Parameters

lease_type_id

string · uuid · required

Lease type ID

Delete charge configuration › Responses

Charge configuration deleted successfully

No data returned

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

curl --request DELETE \
  --url https://api.faireplace.com/api/lease-types/:lease_type_id/charges/config

shell

Example Responses

No example specified for this content type

Legislative Zones Energy Diagnosis