FairePlace Property Management API

Syndic Fund Allocations

Endpointhttps://api.faireplace.com/api

Allocate fund call to leases

POST

https://api.faireplace.com/api

/syndics/{syndic_id}/fund-calls/{call_id}/allocate

Distributes the recoverable lines of a fund call to leases based on millième values (tantièmes de copropriété).

Allocation formula:

Code
 
allocated_amount = line_amount × (millieme_value / total_milliemes)

Rounding is handled by adjusting the last lease to ensure the exact total matches. Existing allocations for the same fund call are deleted and recreated (idempotent re-allocation).

Allocate fund call to leases › path Parameters

syndic_id

string · uuid · required

call_id

string · uuid · required

Allocate fund call to leases › Request Body

Request to allocate fund call lines to leases based on millièmes

object[] · minItems: 1 · required

total_milliemes

number · decimal · required

Total millièmes of the copropriété

Allocate fund call to leases › Responses

Allocations created

object[]

Allocation of a fund call line to a lease

id

string · uuid · required

fund_call_line_id

string · uuid · required

lease_id

string · uuid · required

millieme_value

number · decimal · required

Millièmes for this lease

total_milliemes

number · decimal · required

Total millièmes used for calculation

allocated_amount

number · decimal · required

Calculated amount = line_amount × (millieme_value / total_milliemes)

status

string · required

Allocation status

created_at

string · date-time · required

updated_at

string · date-time · required

lease_charge_id

string | null · uuid

Link to the lease charge (set after link-charges)

POST/syndics/{syndic_id}/fund-calls/{call_id}/allocate

curl --request POST \
  --url https://api.faireplace.com/api/syndics/:syndic_id/fund-calls/:call_id/allocate \
  --header 'Content-Type: application/json' \
  --data '
{
  "leases": [
    {
      "lease_id": "00000000-0000-0000-0000-000000000000",
      "millieme_value": 0
    }
  ],
  "total_milliemes": 0
}
'

shell

Example Request Body

{
  "leases": [
    {
      "lease_id": "00000000-0000-0000-0000-000000000000",
      "millieme_value": 0
    }
  ],
  "total_milliemes": 0
}

json

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "fund_call_line_id": "00000000-0000-0000-0000-000000000000",
    "lease_id": "00000000-0000-0000-0000-000000000000",
    "millieme_value": 0,
    "total_milliemes": 0,
    "allocated_amount": 0,
    "lease_charge_id": "00000000-0000-0000-0000-000000000000",
    "status": "status",
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

List allocations for a fund call

GET

https://api.faireplace.com/api

/syndics/{syndic_id}/fund-calls/{call_id}/allocations

List allocations for a fund call › path Parameters

syndic_id

string · uuid · required

call_id

string · uuid · required

List allocations for a fund call › Responses

List of allocations

object[]

Allocation of a fund call line to a lease

id

string · uuid · required

fund_call_line_id

string · uuid · required

lease_id

string · uuid · required

millieme_value

number · decimal · required

Millièmes for this lease

total_milliemes

number · decimal · required

Total millièmes used for calculation

allocated_amount

number · decimal · required

Calculated amount = line_amount × (millieme_value / total_milliemes)

status

string · required

Allocation status

created_at

string · date-time · required

updated_at

string · date-time · required

lease_charge_id

string | null · uuid

Link to the lease charge (set after link-charges)

GET/syndics/{syndic_id}/fund-calls/{call_id}/allocations

curl --request GET \
  --url https://api.faireplace.com/api/syndics/:syndic_id/fund-calls/:call_id/allocations

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "fund_call_line_id": "00000000-0000-0000-0000-000000000000",
    "lease_id": "00000000-0000-0000-0000-000000000000",
    "millieme_value": 0,
    "total_milliemes": 0,
    "allocated_amount": 0,
    "lease_charge_id": "00000000-0000-0000-0000-000000000000",
    "status": "status",
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Link syndic allocations to lease charges

POST

https://api.faireplace.com/api

/syndics/{syndic_id}/fund-calls/{call_id}/link-charges

Links existing fund call allocations to their corresponding lease charges using the charge distribution calculation service.

Link syndic allocations to lease charges › path Parameters

syndic_id

string · uuid · required

call_id

string · uuid · required

Link syndic allocations to lease charges › Responses

Allocations linked to charges

No data returned

POST/syndics/{syndic_id}/fund-calls/{call_id}/link-charges

curl --request POST \
  --url https://api.faireplace.com/api/syndics/:syndic_id/fund-calls/:call_id/link-charges

shell

Example Responses

No example specified for this content type

List syndic allocations for a lease

GET

https://api.faireplace.com/api

/leases/{lease_id}/syndic-allocations

Returns all syndic fund allocations linked to a specific lease.

List syndic allocations for a lease › path Parameters

lease_id

string · uuid · required

List syndic allocations for a lease › Responses

List of allocations for this lease

object[]

Allocation of a fund call line to a lease

id

string · uuid · required

fund_call_line_id

string · uuid · required

lease_id

string · uuid · required

millieme_value

number · decimal · required

Millièmes for this lease

total_milliemes

number · decimal · required

Total millièmes used for calculation

allocated_amount

number · decimal · required

Calculated amount = line_amount × (millieme_value / total_milliemes)

status

string · required

Allocation status

created_at

string · date-time · required

updated_at

string · date-time · required

lease_charge_id

string | null · uuid

Link to the lease charge (set after link-charges)

GET/leases/{lease_id}/syndic-allocations

curl --request GET \
  --url https://api.faireplace.com/api/leases/:lease_id/syndic-allocations

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "fund_call_line_id": "00000000-0000-0000-0000-000000000000",
    "lease_id": "00000000-0000-0000-0000-000000000000",
    "millieme_value": 0,
    "total_milliemes": 0,
    "allocated_amount": 0,
    "lease_charge_id": "00000000-0000-0000-0000-000000000000",
    "status": "status",
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Syndic Fund Calls Configurations