3 API3.6
3.6
Consulter le catalogue : GET /catalogue/{code}
Consulter un code du catalogue.
- Dans le bac à sable
En termes simples
Cet appel explique un code d’erreur en termes simples : ce qui ne va pas, ce qu’il faut faire et qui agit.
GET /catalogue/{code} renvoie la partie publique d’une entrée du catalogue. Chaque constat d’un rapport, et chaque erreur d’un 422, porte l’un de ces codes. L’appel nécessite une clé dotée de la portée read. Le code peut aussi être l’un de ses alias.
| Champ | Signification |
|---|---|
id | Le code. |
meaning | Ce qui ne va pas. |
fix | Ce qu’il faut faire. |
owner | Qui agit : us ou l’un des autres responsables listés sur la page Erreurs et catalogue. |
severity | error, business, warning ou info. |
routes | Les canaux auxquels le code s’applique. ALL signifie tous les canaux. |
partner_message | La phrase que nous enverrions au client. Pour certains codes, elle existe en plusieurs langues. |
curl "https://api-sandbox-eu.eurinvoice.com/catalogue/EI-SCHEMA" \
-H "Authorization: Bearer <your-api-key>"import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder(URI.create("https://api-sandbox-eu.eurinvoice.com/catalogue/EI-SCHEMA"))
.header("Authorization", "Bearer <your-api-key>")
.GET()
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}const response = await fetch('https://api-sandbox-eu.eurinvoice.com/catalogue/EI-SCHEMA', {
headers: {
Authorization: 'Bearer <your-api-key>',
},
});
console.log(response.status);
console.log(await response.text());{
"severity": "error",
"owner": "us",
"routes": [
"ALL"
],
"partner_message": "We could not read this invoice from your export. We are correcting our mapping; if a field is missing in the ERP we will tell you which one.",
"fix": "Read the JSON path in the error and correct the client mapping.",
"meaning": "The invoice JSON does not match the canonical model: a missing or unknown field, a wrong type or code, or a route rule on structure.",
"id": "EI-SCHEMA"
}Pour un code absent du catalogue, la réponse est 404.
curl "https://api-sandbox-eu.eurinvoice.com/catalogue/NO-SUCH-CODE" \
-H "Authorization: Bearer <your-api-key>"import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder(URI.create("https://api-sandbox-eu.eurinvoice.com/catalogue/NO-SUCH-CODE"))
.header("Authorization", "Bearer <your-api-key>")
.GET()
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}const response = await fetch('https://api-sandbox-eu.eurinvoice.com/catalogue/NO-SUCH-CODE', {
headers: {
Authorization: 'Bearer <your-api-key>',
},
});
console.log(response.status);
console.log(await response.text());{
"detail": "NO-SUCH-CODE",
"type": "https://eurinvoice.com/problems/not-found",
"title": "No such catalogue entry",
"status": 404
}Réponses
| Statut | Signification |
|---|---|
200 | L’entrée. |
401 | Aucune clé, ou une clé inconnue. |
403 | La clé n’a pas la portée read. |
404 | Cette entrée du catalogue n’existe pas. |
429 | Trop de requêtes pour la clé. Attendez Retry-After secondes. |