FAQ

 FAQ

Le API di fatturapertutti

Accesso a fatturapertutti tramite servizio web APIs Restful (ultimo rilascio 18/07/2019)

Le API di fatturapertutti sono un’interfaccia software che, tramite semplici chiamate http, ti permetterà di:

  • verificare i dati del profilo cedente; 
  • inviare un documento XML;
  • verificare lo stato di un singolo documento;
  • verificare lo stato di più documenti.

 

Il modello prevede chiamate di tipo GET e POST, con parametri codificati in formato JSON nel corpo della richiesta.

L'endpoint di riferimento è: https://api.fatturapertutti.it 

I parametri apiKey e password devono essere sempre indicati nel path di tutte le chiamate. 

Esempio formato richiesta: https://api.fatturapertutti.it/operazione/apiKey/password/parametri

 


Verificare i dati del profilo cedente

GET: /info/{apiKey}/{password}/{partita iva}

 

Parametro Valore
operazione info
apiKey prelevabile da fatturapertutti
password indicata sul canale web/api del cedente
partita iva quella del cedente su cui è stato attivato il canale

 

Prova

 

Struttura risposta

JSON {
   errorCode (integer): codice errore richiesta 0 = ok (vedi tabella per l'elenco completo),
   errorMessage (string): descrizione errore, 
   DataOraServer (date-time): data e ora del server (formato yyyy-MM-ddTHH:mm:ss),
   DataScadenza (date): data di scadenza del contratto (formato yyyy-MM-dd),
   DocumentiXml (integer): totale documenti disponibili per l'import di file xml,
   VersioneCanale (integer): indica la versione del canale, è un valore incrementale, se maggiore rispetto all'ultimo utilizzo è necessario prendere visioni degli aggiornamenti.
   contratto (string): tipo contratto attivo sul cedente,
   denominazione (string): ragione sociale del cedente,
   idFiscale (string): partita IVA del cedente,
   indirizzo (string): indirizzo sede legale del cedente,

}

 


Inviare un documento XML, XLS, CSV o TXT

POST: /upload/{apiKey}/{password}/{processo}

 

Parametro Valore
operazione upload
apiKey prelevabile da fatturapertutti
password indicata sul canale web/api del cedente
processo specifica il processo da eseguire dopo l'upload dell'xml:
0 "nessuna": viene creato un documento con lo stato aperto
Se si reinvia lo stesso documento questo verrà sovrapposto automaticamente.

1 "convalida": viene creato un documento e convalidato, il documento è pronto per essere inviato allo SDI
Se si reinvia lo stesso documento verrà generato un errore, il documento può essere riaperto, modificato o eliminato.

2 "convalida e approva": viene creato un documento, convalidato e approvato, il documento viene automaticamente inviato allo SDI
Se si reinvia lo stesso documento verrà generato un errore, il documento non può più essere modificato o eliminato.

 

Prova

 

Corpo richiesta

JSON {
    fileName (string): nome del file
    fileXml (string): file in base64, con il seguente formato: "data:text/xml;base64," + stringa in base64.
    Il file xml può contenere un solo documento ed avere una dimensione massima di 5mb. }

 


Verificare lo stato di un singolo documento

POST: /statodocumento/{apiKey}/{password}

 

Parametro Valore
operazione statodocumento
apiKey prelevabile da fatturapertutti
password indicata sul canale web/api del cedente

 

Prova

 

Corpo richiesta

JSON {
   data (string): data del documento (formato yyyy-MM-dd),
   numero (string): numero del documento

Struttura risposta

JSON {
   errorCode (integer): codice errore richiesta 0 = ok (vedi tabella per l'elenco completo),
   errorMessage (string): descrizione errore,
   count (integer): totale documenti,
   statoDoc :
   [{
      id (string): identificativo unico del documento (necessario per scaricare l'xml)
      data (string): data documento (yyyy-MM-dd)
      numero (string): numero documento
      stato (string): stato documento
      dataStato (string): data stato del documento (yyyy-MM-ddTHH:mm:ss)
      identificativoSdi (string): identificativo del servizio di interscambio
      note (string): note inviate dallo SDI (nel caso di scarto indica la motivazione)
   }]
}

 


Verificare lo stato di più documenti

POST: /statodocumento/{apiKey}/{password}
Parametro Valore
operazione statodocumento
apiKey prelevabile da fatturapertutti
password indicata sul canale web/api del cedente

 

Prova

 

Corpo richiesta

JSON {
   dataSincronia (string): tutti i documenti modificati dalla data indicata (formato yyyy-MM-ddTHH:mm:ss) (obbligatorio),
   esercizio (integer): anno esercizio (obbligatorio),
   serie (string): serie utilizzata nella numerazione del documento (opzionale),
   progressivoDal (integer): progressivo iniziale dei documenti (opzionale),
   progressivoAl (integer): progressivo finale dei documenti (opzionale),
   partitaIva (string): partita iva del committente (opzionale),
   codiceFiscale (string): codice fiscale del committente (opzionale)
}
NB: In ogni caso, per qualsiasi filtro applicato, non verranno restituiti più di 50.000 records per singola richiesta. 

Struttura risposta

JSON {
   errorCode (integer): codice errore richiesta 0 = ok (vedi tabella per l'elenco completo),
   errorMessage (string): descrizione errore,
   count (integer): totale documenti,
   statoDoc :
   [{
      id (string): identificativo unico del documento (necessario per scaricare l'xml)
      data (string): data documento (yyyy-MM-dd)
      numero (string): numero documento
      stato (string): stato documento
      dataStato (string): data stato del documento (yyyy-MM-ddTHH:mm:ss)
      identificativoSdi (string): identificativo del servizio di interscambio
      note (string): note inviate dallo SDI (nel caso di scarto indica la motivazione)
   }]
}

 

Stampa
Data: lug 8, 2019,
Commenti: 0,
Valutazione:
5.0

Commenta

Nome:
Email:
Commento:
Aggiungi commento

Partecipa alla community