Erreurs


Lorsqu'une requête échoue, success est false et une liste errors indique ce qui s'est mal passé. Le statut HTTP n'est jamais 200. Vérifiez success dans chaque réponse avant de considérer un enregistrement comme sauvegardé.

Réponse en échec
			
{
  "success": false,
  "errors": [
    "Unable to find record"
  ]
}


		

Codes de statut HTTP

  • 400 La requête a été rejetée. La plupart des échecs utilisent ce statut : un champ manquant ou invalide, un enregistrement inexistant ou une règle que les données enfreignent. Corrigez la requête avant de l'envoyer de nouveau.
  • 401 Le jeton est manquant ou illisible. Consultez Authentification.
  • 403 Le jeton est valide, mais n'est pas autorisé à effectuer cette action, ou l'accès à l'API n'est pas activé pour le site.
  • 413 Le corps de la requête dépasse 1 Mo.
  • 422 Un point de terminaison Add/Update a refusé des données qui ne pourront jamais être acceptées telles qu'elles ont été envoyées; les renvoyer échouera donc de la même façon.
  • 429 Vous avez envoyé trop de requêtes. Consultez Limites de débit.
  • 503 Sur un point de terminaison Add/Update, une autre requête mettait à jour le même enregistrement au même moment. Attendez quelques secondes et renvoyez la même requête.
  • 500 Un problème est survenu de notre côté. Réessayez et communiquez avec le soutien si cela persiste.

Codes d'erreur

La plupart des entrées de errors sont de simples messages. Quelques-unes sont des objets avec un code que vous pouvez utiliser à la place du texte, et data qui décrit l'enregistrement concerné.

Erreur avec un code
			
{
  "success": false,
  "errors": [
    {
      "code": "record_not_found",
      "data": {
        "modelName": "Customer",
        "externalId": "CUST-1001"
      }
    }
  ]
}


		
  • record_not_found Un enregistrement auquel vous avez fait référence n'existe pas sur ce site. Vérifiez l'identifiant envoyé ou créez d'abord l'enregistrement.
  • record_locked Une autre requête met à jour le même enregistrement. Le statut est 503 sur les points de terminaison Add/Update et 400 sur les autres. Dans les deux cas, vous pouvez renvoyer la même requête après une courte attente sans risque.

Enregistrements à envoyer en premier

Lorsqu'une requête fait référence à un enregistrement qui doit exister au préalable, comme le parent d'un client, la réponse peut inclure une liste missingRecords. Chaque entrée indique le type d'enregistrement et l'identifiant que vous avez utilisé pour celui-ci. Créez ces enregistrements, puis renvoyez la requête initiale.

Réponse avec enregistrements manquants
			
{
  "success": false,
  "errors": [
    {
      "code": "record_not_found",
      "data": {
        "modelName": "Customer",
        "externalId": "PARENT-1001"
      }
    }
  ],
  "missingRecords": [
    {
      "model": "Customer",
      "externalId": "PARENT-1001"
    }
  ]
}


		

Erreurs courantes

Les messages ci-dessous sont cités textuellement, ce qui vous permet de rechercher sur cette page le texte que vous avez reçu.

  • Feature integrations.hyfin_api_access is not available for Site {site_id} L'accès à l'API n'est pas activé pour ce site. Communiquez avec le soutien pour le faire activer. Le message se termine par l'identifiant du site.
  • Unable to find record Aucun enregistrement avec cet identifiant n'existe sur ce site, ou l'enregistrement a été supprimé.
  • Missing required field Un champ obligatoire est vide ou manquant. Le message indique le nom du champ.
  • Invalid totals.subtotal Invalid totals.total Les totaux que vous avez envoyés ne correspondent pas aux lignes de la facture. Le message indique le montant attendu et le montant reçu.
  • Invoice has been paid and cannot be deactivated La facture comporte un paiement effectué par l'application et ne peut donc pas être supprimée. Consultez Suppression d'enregistrements.
  • Invoice is deleted, will not resend. Une facture supprimée ne peut pas être renvoyée.
  • You have hit the throttle limit for this payment, please try again in a minute Le même paiement a été demandé à nouveau en moins d'une minute.
  • Request body too large Le corps de la requête dépasse 1 Mo. Envoyez moins d'enregistrements dans chaque requête.