API docs by Redocly

Loctavia API (1.0.0)

Download OpenAPI specification:

API Support: support@sinoia.fr

API de gestion locative Loctavia : mandataires, baux, quittancements, mandats, patrimoine (immeubles/lots), tiers, paiements et incidents.

Authentification

Multi-tenant : <code>X-Mandataire-Id</code>

Authentification

Toutes les requêtes exigent un token Bearer (PAT, ex. via le device flow CLI) avec le scope adapté au verbe HTTP : read pour les GET, write pour les mutations. L'obtention des tokens est documentée sur la page Authentification.

Multi-tenant : X-Mandataire-Id

Tous les endpoints (sauf GET /loctavia/api/v1/mandataires, qui sert justement à les découvrir) exigent l'en-tête X-Mandataire-Id identifiant le mandataire (tenant) sur lequel opérer. Un mandataire inaccessible à l'utilisateur renvoie un 403.

Mandataires

Point d'entrée de l'API Loctavia : liste les mandataires (tenants) accessibles à l'utilisateur. L'id retourné alimente l'en-tête X-Mandataire-Id requis par tous les autres endpoints Loctavia. Auth Bearer (PAT, ex. via le device flow CLI).

Lister les mandataires accessibles à l'utilisateur

Authorizations:
OAuth2PasswordOAuth2AuthCode

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Baux

Baux (leases) — création avec conditions financières par lot, terme d'indexation et locataire.

Lister les baux

Authorizations:
OAuth2PasswordOAuth2AuthCode
query Parameters
sort
string
direction
string
Default: "asc"
Enum: "asc" "desc"
per_page
integer [ 1 .. 100 ]
Default: 25
page
integer >= 1
Default: 1
object
header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Créer un bail

Authorizations:
OAuth2PasswordOAuth2AuthCode
header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Content-Type
required
string
Value: "application/json"
Example: application/json

Type de contenu de la requête

Request Body schema: application/json
required
required
object
object
Array of objects
tenant_id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "lease": {
    },
  • "term": {
    },
  • "units": [
    ],
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0"
}

Response samples

Content type
application/json
{
  • "id": "3f8a1c2e-9b4d-4e5f-8a1b-2c3d4e5f6a7b",
  • "reference": "BL-2024-00042",
  • "leaseType": "residential",
  • "status": "active",
  • "startDate": "2024-01-01",
  • "endDate": "2027-01-01",
  • "tenantName": "Jean Dupont",
  • "tenantId": "7a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
  • "unitIdentifier": "A-101",
  • "propertyName": "Résidence Les Tilleuls",
  • "propertyId": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
  • "monthlyRent": {
    },
  • "paymentTiming": "in_advance",
  • "units": [
    ]
}

Détail d'un bail

Authorizations:
OAuth2PasswordOAuth2AuthCode
path Parameters
id
required
string <uuid>
Example: 019951a3-01b7-7eb9-88bb-f872a01ed886

Identifiant de la ressource

header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Responses

Response samples

Content type
application/json
{
  • "id": "3f8a1c2e-9b4d-4e5f-8a1b-2c3d4e5f6a7b",
  • "reference": "BL-2024-00042",
  • "externalId": "LEGACY-88213",
  • "leaseType": "residential",
  • "status": "active",
  • "startDate": "2024-01-01",
  • "endDate": "2027-01-01",
  • "signatureDate": "2023-12-15",
  • "revisionMode": "automatic",
  • "initialBalance": {
    },
  • "cafAllocataireNumber": "1234567",
  • "paymentDay": 5,
  • "paymentFrequency": "monthly",
  • "paymentTiming": "in_advance",
  • "noticeMonths": 3,
  • "terms": [
    ],
  • "parties": [
    ],
  • "units": [
    ],
  • "revisionIndicator": {
    },
  • "revisions": [
    ],
  • "securityDeposit": {
    },
  • "gliPolicies": [
    ],
  • "breakDates": [
    ],
  • "franchisePeriods": [
    ],
  • "cappingRules": [
    ],
  • "supportMeasures": [
    ],
  • "autoRenewal": true,
  • "renewalNoticePeriod": 6,
  • "renewalNoticeDate": "2026-07-01"
}

Quittancements

Quittancements (billing runs). Cycle : POST /billing_runs (calcul asynchrone — poller le détail jusqu'au statut computed/review), relecture des lignes (/lines, exclusion ou acquittement d'anomalies), puis validate et apply.

Lister les quittancements

Authorizations:
OAuth2PasswordOAuth2AuthCode
query Parameters
sort
string
direction
string
Default: "asc"
Enum: "asc" "desc"
per_page
integer [ 1 .. 100 ]
Default: 25
page
integer >= 1
Default: 1
object
header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Créer un quittancement (calcul asynchrone)

Le calcul est asynchrone (job). Le run renvoyé démarre en draft/scheduled avec linesCount 0 ; interroger GET /billing_runs/{id} jusqu au statut computed/review avant de valider.

Authorizations:
OAuth2PasswordOAuth2AuthCode
header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Content-Type
required
string
Value: "application/json"
Example: application/json

Type de contenu de la requête

Request Body schema: application/json
required
period_start
required
string <date>

Premier jour du mois facturé (YYYY-MM-DD)

grouping_mode
string
Enum: "per_lease" "per_tenant"
property_id
string <uuid>
schedule
boolean
frequencies
Array of strings
Items Enum: "monthly" "quarterly" "annual"
timings
Array of strings
Items Enum: "advance" "arrears"
lease_types
Array of strings
lease_ids
Array of strings <uuid> [ items <uuid > ]
exclude_lease_ids
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "period_start": "2019-08-24",
  • "grouping_mode": "per_lease",
  • "property_id": "05003a8a-8f3c-454b-8884-a906ec46f5f5",
  • "schedule": true,
  • "frequencies": [
    ],
  • "timings": [
    ],
  • "lease_types": [
    ],
  • "lease_ids": [
    ],
  • "exclude_lease_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reference": "FACT-2026-05",
  • "status": "draft",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "totalTenantAmount": 0,
  • "totalOwnerAmount": 0,
  • "linesCount": 0,
  • "anomaliesCount": 0,
  • "validatedAt": "2019-08-24T14:15:22Z",
  • "validatedBy": "string",
  • "appliedAt": "2019-08-24T14:15:22Z",
  • "billingFrequency": "string",
  • "editable": true,
  • "cancellable": true,
  • "currentStep": 0,
  • "allAnomaliesAcknowledged": true,
  • "scheduledAt": "2019-08-24T14:15:22Z",
  • "computedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "totalRentAmount": 0,
  • "totalChargesAmount": 0
}

Détail d'un quittancement

Authorizations:
OAuth2PasswordOAuth2AuthCode
path Parameters
id
required
string <uuid>
Example: 019951a3-01b7-7eb9-88bb-f872a01ed886

Identifiant de la ressource

header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reference": "FACT-2026-05",
  • "status": "draft",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "totalTenantAmount": 0,
  • "totalOwnerAmount": 0,
  • "linesCount": 0,
  • "anomaliesCount": 0,
  • "validatedAt": "2019-08-24T14:15:22Z",
  • "validatedBy": "string",
  • "appliedAt": "2019-08-24T14:15:22Z",
  • "billingFrequency": "string",
  • "editable": true,
  • "cancellable": true,
  • "currentStep": 0,
  • "allAnomaliesAcknowledged": true,
  • "scheduledAt": "2019-08-24T14:15:22Z",
  • "computedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "totalRentAmount": 0,
  • "totalChargesAmount": 0,
  • "groupingMode": "string",
  • "cancelledAt": "2019-08-24T14:15:22Z",
  • "cancellationReason": "string",
  • "metadata": { },
  • "ownerPaymentsSummary": {
    },
  • "billingNoticesSummary": {
    },
  • "receiptsMetadata": { },
  • "scopeSummary": {
    },
  • "vatBreakdown": { }
}

Lignes d'un quittancement

Authorizations:
OAuth2PasswordOAuth2AuthCode
path Parameters
id
required
string <uuid>
Example: 019951a3-01b7-7eb9-88bb-f872a01ed886

Identifiant de la ressource

query Parameters
type
string
Default: "tenant"
Enum: "tenant" "owner"
per_page
integer [ 1 .. 100 ]
Default: 25
page
integer >= 1
Default: 1
header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Mettre à jour une ligne (exclure/inclure ou acquitter)

Authorizations:
OAuth2PasswordOAuth2AuthCode
path Parameters
id
required
string <uuid>
Example: 019951a3-01b7-7eb9-88bb-f872a01ed886

Identifiant de la ressource

line_id
required
string <uuid>
header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Content-Type
required
string
Value: "application/json"
Example: application/json

Type de contenu de la requête

Request Body schema: application/json
required
excluded
boolean
review_status
string
Enum: "ok" "flagged"
comment
string

Responses

Request samples

Content type
application/json
{
  • "excluded": true,
  • "review_status": "ok",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "lineType": "tenant",
  • "billingCategory": "string",
  • "computedAmount": 0,
  • "baseAmount": 0,
  • "status": "pending",
  • "leaseId": "a3abd432-1f03-4b93-888c-0da4d3703e99",
  • "unitIdentifier": "string",
  • "hasAnomaly": true,
  • "anomalyType": "string"
}

Valider un quittancement

Authorizations:
OAuth2PasswordOAuth2AuthCode
path Parameters
id
required
string <uuid>
Example: 019951a3-01b7-7eb9-88bb-f872a01ed886

Identifiant de la ressource

query Parameters
force
boolean

Valide malgré des anomalies non acquittées (présence du paramètre = activé)

header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reference": "FACT-2026-05",
  • "status": "draft",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "totalTenantAmount": 0,
  • "totalOwnerAmount": 0,
  • "linesCount": 0,
  • "anomaliesCount": 0,
  • "validatedAt": "2019-08-24T14:15:22Z",
  • "validatedBy": "string",
  • "appliedAt": "2019-08-24T14:15:22Z",
  • "billingFrequency": "string",
  • "editable": true,
  • "cancellable": true,
  • "currentStep": 0,
  • "allAnomaliesAcknowledged": true,
  • "scheduledAt": "2019-08-24T14:15:22Z",
  • "computedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "totalRentAmount": 0,
  • "totalChargesAmount": 0
}

Appliquer un quittancement (génère les appels de loyer)

Authorizations:
OAuth2PasswordOAuth2AuthCode
path Parameters
id
required
string <uuid>
Example: 019951a3-01b7-7eb9-88bb-f872a01ed886

Identifiant de la ressource

header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reference": "FACT-2026-05",
  • "status": "draft",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "totalTenantAmount": 0,
  • "totalOwnerAmount": 0,
  • "linesCount": 0,
  • "anomaliesCount": 0,
  • "validatedAt": "2019-08-24T14:15:22Z",
  • "validatedBy": "string",
  • "appliedAt": "2019-08-24T14:15:22Z",
  • "billingFrequency": "string",
  • "editable": true,
  • "cancellable": true,
  • "currentStep": 0,
  • "allAnomaliesAcknowledged": true,
  • "scheduledAt": "2019-08-24T14:15:22Z",
  • "computedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "totalRentAmount": 0,
  • "totalChargesAmount": 0
}

Mandats

Mandats de gestion (propriétaire × immeuble, honoraires).

Lister les mandats

Authorizations:
OAuth2PasswordOAuth2AuthCode
query Parameters
sort
string
direction
string
Default: "asc"
Enum: "asc" "desc"
per_page
integer [ 1 .. 100 ]
Default: 25
page
integer >= 1
Default: 1
object
header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Créer un mandat

Authorizations:
OAuth2PasswordOAuth2AuthCode
header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Content-Type
required
string
Value: "application/json"
Example: application/json

Type de contenu de la requête

Request Body schema: application/json
required
owner_profile_id
required
string <uuid>
property_id
string <uuid>
reference
required
string
mandate_type
string
Default: "full_management"
Enum: "full_management" "rental_only" "charges_only"
start_date
required
string <date>
end_date
string <date>
management_fee_rate
number

Responses

Request samples

Content type
application/json
{
  • "owner_profile_id": "21e0f360-ea66-4de2-b817-b59c51592556",
  • "property_id": "05003a8a-8f3c-454b-8884-a906ec46f5f5",
  • "reference": "MAN-2026-001",
  • "mandate_type": "full_management",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "management_fee_rate": 0.08
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reference": "MG-2026-0042",
  • "mandateType": "gestion_locative",
  • "status": "active",
  • "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
  • "ownerActorId": "7489ec5e-dd90-4fe5-bb3a-4656813837ab",
  • "ownerName": "SCI Les Tilleuls",
  • "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",
  • "propertyName": "Résidence Bellevue",
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "managementFeeRate": 7.5,
  • "paymentTiming": "term_echu",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Détail d'un mandat

Authorizations:
OAuth2PasswordOAuth2AuthCode
path Parameters
id
required
string <uuid>
Example: 019951a3-01b7-7eb9-88bb-f872a01ed886

Identifiant de la ressource

header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reference": "MG-2026-0042",
  • "mandateType": "gestion_locative",
  • "status": "active",
  • "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
  • "ownerActorId": "7489ec5e-dd90-4fe5-bb3a-4656813837ab",
  • "ownerName": "SCI Les Tilleuls",
  • "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",
  • "propertyName": "Résidence Bellevue",
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "managementFeeRate": 7.5,
  • "paymentTiming": "term_echu",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "signatureDate": "2019-08-24",
  • "vatRateOnFees": 20,
  • "renewalMode": "tacit",
  • "noticeMonths": 3,
  • "specialConditions": "string",
  • "distributionMode": "string",
  • "distributionFrequency": "string",
  • "distributionDay": 5,
  • "distributionMarginDays": 0,
  • "depotGarantieDetention": "string",
  • "retenueDestination": "string",
  • "accountingMode": "string",
  • "effectiveAccountingMode": "string",
  • "metadata": { },
  • "mandateServices": [
    ]
}

Patrimoine

Immeubles (properties) et lots (units).

Lister les immeubles

Authorizations:
OAuth2PasswordOAuth2AuthCode
query Parameters
sort
string
direction
string
Default: "asc"
Enum: "asc" "desc"
per_page
integer [ 1 .. 100 ]
Default: 25
page
integer >= 1
Default: 1
object
header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Créer un immeuble

Authorizations:
OAuth2PasswordOAuth2AuthCode
header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Content-Type
required
string
Value: "application/json"
Example: application/json

Type de contenu de la requête

Request Body schema: application/json
required
name
required
string
address
required
string
city
string
postal_code
string
property_type
string
Default: "commercial"
Enum: "residential" "commercial" "mixed"
has_elevator
boolean
floor_count
integer

Responses

Request samples

Content type
application/json
{
  • "name": "Résidence de la Paix",
  • "address": "1 rue de la Paix, 75002 Paris",
  • "city": "string",
  • "postal_code": "string",
  • "property_type": "residential",
  • "has_elevator": true,
  • "floor_count": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "Résidence Les Tilleuls",
  • "propertyType": "residence",
  • "address": "12 rue des Lilas",
  • "city": "Lyon",
  • "postalCode": "69003",
  • "hasElevator": true,
  • "floorCount": 5,
  • "active": true,
  • "externalId": "string",
  • "shareKeys": [
    ],
  • "unitsCount": 24,
  • "activeLeaseCount": 18,
  • "occupiedCount": 18,
  • "vacantCount": 6,
  • "totalSurface": 1240.5,
  • "occupancyRate": 75
}

Détail d'un immeuble

Authorizations:
OAuth2PasswordOAuth2AuthCode
path Parameters
id
required
string <uuid>
Example: 019951a3-01b7-7eb9-88bb-f872a01ed886

Identifiant de la ressource

header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "Résidence Les Tilleuls",
  • "propertyType": "residence",
  • "address": "12 rue des Lilas",
  • "city": "Lyon",
  • "postalCode": "69003",
  • "hasElevator": true,
  • "floorCount": 5,
  • "active": true,
  • "externalId": "string",
  • "shareKeys": [
    ],
  • "units": [
    ],
  • "entrances": [
    ],
  • "patrimonyCode": "string",
  • "qrCode": {
    }
}

Lister les lots

Authorizations:
OAuth2PasswordOAuth2AuthCode
query Parameters
sort
string
direction
string
Default: "asc"
Enum: "asc" "desc"
per_page
integer [ 1 .. 100 ]
Default: 25
page
integer >= 1
Default: 1
object
header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Créer un lot

Authorizations:
OAuth2PasswordOAuth2AuthCode
header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Content-Type
required
string
Value: "application/json"
Example: application/json

Type de contenu de la requête

Request Body schema: application/json
required
property_id
required
string <uuid>
identifier
required
string
unit_type
string
Default: "retail"
Enum: "apartment" "office" "retail" "parking" "storage"
area_sqm
number
floor
string
description
string

Responses

Request samples

Content type
application/json
{
  • "property_id": "05003a8a-8f3c-454b-8884-a906ec46f5f5",
  • "identifier": "Lot 12",
  • "unit_type": "apartment",
  • "area_sqm": 0,
  • "floor": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "identifier": "A-102",
  • "unitType": "apartment",
  • "areaSqm": 45.5,
  • "floor": 2,
  • "lotNumber": "102",
  • "active": true,
  • "externalId": "string",
  • "dateReception": "2019-08-24",
  • "allocations": [
    ],
  • "description": "string",
  • "owners": [
    ],
  • "activeLease": {
    }
}

Détail d'un lot

Authorizations:
OAuth2PasswordOAuth2AuthCode
path Parameters
id
required
string <uuid>
Example: 019951a3-01b7-7eb9-88bb-f872a01ed886

Identifiant de la ressource

header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "identifier": "A-102",
  • "unitType": "apartment",
  • "areaSqm": 45.5,
  • "floor": 2,
  • "lotNumber": "102",
  • "active": true,
  • "externalId": "string",
  • "dateReception": "2019-08-24",
  • "allocations": [
    ],
  • "description": "string",
  • "owners": [
    ],
  • "activeLease": {
    },
  • "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",
  • "propertyName": "Résidence Les Tilleuls",
  • "ownerships": [
    ],
  • "ownershipHistory": [
    ],
  • "sharesComplete": true,
  • "totalSharePercent": 100,
  • "leases": [
    ],
  • "qrCode": {
    },
  • "dpe": {
    },
  • "cgpOverride": {
    },
  • "effectiveCgp": {
    }
}

Tiers

Propriétaires et locataires (recherche texte libre via q).

Lister les propriétaires

Authorizations:
OAuth2PasswordOAuth2AuthCode
query Parameters
per_page
integer [ 1 .. 100 ]
Default: 25
page
integer >= 1
Default: 1
q
string

Recherche texte libre (prénom, nom, raison sociale, SIRET)

header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Créer un propriétaire

Authorizations:
OAuth2PasswordOAuth2AuthCode
header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Content-Type
required
string
Value: "application/json"
Example: application/json

Type de contenu de la requête

Request Body schema: application/json
required
first_name
required
string
last_name
string
email_address
string <email>
phone_number
string
owner_type
string
Default: "individual"
Enum: "individual" "company" "sci"
company_name
string
siret
string
address
string

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "email_address": "user@example.com",
  • "phone_number": "string",
  • "owner_type": "individual",
  • "company_name": "string",
  • "siret": "string",
  • "address": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerProfileId": "c89cb221-d0cc-4aba-977c-75836e8307b5",
  • "displayName": "SCI Les Tilleuls",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "contact@lestilleuls.fr",
  • "phone": "string",
  • "ownerType": "string",
  • "companyName": "string",
  • "siret": "81234567800012",
  • "taxId": "string",
  • "address": "string",
  • "accountingCode": "string",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Détail d'un propriétaire

Fiche complète du propriétaire : identité, coordonnées, comptes bancaires, biens détenus, ownerships, mandats de gestion, redditions (owner payments) et CGP courant. Le paramètre id est l'identifiant de l'acteur propriétaire (le même que le champ id du payload de liste).

Authorizations:
OAuth2PasswordOAuth2AuthCode
path Parameters
id
required
string <uuid>
Example: 019951a3-01b7-7eb9-88bb-f872a01ed886

Identifiant de la ressource

header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
  • "name": "Jean Dupont",
  • "firstName": "string",
  • "lastName": "string",
  • "contactType": "owner",
  • "subType": "string",
  • "email": "jean.dupont@example.fr",
  • "phone": "string",
  • "companyName": "string",
  • "siret": "81234567800012",
  • "address": "string",
  • "taxId": "string",
  • "bankAccounts": [
    ],
  • "ownerships": [
    ],
  • "properties": [
    ],
  • "ownerPayments": [
    ],
  • "mandates": [
    ],
  • "currentCgp": {
    },
  • "createdAt": "2019-08-24T14:15:22Z"
}

Lister les locataires

Authorizations:
OAuth2PasswordOAuth2AuthCode
query Parameters
per_page
integer [ 1 .. 100 ]
Default: 25
page
integer >= 1
Default: 1
q
string

Recherche texte libre (prénom, nom, email)

header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Détail d'un locataire

Fiche complète du locataire : identité, coordonnées, comptes bancaires, baux (multi-baux consolidés), appels de loyer (rent calls), paiements et informations de facturation. Le paramètre id est l'identifiant de l'acteur locataire (le même que le champ id du payload de liste).

Authorizations:
OAuth2PasswordOAuth2AuthCode
path Parameters
id
required
string <uuid>
Example: 019951a3-01b7-7eb9-88bb-f872a01ed886

Identifiant de la ressource

header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
  • "name": "Jean Dupont",
  • "firstName": "string",
  • "lastName": "string",
  • "contactType": "tenant",
  • "subType": "string",
  • "email": "jean.dupont@example.fr",
  • "phone": "string",
  • "tradeName": "string",
  • "siret": "81234567800012",
  • "vatNumber": "string",
  • "billingEmail": "string",
  • "billingAddress": "string",
  • "bankAccounts": [
    ],
  • "leases": [
    ],
  • "rentCalls": [
    ],
  • "payments": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z"
}

Paiements

Encaissements (lecture seule).

Lister les encaissements

Authorizations:
OAuth2PasswordOAuth2AuthCode
query Parameters
sort
string
direction
string
Default: "asc"
Enum: "asc" "desc"
per_page
integer [ 1 .. 100 ]
Default: 25
page
integer >= 1
Default: 1
object
header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Détail d'un encaissement

Authorizations:
OAuth2PasswordOAuth2AuthCode
path Parameters
id
required
string <uuid>
Example: 019951a3-01b7-7eb9-88bb-f872a01ed886

Identifiant de la ressource

header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reference": "PAY-2026-00042",
  • "amountCents": 120000,
  • "currency": "EUR",
  • "amount": {
    },
  • "paymentDate": "2019-08-24",
  • "paymentMethod": "virement",
  • "direction": "inflow",
  • "status": "allocated",
  • "leaseReference": "string",
  • "leaseId": "a3abd432-1f03-4b93-888c-0da4d3703e99",
  • "bankAccountId": "5b26b598-a880-4e32-8c41-126aa0206857",
  • "tenantName": "string",
  • "bankTransaction": {
    },
  • "allocations": [
    ],
  • "allocatedAmount": {
    },
  • "remainingAmount": {
    }
}

Incidents

Incidents locataires (lecture seule — la déclaration passe par le portail).

Lister les incidents

Authorizations:
OAuth2PasswordOAuth2AuthCode
query Parameters
sort
string
direction
string
Default: "asc"
Enum: "asc" "desc"
per_page
integer [ 1 .. 100 ]
Default: 25
page
integer >= 1
Default: 1
object
header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Détail d'un incident

Authorizations:
OAuth2PasswordOAuth2AuthCode
path Parameters
id
required
string <uuid>
Example: 019951a3-01b7-7eb9-88bb-f872a01ed886

Identifiant de la ressource

header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reference": "INC-2026-000421",
  • "flexicielReference": "1015299",
  • "title": "Écoulement continu",
  • "status": "in_progress",
  • "priority": "high",
  • "scopeType": "Loctavia::Unit",
  • "scopeId": "65fafe40-a220-4dd7-8724-4598b81c0643",
  • "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
  • "categoryName": "Plomberie",
  • "assignedToId": "7a15e53b-1403-4928-9451-d7062c3a8737",
  • "assignedToName": "string",
  • "reporterId": "997c436a-2349-4904-8879-2f8ba4e8669d",
  • "reporterName": "string",
  • "reporterType": "string",
  • "leaseId": "a3abd432-1f03-4b93-888c-0da4d3703e99",
  • "room": "Salle de bain",
  • "contactEmail": "string",
  • "contactPhone": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "acknowledgedAt": "2019-08-24T14:15:22Z",
  • "resolvedAt": "2019-08-24T14:15:22Z",
  • "closedAt": "2019-08-24T14:15:22Z",
  • "escalatedAt": "2019-08-24T14:15:22Z",
  • "dueAt": "2019-08-24T14:15:22Z",
  • "flexicielType": "string",
  • "flexicielNature": "string",
  • "flexicielMotif": "string",
  • "aareonSyncState": "sent",
  • "aareonSkipReason": "category_unmapped",
  • "aareonSyncRepairable": true,
  • "aareonSyncStale": true,
  • "aareonPulled": true,
  • "aareonFollowupsSummary": {
    },
  • "description": "string",
  • "outcomeMessage": "string",
  • "categoryPath": "Plomberie · Fuite · Fenêtre PVC",
  • "scope": {
    },
  • "leaseReference": "string",
  • "routedMaintenanceContractId": "34db0560-f47f-42e6-980d-7ac62797db24",
  • "routedMaintenanceContractName": "string",
  • "llmAnalysis": { },
  • "funnelData": { },
  • "allowedTransitions": [
    ],
  • "aareonFollowups": {
    },
  • "aareonFollowupsFailed": true,
  • "aareonFollowupSteps": [
    ],
  • "attachments": [
    ],
  • "messagesCount": 0,
  • "activeAssignmentsCount": 0
}

Comptabilité

Écritures comptables en partie double (immuables, correction par extourne, cinq journaux : LOYERS, CHARGES, BANQUE, PROPRIO, OD) et export FEC réglementaire (arrêté du 29 juillet 2013). La génération du FEC est synchrone : le 201 du POST /fec_exports signifie que le fichier est prêt au téléchargement.

Lister les écritures comptables

Écritures en partie double, immuables (correction par extourne), générées automatiquement par les quittancements, encaissements et reversements. Cinq journaux : LOYERS, CHARGES, BANQUE, PROPRIO, OD. Filtres fins via Ransack : q[status_eq]=posted, q[accounting_date_gteq]=2026-01-01…

Authorizations:
OAuth2PasswordOAuth2AuthCode
query Parameters
journal
string
Enum: "LOYERS" "CHARGES" "BANQUE" "PROPRIO" "OD"
sort
string
direction
string
Default: "asc"
Enum: "asc" "desc"
per_page
integer [ 1 .. 100 ]
Default: 25
page
integer >= 1
Default: 1
object
header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Détail d'une écriture et de ses lignes

Authorizations:
OAuth2PasswordOAuth2AuthCode
path Parameters
id
required
string <uuid>
Example: 019951a3-01b7-7eb9-88bb-f872a01ed886

Identifiant de la ressource

header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reference": "string",
  • "journal": "LOYERS",
  • "societyCode": "CABMAR",
  • "entryDate": "2019-08-24T14:15:22Z",
  • "accountingDate": "2019-08-24",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "status": "draft",
  • "description": "string",
  • "totalDebit": 0,
  • "totalCredit": 0,
  • "linesCount": 0,
  • "sourceType": "string",
  • "sourceId": "797f5a94-3689-4ac8-82fd-d749511ea2b2",
  • "validatedBy": "a044084f-073a-46ff-b99b-44bfe3ae5135",
  • "validatedAt": "2019-08-24T14:15:22Z",
  • "reversalOfId": "91205805-6131-4e22-87c1-99e3bbb30d9b",
  • "metadata": { },
  • "lines": [
    ]
}

Générer un export FEC pour un exercice

Fichier des Écritures Comptables au format réglementaire (18 colonnes, arrêté du 29 juillet 2013). Périmètre : écritures validated + posted de l'exercice civil. La génération est synchrone : la réponse 201 signifie que le fichier est prêt, à récupérer via GET /fec_exports/{id}/download.

Authorizations:
OAuth2PasswordOAuth2AuthCode
header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Content-Type
required
string
Value: "application/json"
Example: application/json

Type de contenu de la requête

Request Body schema: application/json
required
fiscal_year
required
integer

Exercice civil à exporter (ex. 2026)

siren
string

SIREN émetteur (9 chiffres). Défaut : 000000000

Responses

Request samples

Content type
application/json
{
  • "fiscal_year": 0,
  • "siren": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "fiscalYear": 2026,
  • "siren": "123456789",
  • "filename": "123456789FEC20261231.txt",
  • "entriesCount": 342,
  • "linesCount": 918,
  • "createdAt": "2019-08-24T14:15:22Z"
}

Télécharger le fichier FEC

Renvoie le fichier .txt FEC en pièce jointe (Content-Disposition: attachment, nom réglementaire <siren>FEC<AAAA1231>.txt).

Authorizations:
OAuth2PasswordOAuth2AuthCode
path Parameters
id
required
string <uuid>
Example: 019951a3-01b7-7eb9-88bb-f872a01ed886

Identifiant de la ressource

header Parameters
X-Mandataire-Id
required
string <uuid>

Identifiant UUID du mandataire (tenant) sur lequel opérer. Renvoie 403 si l'utilisateur n'est pas membre du mandataire indiqué. Obligatoire sauf sur GET /loctavia/api/v1/mandataires (qui sert justement à le découvrir). Tolérances côté serveur, non recommandées pour les clients générés : omission acceptée quand l'utilisateur n'a qu'un seul mandataire, et le paramètre de requête mandataire_id est accepté en équivalent du header.

Responses

Response samples

Content type
application/json
{
  • "error": "bad_request",
  • "message": "Paramètres de requête invalides"
}