Endpoint & Authentification
| Méthode | URL |
|---|---|
GET | https://api.arquos.eu/api/v2/contracts/{id} |
Authorization: Bearer [VOTRE_JETON_D_API]X-Arquos-Agency: [IDENTIFIANT_D_AGENCE](facultatif, voir Agence)
Paramètres de la requête
string
required
L’identifiant de l’objet.
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).
Réponse (200)
string
Le type de l’objet, au singulier.
string
L’identifiant Arquos.
string
Le chemin de la fiche dans Arquos.
string
L’adresse complète de la fiche, à ouvrir dans un navigateur.
object
Les informations de la fiche, par identifiant d’attribut. Toutes sont présentes ; une information non renseignée vaut
null.Show Ses champs
Show Ses champs
string
Numéro. Un texte. Peut valoir
null.string
Formule. Valeurs possibles :
minimal (Minimale), etendu (Étendue), complet (Garantie totale). Peut valoir null.string
Type d’équipement couvert. Un texte. Peut valoir
null.string
Syndicat de copropriété. Un texte. Peut valoir
null.string
Statut. Un texte. Peut valoir
null.string
Date d’effet. Une date, au format JJ/MM/AAAA. Peut valoir
null.string
Durée (mois). Un nombre, mis en forme à la française (virgule décimale). Peut valoir
null.string
Reconduction tacite. Valeurs possibles :
true (Oui), false (Non). Peut valoir null.string
Préavis (mois). Un nombre, mis en forme à la française (virgule décimale). Peut valoir
null.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.string
Résilié le. Une date, au format JJ/MM/AAAA. Peut valoir
null.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.string
Précision. Un texte. Peut valoir
null.string
Groupe de facturation. Un texte. Peut valoir
null.string
Fin de garantie. Une date, au format JJ/MM/AAAA. Peut valoir
null.string
Prestataire précédent. Un texte. Peut valoir
null.string
Prestataire suivant. Un texte. Peut valoir
null.string
Prix annuel HT (€). Un nombre, mis en forme à la française (virgule décimale). Peut valoir
null.string
Révision du prix. Un texte. Peut valoir
null.string
Courrier Chatel envoyé le. Une date, au format JJ/MM/AAAA. Peut valoir
null.string
Pour l’échéance du. Une date, au format JJ/MM/AAAA. Peut valoir
null.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.string
Assureur (responsabilité civile). Un texte. Peut valoir
null.string
N° de police. Un texte. Peut valoir
null.string
Règlement des litiges. Un texte. Peut valoir
null.string
Sous-traitance permise. Valeurs possibles :
true (Oui), false (Non). Peut valoir null.string
Sous-traitant. Un texte. Peut valoir
null.string
Accord écrit du propriétaire. Valeurs possibles :
true (Oui), false (Non). Peut valoir null.string
Modification par avenant. Valeurs possibles :
true (Prévue), false (Absente). Peut valoir null.string
Présence du propriétaire aux visites. Valeurs possibles :
true (Prévue), false (Absente). Peut valoir null.string
Accompagnement du contrôleur technique. Valeurs possibles :
true (Prévu), false (Absent). Peut valoir null.string
Prix de base. Un montant en euros, mis en forme à la française (« 2 872,68 € »). Peut valoir
null.string
Coefficient. Un nombre, mis en forme à la française (virgule décimale). Peut valoir
null.string
Remise. Un pourcentage, mis en forme à la française (« 82 % »). Peut valoir
null.string
Sous-total. Un montant en euros, mis en forme à la française (« 2 872,68 € »). Peut valoir
null.string
Options HT. Un montant en euros, mis en forme à la française (« 2 872,68 € »). Peut valoir
null.string
Options TTC. Un montant en euros, mis en forme à la française (« 2 872,68 € »). Peut valoir
null.string
Contrat HT. Un montant en euros, mis en forme à la française (« 2 872,68 € »). Peut valoir
null.string
Contrat TTC. Un montant en euros, mis en forme à la française (« 2 872,68 € »). Peut valoir
null.string
TVA. Valeurs possibles :
vat_0 (0 %), vat_5_5 (5,5 %), vat_10 (10 %), vat_20 (20 %). Peut valoir null.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. |
error, sa raison en français. Voir Les erreurs.
curl --request GET \
--url https://api.arquos.eu/api/v2/contracts/ID_DE_L_OBJET \
--header 'Authorization: Bearer arq_agent_VOTRE_JETON'
{
"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"
}
}