Vai al contenuto

Documento Commerciale

Di seguito vengono elencate le chiamate per contattare i web service riguardanti la gestione dei documenti commerciali e le rispettive istruzioni per la compilazione degli oggetti utilizzati all'interno di esse.

1. Descrizione servizi esposti

1.1. WSC1 - Consente la trasmissione di un documento commerciale

La chiamata seguente consente la trasmissione di un documento commerciale. Il documento commerciale può essere trasmesso in due modi: compilando l'oggetto <CorrispettivoTestataItem> o compilando il campo tracciato, a seconda del valore inserito nel campo tipoTrasmissione.

inviaCorrispettivo:

    Parametro in ingresso:
        CorrispettivoElettronicoItem:
            - utenteItem <UtenteItem>: indica le credenziali dell'utente per effettuare l'accesso ad e-Portale.
            - utenteAdeItem <UtenteAdeItem>: indica le credenziali Fisconline del soggetto emittente.
            - tipoTrasmissione <byte>: indica in quale modo viene passato il documento commerciale all'interno della chiamata.
            - corrispettivoTestataItem <CorrispettivoTestataItem>: oggetto da popolare per la generazione del tracciato del documento commerciale.
            - tracciato <byte[]>: array di byte del tracciato riguardante il documento commerciale.

    Valore di ritorno:
        MysondInfoItem:
            - esito <byte>: contiene l'esito della chiamata.
            - codice <String>: contiene il codice della chiamata.
            - descrizione <String>: contiene la descrizione della chiamata.
            - messaggio <String>: contiene l'oggetto JSON che restituisce la chiamata all'Agenzia delle Entrate.

1.2. WSC2 - Consente di effettuare l'annullo di un documento commerciale

La chiamata seguente consente di effettuare l'annullo di un documento commerciale. Il documento commerciale può essere annullato compilando il campo progressivoSdi con il progressivo del documento commerciale che si desidera annullare.

annullaCorrispettivo:

    Parametro in ingresso:
        CorrispettivoElettronicoItem:
            - utenteItem <UtenteItem>: indica le credenziali dell'utente per effettuare l'accesso ad e-Portale.
            - utenteAdeItem <UtenteAdeItem>: indica le credenziali Fisconline del soggetto emittente.
            - progressivoSdi <String>: indica il progressivo del documento commerciale che si desidera annullare.

    Valore di ritorno:
        MysondInfoItem:
            - esito <byte>: contiene l'esito della chiamata.
            - codice <String>: contiene il codice della chiamata.
            - descrizione <String>: contiene la descrizione della chiamata.
            - messaggio <String>: contiene l'oggetto JSON che restituisce la chiamata all'Agenzia delle Entrate.

1.3. WSC3 - Consente di richiedere la lista dei documenti commerciali

La chiamata seguente consente di richiedere la lista dei documenti commerciali presenti all'interno del cassetto fiscale o del gestionale, in base al valore inserito nel campo from. Se richiesti dal cassetto fiscale, i documenti commerciali verrano inseriti nel campo messaggio della risposta sotto forma di stringa, mentre se richiesti dal gestionale verranno inseriti nel campo corrispettivoTestataItemList sotto forma di List<CorrispettivoTestataItem>. Per effettuare la chiamata l'intervallo temporale di ricerca non deve superare i 31 giorni. Inoltre è possibile filtrare il tipo di operazione desiderato a seconda del valore inserito nel campo tipoOperazione.

listaCorrispettivo:

    Parametro in ingresso:
        CorrispettivoElettronicoItem:
            - from <Byte>: indica al sistema dove effettuare la lettura dei documenti commerciali.
            - dataDal <Date>: filtro 'Data Dal' per la chiamata riguardante la lista dei documenti commerciali.
            - dataAl <Date>: filtro 'Data Al' per la chiamata riguardante la lista dei documenti commerciali.
            - tipoOperazione <String>: filtro per la tipologia di operazioni che si desidera recuperare.
            - utenteItem <UtenteItem>: indica le credenziali dell'utente per effettuare l'accesso ad e-Portale.
            - utenteAdeItem <UtenteAdeItem>: indica le credenziali Fisconline del soggetto emittente.

    Valore di ritorno:
        MysondInfoItem:
            - esito <byte>: contiene l'esito della chiamata.
            - codice <String>: contiene il codice della chiamata.
            - descrizione <String>: contiene la descrizione della chiamata.
            - messaggio <String>: contiene i documenti commerciali in caso di lettura da cassetto fiscale.
            - corrispettivoTestataItemList <List<CorrispettivoTestataItem>>: contiene i documenti commerciali in caso di lettura da gestionale.

2. Struttura degli oggetti utilizzati all'interno del servizio

2.1. Struttura dell'oggetto UtenteItem - dati di accesso ad e-Portale

Campo Descrizione
codiceAzienda Codice azienda e-Portale della quale si vuole effettuare l'accesso.
username Username dell'utente e-Portale.
password Password dell'utente e-Portale.

2.2. Struttura dell'oggetto UtenteAdeItem - dati credenziali Fisconline del soggetto emittente

Campo Descrizione
tipoUtenza Scelta dell'utenza di lavoro.
username Username dell'utente incaricato Fisconline.
password Password dell'utente incaricato Fisconline.
pincode Pincode dell'utente incaricato Fisconline.
utenza1 Utenza di primo livello (Partita Iva del soggetto emittente).
utenza2 Utenza di secondo livello (da compilare solo in caso di necessità).

2.3. Struttura dell'oggetto CorrispettivoTestataItem - testata del documento commerciale

Campo Descrizione
cfCessionarioCommittente Eventuale codice lotteria presentato dal cliente (non può essere indicato su documenti di importo inferiore ad 1 euro o non pagati esclusivamente con mezzi elettronici).
dataDoc Data di emissione del documento commerciale. (Il formato della data deve essere: 'yyyy-MM-ddTHH:mm:ss')
importoTotaleIva Importo totale dell'iva.
scontoTotale Importo totale dello sconto.
scontoTotaleLordo Importo lordo dello sconto.
scontoAbbuono Indica l'abbuono o sconto a pagare.
totaleImponibile Importo totale dell'imponibile.
ammontareComplessivo Ammontare complessivo del documento commerciale.
pagamento Tipo di pagamento del documento commerciale. ('PE': Pagamento Elettronico 'PC': Pagamento Contante)
incasso Importo del pagamento da parte del cliente.
resto Importo del resto dovuto al cliente.
corrispettivoRigaItemList Lista delle righe del documento commerciale. <CorrispettivoRigaItem>
Attenzione! I campi che seguono sono in sola lettura, vengono valorizzati solo nella chiamata WSC3.
id Identificativo dell'oggetto.
progressivoSdi Progressivo assegnato allo scontrino dal Sistema di Interscambio.
progressivoCollegato Progressivo dello scontrino annullato nel caso di creazione di un Annullo.
tipo Tipo dell'oggetto. Può assumere i seguenti valori.
stato Stato attuale del preconto. Può assumere i seguenti valori.
tipoDoc Tipo dello scontrino. Può assumere i seguenti valori.
descrizione Descrizione dell'oggetto.
utenteLog_id Utente che ha effettuato l'operazione.

2.4. Struttura dell'oggetto CorrispettivoRigaItem - riga del documento commerciale

Campo Descrizione
quantita Quantità del prodotto all'interno della riga.
descrizione Descrizione della riga.
prezzoLordo Importo prezzo lordo della riga.
prezzoUnitario Prezzo unitario del prodotto all'interno della riga.
scontoUnitario Importo sconto unitario della riga.
scontoLordo Importo sconto lordo della riga.
aliquotaIva Aliquota o natura iva del prodotto all'interno della riga.
importoIva Importo iva della riga.
imponibile Importo imponibile della riga.
imponibileNetto Importo imponibile netto della riga.
totale Importo totale della riga.
Attenzione! I campi che seguono sono in sola lettura, vengono valorizzati solo nella chiamata WSC3.
codice Codice del prodotto.

2.5. Valori utilizzabili per il campo tipoUtenza dell'oggetto UtenteAdeItem

Valore Descrizione
0 Per l'utenza di lavoro come Incaricato.
1 Per l'utenza di lavoro come Me Stesso.

2.6. Valori utilizzabili per il campo tipoTrasmissione nella chiamata WSC1

Valore Descrizione
1 Se si desidera trasmettere il documento commerciale compilando l'oggetto <CorrispettivoTestataItem>.
2 Se si desidera trasmettere il documento commerciale tramite byte array compilando il campo 'tracciato'.

2.7. Valori utilizzabili per il campo from nella chiamata WSC3

Valore Descrizione
null / 0 Se si desidera recuperare i documenti commerciali dal cassetto fiscale.
1 Se si desidera recuperare i documenti commerciali dal gestionale.

2.8. Valori utilizzabili per il campo tipoOperazione nella chiamata WSC3

Valore Descrizione
R Se si desidera recuperare i documenti commerciali di tipo 'Reso'.
A Se si desidera recuperare i documenti commerciali di tipo 'Annullo'.
V Se si desidera recuperare i documenti commerciali di tipo 'Vendita/Prestazione'.

2.9. Valori che può assumere il campo tipo nella risposta della chiamata WSC3

Valore Descrizione
1 Se è un preconto.
2 Se è uno scontrino.

3.0. Valori che può assumere il campo stato nella risposta della chiamata WSC3

Valore Descrizione
0 Se il preconto è aperto.
1 Se il preconto è chiuso.

3.1. Valori che può assumere il campo tipoDoc nella risposta della chiamata WSC3

Valore Descrizione
S Se lo scontrino è una vendita.
A Se lo scontrino è un annullo.

3.2. Valori utilizzabili per il campo esito nella risposta di tutte le chiamate

Valore Descrizione
0 Se la chiamata è andata a buon fine.
!= 0 Se si sono verificati errori, specificati nei campi codice, descrizione e messaggio.

File