FairePlace Property Management API

Configurations

Endpointhttps://api.faireplace.com/api

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

Webhooks Templates