DOCUMENTATION DE L'API

Erreurs

Une seule enveloppe partout : une phrase, un code, un ID de demande.

{
  "error": "The request body has problems.",
  "code": "VALIDATION_FAILED",
  "requestId": "a36bda957b8a7631-YVR",
  "docs_url": "https://docs.taxpio.com/errors#validation-failed",
  "problems": [{ "field": "inputs.taxableTotalProfitsPence", "message": "taxableTotalProfitsPence must be a whole number of at least 0." }]
}

Branchez-vous sur code, affichez error à une personne, journalisez requestId. Les échecs de validation énumèrent chaque problème avec le champ qui le porte. Un code nommé par la route est conservé; sinon, le code est celui du statut.

CodeStatutSignification
BAD_REQUEST400Comme l'indique le statut.
UNAUTHENTICATED401Comme l'indique le statut.
PAYMENT_REQUIRED402Comme l'indique le statut.
FORBIDDEN403Comme l'indique le statut.
NOT_FOUND404Aucune ressource de ce type dans cet environnement.
METHOD_NOT_ALLOWED405Comme l'indique le statut.
NOT_ACCEPTABLE406Comme l'indique le statut.
REQUEST_TIMEOUT408Comme l'indique le statut.
CONFLICT409La demande entre en conflit avec l'état actuel (le message indique comment).
GONE410Comme l'indique le statut.
PAYLOAD_TOO_LARGE413Le corps dépasse la limite.
UNSUPPORTED_MEDIA_TYPE415Envoyez application/json.
VALIDATION_FAILED422Un ou plusieurs champs sont erronés; problems les énumère.
LOCKED423Comme l'indique le statut.
PRECONDITION_REQUIRED428Comme l'indique le statut.
RATE_LIMITED429Limite par minute dépassée; retry-after indique quand réessayer.
INTERNAL500Un problème est survenu de notre côté; indiquez l'ID de la demande.
NOT_IMPLEMENTED501Comme l'indique le statut.
UNAVAILABLE503Comme l'indique le statut.
TIMEOUT504Comme l'indique le statut.
ORIGIN_REQUIRED403Une modification par navigateur venant d'une autre origine (routes du produit seulement).
PASSKEY_REQUIRED403Comme l'indique le statut.
PASSKEY_ENROLLMENT_REQUIRED428Comme l'indique le statut.
RECENT_MFA_REQUIRED428Comme l'indique le statut.
RECENT_AUTHENTICATION_REQUIRED403Comme l'indique le statut.
ACCOUNT_PASSWORD_REQUIRED428Comme l'indique le statut.
EMAIL_VERIFICATION_REQUIRED403Comme l'indique le statut.
VERIFICATION_DELIVERY_FAILED503Comme l'indique le statut.
RESOURCE_ROUTE_UNAVAILABLE503Comme l'indique le statut.
MALWARE_DETECTED422Comme l'indique le statut.
NONDETERMINISTIC_PROVIDER_RETRY503Comme l'indique le statut.
CREDITS_REQUIRED402Une opération réelle exige plus de crédits que l'espace de travail n'en détient.
API_KEY_MISSING401Aucun jeton porteur n'a été envoyé.
API_KEY_INVALID401Le jeton n'est pas une clé émise par TaxPio.
API_KEY_REVOKED401La clé a été révoquée; créez-en une nouvelle.
API_KEY_EXPIRED401La clé a dépassé sa date d'expiration.
WORKSPACE_SUSPENDED403L'espace de travail n'est pas actif.
APPLICATION_ARCHIVED403L'application a été archivée; ses clés ne fonctionnent plus.
SCOPE_REQUIRED403Il manque à la clé la portée dont l'opération a besoin (required_scope l'indique).
PRODUCTION_REVIEW_REQUIRED403Une clé réelle a été utilisée avant que l'examen de production approuve l'espace de travail.
IDEMPOTENCY_KEY_INVALID400Idempotency-Key ne compte pas de 8 à 128 caractères parmi les lettres, les chiffres et _ - . :.
IDEMPOTENCY_KEY_REUSED409La même clé a été envoyée avec un autre corps.
IDEMPOTENCY_KEY_IN_PROGRESS409La première demande avec cette clé est encore en cours.
BODY_INVALID400Le corps n'est pas un JSON valide.
UNSUPPORTED_PROGRAM422La juridiction, le programme ou l'année d'imposition n'est pas offert (le message indique ce qui l'est).
SANDBOX_ONLY403Un outil de bac à sable a été appelé avec une clé réelle.
CONNECTION_PENDING409Comme l'indique le statut.
CONNECTION_REVOKED409Comme l'indique le statut.
CONNECTION_PERMISSION_REQUIRED403Comme l'indique le statut.
LIVE_ONLY403Une opération liée au gouvernement a été appelée avec une clé de bac à sable.
WEBHOOK_SIGNATURE_INVALID401Le collecteur n'a pas pu vérifier la signature de la livraison.