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.

Documentation interactive : /docs/loctavia. Les listes restent des tableaux camelCase, paginés à 25 (maximum 100). updated_since est inclusif et impose une déduplication. Les snapshots conservés sept jours permettent la convergence avec suppressions et retraits de droits ; ils ne constituent pas un journal de toutes les transitions.

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:
OAuth2PasswordOAuth2AuthCodeBearerAuth
query Parameters
search
string

Recherche textuelle publique.

updated_since
string <date-time>

Borne ISO 8601 inclusive ; dédupliquer par identifiant.

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:
OAuth2PasswordOAuth2AuthCodeBearerAuth
query Parameters
sort
string
direction
string
Default: "asc"
Enum: "asc" "desc"
per_page
integer >= 1
Default: 25
page
integer >= 1
Default: 1
object
Example:
search
string

Recherche textuelle publique.

updated_since
string <date-time>

Borne ISO 8601 inclusive ; dédupliquer par identifiant.

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:
OAuth2PasswordOAuth2AuthCodeBearerAuth
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": {
    },
  • "units": [
    ],
  • "tenant_id": "22222222-2222-4222-8222-222222222222"
}

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",
  • "billingCalendar": "civil",
  • "billingCycleMonth": 2,
  • "effectiveBillingCalendar": "civil",
  • "effectiveBillingCycleMonth": 1,
  • "noticeMonths": 3,
  • "terms": [
    ],
  • "parties": [
    ],
  • "units": [
    ],
  • "revisionIndicator": {
    },
  • "revisions": [
    ],
  • "securityDeposit": {
    },
  • "gliPolicies": [
    ],
  • "breakDates": [
    ],
  • "franchisePeriods": [
    ],
  • "cappingRules": [
    ],
  • "supportMeasures": [
    ],
  • "autoRenewal": true,
  • "renewalNoticePeriod": 6,
  • "renewalNoticeDate": "2026-07-01",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Détail d'un bail

Authorizations:
OAuth2PasswordOAuth2AuthCodeBearerAuth
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",
  • "billingCalendar": "civil",
  • "billingCycleMonth": 2,
  • "effectiveBillingCalendar": "civil",
  • "effectiveBillingCycleMonth": 1,
  • "noticeMonths": 3,
  • "terms": [
    ],
  • "parties": [
    ],
  • "units": [
    ],
  • "revisionIndicator": {
    },
  • "revisions": [
    ],
  • "securityDeposit": {
    },
  • "gliPolicies": [
    ],
  • "breakDates": [
    ],
  • "franchisePeriods": [
    ],
  • "cappingRules": [
    ],
  • "supportMeasures": [
    ],
  • "autoRenewal": true,
  • "renewalNoticePeriod": 6,
  • "renewalNoticeDate": "2026-07-01",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Modifier baux

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object
object
Array of objects
tenant_id
string <uuid>
unit_ids
Array of strings <uuid> [ items <uuid > ]
Array of objects

Responses

Request samples

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

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",
  • "billingCalendar": "civil",
  • "billingCycleMonth": 2,
  • "effectiveBillingCalendar": "civil",
  • "effectiveBillingCycleMonth": 1,
  • "noticeMonths": 3,
  • "terms": [
    ],
  • "parties": [
    ],
  • "units": [
    ],
  • "revisionIndicator": {
    },
  • "revisions": [
    ],
  • "securityDeposit": {
    },
  • "gliPolicies": [
    ],
  • "breakDates": [
    ],
  • "franchisePeriods": [
    ],
  • "cappingRules": [
    ],
  • "supportMeasures": [
    ],
  • "autoRenewal": true,
  • "renewalNoticePeriod": 6,
  • "renewalNoticeDate": "2026-07-01",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Modifier baux

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object
object
Array of objects
tenant_id
string <uuid>
unit_ids
Array of strings <uuid> [ items <uuid > ]
Array of objects

Responses

Request samples

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

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",
  • "billingCalendar": "civil",
  • "billingCycleMonth": 2,
  • "effectiveBillingCalendar": "civil",
  • "effectiveBillingCycleMonth": 1,
  • "noticeMonths": 3,
  • "terms": [
    ],
  • "parties": [
    ],
  • "units": [
    ],
  • "revisionIndicator": {
    },
  • "revisions": [
    ],
  • "securityDeposit": {
    },
  • "gliPolicies": [
    ],
  • "breakDates": [
    ],
  • "franchisePeriods": [
    ],
  • "cappingRules": [
    ],
  • "supportMeasures": [
    ],
  • "autoRenewal": true,
  • "renewalNoticePeriod": 6,
  • "renewalNoticeDate": "2026-07-01",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Lister parties au bail

Authorizations:
BearerAuthOAuth2Password
query Parameters
page
integer >= 1
Default: 1
per_page
integer >= 1
Default: 25

Valeur plafonnée à 100.

sort
string
Enum: "id" "lease_id" "party_type" "partyable_type" "partyable_id" "tenant_profile_id" "role" "share_numerator" "share_denominator" "valid_from" "valid_to" "created_at" "updated_at" "bank_account_id"
direction
string
Enum: "asc" "desc"
search
string <= 200 characters
updated_since
string <date-time>
q
object
Example:

Filtres autorisés sur les champs publics : suffixes _eq, _in, _cont (texte), _gteq, _lteq. Une valeur inconnue renvoie 400. La chaîne historique q est un alias de search.

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 parties au bail

Authorizations:
BearerAuthOAuth2Password
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "lease_party": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "leaseId": "a3abd432-1f03-4b93-888c-0da4d3703e99",
  • "partyType": "tenant",
  • "partyableType": "string",
  • "partyableId": "1cfae732-8e9c-42e5-8e88-887a3071b881",
  • "tenantProfileId": "b61ec85f-4d34-4fc4-8f6b-9a17f2a589cc",
  • "role": "main",
  • "shareNumerator": 0,
  • "shareDenominator": 0,
  • "validFrom": "2019-08-24",
  • "validTo": "2019-08-24",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Consulter parties au bail

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "leaseId": "a3abd432-1f03-4b93-888c-0da4d3703e99",
  • "partyType": "tenant",
  • "partyableType": "string",
  • "partyableId": "1cfae732-8e9c-42e5-8e88-887a3071b881",
  • "tenantProfileId": "b61ec85f-4d34-4fc4-8f6b-9a17f2a589cc",
  • "role": "main",
  • "shareNumerator": 0,
  • "shareDenominator": 0,
  • "validFrom": "2019-08-24",
  • "validTo": "2019-08-24",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Modifier parties au bail

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "lease_party": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "leaseId": "a3abd432-1f03-4b93-888c-0da4d3703e99",
  • "partyType": "tenant",
  • "partyableType": "string",
  • "partyableId": "1cfae732-8e9c-42e5-8e88-887a3071b881",
  • "tenantProfileId": "b61ec85f-4d34-4fc4-8f6b-9a17f2a589cc",
  • "role": "main",
  • "shareNumerator": 0,
  • "shareDenominator": 0,
  • "validFrom": "2019-08-24",
  • "validTo": "2019-08-24",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Modifier parties au bail

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "lease_party": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "leaseId": "a3abd432-1f03-4b93-888c-0da4d3703e99",
  • "partyType": "tenant",
  • "partyableType": "string",
  • "partyableId": "1cfae732-8e9c-42e5-8e88-887a3071b881",
  • "tenantProfileId": "b61ec85f-4d34-4fc4-8f6b-9a17f2a589cc",
  • "role": "main",
  • "shareNumerator": 0,
  • "shareDenominator": 0,
  • "validFrom": "2019-08-24",
  • "validTo": "2019-08-24",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Retirer parties au bail

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

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

Lister conditions financières du bail

Authorizations:
BearerAuthOAuth2Password
query Parameters
page
integer >= 1
Default: 1
per_page
integer >= 1
Default: 25

Valeur plafonnée à 100.

sort
string
Enum: "id" "lease_id" "effective_from" "effective_to" "revision_month" "revision_frequency_years" "payment_tolerance_type" "payment_tolerance_value" "created_at" "updated_at"
direction
string
Enum: "asc" "desc"
search
string <= 200 characters
updated_since
string <date-time>
q
object
Example:

Filtres autorisés sur les champs publics : suffixes _eq, _in, _cont (texte), _gteq, _lteq. Une valeur inconnue renvoie 400. La chaîne historique q est un alias de search.

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 conditions financières du bail

Authorizations:
BearerAuthOAuth2Password
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "lease_term": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "leaseId": "a3abd432-1f03-4b93-888c-0da4d3703e99",
  • "effectiveFrom": "2019-08-24",
  • "effectiveTo": "2019-08-24",
  • "revisionMonth": 0,
  • "revisionFrequencyYears": 0,
  • "paymentToleranceType": "exact",
  • "paymentToleranceValue": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "leaseUnitTerms": [
    ]
}

Consulter conditions financières du bail

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "leaseId": "a3abd432-1f03-4b93-888c-0da4d3703e99",
  • "effectiveFrom": "2019-08-24",
  • "effectiveTo": "2019-08-24",
  • "revisionMonth": 0,
  • "revisionFrequencyYears": 0,
  • "paymentToleranceType": "exact",
  • "paymentToleranceValue": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "leaseUnitTerms": [
    ]
}

Modifier conditions financières du bail

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "lease_term": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "leaseId": "a3abd432-1f03-4b93-888c-0da4d3703e99",
  • "effectiveFrom": "2019-08-24",
  • "effectiveTo": "2019-08-24",
  • "revisionMonth": 0,
  • "revisionFrequencyYears": 0,
  • "paymentToleranceType": "exact",
  • "paymentToleranceValue": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "leaseUnitTerms": [
    ]
}

Modifier conditions financières du bail

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "lease_term": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "leaseId": "a3abd432-1f03-4b93-888c-0da4d3703e99",
  • "effectiveFrom": "2019-08-24",
  • "effectiveTo": "2019-08-24",
  • "revisionMonth": 0,
  • "revisionFrequencyYears": 0,
  • "paymentToleranceType": "exact",
  • "paymentToleranceValue": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "leaseUnitTerms": [
    ]
}

Retirer conditions financières du bail

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

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

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:
OAuth2PasswordOAuth2AuthCodeBearerAuth
query Parameters
sort
string
direction
string
Default: "asc"
Enum: "asc" "desc"
per_page
integer >= 1
Default: 25
page
integer >= 1
Default: 1
object
Example:
search
string

Recherche textuelle publique.

updated_since
string <date-time>

Borne ISO 8601 inclusive ; dédupliquer par identifiant.

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:
OAuth2PasswordOAuth2AuthCodeBearerAuth
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",
  • "label": "Loyers d'octobre",
  • "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",
  • "rentCallGrouping": [
    ],
  • "cancelledAt": "2019-08-24T14:15:22Z",
  • "cancellationReason": "string",
  • "ownerPaymentsSummary": {
    },
  • "billingNoticesSummary": {
    },
  • "scopeSummary": {
    },
  • "vatBreakdown": { },
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Détail d'un quittancement

Authorizations:
OAuth2PasswordOAuth2AuthCodeBearerAuth
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",
  • "label": "Loyers d'octobre",
  • "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",
  • "rentCallGrouping": [
    ],
  • "cancelledAt": "2019-08-24T14:15:22Z",
  • "cancellationReason": "string",
  • "ownerPaymentsSummary": {
    },
  • "billingNoticesSummary": {
    },
  • "scopeSummary": {
    },
  • "vatBreakdown": { },
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Lignes d'un quittancement

Authorizations:
OAuth2PasswordOAuth2AuthCodeBearerAuth
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
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:
OAuth2PasswordOAuth2AuthCodeBearerAuth
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",
  • "label": "string",
  • "computedAmount": 0,
  • "baseAmount": 0,
  • "status": "pending",
  • "leaseId": "a3abd432-1f03-4b93-888c-0da4d3703e99",
  • "unitIdentifier": "string",
  • "hasAnomaly": true,
  • "anomalyType": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "billingRunId": "015c85a3-dd76-4e8f-b4bd-d7158b0de7e9",
  • "amountHt": 0,
  • "vatAmount": 0,
  • "vatRate": 0,
  • "amountTtc": 0,
  • "vatApplicable": true,
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "isProrata": true,
  • "prorataDays": 0,
  • "anomalyDetails": "string",
  • "leaseType": "string",
  • "paymentFrequency": "string",
  • "tenantName": "string",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "rentCallId": "2f47c2ea-f6c6-406a-9d95-1dc9dca4394a",
  • "propertyName": "string",
  • "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",
  • "ownerName": "string",
  • "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
  • "chargeProvision": 0,
  • "totalAmount": 0,
  • "dueDate": "2019-08-24",
  • "alreadyPaidCents": 0,
  • "totalDueCents": 0,
  • "remainingCents": 0,
  • "currency": "string",
  • "reviewStatus": "string",
  • "leaseReference": "string"
}

Valider un quittancement

Authorizations:
OAuth2PasswordOAuth2AuthCodeBearerAuth
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",
  • "label": "Loyers d'octobre",
  • "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",
  • "rentCallGrouping": [
    ],
  • "cancelledAt": "2019-08-24T14:15:22Z",
  • "cancellationReason": "string",
  • "ownerPaymentsSummary": {
    },
  • "billingNoticesSummary": {
    },
  • "scopeSummary": {
    },
  • "vatBreakdown": { },
  • "updatedAt": "2019-08-24T14:15:22Z"
}

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

Authorizations:
OAuth2PasswordOAuth2AuthCodeBearerAuth
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",
  • "label": "Loyers d'octobre",
  • "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",
  • "rentCallGrouping": [
    ],
  • "cancelledAt": "2019-08-24T14:15:22Z",
  • "cancellationReason": "string",
  • "ownerPaymentsSummary": {
    },
  • "billingNoticesSummary": {
    },
  • "scopeSummary": {
    },
  • "vatBreakdown": { },
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Démarrer la revue des quittancements

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reference": "FACT-2026-05",
  • "label": "Loyers d'octobre",
  • "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",
  • "rentCallGrouping": [
    ],
  • "cancelledAt": "2019-08-24T14:15:22Z",
  • "cancellationReason": "string",
  • "ownerPaymentsSummary": {
    },
  • "billingNoticesSummary": {
    },
  • "scopeSummary": {
    },
  • "vatBreakdown": { },
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Annuler quittancements

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reference": "FACT-2026-05",
  • "label": "Loyers d'octobre",
  • "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",
  • "rentCallGrouping": [
    ],
  • "cancelledAt": "2019-08-24T14:15:22Z",
  • "cancellationReason": "string",
  • "ownerPaymentsSummary": {
    },
  • "billingNoticesSummary": {
    },
  • "scopeSummary": {
    },
  • "vatBreakdown": { },
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Envoyer les appels des quittancements

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reference": "FACT-2026-05",
  • "label": "Loyers d'octobre",
  • "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",
  • "rentCallGrouping": [
    ],
  • "cancelledAt": "2019-08-24T14:15:22Z",
  • "cancellationReason": "string",
  • "ownerPaymentsSummary": {
    },
  • "billingNoticesSummary": {
    },
  • "scopeSummary": {
    },
  • "vatBreakdown": { },
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Mandats

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

Lister les mandats

Authorizations:
OAuth2PasswordOAuth2AuthCodeBearerAuth
query Parameters
sort
string
direction
string
Default: "asc"
Enum: "asc" "desc"
per_page
integer >= 1
Default: 25
page
integer >= 1
Default: 1
object
Example:
search
string

Recherche textuelle publique.

updated_since
string <date-time>

Borne ISO 8601 inclusive ; dédupliquer par identifiant.

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:
OAuth2PasswordOAuth2AuthCodeBearerAuth
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,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "signatureDate": "2019-08-24",
  • "vatRateOnFees": 20,
  • "renewalMode": "tacit",
  • "noticeMonths": 3,
  • "specialConditions": "string",
  • "distributionFrequency": "string",
  • "distributionDay": 5,
  • "distributionMarginDays": 0,
  • "depotGarantieDetention": "string",
  • "retenueDestination": "string",
  • "accountingMode": "string",
  • "effectiveAccountingMode": "string",
  • "mandateServices": [
    ],
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "businessCode": "string",
  • "ownerBusinessCode": "string",
  • "propertyBusinessCode": "string",
  • "properties": [
    ]
}

Détail d'un mandat

Authorizations:
OAuth2PasswordOAuth2AuthCodeBearerAuth
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,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "signatureDate": "2019-08-24",
  • "vatRateOnFees": 20,
  • "renewalMode": "tacit",
  • "noticeMonths": 3,
  • "specialConditions": "string",
  • "distributionFrequency": "string",
  • "distributionDay": 5,
  • "distributionMarginDays": 0,
  • "depotGarantieDetention": "string",
  • "retenueDestination": "string",
  • "accountingMode": "string",
  • "effectiveAccountingMode": "string",
  • "mandateServices": [
    ],
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "businessCode": "string",
  • "ownerBusinessCode": "string",
  • "propertyBusinessCode": "string",
  • "properties": [
    ]
}

Modifier mandats

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
reference
string
mandate_type
string
start_date
string <date>
end_date
string <date>
management_fee_rate
number
property_ids
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "reference": "string",
  • "mandate_type": "string",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "management_fee_rate": 0,
  • "property_ids": [
    ]
}

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,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "signatureDate": "2019-08-24",
  • "vatRateOnFees": 20,
  • "renewalMode": "tacit",
  • "noticeMonths": 3,
  • "specialConditions": "string",
  • "distributionFrequency": "string",
  • "distributionDay": 5,
  • "distributionMarginDays": 0,
  • "depotGarantieDetention": "string",
  • "retenueDestination": "string",
  • "accountingMode": "string",
  • "effectiveAccountingMode": "string",
  • "mandateServices": [
    ],
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "businessCode": "string",
  • "ownerBusinessCode": "string",
  • "propertyBusinessCode": "string",
  • "properties": [
    ]
}

Modifier mandats

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
reference
string
mandate_type
string
start_date
string <date>
end_date
string <date>
management_fee_rate
number
property_ids
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "reference": "string",
  • "mandate_type": "string",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "management_fee_rate": 0,
  • "property_ids": [
    ]
}

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,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "signatureDate": "2019-08-24",
  • "vatRateOnFees": 20,
  • "renewalMode": "tacit",
  • "noticeMonths": 3,
  • "specialConditions": "string",
  • "distributionFrequency": "string",
  • "distributionDay": 5,
  • "distributionMarginDays": 0,
  • "depotGarantieDetention": "string",
  • "retenueDestination": "string",
  • "accountingMode": "string",
  • "effectiveAccountingMode": "string",
  • "mandateServices": [
    ],
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "businessCode": "string",
  • "ownerBusinessCode": "string",
  • "propertyBusinessCode": "string",
  • "properties": [
    ]
}

Activer mandats

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

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,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "signatureDate": "2019-08-24",
  • "vatRateOnFees": 20,
  • "renewalMode": "tacit",
  • "noticeMonths": 3,
  • "specialConditions": "string",
  • "distributionFrequency": "string",
  • "distributionDay": 5,
  • "distributionMarginDays": 0,
  • "depotGarantieDetention": "string",
  • "retenueDestination": "string",
  • "accountingMode": "string",
  • "effectiveAccountingMode": "string",
  • "mandateServices": [
    ],
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "businessCode": "string",
  • "ownerBusinessCode": "string",
  • "propertyBusinessCode": "string",
  • "properties": [
    ]
}

Suspendre mandats

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

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,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "signatureDate": "2019-08-24",
  • "vatRateOnFees": 20,
  • "renewalMode": "tacit",
  • "noticeMonths": 3,
  • "specialConditions": "string",
  • "distributionFrequency": "string",
  • "distributionDay": 5,
  • "distributionMarginDays": 0,
  • "depotGarantieDetention": "string",
  • "retenueDestination": "string",
  • "accountingMode": "string",
  • "effectiveAccountingMode": "string",
  • "mandateServices": [
    ],
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "businessCode": "string",
  • "ownerBusinessCode": "string",
  • "propertyBusinessCode": "string",
  • "properties": [
    ]
}

Renouveler mandats

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
new_end_date
required
string

Responses

Request samples

Content type
application/json
{
  • "new_end_date": "string"
}

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,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "signatureDate": "2019-08-24",
  • "vatRateOnFees": 20,
  • "renewalMode": "tacit",
  • "noticeMonths": 3,
  • "specialConditions": "string",
  • "distributionFrequency": "string",
  • "distributionDay": 5,
  • "distributionMarginDays": 0,
  • "depotGarantieDetention": "string",
  • "retenueDestination": "string",
  • "accountingMode": "string",
  • "effectiveAccountingMode": "string",
  • "mandateServices": [
    ],
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "businessCode": "string",
  • "ownerBusinessCode": "string",
  • "propertyBusinessCode": "string",
  • "properties": [
    ]
}

Résilier mandats

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
termination_date
string
reason
string

Responses

Request samples

Content type
application/json
{
  • "termination_date": "string",
  • "reason": "string"
}

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,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "signatureDate": "2019-08-24",
  • "vatRateOnFees": 20,
  • "renewalMode": "tacit",
  • "noticeMonths": 3,
  • "specialConditions": "string",
  • "distributionFrequency": "string",
  • "distributionDay": 5,
  • "distributionMarginDays": 0,
  • "depotGarantieDetention": "string",
  • "retenueDestination": "string",
  • "accountingMode": "string",
  • "effectiveAccountingMode": "string",
  • "mandateServices": [
    ],
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "businessCode": "string",
  • "ownerBusinessCode": "string",
  • "propertyBusinessCode": "string",
  • "properties": [
    ]
}

Patrimoine

Immeubles (properties) et lots (units).

Lister les immeubles

Authorizations:
OAuth2PasswordOAuth2AuthCodeBearerAuth
query Parameters
sort
string
direction
string
Default: "asc"
Enum: "asc" "desc"
per_page
integer >= 1
Default: 25
page
integer >= 1
Default: 1
object
Example:
search
string

Recherche textuelle publique.

updated_since
string <date-time>

Borne ISO 8601 inclusive ; dédupliquer par identifiant.

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:
OAuth2PasswordOAuth2AuthCodeBearerAuth
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 des Tilleuls",
  • "city": "Lyon",
  • "postal_code": "69003",
  • "property_type": "residential",
  • "address": "12 rue des Tilleuls"
}

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",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "businessCode": "string",
  • "unitsCount": 0,
  • "navigationOnly": true
}

Détail d'un immeuble

Authorizations:
OAuth2PasswordOAuth2AuthCodeBearerAuth
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",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "businessCode": "string",
  • "unitsCount": 0,
  • "navigationOnly": true
}

Modifier immeubles

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
name
string
address
string
city
string
postal_code
string
property_type
string
has_elevator
string
floor_count
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "address": "string",
  • "city": "string",
  • "postal_code": "string",
  • "property_type": "string",
  • "has_elevator": "string",
  • "floor_count": "string"
}

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",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "businessCode": "string",
  • "unitsCount": 0,
  • "navigationOnly": true
}

Modifier immeubles

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
name
string
address
string
city
string
postal_code
string
property_type
string
has_elevator
string
floor_count
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "address": "string",
  • "city": "string",
  • "postal_code": "string",
  • "property_type": "string",
  • "has_elevator": "string",
  • "floor_count": "string"
}

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",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "businessCode": "string",
  • "unitsCount": 0,
  • "navigationOnly": true
}

Retirer immeubles

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

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

Lister les lots

Authorizations:
OAuth2PasswordOAuth2AuthCodeBearerAuth
query Parameters
sort
string
direction
string
Default: "asc"
Enum: "asc" "desc"
per_page
integer >= 1
Default: 25
page
integer >= 1
Default: 1
object
Example:
search
string

Recherche textuelle publique.

updated_since
string <date-time>

Borne ISO 8601 inclusive ; dédupliquer par identifiant.

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:
OAuth2PasswordOAuth2AuthCodeBearerAuth
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": "33333333-3333-4333-8333-333333333333",
  • "identifier": "A-101",
  • "unit_type": "apartment",
  • "area_sqm": 65
}

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",
  • "address": {
    },
  • "entranceId": "f1d71af7-bbf3-4741-b937-474e4ce1525e",
  • "entranceName": "RUE ROSA BONHEUR",
  • "ownAddress": {
    },
  • "owners": [
    ],
  • "activeLease": {
    },
  • "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",
  • "propertyName": "Résidence Les Tilleuls",
  • "ownerships": [
    ],
  • "ownershipHistory": [
    ],
  • "sharesComplete": true,
  • "totalSharePercent": 100,
  • "leases": [
    ],
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Détail d'un lot

Authorizations:
OAuth2PasswordOAuth2AuthCodeBearerAuth
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",
  • "address": {
    },
  • "entranceId": "f1d71af7-bbf3-4741-b937-474e4ce1525e",
  • "entranceName": "RUE ROSA BONHEUR",
  • "ownAddress": {
    },
  • "owners": [
    ],
  • "activeLease": {
    },
  • "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",
  • "propertyName": "Résidence Les Tilleuls",
  • "ownerships": [
    ],
  • "ownershipHistory": [
    ],
  • "sharesComplete": true,
  • "totalSharePercent": 100,
  • "leases": [
    ],
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Modifier lots

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
identifier
string
unit_type
string
area_sqm
number
floor
string
description
string

Responses

Request samples

Content type
application/json
{
  • "identifier": "string",
  • "unit_type": "string",
  • "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",
  • "address": {
    },
  • "entranceId": "f1d71af7-bbf3-4741-b937-474e4ce1525e",
  • "entranceName": "RUE ROSA BONHEUR",
  • "ownAddress": {
    },
  • "owners": [
    ],
  • "activeLease": {
    },
  • "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",
  • "propertyName": "Résidence Les Tilleuls",
  • "ownerships": [
    ],
  • "ownershipHistory": [
    ],
  • "sharesComplete": true,
  • "totalSharePercent": 100,
  • "leases": [
    ],
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Modifier lots

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
identifier
string
unit_type
string
area_sqm
number
floor
string
description
string

Responses

Request samples

Content type
application/json
{
  • "identifier": "string",
  • "unit_type": "string",
  • "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",
  • "address": {
    },
  • "entranceId": "f1d71af7-bbf3-4741-b937-474e4ce1525e",
  • "entranceName": "RUE ROSA BONHEUR",
  • "ownAddress": {
    },
  • "owners": [
    ],
  • "activeLease": {
    },
  • "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",
  • "propertyName": "Résidence Les Tilleuls",
  • "ownerships": [
    ],
  • "ownershipHistory": [
    ],
  • "sharesComplete": true,
  • "totalSharePercent": 100,
  • "leases": [
    ],
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Retirer lots

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

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

Lister détentions de lots

Authorizations:
BearerAuthOAuth2Password
query Parameters
page
integer >= 1
Default: 1
per_page
integer >= 1
Default: 25

Valeur plafonnée à 100.

sort
string
Enum: "id" "owner_id" "unit_id" "share_numerator" "share_denominator" "valid_from" "valid_to" "acquisition_date" "acquisition_type" "created_at" "updated_at" "mandataire_id"
direction
string
Enum: "asc" "desc"
search
string <= 200 characters
updated_since
string <date-time>
q
object
Example:

Filtres autorisés sur les champs publics : suffixes _eq, _in, _cont (texte), _gteq, _lteq. Une valeur inconnue renvoie 400. La chaîne historique q est un alias de search.

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 détentions de lots

Authorizations:
BearerAuthOAuth2Password
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "ownership": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
  • "unitId": "b3eb5f92-604a-46b9-9881-9d84000fd7ed",
  • "shareNumerator": 0,
  • "shareDenominator": 0,
  • "validFrom": "2019-08-24",
  • "validTo": "2019-08-24",
  • "acquisitionDate": "2019-08-24",
  • "acquisitionType": "purchase",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd"
}

Consulter détentions de lots

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
  • "unitId": "b3eb5f92-604a-46b9-9881-9d84000fd7ed",
  • "shareNumerator": 0,
  • "shareDenominator": 0,
  • "validFrom": "2019-08-24",
  • "validTo": "2019-08-24",
  • "acquisitionDate": "2019-08-24",
  • "acquisitionType": "purchase",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd"
}

Modifier détentions de lots

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "ownership": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
  • "unitId": "b3eb5f92-604a-46b9-9881-9d84000fd7ed",
  • "shareNumerator": 0,
  • "shareDenominator": 0,
  • "validFrom": "2019-08-24",
  • "validTo": "2019-08-24",
  • "acquisitionDate": "2019-08-24",
  • "acquisitionType": "purchase",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd"
}

Modifier détentions de lots

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "ownership": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
  • "unitId": "b3eb5f92-604a-46b9-9881-9d84000fd7ed",
  • "shareNumerator": 0,
  • "shareDenominator": 0,
  • "validFrom": "2019-08-24",
  • "validTo": "2019-08-24",
  • "acquisitionDate": "2019-08-24",
  • "acquisitionType": "purchase",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd"
}

Retirer détentions de lots

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

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

Tiers

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

Lister les propriétaires

Authorizations:
OAuth2PasswordOAuth2AuthCodeBearerAuth
query Parameters
per_page
integer >= 1
Default: 25
page
integer >= 1
Default: 1
q
string

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

search
string

Recherche textuelle publique.

updated_since
string <date-time>

Borne ISO 8601 inclusive ; dédupliquer par identifiant.

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:
OAuth2PasswordOAuth2AuthCodeBearerAuth
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",
  • "updatedAt": "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:
OAuth2PasswordOAuth2AuthCodeBearerAuth
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": [
    ],
  • "mandates": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "code": "string"
}

Modifier propriétaires

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
first_name
string
last_name
string
email_address
string
phone_number
string
owner_type
string
company_name
string
siret
string
address
string

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "email_address": "string",
  • "phone_number": "string",
  • "owner_type": "string",
  • "company_name": "string",
  • "siret": "string",
  • "address": "string"
}

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": [
    ],
  • "mandates": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "code": "string"
}

Modifier propriétaires

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
first_name
string
last_name
string
email_address
string
phone_number
string
owner_type
string
company_name
string
siret
string
address
string

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "email_address": "string",
  • "phone_number": "string",
  • "owner_type": "string",
  • "company_name": "string",
  • "siret": "string",
  • "address": "string"
}

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": [
    ],
  • "mandates": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "code": "string"
}

Retirer propriétaires

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

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

Lister les locataires

Authorizations:
OAuth2PasswordOAuth2AuthCodeBearerAuth
query Parameters
per_page
integer >= 1
Default: 25
page
integer >= 1
Default: 1
q
string

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

search
string

Recherche textuelle publique.

updated_since
string <date-time>

Borne ISO 8601 inclusive ; dédupliquer par identifiant.

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 locataires

Authorizations:
BearerAuthOAuth2Password
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.

Request Body schema: application/json
required
first_name
string
last_name
string
email_address
string
phone_number
string
tenant_type
string
trade_name
string
siret
string
vat_number
string
billing_email
string
billing_address
string

Responses

Request samples

Content type
application/json
{
  • "first_name": "Camille",
  • "last_name": "Exemple",
  • "email_address": "camille@example.test"
}

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",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "code": "string"
}

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:
OAuth2PasswordOAuth2AuthCodeBearerAuth
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",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "code": "string"
}

Modifier locataires

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
first_name
string
last_name
string
email_address
string
phone_number
string
tenant_type
string
trade_name
string
siret
string
vat_number
string
billing_email
string
billing_address
string

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "email_address": "string",
  • "phone_number": "string",
  • "tenant_type": "string",
  • "trade_name": "string",
  • "siret": "string",
  • "vat_number": "string",
  • "billing_email": "string",
  • "billing_address": "string"
}

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",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "code": "string"
}

Modifier locataires

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
first_name
string
last_name
string
email_address
string
phone_number
string
tenant_type
string
trade_name
string
siret
string
vat_number
string
billing_email
string
billing_address
string

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "email_address": "string",
  • "phone_number": "string",
  • "tenant_type": "string",
  • "trade_name": "string",
  • "siret": "string",
  • "vat_number": "string",
  • "billing_email": "string",
  • "billing_address": "string"
}

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",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "code": "string"
}

Lister contacts

Authorizations:
BearerAuthOAuth2Password
query Parameters
page
integer >= 1
Default: 1
per_page
integer >= 1
Default: 25

Valeur plafonnée à 100.

sort
string
Enum: "id" "contact_profile_id" "mandataire_id" "first_name" "last_name" "display_name" "email" "phone" "contact_type" "company_name" "siret" "activity" "address" "created_at" "updated_at"
direction
string
Enum: "asc" "desc"
search
string <= 200 characters
updated_since
string <date-time>
q
object
Example:

Filtres autorisés sur les champs publics : suffixes _eq, _in, _cont (texte), _gteq, _lteq. Une valeur inconnue renvoie 400. La chaîne historique q est un alias de search. Les champs first_name, last_name, email_address et phone_number filtrent les coordonnées du contact.

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 contacts

Authorizations:
BearerAuthOAuth2Password
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "contact": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "contactProfileId": "f3b48583-eca0-49f4-bbee-023dfdf84e1b",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "firstName": "string",
  • "lastName": "string",
  • "displayName": "string",
  • "email": "string",
  • "phone": "string",
  • "contactType": "string",
  • "companyName": "string",
  • "siret": "string",
  • "activity": "string",
  • "address": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Consulter contacts

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "contactProfileId": "f3b48583-eca0-49f4-bbee-023dfdf84e1b",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "firstName": "string",
  • "lastName": "string",
  • "displayName": "string",
  • "email": "string",
  • "phone": "string",
  • "contactType": "string",
  • "companyName": "string",
  • "siret": "string",
  • "activity": "string",
  • "address": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Modifier contacts

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "contact": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "contactProfileId": "f3b48583-eca0-49f4-bbee-023dfdf84e1b",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "firstName": "string",
  • "lastName": "string",
  • "displayName": "string",
  • "email": "string",
  • "phone": "string",
  • "contactType": "string",
  • "companyName": "string",
  • "siret": "string",
  • "activity": "string",
  • "address": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Modifier contacts

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "contact": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "contactProfileId": "f3b48583-eca0-49f4-bbee-023dfdf84e1b",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "firstName": "string",
  • "lastName": "string",
  • "displayName": "string",
  • "email": "string",
  • "phone": "string",
  • "contactType": "string",
  • "companyName": "string",
  • "siret": "string",
  • "activity": "string",
  • "address": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Retirer contacts

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

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

Lister fournisseurs

Authorizations:
BearerAuthOAuth2Password
query Parameters
page
integer >= 1
Default: 1
per_page
integer >= 1
Default: 25

Valeur plafonnée à 100.

sort
string
Enum: "id" "contact_profile_id" "mandataire_id" "first_name" "last_name" "display_name" "email" "phone" "contact_type" "company_name" "siret" "activity" "address" "created_at" "updated_at"
direction
string
Enum: "asc" "desc"
search
string <= 200 characters
updated_since
string <date-time>
q
object
Example:

Filtres autorisés sur les champs publics : suffixes _eq, _in, _cont (texte), _gteq, _lteq. Une valeur inconnue renvoie 400. La chaîne historique q est un alias de search. Les champs first_name, last_name, email_address et phone_number filtrent les coordonnées du contact.

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 fournisseurs

Authorizations:
BearerAuthOAuth2Password
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "contact": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "contactProfileId": "f3b48583-eca0-49f4-bbee-023dfdf84e1b",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "firstName": "string",
  • "lastName": "string",
  • "displayName": "string",
  • "email": "string",
  • "phone": "string",
  • "contactType": "string",
  • "companyName": "string",
  • "siret": "string",
  • "activity": "string",
  • "address": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Consulter fournisseurs

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "contactProfileId": "f3b48583-eca0-49f4-bbee-023dfdf84e1b",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "firstName": "string",
  • "lastName": "string",
  • "displayName": "string",
  • "email": "string",
  • "phone": "string",
  • "contactType": "string",
  • "companyName": "string",
  • "siret": "string",
  • "activity": "string",
  • "address": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Modifier fournisseurs

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "contact": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "contactProfileId": "f3b48583-eca0-49f4-bbee-023dfdf84e1b",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "firstName": "string",
  • "lastName": "string",
  • "displayName": "string",
  • "email": "string",
  • "phone": "string",
  • "contactType": "string",
  • "companyName": "string",
  • "siret": "string",
  • "activity": "string",
  • "address": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Modifier fournisseurs

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "contact": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "contactProfileId": "f3b48583-eca0-49f4-bbee-023dfdf84e1b",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "firstName": "string",
  • "lastName": "string",
  • "displayName": "string",
  • "email": "string",
  • "phone": "string",
  • "contactType": "string",
  • "companyName": "string",
  • "siret": "string",
  • "activity": "string",
  • "address": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Retirer fournisseurs

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

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

Paiements

Encaissements (lecture seule).

Lister les encaissements

Authorizations:
OAuth2PasswordOAuth2AuthCodeBearerAuth
query Parameters
sort
string
direction
string
Default: "asc"
Enum: "asc" "desc"
per_page
integer >= 1
Default: 25
page
integer >= 1
Default: 1
object
Example:
search
string

Recherche textuelle publique.

updated_since
string <date-time>

Borne ISO 8601 inclusive ; dédupliquer par identifiant.

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:
OAuth2PasswordOAuth2AuthCodeBearerAuth
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": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Incidents

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

Lister les incidents

Authorizations:
OAuth2PasswordOAuth2AuthCodeBearerAuth
query Parameters
sort
string
direction
string
Default: "asc"
Enum: "asc" "desc"
per_page
integer >= 1
Default: 25
page
integer >= 1
Default: 1
object
Example:
search
string

Recherche textuelle publique.

updated_since
string <date-time>

Borne ISO 8601 inclusive ; dédupliquer par identifiant.

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:
OAuth2PasswordOAuth2AuthCodeBearerAuth
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",
  • "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:
OAuth2PasswordOAuth2AuthCodeBearerAuth
query Parameters
journal
string
Enum: "LOYERS" "CHARGES" "BANQUE" "PROPRIO" "OD"
sort
string
direction
string
Default: "asc"
Enum: "asc" "desc"
per_page
integer >= 1
Default: 25
page
integer >= 1
Default: 1
object
Example:
search
string

Recherche textuelle publique.

updated_since
string <date-time>

Borne ISO 8601 inclusive ; dédupliquer par identifiant.

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:
OAuth2PasswordOAuth2AuthCodeBearerAuth
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",
  • "lines": [
    ],
  • "updatedAt": "2019-08-24T14:15:22Z"
}

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:
OAuth2PasswordOAuth2AuthCodeBearerAuth
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",
  • "updatedAt": "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:
OAuth2PasswordOAuth2AuthCodeBearerAuth
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"
}

Loctavia — Appels de loyer

Appels de loyer : consultation et actions métier sous autorisation.

Envoyer les appels de loyer

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "billingRunId": "015c85a3-dd76-4e8f-b4bd-d7158b0de7e9",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "tenantProfileId": "b61ec85f-4d34-4fc4-8f6b-9a17f2a589cc",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "reference": "string",
  • "status": "draft",
  • "totalAmountCents": 0,
  • "currency": "string",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "sentAt": "2019-08-24T14:15:22Z",
  • "receiptGeneratedAt": "2019-08-24T14:15:22Z",
  • "dueDate": "2019-08-24",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "rentAmountCents": 0,
  • "chargesAmountCents": 0
}

Renvoyer les appels de loyer

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "billingRunId": "015c85a3-dd76-4e8f-b4bd-d7158b0de7e9",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "tenantProfileId": "b61ec85f-4d34-4fc4-8f6b-9a17f2a589cc",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "reference": "string",
  • "status": "draft",
  • "totalAmountCents": 0,
  • "currency": "string",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "sentAt": "2019-08-24T14:15:22Z",
  • "receiptGeneratedAt": "2019-08-24T14:15:22Z",
  • "dueDate": "2019-08-24",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "rentAmountCents": 0,
  • "chargesAmountCents": 0
}

Enregistrer un paiement des appels de loyer

Les appels regroupant plusieurs baux sont refusés en 422 avant toute création de paiement ou allocation.

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "payment": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "billingRunId": "015c85a3-dd76-4e8f-b4bd-d7158b0de7e9",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "tenantProfileId": "b61ec85f-4d34-4fc4-8f6b-9a17f2a589cc",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "reference": "string",
  • "status": "draft",
  • "totalAmountCents": 0,
  • "currency": "string",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "sentAt": "2019-08-24T14:15:22Z",
  • "receiptGeneratedAt": "2019-08-24T14:15:22Z",
  • "dueDate": "2019-08-24",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "rentAmountCents": 0,
  • "chargesAmountCents": 0
}

Télécharger les appels de loyer

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

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

Télécharger la quittance des appels de loyer

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

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

Lister appels de loyer

Authorizations:
BearerAuthOAuth2Password
query Parameters
page
integer >= 1
Default: 1
per_page
integer >= 1
Default: 25

Valeur plafonnée à 100.

sort
string
Enum: "id" "billing_run_id" "tenant_id" "tenant_profile_id" "mandataire_id" "reference" "status" "total_amount_cents" "currency" "period_start" "period_end" "sent_at" "receipt_generated_at" "due_date" "created_at" "updated_at" "rent_amount_cents" "charges_amount_cents"
direction
string
Enum: "asc" "desc"
search
string <= 200 characters
updated_since
string <date-time>
q
object
Example:

Filtres autorisés sur les champs publics : suffixes _eq, _in, _cont (texte), _gteq, _lteq. Une valeur inconnue renvoie 400. La chaîne historique q est un alias de search.

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 appels de loyer

Authorizations:
BearerAuthOAuth2Password
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.

Request Body schema: application/json
required
lease_id
required
string <uuid>
reference_date
required
string <date>
send_immediately
boolean

Responses

Request samples

Content type
application/json
{
  • "lease_id": "55555555-5555-4555-8555-555555555555",
  • "reference_date": "2026-03-01",
  • "send_immediately": false
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "billingRunId": "015c85a3-dd76-4e8f-b4bd-d7158b0de7e9",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "tenantProfileId": "b61ec85f-4d34-4fc4-8f6b-9a17f2a589cc",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "reference": "string",
  • "status": "draft",
  • "totalAmountCents": 0,
  • "currency": "string",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "sentAt": "2019-08-24T14:15:22Z",
  • "receiptGeneratedAt": "2019-08-24T14:15:22Z",
  • "dueDate": "2019-08-24",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "rentAmountCents": 0,
  • "chargesAmountCents": 0
}

Consulter appels de loyer

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "billingRunId": "015c85a3-dd76-4e8f-b4bd-d7158b0de7e9",
  • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  • "tenantProfileId": "b61ec85f-4d34-4fc4-8f6b-9a17f2a589cc",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "reference": "string",
  • "status": "draft",
  • "totalAmountCents": 0,
  • "currency": "string",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "sentAt": "2019-08-24T14:15:22Z",
  • "receiptGeneratedAt": "2019-08-24T14:15:22Z",
  • "dueDate": "2019-08-24",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "rentAmountCents": 0,
  • "chargesAmountCents": 0
}

Loctavia — Banque

Banque : consultation et actions métier sous autorisation.

Lister les relevés bancaires

Relevés du cabinet, les plus récents d'abord (brouillons à importer compris). Réservé à qui peut rapprocher (loctavia.op.rapprocher), en pratique l'analyste bancaire Synapse authentifié par son propre jeton d'agent (jamais délégué) : les mêmes gestes que le gestionnaire à l'écran, par les mêmes règles ; chaque geste d'un agent est enregistré en mode ai, signé par lui.

Authorizations:
BearerAuthOAuth2Password
query Parameters
status
string
Enum: "draft" "imported"

draft (brouillon à importer) ou imported.

bank_account_id
string

Compte bancaire.

page
integer

Page.

per_page
integer

Éléments par page (plafonné à 100).

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
[
  • {
    }
]

Consulter un relevé bancaire

En-tête du relevé, avancement (tri par immeuble, statuts, propositions), seuils du cabinet et dernier compte rendu de l'analyste. Réservé à qui peut rapprocher (loctavia.op.rapprocher), en pratique l'analyste bancaire Synapse authentifié par son propre jeton d'agent (jamais délégué).

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "draft",
  • "originalFilename": "string",
  • "sourceFormat": "string",
  • "currency": "string",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "openingBalanceCents": 0,
  • "closingBalanceCents": 0,
  • "bankAccount": {
    },
  • "transactionsCount": 0,
  • "canonical": {
    },
  • "findings": {
    },
  • "triage": {
    },
  • "statuses": {
    },
  • "proposals": {
    },
  • "thresholds": {
    },
  • "latestReport": {
    }
}

Lire les lignes d'un brouillon

Lignes lues dans le fichier (ou le canonique déposé), empreinte et doublons signalés, comme l'aperçu de l'import. Réservé à qui peut rapprocher (loctavia.op.rapprocher), en pratique l'analyste bancaire Synapse authentifié par son propre jeton d'agent (jamais délégué) : les mêmes gestes que le gestionnaire à l'écran, par les mêmes règles ; chaque geste d'un agent est enregistré en mode ai, signé par lui.

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "summary": {
    },
  • "lines": [
    ]
}

Importer un brouillon

Crée les opérations des lignes choisies (par défaut toutes sauf les doublons), comme « Importer » à l'écran ; les opérations d'un compte trié par immeuble reçoivent leur immeuble suggéré. Réservé à qui peut rapprocher (loctavia.op.rapprocher), en pratique l'analyste bancaire Synapse authentifié par son propre jeton d'agent (jamais délégué) : les mêmes gestes que le gestionnaire à l'écran, par les mêmes règles ; chaque geste d'un agent est enregistré en mode ai, signé par lui.

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
fingerprints
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "fingerprints": [
    ]
}

Response samples

Content type
application/json
{
  • "statement": {
    },
  • "transactionsCount": 0,
  • "toTriageCount": 0
}

Relancer les propositions de rapprochement

Relance le moteur de propositions sur le relevé, sans tâche de fond : les propositions sont lisibles au retour. Réservé à qui peut rapprocher (loctavia.op.rapprocher), en pratique l'analyste bancaire Synapse authentifié par son propre jeton d'agent (jamais délégué) : les mêmes gestes que le gestionnaire à l'écran, par les mêmes règles ; chaque geste d'un agent est enregistré en mode ai, signé par lui.

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "proposalsCount": 0,
  • "counts": {
    }
}

Lister les comptes rendus de l'analyste

Comptes rendus de l'analyste bancaire sur le relevé, le plus récent d'abord. Réservé à qui peut rapprocher (loctavia.op.rapprocher), en pratique l'analyste bancaire Synapse authentifié par son propre jeton d'agent (jamais délégué) : les mêmes gestes que le gestionnaire à l'écran, par les mêmes règles ; chaque geste d'un agent est enregistré en mode ai, signé par lui.

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Déposer un compte rendu

Compte rendu d'un passage de l'analyste bancaire (Markdown), affiché au gestionnaire sur l'espace de rapprochement du relevé. Réservé à qui peut rapprocher (loctavia.op.rapprocher), en pratique l'analyste bancaire Synapse authentifié par son propre jeton d'agent (jamais délégué) : les mêmes gestes que le gestionnaire à l'écran, par les mêmes règles ; chaque geste d'un agent est enregistré en mode ai, signé par lui.

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
outcome
required
string
Enum: "completed" "partial" "failed"
body
required
string <= 100000 characters

Compte rendu en Markdown.

object or null

Responses

Request samples

Content type
application/json
{
  • "outcome": "completed",
  • "body": "string",
  • "summary": { }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "outcome": "completed",
  • "body": "string",
  • "summary": { },
  • "author": "string",
  • "missionId": "ffe1fa43-ef81-4ced-9a12-8c92ffb6f0ba",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Télécharger le fichier brut d'un relevé

Fichier déposé à l'import (CSV, OFX, CFONB, PDF, scan…). Réservé à l'analyste bancaire Synapse, authentifié par son propre jeton d'agent (jamais délégué) ; exige la capacité de rapprochement (loctavia.op.rapprocher).

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

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

Lister les opérations d'un relevé

Opérations du relevé importé : tri par immeuble, proposition ouverte (alternatives comprises), rapprochement. Réservé à l'analyste bancaire Synapse, authentifié par son propre jeton d'agent (jamais délégué) ; exige la capacité de rapprochement (loctavia.op.rapprocher).

Authorizations:
BearerAuthOAuth2Password
path Parameters
id
required
string <uuid>
query Parameters
status
string
Enum: "pending" "matched" "ignored" "suspended"

Statut de rapprochement.

triage_status
string
Enum: "not_required" "to_triage" "triaged" "out_of_scope"

Statut de tri par immeuble.

tab
string
Enum: "sure" "review" "ambiguous" "unproposed" "matched" "set_aside"

Onglet de l'espace de rapprochement.

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
[
  • {
    }
]

Lister les attendus ouverts rapprochables

Échéances appelées non soldées et factures émises non payées du cabinet, limitées aux baux sur lesquels l'appelant peut rapprocher. Réservé à l'analyste bancaire Synapse, authentifié par son propre jeton d'agent (jamais délégué) ; exige la capacité de rapprochement (loctavia.op.rapprocher).

Authorizations:
BearerAuthOAuth2Password
path Parameters
id
required
string <uuid>
query Parameters
property_id
string

Immeuble (celui où l'opération est triée).

lease_id
string

Bail.

q
string

Texte : exploitant, référence, immeuble.

remaining_cents
integer

Reste dû exact, en centimes.

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époser le relevé canonique

Idempotent. Brouillon : le canonique devient la source des lignes de l'import (l'humain choisit toujours les lignes). Relevé importé : les opérations reçoivent la confiance et la zone source de l'extraction, rien n'est créé. Réservé à l'analyste bancaire Synapse, authentifié par son propre jeton d'agent (jamais délégué) ; exige la capacité de rapprochement (loctavia.op.rapprocher).

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
schema_version
required
integer
Value: 1
required
object
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "schema_version": 1,
  • "statement": {
    },
  • "transactions": [
    ]
}

Response samples

Content type
application/json
{
  • "statement": {
    },
  • "transactions": [
    ]
}

Déposer les findings de rapprochement

Idempotent (remplace le dépôt précédent, corrélé par finding.id). Les match_proposal deviennent des propositions à valider par un humain, attribuées à l'agent ; anomalies et ambiguïtés sont rangées sur le relevé. Réservé à l'analyste bancaire Synapse, authentifié par son propre jeton d'agent (jamais délégué) ; exige la capacité de rapprochement (loctavia.op.rapprocher).

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
schema_version
required
integer
Value: 1
statement_id
string
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "schema_version": 1,
  • "statement_id": "string",
  • "findings": [
    ]
}

Response samples

Content type
application/json
{
  • "proposals": 0,
  • "anomalies": 0,
  • "ambiguities": 0,
  • "skipped": [
    ]
}

Consulter une opération bancaire

Ce que dit la banque, le tri par immeuble, la proposition ouverte (alternatives comprises) et le rapprochement. Réservé à qui peut rapprocher (loctavia.op.rapprocher), en pratique l'analyste bancaire Synapse authentifié par son propre jeton d'agent (jamais délégué) : les mêmes gestes que le gestionnaire à l'écran, par les mêmes règles ; chaque geste d'un agent est enregistré en mode ai, signé par lui.

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "statementId": "775b692d-f1fa-4640-9327-0c9bb8d02222",
  • "canonicalIndex": 0,
  • "fingerprint": "string",
  • "date": "2019-08-24",
  • "valueDate": "2019-08-24",
  • "amountCents": 0,
  • "direction": "credit",
  • "label": "string",
  • "reference": "string",
  • "counterparty": "string",
  • "operationCode": "string",
  • "bankDetails": { },
  • "status": "pending",
  • "triage": {
    },
  • "proposal": {
    },
  • "openProposals": [
    ],
  • "reconciliation": {
    },
  • "suspense": {
    }
}

Trier une opération par immeuble

Rattache l'opération à un immeuble, à son immeuble suggéré, ou la classe hors immeuble ; exige l'habilitation loctavia.op.trier. Réservé à qui peut rapprocher (loctavia.op.rapprocher), en pratique l'analyste bancaire Synapse authentifié par son propre jeton d'agent (jamais délégué) : les mêmes gestes que le gestionnaire à l'écran, par les mêmes règles ; chaque geste d'un agent est enregistré en mode ai, signé par lui.

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
property_id
string or null <uuid>
accept_suggestion
boolean or null
out_of_scope
boolean or null

Responses

Request samples

Content type
application/json
{
  • "property_id": "05003a8a-8f3c-454b-8884-a906ec46f5f5",
  • "accept_suggestion": true,
  • "out_of_scope": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "statementId": "775b692d-f1fa-4640-9327-0c9bb8d02222",
  • "canonicalIndex": 0,
  • "fingerprint": "string",
  • "date": "2019-08-24",
  • "valueDate": "2019-08-24",
  • "amountCents": 0,
  • "direction": "credit",
  • "label": "string",
  • "reference": "string",
  • "counterparty": "string",
  • "operationCode": "string",
  • "bankDetails": { },
  • "status": "pending",
  • "triage": {
    },
  • "proposal": {
    },
  • "openProposals": [
    ],
  • "reconciliation": {
    },
  • "suspense": {
    }
}

Valider la proposition ouverte

Valide la proposition (ou l'alternative choisie d'une ambiguë) par les gestes de rapprochement habituels. Réservé à qui peut rapprocher (loctavia.op.rapprocher), en pratique l'analyste bancaire Synapse authentifié par son propre jeton d'agent (jamais délégué) : les mêmes gestes que le gestionnaire à l'écran, par les mêmes règles ; chaque geste d'un agent est enregistré en mode ai, signé par lui.

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
alternative
integer or null

Index de l'alternative retenue (proposition ambiguë).

rationale
string or null <= 2000 characters

Pourquoi ce geste, en une phrase pour le gestionnaire (affichée à l'écran).

Responses

Request samples

Content type
application/json
{
  • "alternative": 0,
  • "rationale": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "statementId": "775b692d-f1fa-4640-9327-0c9bb8d02222",
  • "canonicalIndex": 0,
  • "fingerprint": "string",
  • "date": "2019-08-24",
  • "valueDate": "2019-08-24",
  • "amountCents": 0,
  • "direction": "credit",
  • "label": "string",
  • "reference": "string",
  • "counterparty": "string",
  • "operationCode": "string",
  • "bankDetails": { },
  • "status": "pending",
  • "triage": {
    },
  • "proposal": {
    },
  • "openProposals": [
    ],
  • "reconciliation": {
    },
  • "suspense": {
    }
}

Rejeter la proposition ouverte

La proposition rejetée n'est plus jamais refaite sur l'opération. Réservé à qui peut rapprocher (loctavia.op.rapprocher), en pratique l'analyste bancaire Synapse authentifié par son propre jeton d'agent (jamais délégué) : les mêmes gestes que le gestionnaire à l'écran, par les mêmes règles ; chaque geste d'un agent est enregistré en mode ai, signé par lui.

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "statementId": "775b692d-f1fa-4640-9327-0c9bb8d02222",
  • "canonicalIndex": 0,
  • "fingerprint": "string",
  • "date": "2019-08-24",
  • "valueDate": "2019-08-24",
  • "amountCents": 0,
  • "direction": "credit",
  • "label": "string",
  • "reference": "string",
  • "counterparty": "string",
  • "operationCode": "string",
  • "bankDetails": { },
  • "status": "pending",
  • "triage": {
    },
  • "proposal": {
    },
  • "openProposals": [
    ],
  • "reconciliation": {
    },
  • "suspense": {
    }
}

Rapprocher un encaissement

Impute l'encaissement sur des échéances et des factures, d'un ou plusieurs baux (un paiement par bail). Réservé à qui peut rapprocher (loctavia.op.rapprocher), en pratique l'analyste bancaire Synapse authentifié par son propre jeton d'agent (jamais délégué) : les mêmes gestes que le gestionnaire à l'écran, par les mêmes règles ; chaque geste d'un agent est enregistré en mode ai, signé par lui.

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
Array of objects non-empty
rationale
string or null <= 2000 characters

Pourquoi ce geste, en une phrase pour le gestionnaire (affichée à l'écran).

Responses

Request samples

Content type
application/json
{
  • "allocations": [
    ],
  • "rationale": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "statementId": "775b692d-f1fa-4640-9327-0c9bb8d02222",
  • "canonicalIndex": 0,
  • "fingerprint": "string",
  • "date": "2019-08-24",
  • "valueDate": "2019-08-24",
  • "amountCents": 0,
  • "direction": "credit",
  • "label": "string",
  • "reference": "string",
  • "counterparty": "string",
  • "operationCode": "string",
  • "bankDetails": { },
  • "status": "pending",
  • "triage": {
    },
  • "proposal": {
    },
  • "openProposals": [
    ],
  • "reconciliation": {
    },
  • "suspense": {
    }
}

Lister ce qu'un débit peut régler

Ordres de virement ouverts et factures à payer prélevées. Réservé à qui peut rapprocher (loctavia.op.rapprocher), en pratique l'analyste bancaire Synapse authentifié par son propre jeton d'agent (jamais délégué) : les mêmes gestes que le gestionnaire à l'écran, par les mêmes règles ; chaque geste d'un agent est enregistré en mode ai, signé par lui.

Authorizations:
BearerAuthOAuth2Password
path Parameters
id
required
string <uuid>
query Parameters
q
string

Bénéficiaire ou référence.

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
{
  • "orders": [
    ],
  • "charges": [
    ]
}

Rapprocher un débit

Rapproche le débit sur des lignes d'ordres de virement et des factures prélevées, et exécute ce qu'il règle. Réservé à qui peut rapprocher (loctavia.op.rapprocher), en pratique l'analyste bancaire Synapse authentifié par son propre jeton d'agent (jamais délégué) : les mêmes gestes que le gestionnaire à l'écran, par les mêmes règles ; chaque geste d'un agent est enregistré en mode ai, signé par lui.

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
payment_order_line_ids
Array of strings <uuid> [ items <uuid > ]
charge_ids
Array of strings <uuid> [ items <uuid > ]
rationale
string or null <= 2000 characters

Pourquoi ce geste, en une phrase pour le gestionnaire (affichée à l'écran).

Responses

Request samples

Content type
application/json
{
  • "payment_order_line_ids": [
    ],
  • "charge_ids": [
    ],
  • "rationale": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "statementId": "775b692d-f1fa-4640-9327-0c9bb8d02222",
  • "canonicalIndex": 0,
  • "fingerprint": "string",
  • "date": "2019-08-24",
  • "valueDate": "2019-08-24",
  • "amountCents": 0,
  • "direction": "credit",
  • "label": "string",
  • "reference": "string",
  • "counterparty": "string",
  • "operationCode": "string",
  • "bankDetails": { },
  • "status": "pending",
  • "triage": {
    },
  • "proposal": {
    },
  • "openProposals": [
    ],
  • "reconciliation": {
    },
  • "suspense": {
    }
}

Lister les comptes de frais bancaires

Comptes de frais du cabinet (le compte par défaut en premier) et porteur proposé. Réservé à qui peut rapprocher (loctavia.op.rapprocher), en pratique l'analyste bancaire Synapse authentifié par son propre jeton d'agent (jamais délégué) : les mêmes gestes que le gestionnaire à l'écran, par les mêmes règles ; chaque geste d'un agent est enregistré en mode ai, signé par lui.

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "accounts": [
    ],
  • "bearer": "cabinet",
  • "owner": {
    }
}

Imputer des frais bancaires

Impute le débit sur un compte de charge du cabinet, ou sur le propriétaire qui supporte les frais. Réservé à qui peut rapprocher (loctavia.op.rapprocher), en pratique l'analyste bancaire Synapse authentifié par son propre jeton d'agent (jamais délégué) : les mêmes gestes que le gestionnaire à l'écran, par les mêmes règles ; chaque geste d'un agent est enregistré en mode ai, signé par lui.

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
account_id
string or null <uuid>
owner_profile_id
string or null <uuid>
mandate_id
string or null <uuid>

Mandat du propriétaire qui supporte les frais : les fonds sortent de ce mandat. Requis quand le propriétaire en a plusieurs et que l'immeuble de l'opération ne le désigne pas.

rationale
string or null <= 2000 characters

Pourquoi ce geste, en une phrase pour le gestionnaire (affichée à l'écran).

Responses

Request samples

Content type
application/json
{
  • "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
  • "owner_profile_id": "21e0f360-ea66-4de2-b817-b59c51592556",
  • "mandate_id": "e98a8906-c5df-4f83-89a8-e8197c5fddcb",
  • "rationale": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "statementId": "775b692d-f1fa-4640-9327-0c9bb8d02222",
  • "canonicalIndex": 0,
  • "fingerprint": "string",
  • "date": "2019-08-24",
  • "valueDate": "2019-08-24",
  • "amountCents": 0,
  • "direction": "credit",
  • "label": "string",
  • "reference": "string",
  • "counterparty": "string",
  • "operationCode": "string",
  • "bankDetails": { },
  • "status": "pending",
  • "triage": {
    },
  • "proposal": {
    },
  • "openProposals": [
    ],
  • "reconciliation": {
    },
  • "suspense": {
    }
}

Lister les autres comptes bancaires

Comptes bancaires du cabinet vers ou depuis lesquels un virement interne est possible. Réservé à qui peut rapprocher (loctavia.op.rapprocher), en pratique l'analyste bancaire Synapse authentifié par son propre jeton d'agent (jamais délégué) : les mêmes gestes que le gestionnaire à l'écran, par les mêmes règles ; chaque geste d'un agent est enregistré en mode ai, signé par lui.

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Rapprocher un virement interne

Rapproche un virement entre deux comptes bancaires du cabinet. Réservé à qui peut rapprocher (loctavia.op.rapprocher), en pratique l'analyste bancaire Synapse authentifié par son propre jeton d'agent (jamais délégué) : les mêmes gestes que le gestionnaire à l'écran, par les mêmes règles ; chaque geste d'un agent est enregistré en mode ai, signé par lui.

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
bank_account_id
required
string <uuid>
rationale
string or null <= 2000 characters

Pourquoi ce geste, en une phrase pour le gestionnaire (affichée à l'écran).

Responses

Request samples

Content type
application/json
{
  • "bank_account_id": "9335a679-63ab-44d5-9de9-e01e0c5a1fff",
  • "rationale": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "statementId": "775b692d-f1fa-4640-9327-0c9bb8d02222",
  • "canonicalIndex": 0,
  • "fingerprint": "string",
  • "date": "2019-08-24",
  • "valueDate": "2019-08-24",
  • "amountCents": 0,
  • "direction": "credit",
  • "label": "string",
  • "reference": "string",
  • "counterparty": "string",
  • "operationCode": "string",
  • "bankDetails": { },
  • "status": "pending",
  • "triage": {
    },
  • "proposal": {
    },
  • "openProposals": [
    ],
  • "reconciliation": {
    },
  • "suspense": {
    }
}

Mettre un encaissement en attente

Porte l'encaissement sur le compte d'attente d'un immeuble. Réservé à qui peut rapprocher (loctavia.op.rapprocher), en pratique l'analyste bancaire Synapse authentifié par son propre jeton d'agent (jamais délégué) : les mêmes gestes que le gestionnaire à l'écran, par les mêmes règles ; chaque geste d'un agent est enregistré en mode ai, signé par lui.

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
property_id
required
string <uuid>
label
string or null
rationale
string or null <= 2000 characters

Pourquoi ce geste, en une phrase pour le gestionnaire (affichée à l'écran).

Responses

Request samples

Content type
application/json
{
  • "property_id": "05003a8a-8f3c-454b-8884-a906ec46f5f5",
  • "label": "string",
  • "rationale": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "statementId": "775b692d-f1fa-4640-9327-0c9bb8d02222",
  • "canonicalIndex": 0,
  • "fingerprint": "string",
  • "date": "2019-08-24",
  • "valueDate": "2019-08-24",
  • "amountCents": 0,
  • "direction": "credit",
  • "label": "string",
  • "reference": "string",
  • "counterparty": "string",
  • "operationCode": "string",
  • "bankDetails": { },
  • "status": "pending",
  • "triage": {
    },
  • "proposal": {
    },
  • "openProposals": [
    ],
  • "reconciliation": {
    },
  • "suspense": {
    }
}

Prévoir l'annulation d'un rapprochement

Paiements, écritures, lettrages et blocages qu'impliquerait l'annulation. Réservé à qui peut rapprocher (loctavia.op.rapprocher), en pratique l'analyste bancaire Synapse authentifié par son propre jeton d'agent (jamais délégué) : les mêmes gestes que le gestionnaire à l'écran, par les mêmes règles ; chaque geste d'un agent est enregistré en mode ai, signé par lui.

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "payments": [
    ],
  • "keptPayments": [
    ],
  • "entries": [
    ],
  • "undoneTransfers": [
    ],
  • "invoices": [
    ],
  • "letteringsCount": 0,
  • "transfersCount": 0,
  • "blockers": [
    ]
}

Annuler un rapprochement

Écritures extournées, lettrages levés, paiements nés du rapprochement supprimés. Réservé à qui peut rapprocher (loctavia.op.rapprocher), en pratique l'analyste bancaire Synapse authentifié par son propre jeton d'agent (jamais délégué) : les mêmes gestes que le gestionnaire à l'écran, par les mêmes règles ; chaque geste d'un agent est enregistré en mode ai, signé par lui.

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
reason
string or null

Responses

Request samples

Content type
application/json
{
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "statementId": "775b692d-f1fa-4640-9327-0c9bb8d02222",
  • "canonicalIndex": 0,
  • "fingerprint": "string",
  • "date": "2019-08-24",
  • "valueDate": "2019-08-24",
  • "amountCents": 0,
  • "direction": "credit",
  • "label": "string",
  • "reference": "string",
  • "counterparty": "string",
  • "operationCode": "string",
  • "bankDetails": { },
  • "status": "pending",
  • "triage": {
    },
  • "proposal": {
    },
  • "openProposals": [
    ],
  • "reconciliation": {
    },
  • "suspense": {
    }
}

Lister comptes bancaires

Authorizations:
BearerAuthOAuth2Password
query Parameters
page
integer >= 1
Default: 1
per_page
integer >= 1
Default: 25

Valeur plafonnée à 100.

sort
string
Enum: "id" "mandataire_id" "accountable_id" "accountable_type" "label" "holder_name" "iban" "bic" "bank_name" "is_default" "purpose" "status" "is_segregated" "opened_on" "closed_on" "created_at" "updated_at"
direction
string
Enum: "asc" "desc"
search
string <= 200 characters
updated_since
string <date-time>
q
object
Example:

Filtres autorisés sur les champs publics : suffixes _eq, _in, _cont (texte), _gteq, _lteq. Une valeur inconnue renvoie 400. La chaîne historique q est un alias de search.

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 comptes bancaires

Authorizations:
BearerAuthOAuth2Password
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "bank_account": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "accountableId": "7a564b68-9ab4-4a88-8e4d-5e5b25fec3dd",
  • "accountableType": "string",
  • "label": "string",
  • "holderName": "string",
  • "iban": "string",
  • "bic": "string",
  • "bankName": "string",
  • "isDefault": true,
  • "purpose": "string",
  • "status": "string",
  • "isSegregated": true,
  • "openedOn": "2019-08-24",
  • "closedOn": "2019-08-24",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Consulter comptes bancaires

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "accountableId": "7a564b68-9ab4-4a88-8e4d-5e5b25fec3dd",
  • "accountableType": "string",
  • "label": "string",
  • "holderName": "string",
  • "iban": "string",
  • "bic": "string",
  • "bankName": "string",
  • "isDefault": true,
  • "purpose": "string",
  • "status": "string",
  • "isSegregated": true,
  • "openedOn": "2019-08-24",
  • "closedOn": "2019-08-24",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Modifier comptes bancaires

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "bank_account": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "accountableId": "7a564b68-9ab4-4a88-8e4d-5e5b25fec3dd",
  • "accountableType": "string",
  • "label": "string",
  • "holderName": "string",
  • "iban": "string",
  • "bic": "string",
  • "bankName": "string",
  • "isDefault": true,
  • "purpose": "string",
  • "status": "string",
  • "isSegregated": true,
  • "openedOn": "2019-08-24",
  • "closedOn": "2019-08-24",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Modifier comptes bancaires

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "bank_account": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "accountableId": "7a564b68-9ab4-4a88-8e4d-5e5b25fec3dd",
  • "accountableType": "string",
  • "label": "string",
  • "holderName": "string",
  • "iban": "string",
  • "bic": "string",
  • "bankName": "string",
  • "isDefault": true,
  • "purpose": "string",
  • "status": "string",
  • "isSegregated": true,
  • "openedOn": "2019-08-24",
  • "closedOn": "2019-08-24",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Retirer comptes bancaires

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

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

Loctavia — Charges et budgets

Charges et budgets : consultation et actions métier sous autorisation.

Consulter les allocations des clés de répartition

Authorizations:
BearerAuthOAuth2Password
path Parameters
id
required
string <uuid>
query Parameters
page
integer >= 1
Default: 1
per_page
integer >= 1
Default: 25

Valeur plafonnée à 100.

sort
string
Enum: "id" "property_id" "name" "total" "charge_nature_id" "distribution_strategy" "excluded_unit_types" "created_at" "updated_at"
direction
string
Enum: "asc" "desc"
search
string <= 200 characters
updated_since
string <date-time>
q
object
Example:

Filtres autorisés sur les champs publics : suffixes _eq, _in, _cont (texte), _gteq, _lteq. Une valeur inconnue renvoie 400. La chaîne historique q est un alias de search.

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
[
  • {
    }
]

Modifier les allocations des clés de répartition

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "allocations": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",
  • "name": "string",
  • "total": 0,
  • "chargeNatureId": "bcba10fb-4f9d-4d10-8294-bb345b911779",
  • "distributionStrategy": "manual",
  • "excludedUnitTypes": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "allocations": [
    ]
}

Lister clés de répartition

Authorizations:
BearerAuthOAuth2Password
query Parameters
page
integer >= 1
Default: 1
per_page
integer >= 1
Default: 25

Valeur plafonnée à 100.

sort
string
Enum: "id" "property_id" "name" "total" "charge_nature_id" "distribution_strategy" "excluded_unit_types" "created_at" "updated_at"
direction
string
Enum: "asc" "desc"
search
string <= 200 characters
updated_since
string <date-time>
q
object
Example:

Filtres autorisés sur les champs publics : suffixes _eq, _in, _cont (texte), _gteq, _lteq. Une valeur inconnue renvoie 400. La chaîne historique q est un alias de search.

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 clés de répartition

Authorizations:
BearerAuthOAuth2Password
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "share_key": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",
  • "name": "string",
  • "total": 0,
  • "chargeNatureId": "bcba10fb-4f9d-4d10-8294-bb345b911779",
  • "distributionStrategy": "manual",
  • "excludedUnitTypes": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "allocations": [
    ]
}

Consulter clés de répartition

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",
  • "name": "string",
  • "total": 0,
  • "chargeNatureId": "bcba10fb-4f9d-4d10-8294-bb345b911779",
  • "distributionStrategy": "manual",
  • "excludedUnitTypes": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "allocations": [
    ]
}

Modifier clés de répartition

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "share_key": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",
  • "name": "string",
  • "total": 0,
  • "chargeNatureId": "bcba10fb-4f9d-4d10-8294-bb345b911779",
  • "distributionStrategy": "manual",
  • "excludedUnitTypes": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "allocations": [
    ]
}

Modifier clés de répartition

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "share_key": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",
  • "name": "string",
  • "total": 0,
  • "chargeNatureId": "bcba10fb-4f9d-4d10-8294-bb345b911779",
  • "distributionStrategy": "manual",
  • "excludedUnitTypes": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "allocations": [
    ]
}

Retirer clés de répartition

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

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

Lister natures de charges

Authorizations:
BearerAuthOAuth2Password
query Parameters
page
integer >= 1
Default: 1
per_page
integer >= 1
Default: 25

Valeur plafonnée à 100.

sort
string
Enum: "id" "mandataire_id" "code" "name" "description" "kind" "recoverable_rate" "allocation_default" "legal_reference" "created_at" "updated_at"
direction
string
Enum: "asc" "desc"
search
string <= 200 characters
updated_since
string <date-time>
q
object
Example:

Filtres autorisés sur les champs publics : suffixes _eq, _in, _cont (texte), _gteq, _lteq. Une valeur inconnue renvoie 400. La chaîne historique q est un alias de search.

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 natures de charges

Authorizations:
BearerAuthOAuth2Password
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "charge_nature": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "kind": "operating",
  • "recoverableRate": 0,
  • "allocationDefault": "tantiemes",
  • "legalReference": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Consulter natures de charges

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "kind": "operating",
  • "recoverableRate": 0,
  • "allocationDefault": "tantiemes",
  • "legalReference": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Modifier natures de charges

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "charge_nature": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "kind": "operating",
  • "recoverableRate": 0,
  • "allocationDefault": "tantiemes",
  • "legalReference": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Modifier natures de charges

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "charge_nature": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "kind": "operating",
  • "recoverableRate": 0,
  • "allocationDefault": "tantiemes",
  • "legalReference": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Retirer natures de charges

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

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

Activer enveloppes budgétaires

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "name": "string",
  • "scope": "property",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "estimatedAmountCents": 0,
  • "status": "draft",
  • "distributionStrategy": "by_area",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "previousEnvelopeId": "fb4a188b-1a12-45df-9002-c1a3793f6cc5",
  • "budgetLineIds": [
    ]
}

Initialiser les lignes des enveloppes budgétaires

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
strategy
string
replace_existing
boolean
property_ids
Array of strings <uuid> [ items <uuid > ]
charge_nature_ids
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "strategy": "string",
  • "replace_existing": true,
  • "property_ids": [
    ],
  • "charge_nature_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "name": "string",
  • "scope": "property",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "estimatedAmountCents": 0,
  • "status": "draft",
  • "distributionStrategy": "by_area",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "previousEnvelopeId": "fb4a188b-1a12-45df-9002-c1a3793f6cc5",
  • "budgetLineIds": [
    ]
}

Lister enveloppes budgétaires

Authorizations:
BearerAuthOAuth2Password
query Parameters
page
integer >= 1
Default: 1
per_page
integer >= 1
Default: 25

Valeur plafonnée à 100.

sort
string
Enum: "id" "mandataire_id" "name" "scope" "period_start" "period_end" "estimated_amount_cents" "status" "distribution_strategy" "created_at" "updated_at" "previous_envelope_id"
direction
string
Enum: "asc" "desc"
search
string <= 200 characters
updated_since
string <date-time>
q
object
Example:

Filtres autorisés sur les champs publics : suffixes _eq, _in, _cont (texte), _gteq, _lteq. Une valeur inconnue renvoie 400. La chaîne historique q est un alias de search.

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 enveloppes budgétaires

Authorizations:
BearerAuthOAuth2Password
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "budget_envelope": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "name": "string",
  • "scope": "property",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "estimatedAmountCents": 0,
  • "status": "draft",
  • "distributionStrategy": "by_area",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "previousEnvelopeId": "fb4a188b-1a12-45df-9002-c1a3793f6cc5",
  • "budgetLineIds": [
    ]
}

Consulter enveloppes budgétaires

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "name": "string",
  • "scope": "property",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "estimatedAmountCents": 0,
  • "status": "draft",
  • "distributionStrategy": "by_area",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "previousEnvelopeId": "fb4a188b-1a12-45df-9002-c1a3793f6cc5",
  • "budgetLineIds": [
    ]
}

Modifier enveloppes budgétaires

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "budget_envelope": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "name": "string",
  • "scope": "property",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "estimatedAmountCents": 0,
  • "status": "draft",
  • "distributionStrategy": "by_area",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "previousEnvelopeId": "fb4a188b-1a12-45df-9002-c1a3793f6cc5",
  • "budgetLineIds": [
    ]
}

Modifier enveloppes budgétaires

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "budget_envelope": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "name": "string",
  • "scope": "property",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "estimatedAmountCents": 0,
  • "status": "draft",
  • "distributionStrategy": "by_area",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "previousEnvelopeId": "fb4a188b-1a12-45df-9002-c1a3793f6cc5",
  • "budgetLineIds": [
    ]
}

Retirer enveloppes budgétaires

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

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

Activer lignes budgétaires

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",
  • "chargeNatureId": "bcba10fb-4f9d-4d10-8294-bb345b911779",
  • "shareKeyId": "e0c7387f-a5dd-4fbd-8652-040b03aded20",
  • "previousBudgetId": "da7c2cb4-3402-4bce-9df0-d73ba53c770d",
  • "reference": "string",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "estimatedAmountCents": 0,
  • "estimatedAmountCurrency": "string",
  • "status": "draft",
  • "activatedAt": "2019-08-24T14:15:22Z",
  • "closedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "envelopeId": "9494e254-c08a-4611-806e-b9c722e2fe3d"
}

Réviser lignes budgétaires

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "revision": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",
  • "chargeNatureId": "bcba10fb-4f9d-4d10-8294-bb345b911779",
  • "shareKeyId": "e0c7387f-a5dd-4fbd-8652-040b03aded20",
  • "previousBudgetId": "da7c2cb4-3402-4bce-9df0-d73ba53c770d",
  • "reference": "string",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "estimatedAmountCents": 0,
  • "estimatedAmountCurrency": "string",
  • "status": "draft",
  • "activatedAt": "2019-08-24T14:15:22Z",
  • "closedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "envelopeId": "9494e254-c08a-4611-806e-b9c722e2fe3d"
}

Réviser les provisions des lignes budgétaires

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

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

Responses

Request samples

Content type
application/json
{
  • "effective_from": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",
  • "chargeNatureId": "bcba10fb-4f9d-4d10-8294-bb345b911779",
  • "shareKeyId": "e0c7387f-a5dd-4fbd-8652-040b03aded20",
  • "previousBudgetId": "da7c2cb4-3402-4bce-9df0-d73ba53c770d",
  • "reference": "string",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "estimatedAmountCents": 0,
  • "estimatedAmountCurrency": "string",
  • "status": "draft",
  • "activatedAt": "2019-08-24T14:15:22Z",
  • "closedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "envelopeId": "9494e254-c08a-4611-806e-b9c722e2fe3d"
}

Dupliquer lignes budgétaires

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",
  • "chargeNatureId": "bcba10fb-4f9d-4d10-8294-bb345b911779",
  • "shareKeyId": "e0c7387f-a5dd-4fbd-8652-040b03aded20",
  • "previousBudgetId": "da7c2cb4-3402-4bce-9df0-d73ba53c770d",
  • "reference": "string",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "estimatedAmountCents": 0,
  • "estimatedAmountCurrency": "string",
  • "status": "draft",
  • "activatedAt": "2019-08-24T14:15:22Z",
  • "closedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "envelopeId": "9494e254-c08a-4611-806e-b9c722e2fe3d"
}

Lister lignes budgétaires

Authorizations:
BearerAuthOAuth2Password
query Parameters
page
integer >= 1
Default: 1
per_page
integer >= 1
Default: 25

Valeur plafonnée à 100.

sort
string
Enum: "id" "mandataire_id" "property_id" "charge_nature_id" "share_key_id" "previous_budget_id" "reference" "period_start" "period_end" "estimated_amount_cents" "estimated_amount_currency" "status" "activated_at" "closed_at" "created_at" "updated_at" "envelope_id"
direction
string
Enum: "asc" "desc"
search
string <= 200 characters
updated_since
string <date-time>
q
object
Example:

Filtres autorisés sur les champs publics : suffixes _eq, _in, _cont (texte), _gteq, _lteq. Une valeur inconnue renvoie 400. La chaîne historique q est un alias de search.

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 lignes budgétaires

Authorizations:
BearerAuthOAuth2Password
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "budget_line": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",
  • "chargeNatureId": "bcba10fb-4f9d-4d10-8294-bb345b911779",
  • "shareKeyId": "e0c7387f-a5dd-4fbd-8652-040b03aded20",
  • "previousBudgetId": "da7c2cb4-3402-4bce-9df0-d73ba53c770d",
  • "reference": "string",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "estimatedAmountCents": 0,
  • "estimatedAmountCurrency": "string",
  • "status": "draft",
  • "activatedAt": "2019-08-24T14:15:22Z",
  • "closedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "envelopeId": "9494e254-c08a-4611-806e-b9c722e2fe3d"
}

Consulter lignes budgétaires

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",
  • "chargeNatureId": "bcba10fb-4f9d-4d10-8294-bb345b911779",
  • "shareKeyId": "e0c7387f-a5dd-4fbd-8652-040b03aded20",
  • "previousBudgetId": "da7c2cb4-3402-4bce-9df0-d73ba53c770d",
  • "reference": "string",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "estimatedAmountCents": 0,
  • "estimatedAmountCurrency": "string",
  • "status": "draft",
  • "activatedAt": "2019-08-24T14:15:22Z",
  • "closedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "envelopeId": "9494e254-c08a-4611-806e-b9c722e2fe3d"
}

Modifier lignes budgétaires

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "budget_line": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",
  • "chargeNatureId": "bcba10fb-4f9d-4d10-8294-bb345b911779",
  • "shareKeyId": "e0c7387f-a5dd-4fbd-8652-040b03aded20",
  • "previousBudgetId": "da7c2cb4-3402-4bce-9df0-d73ba53c770d",
  • "reference": "string",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "estimatedAmountCents": 0,
  • "estimatedAmountCurrency": "string",
  • "status": "draft",
  • "activatedAt": "2019-08-24T14:15:22Z",
  • "closedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "envelopeId": "9494e254-c08a-4611-806e-b9c722e2fe3d"
}

Modifier lignes budgétaires

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "budget_line": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",
  • "chargeNatureId": "bcba10fb-4f9d-4d10-8294-bb345b911779",
  • "shareKeyId": "e0c7387f-a5dd-4fbd-8652-040b03aded20",
  • "previousBudgetId": "da7c2cb4-3402-4bce-9df0-d73ba53c770d",
  • "reference": "string",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "estimatedAmountCents": 0,
  • "estimatedAmountCurrency": "string",
  • "status": "draft",
  • "activatedAt": "2019-08-24T14:15:22Z",
  • "closedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "envelopeId": "9494e254-c08a-4611-806e-b9c722e2fe3d"
}

Retirer lignes budgétaires

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

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

validate charge — charges

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "budgetId": "fcf1d230-a9d0-4836-9e20-f98f3396e01b",
  • "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
  • "leaseId": "a3abd432-1f03-4b93-888c-0da4d3703e99",
  • "amountCurrency": "string",
  • "entryDate": "2019-08-24",
  • "supplierName": "string",
  • "invoiceNumber": "string",
  • "description": "string",
  • "status": "pending",
  • "validatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "amountHtCents": 0,
  • "vatRate": 0,
  • "vatAmountCents": 0,
  • "amountTtcCents": 0,
  • "kind": "invoice",
  • "commitmentLineId": "99180ef4-415f-45c1-858f-bfc2c2a4d63a",
  • "supplierSiren": "string",
  • "supplierContactId": "a6a61f88-2db9-400d-a12b-6191eddf0f56"
}

Lister charges

Authorizations:
BearerAuthOAuth2Password
query Parameters
page
integer >= 1
Default: 1
per_page
integer >= 1
Default: 25

Valeur plafonnée à 100.

sort
string
Enum: "id" "budget_id" "invoice_id" "lease_id" "amount_currency" "entry_date" "supplier_name" "invoice_number" "description" "status" "validated_at" "created_at" "updated_at" "amount_ht_cents" "vat_rate" "vat_amount_cents" "amount_ttc_cents" "kind" "commitment_line_id" "supplier_siren" "supplier_contact_id"
direction
string
Enum: "asc" "desc"
search
string <= 200 characters
updated_since
string <date-time>
q
object
Example:

Filtres autorisés sur les champs publics : suffixes _eq, _in, _cont (texte), _gteq, _lteq. Une valeur inconnue renvoie 400. La chaîne historique q est un alias de search.

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 charges

Authorizations:
BearerAuthOAuth2Password
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "charge": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "budgetId": "fcf1d230-a9d0-4836-9e20-f98f3396e01b",
  • "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
  • "leaseId": "a3abd432-1f03-4b93-888c-0da4d3703e99",
  • "amountCurrency": "string",
  • "entryDate": "2019-08-24",
  • "supplierName": "string",
  • "invoiceNumber": "string",
  • "description": "string",
  • "status": "pending",
  • "validatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "amountHtCents": 0,
  • "vatRate": 0,
  • "vatAmountCents": 0,
  • "amountTtcCents": 0,
  • "kind": "invoice",
  • "commitmentLineId": "99180ef4-415f-45c1-858f-bfc2c2a4d63a",
  • "supplierSiren": "string",
  • "supplierContactId": "a6a61f88-2db9-400d-a12b-6191eddf0f56"
}

Consulter charges

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "budgetId": "fcf1d230-a9d0-4836-9e20-f98f3396e01b",
  • "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
  • "leaseId": "a3abd432-1f03-4b93-888c-0da4d3703e99",
  • "amountCurrency": "string",
  • "entryDate": "2019-08-24",
  • "supplierName": "string",
  • "invoiceNumber": "string",
  • "description": "string",
  • "status": "pending",
  • "validatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "amountHtCents": 0,
  • "vatRate": 0,
  • "vatAmountCents": 0,
  • "amountTtcCents": 0,
  • "kind": "invoice",
  • "commitmentLineId": "99180ef4-415f-45c1-858f-bfc2c2a4d63a",
  • "supplierSiren": "string",
  • "supplierContactId": "a6a61f88-2db9-400d-a12b-6191eddf0f56"
}

Modifier charges

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "charge": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "budgetId": "fcf1d230-a9d0-4836-9e20-f98f3396e01b",
  • "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
  • "leaseId": "a3abd432-1f03-4b93-888c-0da4d3703e99",
  • "amountCurrency": "string",
  • "entryDate": "2019-08-24",
  • "supplierName": "string",
  • "invoiceNumber": "string",
  • "description": "string",
  • "status": "pending",
  • "validatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "amountHtCents": 0,
  • "vatRate": 0,
  • "vatAmountCents": 0,
  • "amountTtcCents": 0,
  • "kind": "invoice",
  • "commitmentLineId": "99180ef4-415f-45c1-858f-bfc2c2a4d63a",
  • "supplierSiren": "string",
  • "supplierContactId": "a6a61f88-2db9-400d-a12b-6191eddf0f56"
}

Modifier charges

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "charge": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "budgetId": "fcf1d230-a9d0-4836-9e20-f98f3396e01b",
  • "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec",
  • "leaseId": "a3abd432-1f03-4b93-888c-0da4d3703e99",
  • "amountCurrency": "string",
  • "entryDate": "2019-08-24",
  • "supplierName": "string",
  • "invoiceNumber": "string",
  • "description": "string",
  • "status": "pending",
  • "validatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "amountHtCents": 0,
  • "vatRate": 0,
  • "vatAmountCents": 0,
  • "amountTtcCents": 0,
  • "kind": "invoice",
  • "commitmentLineId": "99180ef4-415f-45c1-858f-bfc2c2a4d63a",
  • "supplierSiren": "string",
  • "supplierContactId": "a6a61f88-2db9-400d-a12b-6191eddf0f56"
}

Retirer charges

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

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

Clore engagements

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reference": "string",
  • "supplierName": "string",
  • "supplierSiren": "string",
  • "amountCurrency": "string",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "status": "open",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "budgetEnvelopeId": "3613e5d3-cf7c-404b-98ba-5c3dc0dcff6c",
  • "contractRef": "string",
  • "kind": "ponctuel",
  • "signedOn": "2019-08-24",
  • "tacitRenewal": true,
  • "renewalNoticePeriodDays": 0,
  • "terminatedOn": "2019-08-24",
  • "lines": [
    ]
}

Rapprocher une charge des engagements

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
commitment_line_id
required
string <uuid>
charge_id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "commitment_line_id": "5e082499-9cf6-452b-83de-eec40e311f9a",
  • "charge_id": "cf8b747b-a752-4d0a-9a4d-7d19fc1769f3"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reference": "string",
  • "supplierName": "string",
  • "supplierSiren": "string",
  • "amountCurrency": "string",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "status": "open",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "budgetEnvelopeId": "3613e5d3-cf7c-404b-98ba-5c3dc0dcff6c",
  • "contractRef": "string",
  • "kind": "ponctuel",
  • "signedOn": "2019-08-24",
  • "tacitRenewal": true,
  • "renewalNoticePeriodDays": 0,
  • "terminatedOn": "2019-08-24",
  • "lines": [
    ]
}

Lister engagements

Authorizations:
BearerAuthOAuth2Password
query Parameters
page
integer >= 1
Default: 1
per_page
integer >= 1
Default: 25

Valeur plafonnée à 100.

sort
string
Enum: "id" "reference" "supplier_name" "supplier_siren" "amount_currency" "period_start" "period_end" "status" "created_at" "updated_at" "budget_envelope_id" "contract_ref" "kind" "signed_on" "tacit_renewal" "renewal_notice_period_days" "terminated_on"
direction
string
Enum: "asc" "desc"
search
string <= 200 characters
updated_since
string <date-time>
q
object
Example:

Filtres autorisés sur les champs publics : suffixes _eq, _in, _cont (texte), _gteq, _lteq. Une valeur inconnue renvoie 400. La chaîne historique q est un alias de search.

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 engagements

Authorizations:
BearerAuthOAuth2Password
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "commitment": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reference": "string",
  • "supplierName": "string",
  • "supplierSiren": "string",
  • "amountCurrency": "string",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "status": "open",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "budgetEnvelopeId": "3613e5d3-cf7c-404b-98ba-5c3dc0dcff6c",
  • "contractRef": "string",
  • "kind": "ponctuel",
  • "signedOn": "2019-08-24",
  • "tacitRenewal": true,
  • "renewalNoticePeriodDays": 0,
  • "terminatedOn": "2019-08-24",
  • "lines": [
    ]
}

Consulter engagements

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reference": "string",
  • "supplierName": "string",
  • "supplierSiren": "string",
  • "amountCurrency": "string",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "status": "open",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "budgetEnvelopeId": "3613e5d3-cf7c-404b-98ba-5c3dc0dcff6c",
  • "contractRef": "string",
  • "kind": "ponctuel",
  • "signedOn": "2019-08-24",
  • "tacitRenewal": true,
  • "renewalNoticePeriodDays": 0,
  • "terminatedOn": "2019-08-24",
  • "lines": [
    ]
}

Modifier engagements

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "commitment": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reference": "string",
  • "supplierName": "string",
  • "supplierSiren": "string",
  • "amountCurrency": "string",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "status": "open",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "budgetEnvelopeId": "3613e5d3-cf7c-404b-98ba-5c3dc0dcff6c",
  • "contractRef": "string",
  • "kind": "ponctuel",
  • "signedOn": "2019-08-24",
  • "tacitRenewal": true,
  • "renewalNoticePeriodDays": 0,
  • "terminatedOn": "2019-08-24",
  • "lines": [
    ]
}

Modifier engagements

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "commitment": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reference": "string",
  • "supplierName": "string",
  • "supplierSiren": "string",
  • "amountCurrency": "string",
  • "periodStart": "2019-08-24",
  • "periodEnd": "2019-08-24",
  • "status": "open",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "budgetEnvelopeId": "3613e5d3-cf7c-404b-98ba-5c3dc0dcff6c",
  • "contractRef": "string",
  • "kind": "ponctuel",
  • "signedOn": "2019-08-24",
  • "tacitRenewal": true,
  • "renewalNoticePeriodDays": 0,
  • "terminatedOn": "2019-08-24",
  • "lines": [
    ]
}

Retirer engagements

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

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

Lister provisions

Authorizations:
BearerAuthOAuth2Password
query Parameters
page
integer >= 1
Default: 1
per_page
integer >= 1
Default: 25

Valeur plafonnée à 100.

sort
string
Enum: "id" "budget_id" "lease_id" "monthly_amount_cents" "monthly_amount_currency" "effective_from" "effective_until" "allocation_ratio" "is_manual" "created_at" "updated_at"
direction
string
Enum: "asc" "desc"
search
string <= 200 characters
updated_since
string <date-time>
q
object
Example:

Filtres autorisés sur les champs publics : suffixes _eq, _in, _cont (texte), _gteq, _lteq. Une valeur inconnue renvoie 400. La chaîne historique q est un alias de search.

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
[
  • {
    }
]

Consulter provisions

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "budgetId": "fcf1d230-a9d0-4836-9e20-f98f3396e01b",
  • "leaseId": "a3abd432-1f03-4b93-888c-0da4d3703e99",
  • "monthlyAmountCents": 0,
  • "monthlyAmountCurrency": "string",
  • "effectiveFrom": "2019-08-24",
  • "effectiveUntil": "2019-08-24",
  • "allocationRatio": 0,
  • "isManual": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Appliquer clôtures

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
balance_treatment
string
create_next_budget
boolean
next_budget_estimated_amount_cents
integer
next_budget_period_start
string <date>
next_budget_period_end
string <date>

Responses

Request samples

Content type
application/json
{
  • "balance_treatment": "string",
  • "create_next_budget": true,
  • "next_budget_estimated_amount_cents": 0,
  • "next_budget_period_start": "2019-08-24",
  • "next_budget_period_end": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "budgetId": "fcf1d230-a9d0-4836-9e20-f98f3396e01b",
  • "nextBudgetId": "bc824c7f-82c7-4844-9865-7e57f08b33b9",
  • "reference": "string",
  • "status": "draft",
  • "balanceTreatment": "refund_tenants",
  • "totalEstimatedCents": 0,
  • "totalRealCents": 0,
  • "recoverableCents": 0,
  • "balanceCents": 0,
  • "amountCurrency": "string",
  • "appliedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "decompteSentAt": "2019-08-24T14:15:22Z",
  • "parentClosureId": "3de0d669-b914-4ac7-8d61-d918d816722c",
  • "lines": [
    ]
}

Rectifier clôtures

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "budgetId": "fcf1d230-a9d0-4836-9e20-f98f3396e01b",
  • "nextBudgetId": "bc824c7f-82c7-4844-9865-7e57f08b33b9",
  • "reference": "string",
  • "status": "draft",
  • "balanceTreatment": "refund_tenants",
  • "totalEstimatedCents": 0,
  • "totalRealCents": 0,
  • "recoverableCents": 0,
  • "balanceCents": 0,
  • "amountCurrency": "string",
  • "appliedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "decompteSentAt": "2019-08-24T14:15:22Z",
  • "parentClosureId": "3de0d669-b914-4ac7-8d61-d918d816722c",
  • "lines": [
    ]
}

Envoyer les décomptes des clôtures

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "budgetId": "fcf1d230-a9d0-4836-9e20-f98f3396e01b",
  • "nextBudgetId": "bc824c7f-82c7-4844-9865-7e57f08b33b9",
  • "reference": "string",
  • "status": "draft",
  • "balanceTreatment": "refund_tenants",
  • "totalEstimatedCents": 0,
  • "totalRealCents": 0,
  • "recoverableCents": 0,
  • "balanceCents": 0,
  • "amountCurrency": "string",
  • "appliedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "decompteSentAt": "2019-08-24T14:15:22Z",
  • "parentClosureId": "3de0d669-b914-4ac7-8d61-d918d816722c",
  • "lines": [
    ]
}

Télécharger le décompte des clôtures

Authorizations:
BearerAuthOAuth2Password
path Parameters
id
required
string <uuid>
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.

Responses

Response samples

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

Lister clôtures

Authorizations:
BearerAuthOAuth2Password
query Parameters
page
integer >= 1
Default: 1
per_page
integer >= 1
Default: 25

Valeur plafonnée à 100.

sort
string
Enum: "id" "budget_id" "next_budget_id" "reference" "status" "balance_treatment" "total_estimated_cents" "total_real_cents" "recoverable_cents" "balance_cents" "amount_currency" "applied_at" "created_at" "updated_at" "decompte_sent_at" "parent_closure_id"
direction
string
Enum: "asc" "desc"
search
string <= 200 characters
updated_since
string <date-time>
q
object
Example:

Filtres autorisés sur les champs publics : suffixes _eq, _in, _cont (texte), _gteq, _lteq. Une valeur inconnue renvoie 400. La chaîne historique q est un alias de search.

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 clôtures

Authorizations:
BearerAuthOAuth2Password
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.

Request Body schema: application/json
required
budget_id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "budget_id": "66666666-6666-4666-8666-666666666666"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "budgetId": "fcf1d230-a9d0-4836-9e20-f98f3396e01b",
  • "nextBudgetId": "bc824c7f-82c7-4844-9865-7e57f08b33b9",
  • "reference": "string",
  • "status": "draft",
  • "balanceTreatment": "refund_tenants",
  • "totalEstimatedCents": 0,
  • "totalRealCents": 0,
  • "recoverableCents": 0,
  • "balanceCents": 0,
  • "amountCurrency": "string",
  • "appliedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "decompteSentAt": "2019-08-24T14:15:22Z",
  • "parentClosureId": "3de0d669-b914-4ac7-8d61-d918d816722c",
  • "lines": [
    ]
}

Consulter clôtures

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "budgetId": "fcf1d230-a9d0-4836-9e20-f98f3396e01b",
  • "nextBudgetId": "bc824c7f-82c7-4844-9865-7e57f08b33b9",
  • "reference": "string",
  • "status": "draft",
  • "balanceTreatment": "refund_tenants",
  • "totalEstimatedCents": 0,
  • "totalRealCents": 0,
  • "recoverableCents": 0,
  • "balanceCents": 0,
  • "amountCurrency": "string",
  • "appliedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "decompteSentAt": "2019-08-24T14:15:22Z",
  • "parentClosureId": "3de0d669-b914-4ac7-8d61-d918d816722c",
  • "lines": [
    ]
}

Modifier clôtures

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "closure": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "budgetId": "fcf1d230-a9d0-4836-9e20-f98f3396e01b",
  • "nextBudgetId": "bc824c7f-82c7-4844-9865-7e57f08b33b9",
  • "reference": "string",
  • "status": "draft",
  • "balanceTreatment": "refund_tenants",
  • "totalEstimatedCents": 0,
  • "totalRealCents": 0,
  • "recoverableCents": 0,
  • "balanceCents": 0,
  • "amountCurrency": "string",
  • "appliedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "decompteSentAt": "2019-08-24T14:15:22Z",
  • "parentClosureId": "3de0d669-b914-4ac7-8d61-d918d816722c",
  • "lines": [
    ]
}

Modifier clôtures

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "closure": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "budgetId": "fcf1d230-a9d0-4836-9e20-f98f3396e01b",
  • "nextBudgetId": "bc824c7f-82c7-4844-9865-7e57f08b33b9",
  • "reference": "string",
  • "status": "draft",
  • "balanceTreatment": "refund_tenants",
  • "totalEstimatedCents": 0,
  • "totalRealCents": 0,
  • "recoverableCents": 0,
  • "balanceCents": 0,
  • "amountCurrency": "string",
  • "appliedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "decompteSentAt": "2019-08-24T14:15:22Z",
  • "parentClosureId": "3de0d669-b914-4ac7-8d61-d918d816722c",
  • "lines": [
    ]
}

Loctavia — Documents

Documents : consultation et actions métier sous autorisation.

Télécharger les rattachements documentaires

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

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

Lister rattachements documentaires

Authorizations:
BearerAuthOAuth2Password
query Parameters
page
integer >= 1
Default: 1
per_page
integer >= 1
Default: 25

Valeur plafonnée à 100.

sort
string
Enum: "id" "file_id" "role" "created_at" "updated_at"
direction
string
Enum: "asc" "desc"
search
string <= 200 characters
updated_since
string <date-time>
q
object
Example:

Filtres autorisés sur les champs publics : suffixes _eq, _in, _cont (texte), _gteq, _lteq. Une valeur inconnue renvoie 400. La chaîne historique q est un alias de search.

entity_type
string
entity_id
string <uuid>
file_type
string

Type MIME exact du fichier, par exemple application/pdf.

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 rattachements documentaires

Authorizations:
BearerAuthOAuth2Password
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.

Request Body schema:
required
entity_type
required
string
entity_id
required
string <uuid>
role
required
string
file_id
string <uuid>
file
string <binary>

Responses

Request samples

Content type
No sample

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
  • "entityType": "string",
  • "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
  • "role": "string",
  • "name": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "downloadUrl": "string"
}

Consulter rattachements documentaires

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
  • "entityType": "string",
  • "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
  • "role": "string",
  • "name": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "downloadUrl": "string"
}

Retirer rattachements documentaires

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

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

Loctavia — Factures

Factures : consultation et actions métier sous autorisation.

Enregistrer les factures fournisseur

Authorizations:
BearerAuthOAuth2Password
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.

Request Body schema: application/json
required
supplier_id
required
string <uuid>
external_number
required
string
issued_on
required
string <date>
due_on
string <date>
currency
string
total_excl_vat_cents
required
integer
total_vat_cents
required
integer
total_incl_vat_cents
required
integer

Responses

Request samples

Content type
application/json
{
  • "supplier_id": "3cb1e20c-c6c9-4e71-ba66-399c468f697c",
  • "external_number": "string",
  • "issued_on": "2019-08-24",
  • "due_on": "2019-08-24",
  • "currency": "string",
  • "total_excl_vat_cents": 0,
  • "total_vat_cents": 0,
  • "total_incl_vat_cents": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "number": "string",
  • "direction": "outbound",
  • "kind": "rent_call",
  • "status": "draft",
  • "issuerPartyId": "e985254e-4af0-4f72-b791-2d5f32305e54",
  • "recipientPartyId": "ea677342-5478-4a65-bbb7-cd942b0d1574",
  • "leaseId": "a3abd432-1f03-4b93-888c-0da4d3703e99",
  • "totalExclVatCents": 0,
  • "totalVatCents": 0,
  • "totalInclVatCents": 0,
  • "currency": "string",
  • "issuedOn": "2019-08-24",
  • "dueOn": "2019-08-24",
  • "paidOn": "2019-08-24",
  • "sentAt": "2019-08-24T14:15:22Z",
  • "legalMentions": {
    },
  • "creditedInvoiceId": "74ebea99-ce39-4315-8d5b-103e18e641e4",
  • "cancellationReason": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "lines": [
    ],
  • "issuer": {
    },
  • "recipient": {
    }
}

Annuler factures

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
reason
string

Responses

Request samples

Content type
application/json
{
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "number": "string",
  • "direction": "outbound",
  • "kind": "rent_call",
  • "status": "draft",
  • "issuerPartyId": "e985254e-4af0-4f72-b791-2d5f32305e54",
  • "recipientPartyId": "ea677342-5478-4a65-bbb7-cd942b0d1574",
  • "leaseId": "a3abd432-1f03-4b93-888c-0da4d3703e99",
  • "totalExclVatCents": 0,
  • "totalVatCents": 0,
  • "totalInclVatCents": 0,
  • "currency": "string",
  • "issuedOn": "2019-08-24",
  • "dueOn": "2019-08-24",
  • "paidOn": "2019-08-24",
  • "sentAt": "2019-08-24T14:15:22Z",
  • "legalMentions": {
    },
  • "creditedInvoiceId": "74ebea99-ce39-4315-8d5b-103e18e641e4",
  • "cancellationReason": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "lines": [
    ],
  • "issuer": {
    },
  • "recipient": {
    }
}

Envoyer les factures

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "number": "string",
  • "direction": "outbound",
  • "kind": "rent_call",
  • "status": "draft",
  • "issuerPartyId": "e985254e-4af0-4f72-b791-2d5f32305e54",
  • "recipientPartyId": "ea677342-5478-4a65-bbb7-cd942b0d1574",
  • "leaseId": "a3abd432-1f03-4b93-888c-0da4d3703e99",
  • "totalExclVatCents": 0,
  • "totalVatCents": 0,
  • "totalInclVatCents": 0,
  • "currency": "string",
  • "issuedOn": "2019-08-24",
  • "dueOn": "2019-08-24",
  • "paidOn": "2019-08-24",
  • "sentAt": "2019-08-24T14:15:22Z",
  • "legalMentions": {
    },
  • "creditedInvoiceId": "74ebea99-ce39-4315-8d5b-103e18e641e4",
  • "cancellationReason": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "lines": [
    ],
  • "issuer": {
    },
  • "recipient": {
    }
}

Émettre un avoir sur les factures

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "number": "string",
  • "direction": "outbound",
  • "kind": "rent_call",
  • "status": "draft",
  • "issuerPartyId": "e985254e-4af0-4f72-b791-2d5f32305e54",
  • "recipientPartyId": "ea677342-5478-4a65-bbb7-cd942b0d1574",
  • "leaseId": "a3abd432-1f03-4b93-888c-0da4d3703e99",
  • "totalExclVatCents": 0,
  • "totalVatCents": 0,
  • "totalInclVatCents": 0,
  • "currency": "string",
  • "issuedOn": "2019-08-24",
  • "dueOn": "2019-08-24",
  • "paidOn": "2019-08-24",
  • "sentAt": "2019-08-24T14:15:22Z",
  • "legalMentions": {
    },
  • "creditedInvoiceId": "74ebea99-ce39-4315-8d5b-103e18e641e4",
  • "cancellationReason": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "lines": [
    ],
  • "issuer": {
    },
  • "recipient": {
    }
}

Régler les factures

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

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

Responses

Request samples

Content type
application/json
{
  • "paid_on": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "number": "string",
  • "direction": "outbound",
  • "kind": "rent_call",
  • "status": "draft",
  • "issuerPartyId": "e985254e-4af0-4f72-b791-2d5f32305e54",
  • "recipientPartyId": "ea677342-5478-4a65-bbb7-cd942b0d1574",
  • "leaseId": "a3abd432-1f03-4b93-888c-0da4d3703e99",
  • "totalExclVatCents": 0,
  • "totalVatCents": 0,
  • "totalInclVatCents": 0,
  • "currency": "string",
  • "issuedOn": "2019-08-24",
  • "dueOn": "2019-08-24",
  • "paidOn": "2019-08-24",
  • "sentAt": "2019-08-24T14:15:22Z",
  • "legalMentions": {
    },
  • "creditedInvoiceId": "74ebea99-ce39-4315-8d5b-103e18e641e4",
  • "cancellationReason": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "lines": [
    ],
  • "issuer": {
    },
  • "recipient": {
    }
}

Enregistrer un paiement des factures

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "payment": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "number": "string",
  • "direction": "outbound",
  • "kind": "rent_call",
  • "status": "draft",
  • "issuerPartyId": "e985254e-4af0-4f72-b791-2d5f32305e54",
  • "recipientPartyId": "ea677342-5478-4a65-bbb7-cd942b0d1574",
  • "leaseId": "a3abd432-1f03-4b93-888c-0da4d3703e99",
  • "totalExclVatCents": 0,
  • "totalVatCents": 0,
  • "totalInclVatCents": 0,
  • "currency": "string",
  • "issuedOn": "2019-08-24",
  • "dueOn": "2019-08-24",
  • "paidOn": "2019-08-24",
  • "sentAt": "2019-08-24T14:15:22Z",
  • "legalMentions": {
    },
  • "creditedInvoiceId": "74ebea99-ce39-4315-8d5b-103e18e641e4",
  • "cancellationReason": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "lines": [
    ],
  • "issuer": {
    },
  • "recipient": {
    }
}

Télécharger les factures

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

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

Lister factures

Authorizations:
BearerAuthOAuth2Password
query Parameters
page
integer >= 1
Default: 1
per_page
integer >= 1
Default: 25

Valeur plafonnée à 100.

sort
string
Enum: "id" "mandataire_id" "number" "direction" "kind" "status" "issuer_party_id" "recipient_party_id" "source_type" "source_id" "lease_id" "total_excl_vat_cents" "total_vat_cents" "total_incl_vat_cents" "currency" "issued_on" "due_on" "paid_on" "sent_at" "legal_mentions" "credited_invoice_id" "cancellation_reason" "created_at" "updated_at"
direction
string
Enum: "asc" "desc"
search
string <= 200 characters
updated_since
string <date-time>
q
object
Example:

Filtres autorisés sur les champs publics : suffixes _eq, _in, _cont (texte), _gteq, _lteq. Une valeur inconnue renvoie 400. La chaîne historique q est un alias de search.

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 factures

Authorizations:
BearerAuthOAuth2Password
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.

Request Body schema: application/json
required
lease_id
string <uuid>
contact_type
string
contact_id
string <uuid>
due_on
string <date>
issued_on
string <date>
description
string
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "lease_id": "55555555-5555-4555-8555-555555555555",
  • "issued_on": "2026-03-01",
  • "due_on": "2026-03-15",
  • "lines": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "number": "string",
  • "direction": "outbound",
  • "kind": "rent_call",
  • "status": "draft",
  • "issuerPartyId": "e985254e-4af0-4f72-b791-2d5f32305e54",
  • "recipientPartyId": "ea677342-5478-4a65-bbb7-cd942b0d1574",
  • "leaseId": "a3abd432-1f03-4b93-888c-0da4d3703e99",
  • "totalExclVatCents": 0,
  • "totalVatCents": 0,
  • "totalInclVatCents": 0,
  • "currency": "string",
  • "issuedOn": "2019-08-24",
  • "dueOn": "2019-08-24",
  • "paidOn": "2019-08-24",
  • "sentAt": "2019-08-24T14:15:22Z",
  • "legalMentions": {
    },
  • "creditedInvoiceId": "74ebea99-ce39-4315-8d5b-103e18e641e4",
  • "cancellationReason": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "lines": [
    ],
  • "issuer": {
    },
  • "recipient": {
    }
}

Consulter factures

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "number": "string",
  • "direction": "outbound",
  • "kind": "rent_call",
  • "status": "draft",
  • "issuerPartyId": "e985254e-4af0-4f72-b791-2d5f32305e54",
  • "recipientPartyId": "ea677342-5478-4a65-bbb7-cd942b0d1574",
  • "leaseId": "a3abd432-1f03-4b93-888c-0da4d3703e99",
  • "totalExclVatCents": 0,
  • "totalVatCents": 0,
  • "totalInclVatCents": 0,
  • "currency": "string",
  • "issuedOn": "2019-08-24",
  • "dueOn": "2019-08-24",
  • "paidOn": "2019-08-24",
  • "sentAt": "2019-08-24T14:15:22Z",
  • "legalMentions": {
    },
  • "creditedInvoiceId": "74ebea99-ce39-4315-8d5b-103e18e641e4",
  • "cancellationReason": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "lines": [
    ],
  • "issuer": {
    },
  • "recipient": {
    }
}

Loctavia — Synchronisation

Synchronisation : consultation et actions métier sous autorisation.

changes — sync_snapshots

Authorizations:
BearerAuthOAuth2Password
path Parameters
id
required
string <uuid>
query Parameters
cursor
string

Curseur opaque signé ; rejouer la même page est permis.

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
{
  • "snapshotId": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  • "changes": [
    ],
  • "nextCursor": null,
  • "complete": true
}

create — sync_snapshots

Authorizations:
BearerAuthOAuth2Password
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.

Request Body schema: application/json
required
collections
required
Array of strings
Items Enum: "bank_accounts" "billing_runs" "budget_envelopes" "budget_lines" "charge_natures" "charges" "closures" "commitments" "contacts" "documents" "incidents" "invoices" "lease_parties" "lease_terms" "leases" "mandates" "owners" "ownerships" "payments" "properties" "provisions" "rent_calls" "share_keys" "suppliers" "syndic_assignments" "syndics" "tenants" "units"
previous_snapshot_id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "collections": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "pending",
  • "collections": [
    ],
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "failureCode": "string"
}

show — sync_snapshots

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "pending",
  • "collections": [
    ],
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "failureCode": "string"
}

Loctavia — Syndics

Syndics : consultation et actions métier sous autorisation.

Lister syndics

Authorizations:
BearerAuthOAuth2Password
query Parameters
page
integer >= 1
Default: 1
per_page
integer >= 1
Default: 25

Valeur plafonnée à 100.

sort
string
Enum: "id" "contact_id" "first_name" "last_name" "company_name" "email_address" "phone_number" "siret" "activity" "address" "active" "mandataire_id" "created_at" "updated_at"
direction
string
Enum: "asc" "desc"
search
string <= 200 characters
updated_since
string <date-time>
q
object
Example:

Filtres autorisés sur les champs publics : suffixes _eq, _in, _cont (texte), _gteq, _lteq. Une valeur inconnue renvoie 400. La chaîne historique q est un alias de search.

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 syndics

Authorizations:
BearerAuthOAuth2Password
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "syndic": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d",
  • "firstName": "string",
  • "lastName": "string",
  • "companyName": "string",
  • "emailAddress": "string",
  • "phoneNumber": "string",
  • "siret": "string",
  • "activity": "string",
  • "address": "string",
  • "active": true,
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Consulter syndics

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d",
  • "firstName": "string",
  • "lastName": "string",
  • "companyName": "string",
  • "emailAddress": "string",
  • "phoneNumber": "string",
  • "siret": "string",
  • "activity": "string",
  • "address": "string",
  • "active": true,
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Modifier syndics

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "syndic": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d",
  • "firstName": "string",
  • "lastName": "string",
  • "companyName": "string",
  • "emailAddress": "string",
  • "phoneNumber": "string",
  • "siret": "string",
  • "activity": "string",
  • "address": "string",
  • "active": true,
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Modifier syndics

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "syndic": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d",
  • "firstName": "string",
  • "lastName": "string",
  • "companyName": "string",
  • "emailAddress": "string",
  • "phoneNumber": "string",
  • "siret": "string",
  • "activity": "string",
  • "address": "string",
  • "active": true,
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Retirer syndics

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

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

Lister affectations de syndic

Authorizations:
BearerAuthOAuth2Password
query Parameters
page
integer >= 1
Default: 1
per_page
integer >= 1
Default: 25

Valeur plafonnée à 100.

sort
string
Enum: "id" "mandataire_id" "property_id" "unit_id" "contact_id" "external_reference" "copro_lot_number" "valid_from" "valid_until" "created_at" "updated_at"
direction
string
Enum: "asc" "desc"
search
string <= 200 characters
updated_since
string <date-time>
q
object
Example:

Filtres autorisés sur les champs publics : suffixes _eq, _in, _cont (texte), _gteq, _lteq. Une valeur inconnue renvoie 400. La chaîne historique q est un alias de search.

subscription_number
string

Abonnement exact : casse et espaces normalisés.

active_at
string

Date ISO 8601 de validité.

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 affectations de syndic

Authorizations:
BearerAuthOAuth2Password
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "syndic_assignment": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",
  • "unitId": "b3eb5f92-604a-46b9-9881-9d84000fd7ed",
  • "contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d",
  • "externalReference": "string",
  • "coproLotNumber": "string",
  • "validFrom": "2019-08-24",
  • "validUntil": "2019-08-24",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Consulter affectations de syndic

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",
  • "unitId": "b3eb5f92-604a-46b9-9881-9d84000fd7ed",
  • "contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d",
  • "externalReference": "string",
  • "coproLotNumber": "string",
  • "validFrom": "2019-08-24",
  • "validUntil": "2019-08-24",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Modifier affectations de syndic

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "syndic_assignment": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",
  • "unitId": "b3eb5f92-604a-46b9-9881-9d84000fd7ed",
  • "contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d",
  • "externalReference": "string",
  • "coproLotNumber": "string",
  • "validFrom": "2019-08-24",
  • "validUntil": "2019-08-24",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Modifier affectations de syndic

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "syndic_assignment": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "mandataireId": "9c02fc94-a11c-45dc-995e-ce15d253e0cd",
  • "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",
  • "unitId": "b3eb5f92-604a-46b9-9881-9d84000fd7ed",
  • "contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d",
  • "externalReference": "string",
  • "coproLotNumber": "string",
  • "validFrom": "2019-08-24",
  • "validUntil": "2019-08-24",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Retirer affectations de syndic

Authorizations:
BearerAuthOAuth2Password
path Parameters
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.

Responses

Response samples

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