Esempio di chiamata per visualizzazione lista fatture attive passive:


curl -X GET \

  https://INDIRIZZO_AMBIENTE_ARCHIPRO/api/v1/fatturazione/fatture-passive \

  -H 'Authorization: Bearer BEARER_TOKEN' \

  -H 'Postman-Token: RANDOM_TOKEN'

  -H 'cache-control: no-cache'


I filtri di ricerca (rappresentati come query param della chiamata http) sono i seguenti:


  • numero di pagina: tipo numerico, valore non obbligatorio, se assente valorizzato a 1 dalla logica di business della chiamata
  • elementi per pagina: tipo numerico, valore non obbligatorio, se assente valorizzato a 100 dalla logica di business della chiamata
  • da data ricezione: tipo data, valore non obbligatorio
  • a data ricezione:  tipo data, valore non obbligatorio
  • numero documento:  tipo testuale, valore non obbligatorio
  • tipo documento:  tipo testuale, valore non obbligatorio
  • fornitore: tipo testuale, valore non obbligatorio
  • piva: tipo testuale, valore non obbligatorio
  • cf: tipo testuale, valore non obbligatorio
  • idSdi: tipo testuale, valore non obbligatorio
  • solo nuovi: tipo booleano, valore non obbligatorio, se assente valorizzato a true dalla logica di business della chiamata


Formato del risultato (body della response http):


{

      results: [ {

                          filename,idSdi, numero, dataFattura, dataRicezione, fornitore, piva, cf, tipoDocumento

                        }, ... 

       ],

       rows: 3,

       total_result: 2000,

       page: 1

}


Logica di estrazione:

vengono reperite tutte le fatture passive che soddisfano i campi di ricerca in input (da data ricezione, a data ricezione, numero documento, tipo documento, fornitore, piva, cf, idSdi) 


  • total_result viene valorizzato con il conteggio totale dei documenti che soddisfano le condizioni di ricerca
  • rows viene valorizzato con il numero di elementi inseriti nella risposta a seconda della forbice di paginazione
  • pages: numero di pagina estratta


Se il campo solo nuovi non viene valorizzato, viene valorizzato a true di default, quindi viene aggiunta la clausola di estrazione per le sole fatture non ancora scaricate in XML mediante l'apposito endpoint.


Se il campo in input elementi per pagina non viene valorizzato (o è > di 100) gli elementi restituiti daranno di default un massimo di 100 risultati. Se il campo in input numero di pagina non viene valorizzato, verrà restituita sempre la prima pagina.



Esempio di chiamata per download della fattura passiva:



curl -X GET \
  'https://INDIRIZZO_AMBIENTE_ARCHIPRO/api/v1/fatturazione/fatture-passive/{INSERIRE ID-SDI}/xml' \

  -H 'Authorization: Bearer BEARER_TOKEN' \

  -H 'Content-Type: application/x-www-form-urlencoded' \

  -H 'Postman-Token: RANDOM_TOKEN' \

  -H 'cache-control: no-cache'


Per testare la chiamata con POSTMAN seguire i seguenti punti:

  • importare la collection in allegato
  • effettuare la chiamata Autenticazione come da specifiche
  • accedere alla chiamata Notifiche Attive
  • in Authorization selezionare OAUTH 2.0 come TYPE ed incollare il Bearer Token nel riquadro Access Token
  • inserire i Params di ricerca
  • cliccare su SEND  per avere la lista di risultati procedere con SEND per attendere il response che sarà la lista delle fatture:
  • Usare l'idSdi per effettuare la seconda chiamata all'interno della richiesta come nell'esempio, il response sarà lo stream della fattura xml: