3 API3.6
3.6
Consultazione del catalogo: GET /catalogue/{code}
Consultare un codice del catalogo.
- Nella sandbox
In parole semplici
Questa chiamata spiega un codice di errore in parole semplici: cosa non va, cosa fare e chi interviene.
GET /catalogue/{code} restituisce la parte pubblica di una voce del catalogo. Ogni segnalazione in un report, e ogni errore in un 422, riporta uno di questi codici. La chiamata richiede una chiave con lo scope read. Il codice può essere anche uno dei suoi alias.
| Campo | Significato |
|---|---|
id | Il codice. |
meaning | Cosa non va. |
fix | Cosa fare. |
owner | Chi interviene: us o uno degli altri responsabili elencati in errori e catalogo. |
severity | error, business, warning o info. |
routes | I canali a cui si applica il codice. ALL indica tutti i canali. |
partner_message | La frase che invieremmo al cliente. Per alcuni codici è disponibile in più lingue. |
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"
}Per un codice che non è nel catalogo, la risposta è 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
}Risposte
| Stato | Significato |
|---|---|
200 | La voce. |
401 | Nessuna chiave, o una chiave sconosciuta. |
403 | La chiave non ha lo scope read. |
404 | Questa voce non esiste nel catalogo. |
429 | Troppe richieste per la chiave. Attendere Retry-After secondi. |