Allocation of a syndic fund call across the leases of a property.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/faireplace-com:faireplace-com-syndic-fund-allocations-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: FairePlace Property Management Syndic Fund Allocations API
description: 'Comprehensive API for managing properties, leases, tenants, and all aspects of real estate management.
Built with Rust and Actix-web following hexagonal architecture principles.
## Authentication
This API uses API keys for authentication with tenant-based isolation.
## Base URL
- Production: `https://api.faireplace.com/api`'
version: 1.0.0
contact:
name: FairePlace API Support
email: api-support@faireplace.com
license:
name: MIT
url: https://opensource.org/licenses/MIT
servers:
- url: https://api.faireplace.com/api
description: Production server
security:
- BearerAuth: []
tags:
- name: Syndic Fund Allocations
description: Allocation of a syndic fund call across the leases of a property.
paths:
/syndics/{syndic_id}/fund-calls/{call_id}/allocate:
post:
operationId: allocateFundCall
summary: Allocate fund call to leases
description: 'Distributes the recoverable lines of a fund call to leases based on millième values (tantièmes de copropriété).
**Allocation formula:**
```
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).'
tags:
- Syndic Fund Allocations
security:
- BearerAuth: []
parameters:
- name: syndic_id
in: path
required: true
schema:
type: string
format: uuid
- name: call_id
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AllocateRequestDto'
responses:
'201':
description: Allocations created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FundAllocationResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
/syndics/{syndic_id}/fund-calls/{call_id}/allocations:
get:
operationId: listAllocationsByFundCall
summary: List allocations for a fund call
tags:
- Syndic Fund Allocations
security:
- BearerAuth: []
parameters:
- name: syndic_id
in: path
required: true
schema:
type: string
format: uuid
- name: call_id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: List of allocations
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FundAllocationResponse'
'401':
$ref: '#/components/responses/Unauthorized'
/syndics/{syndic_id}/fund-calls/{call_id}/link-charges:
post:
operationId: linkAllocationsToCharges
summary: Link syndic allocations to lease charges
description: Links existing fund call allocations to their corresponding lease charges using the charge distribution calculation service.
tags:
- Syndic Fund Allocations
security:
- BearerAuth: []
parameters:
- name: syndic_id
in: path
required: true
schema:
type: string
format: uuid
- name: call_id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Allocations linked to charges
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
/leases/{lease_id}/syndic-allocations:
get:
operationId: listAllocationsByLease
summary: List syndic allocations for a lease
description: Returns all syndic fund allocations linked to a specific lease.
tags:
- Syndic Fund Allocations
security:
- BearerAuth: []
parameters:
- name: lease_id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: List of allocations for this lease
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FundAllocationResponse'
'401':
$ref: '#/components/responses/Unauthorized'
components:
schemas:
FundAllocationResponse:
type: object
description: Allocation of a fund call line to a lease
required:
- id
- fund_call_line_id
- lease_id
- millieme_value
- total_milliemes
- allocated_amount
- status
- created_at
- updated_at
properties:
id:
type: string
format: uuid
fund_call_line_id:
type: string
format: uuid
lease_id:
type: string
format: uuid
millieme_value:
type: number
format: decimal
description: Millièmes for this lease
total_milliemes:
type: number
format: decimal
description: Total millièmes used for calculation
allocated_amount:
type: number
format: decimal
description: Calculated amount = line_amount × (millieme_value / total_milliemes)
lease_charge_id:
type:
- string
- 'null'
format: uuid
description: Link to the lease charge (set after link-charges)
status:
type: string
description: Allocation status
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
LeaseMilliemeDto:
type: object
description: Millième value for a lease
required:
- lease_id
- millieme_value
properties:
lease_id:
type: string
format: uuid
millieme_value:
type: number
format: decimal
Error:
type: object
description: "The error envelope returned by every authenticated endpoint.\n\nTwo things are worth knowing before you write your error handling:\n\n- **`code` is a symbolic string, not a number.** The numeric HTTP status is\n in `status`. Branch on `code`: it is stable, and show `message`, which\n is written for humans and may be reworded without notice.\n- The public guest-signature endpoints use a **different, flatter shape**\n (`{ \"error_code\": …, \"message\": … }`, no `error` wrapper), because they\n are consumed by a page that has no session. Their responses document it\n inline.\n\nThe `X-Request-Id` response header carries the request identifier: quote it\nwhen reporting a problem. It is a header, not a body field.\n"
required:
- error
properties:
error:
type: object
required:
- code
- message
- status
properties:
code:
type: string
description: Stable symbolic code. Branch on this.
enum:
- NOT_FOUND
- UNAUTHORIZED
- VALIDATION_ERROR
- DATABASE_ERROR
- BUSINESS_ERROR
- STORAGE_ERROR
- CONFIG_ERROR
- FORBIDDEN
- CONFLICT
- PARSE_ERROR
- SERIALIZATION_ERROR
- AUTHENTICATION_ERROR
- AUTHORIZATION_ERROR
- EXTERNAL_SERVICE_ERROR
- RATE_LIMIT_EXCEEDED
- PAYMENT_REQUIRED
- PLAN_LIMIT_REACHED
- GONE
- BAD_REQUEST
- INTERNAL_ERROR
- INTERNAL_SERVER_ERROR
example: NOT_FOUND
message:
type: string
description: 'Human-readable explanation, most often in French. Safe to display,
not safe to parse.
'
example: Lease not found
status:
type: integer
description: The HTTP status code, repeated in the body.
example: 404
details:
type: object
additionalProperties: true
description: 'Extra machine-readable context. Only present on some errors: on
`RATE_LIMIT_EXCEEDED` it carries `retry_after_seconds`.
'
example:
retry_after_seconds: 12
AllocateRequestDto:
type: object
description: Request to allocate fund call lines to leases based on millièmes
required:
- leases
- total_milliemes
properties:
leases:
type: array
items:
$ref: '#/components/schemas/LeaseMilliemeDto'
minItems: 1
total_milliemes:
type: number
format: decimal
description: Total millièmes of the copropriété
responses:
NotFound:
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
BadRequest:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Unauthorized:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
BearerAuth:
type: http
scheme: bearer
description: API key with fp_* prefix, passed as Bearer token
WorkerApiKey:
type: apiKey
in: header
name: X-API-Key
WorkerBearer:
type: http
scheme: bearer
bearerFormat: Worker