> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arquos.eu/llms.txt
> Use this file to discover all available pages before exploring further.

# Lire un contrat

> Les informations déclarées de la fiche, par identifiant d’attribut, et son lien.

### Endpoint & Authentification

| Méthode | URL |
| :- | :- |
| `GET` | `https://api.arquos.eu/api/v2/contracts/{id}` |

**En-têtes (Headers) :**

* `Authorization: Bearer [VOTRE_JETON_D_API]`
* `X-Arquos-Agency: [IDENTIFIANT_D_AGENCE]` (facultatif, voir [Agence](/v2/agence))

### Paramètres de la requête

<ParamField path="id" type="string" required>
  L’identifiant de l’objet.
</ParamField>

<ParamField header="X-Arquos-Agency" type="string">
  L’identifiant de l’agence où agir. Absent : l’agence par défaut du compte. Une agence hors de sa portée est refusée (403).
</ParamField>

### Réponse (`200`)

<ResponseField name="type" type="string">
  Le type de l’objet, au singulier.
</ResponseField>

<ResponseField name="id" type="string">
  L’identifiant Arquos.
</ResponseField>

<ResponseField name="link" type="string">
  Le chemin de la fiche dans Arquos.
</ResponseField>

<ResponseField name="url" type="string">
  L’adresse complète de la fiche, à ouvrir dans un navigateur.
</ResponseField>

<ResponseField name="fields" type="object">
  Les informations de la fiche, par identifiant d’attribut. Toutes sont présentes ; une information non renseignée vaut `null`.

  <Expandable title="Ses champs">
    <ResponseField name="number" type="string">
      Numéro. Un texte. Peut valoir `null`.
    </ResponseField>

    <ResponseField name="type" type="string">
      Formule. Valeurs possibles : `minimal` (Minimale), `etendu` (Étendue), `complet` (Garantie totale). Peut valoir `null`.
    </ResponseField>

    <ResponseField name="equipmentSubtype" type="string">
      Type d’équipement couvert. Un texte. Peut valoir `null`.
    </ResponseField>

    <ResponseField name="sdcName" type="string">
      Syndicat de copropriété. Un texte. Peut valoir `null`.
    </ResponseField>

    <ResponseField name="status" type="string">
      Statut. Un texte. Peut valoir `null`.
    </ResponseField>

    <ResponseField name="effectiveOn" type="string">
      Date d’effet. Une date, au format JJ/MM/AAAA. Peut valoir `null`.
    </ResponseField>

    <ResponseField name="durationMonths" type="string">
      Durée (mois). Un nombre, mis en forme à la française (virgule décimale). Peut valoir `null`.
    </ResponseField>

    <ResponseField name="tacitRenewal" type="string">
      Reconduction tacite. Valeurs possibles : `true` (Oui), `false` (Non). Peut valoir `null`.
    </ResponseField>

    <ResponseField name="noticeMonths" type="string">
      Préavis (mois). Un nombre, mis en forme à la française (virgule décimale). Peut valoir `null`.
    </ResponseField>

    <ResponseField name="visitEveryWeeks" type="string">
      Visites d’entretien. Valeurs possibles : `4` (Toutes les 4 semaines), `6` (Toutes les 6 semaines), `8` (Toutes les 8 semaines), `13` (Tous les 3 mois), `26` (Tous les 6 mois), `52` (Une fois par an). Peut valoir `null`.
    </ResponseField>

    <ResponseField name="terminatedOn" type="string">
      Résilié le. Une date, au format JJ/MM/AAAA. Peut valoir `null`.
    </ResponseField>

    <ResponseField name="terminationReason" type="string">
      Motif de résiliation. Valeurs possibles : `echeance` (À l’échéance, dans le délai de préavis), `manquement_grave` (Manquement grave prévu au contrat), `travaux_importants` (Travaux importants confiés à un autre ascensoriste), `defaut_avis_chatel` (Reconduction sans avis de la loi Chatel). Peut valoir `null`.
    </ResponseField>

    <ResponseField name="terminationNote" type="string">
      Précision. Un texte. Peut valoir `null`.
    </ResponseField>

    <ResponseField name="billingGroup" type="string">
      Groupe de facturation. Un texte. Peut valoir `null`.
    </ResponseField>

    <ResponseField name="warrantyUntil" type="string">
      Fin de garantie. Une date, au format JJ/MM/AAAA. Peut valoir `null`.
    </ResponseField>

    <ResponseField name="previousProvider" type="string">
      Prestataire précédent. Un texte. Peut valoir `null`.
    </ResponseField>

    <ResponseField name="nextProvider" type="string">
      Prestataire suivant. Un texte. Peut valoir `null`.
    </ResponseField>

    <ResponseField name="annualPrice" type="string">
      Prix annuel HT (€). Un nombre, mis en forme à la française (virgule décimale). Peut valoir `null`.
    </ResponseField>

    <ResponseField name="priceRevision" type="string">
      Révision du prix. Un texte. Peut valoir `null`.
    </ResponseField>

    <ResponseField name="chatelLetterSentOn" type="string">
      Courrier Chatel envoyé le. Une date, au format JJ/MM/AAAA. Peut valoir `null`.
    </ResponseField>

    <ResponseField name="chatelLetterForTerm" type="string">
      Pour l’échéance du. Une date, au format JJ/MM/AAAA. Peut valoir `null`.
    </ResponseField>

    <ResponseField name="partsReplacementDays" type="string">
      Délai garanti des petites pièces (jours ouvrés). Un nombre, mis en forme à la française (virgule décimale). Peut valoir `null`.
    </ResponseField>

    <ResponseField name="insurer" type="string">
      Assureur (responsabilité civile). Un texte. Peut valoir `null`.
    </ResponseField>

    <ResponseField name="insurancePolicy" type="string">
      N° de police. Un texte. Peut valoir `null`.
    </ResponseField>

    <ResponseField name="disputeClause" type="string">
      Règlement des litiges. Un texte. Peut valoir `null`.
    </ResponseField>

    <ResponseField name="subcontractingAllowed" type="string">
      Sous-traitance permise. Valeurs possibles : `true` (Oui), `false` (Non). Peut valoir `null`.
    </ResponseField>

    <ResponseField name="subcontractorName" type="string">
      Sous-traitant. Un texte. Peut valoir `null`.
    </ResponseField>

    <ResponseField name="subcontractingOwnerAgreed" type="string">
      Accord écrit du propriétaire. Valeurs possibles : `true` (Oui), `false` (Non). Peut valoir `null`.
    </ResponseField>

    <ResponseField name="amendmentsClause" type="string">
      Modification par avenant. Valeurs possibles : `true` (Prévue), `false` (Absente). Peut valoir `null`.
    </ResponseField>

    <ResponseField name="ownerVisitsClause" type="string">
      Présence du propriétaire aux visites. Valeurs possibles : `true` (Prévue), `false` (Absente). Peut valoir `null`.
    </ResponseField>

    <ResponseField name="inspectorClause" type="string">
      Accompagnement du contrôleur technique. Valeurs possibles : `true` (Prévu), `false` (Absent). Peut valoir `null`.
    </ResponseField>

    <ResponseField name="basePrice" type="string">
      Prix de base. Un montant en euros, mis en forme à la française (« 2 872,68 € »). Peut valoir `null`.
    </ResponseField>

    <ResponseField name="coefficient" type="string">
      Coefficient. Un nombre, mis en forme à la française (virgule décimale). Peut valoir `null`.
    </ResponseField>

    <ResponseField name="discount" type="string">
      Remise. Un pourcentage, mis en forme à la française (« 82 % »). Peut valoir `null`.
    </ResponseField>

    <ResponseField name="subtotal" type="string">
      Sous-total. Un montant en euros, mis en forme à la française (« 2 872,68 € »). Peut valoir `null`.
    </ResponseField>

    <ResponseField name="optionTotalExclTax" type="string">
      Options HT. Un montant en euros, mis en forme à la française (« 2 872,68 € »). Peut valoir `null`.
    </ResponseField>

    <ResponseField name="optionTotalInclTax" type="string">
      Options TTC. Un montant en euros, mis en forme à la française (« 2 872,68 € »). Peut valoir `null`.
    </ResponseField>

    <ResponseField name="totalExclTax" type="string">
      Contrat HT. Un montant en euros, mis en forme à la française (« 2 872,68 € »). Peut valoir `null`.
    </ResponseField>

    <ResponseField name="totalInclTax" type="string">
      Contrat TTC. Un montant en euros, mis en forme à la française (« 2 872,68 € »). Peut valoir `null`.
    </ResponseField>

    <ResponseField name="vat" type="string">
      TVA. Valeurs possibles : `vat_0` (0 %), `vat_5_5` (5,5 %), `vat_10` (10 %), `vat_20` (20 %). Peut valoir `null`.
    </ResponseField>
  </Expandable>
</ResponseField>

### Les erreurs

| Code | Quand |
| :- | :- |
| `400` | Requête mal formée ou champ obligatoire manquant. |
| `401` | Jeton absent, inconnu ou révoqué. |
| `403` | Agence hors de votre portée. |
| `404` | Objet introuvable dans vos agences. |
| `429` | Trop d’appels : réessayez après le délai de l’en-tête Retry-After. |

Le corps d'une erreur porte `error`, sa raison en français. Voir [Les erreurs](/v2/erreurs).

<RequestExample>
  ```bash cURL theme={"system"}
  curl --request GET \
  --url https://api.arquos.eu/api/v2/contracts/ID_DE_L_OBJET \
  --header 'Authorization: Bearer arq_agent_VOTRE_JETON'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={"system"}
  {
  "type": "contrat",
  "id": "3f1c2b9e-8a4d-4c1e-9b7a-2d5e6f708192",
  "link": "/equipment/3f1c…",
  "url": "https://app.arquos.eu/url",
  "fields": {
    "number": "texte",
    "type": "texte",
    "equipmentSubtype": "texte",
    "sdcName": "texte",
    "status": "texte",
    "effectiveOn": "texte",
    "durationMonths": "texte",
    "tacitRenewal": "texte",
    "noticeMonths": "texte",
    "visitEveryWeeks": "texte",
    "terminatedOn": "texte",
    "terminationReason": "texte",
    "terminationNote": "texte",
    "billingGroup": "texte",
    "warrantyUntil": "texte",
    "previousProvider": "texte",
    "nextProvider": "texte",
    "annualPrice": "texte",
    "priceRevision": "texte",
    "chatelLetterSentOn": "texte",
    "chatelLetterForTerm": "texte",
    "partsReplacementDays": "texte",
    "insurer": "texte",
    "insurancePolicy": "texte",
    "disputeClause": "texte",
    "subcontractingAllowed": "texte",
    "subcontractorName": "texte",
    "subcontractingOwnerAgreed": "texte",
    "amendmentsClause": "texte",
    "ownerVisitsClause": "texte",
    "inspectorClause": "texte",
    "basePrice": "texte",
    "coefficient": "texte",
    "discount": "texte",
    "subtotal": "texte",
    "optionTotalExclTax": "texte",
    "optionTotalInclTax": "texte",
    "totalExclTax": "texte",
    "totalInclTax": "texte",
    "vat": "texte"
  }
  }
  ```
</ResponseExample>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.