Docs

Leggere lo stato e i documenti di una fattura ricevuta

  • Nella sandbox
GET
/received/{id}

Dalla 0.35.0. La fattura ricevuta di un altro cliente, o l’id di una fattura che il cliente invia, risponde 404.

Autorizzazione

apiKey
headerAuthorizationBearer <token>

Inviare la chiave come token bearer: Authorization: Bearer <your-api-key>. Lo stato del servizio è l’unica chiamata che non richiede una chiave.

Parametri di percorso

id*string

L’id del servizio per una fattura ricevuta (restituito da POST /received).

Corrispondenza^rcv_[0-9a-f]{24}$

Corpo della risposta

La fattura ricevuta.

application/json
  1. response

Dalla 0.35.0. Una fattura che il cliente ha ricevuto tramite un canale, così come l’ha presa POST /received. Come Invoice, non riporta il contenuto della fattura: né venditore, né acquirente, né importi.

id*string
Corrispondenza^rcv_[0-9a-f]{24}$
invoice_ref*string

Il numero di fattura del file stesso (BT-1; FA(3) Fa/P_2), altrimenti il rail_id, altrimenti l’id.

invoice_number?string
route*Route

Il canale di trasmissione. Gli stessi valori di country_route negli eventi di stato.

Valore tra"PEPPOL""PL-KSEF""RO-EFACTURA""FR-PA""DE-XRECHNUNG"
client*string
environment*string
Valore tra"sandbox""production"
state*string
Valore tra"received""validated""validation_failed"
direction*"in"
Valore tra"in"
rail_id?string

L’id del documento presso il canale stesso, come indicato in POST /received.

document_sha256*string
Corrispondenza^[a-f0-9]{64}$
duplicate_of?string

Solo su POST /received, quando il documento era già presente per il cliente e il canale.

links?
errors?array<>
documents?array<>
created_at*string
Formatodate-time
updated_at*string
Formatodate-time
curl -X GET "https://example.com/received/string" \  -H "Authorization: Bearer <your-api-key>"
{  "id": "string",  "invoice_ref": "string",  "invoice_number": "string",  "route": "PEPPOL",  "client": "string",  "environment": "sandbox",  "state": "received",  "direction": "in",  "rail_id": "string",  "document_sha256": "string",  "duplicate_of": "string",  "links": {    "self": "string",    "events": "string"  },  "errors": [    {      "code": "string"    }  ],  "documents": [    {      "kind": "received-xml",      "sha256": "string",      "href": "string"    }  ],  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}