@invoicetronic/ts-sdk 1.3.0 → 1.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +1 -1
- package/README.md +2 -2
- package/api.ts +1 -0
- package/common.ts +2 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -0
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +1 -0
- package/dist/esm/api.js +1 -0
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -0
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/src/api/company-api.d.ts +55 -10
- package/dist/esm/src/api/company-api.js +87 -11
- package/dist/esm/src/api/export-api.d.ts +10 -16
- package/dist/esm/src/api/export-api.js +4 -9
- package/dist/esm/src/api/health-api.d.ts +74 -0
- package/dist/esm/src/api/health-api.js +120 -0
- package/dist/esm/src/api/receive-api.d.ts +55 -10
- package/dist/esm/src/api/receive-api.js +87 -11
- package/dist/esm/src/api/send-api.d.ts +95 -51
- package/dist/esm/src/api/send-api.js +143 -67
- package/dist/esm/src/api/update-api.d.ts +10 -10
- package/dist/esm/src/api/update-api.js +8 -8
- package/dist/esm/src/models/event.d.ts +3 -0
- package/dist/esm/src/models/index.d.ts +0 -47
- package/dist/esm/src/models/index.js +0 -47
- package/dist/esm/src/models/receive.d.ts +7 -0
- package/dist/esm/src/models/send.d.ts +7 -0
- package/dist/esm/src/models/status.d.ts +3 -0
- package/dist/esm/src/models/update.d.ts +3 -0
- package/dist/esm/src/models/web-hook.d.ts +3 -0
- package/dist/src/api/company-api.d.ts +55 -10
- package/dist/src/api/company-api.js +87 -11
- package/dist/src/api/export-api.d.ts +10 -16
- package/dist/src/api/export-api.js +5 -10
- package/dist/src/api/health-api.d.ts +74 -0
- package/dist/src/api/health-api.js +127 -0
- package/dist/src/api/receive-api.d.ts +55 -10
- package/dist/src/api/receive-api.js +87 -11
- package/dist/src/api/send-api.d.ts +95 -51
- package/dist/src/api/send-api.js +143 -67
- package/dist/src/api/update-api.d.ts +10 -10
- package/dist/src/api/update-api.js +8 -8
- package/dist/src/models/event.d.ts +3 -0
- package/dist/src/models/index.d.ts +0 -47
- package/dist/src/models/index.js +0 -47
- package/dist/src/models/receive.d.ts +7 -0
- package/dist/src/models/send.d.ts +7 -0
- package/dist/src/models/status.d.ts +3 -0
- package/dist/src/models/update.d.ts +3 -0
- package/dist/src/models/web-hook.d.ts +3 -0
- package/docs/CompanyApi.md +59 -2
- package/docs/Event.md +1 -0
- package/docs/ExportApi.md +2 -2
- package/docs/HealthApi.md +54 -0
- package/docs/Receive.md +3 -0
- package/docs/ReceiveApi.md +58 -2
- package/docs/Send.md +3 -0
- package/docs/SendApi.md +78 -26
- package/docs/Status.md +1 -0
- package/docs/Update.md +1 -0
- package/docs/UpdateApi.md +2 -2
- package/docs/WebHook.md +1 -0
- package/package.json +1 -1
- package/src/api/company-api.ts +103 -13
- package/src/api/export-api.ts +10 -16
- package/src/api/health-api.ts +135 -0
- package/src/api/receive-api.ts +105 -13
- package/src/api/send-api.ts +167 -79
- package/src/api/update-api.ts +10 -10
- package/src/models/event.ts +3 -0
- package/src/models/index.ts +0 -47
- package/src/models/receive.ts +7 -0
- package/src/models/send.ts +7 -0
- package/src/models/status.ts +3 -0
- package/src/models/update.ts +3 -0
- package/src/models/web-hook.ts +3 -0
- package/dist/esm/src/models/allegati.d.ts +0 -18
- package/dist/esm/src/models/allegati.js +0 -14
- package/dist/esm/src/models/altri-dati-gestionali.d.ts +0 -17
- package/dist/esm/src/models/altri-dati-gestionali.js +0 -14
- package/dist/esm/src/models/anagrafica.d.ts +0 -18
- package/dist/esm/src/models/anagrafica.js +0 -14
- package/dist/esm/src/models/cedente-prestatore.d.ts +0 -24
- package/dist/esm/src/models/cedente-prestatore.js +0 -14
- package/dist/esm/src/models/cessionario-committente.d.ts +0 -21
- package/dist/esm/src/models/cessionario-committente.js +0 -14
- package/dist/esm/src/models/codice-articolo.d.ts +0 -15
- package/dist/esm/src/models/codice-articolo.js +0 -14
- package/dist/esm/src/models/contatti-trasmittente.d.ts +0 -15
- package/dist/esm/src/models/contatti-trasmittente.js +0 -14
- package/dist/esm/src/models/contatti.d.ts +0 -16
- package/dist/esm/src/models/contatti.js +0 -14
- package/dist/esm/src/models/dati-anagrafici-cedente-prestatore.d.ts +0 -23
- package/dist/esm/src/models/dati-anagrafici-cedente-prestatore.js +0 -14
- package/dist/esm/src/models/dati-anagrafici-cessionario-committente.d.ts +0 -18
- package/dist/esm/src/models/dati-anagrafici-cessionario-committente.js +0 -14
- package/dist/esm/src/models/dati-anagrafici-vettore.d.ts +0 -19
- package/dist/esm/src/models/dati-anagrafici-vettore.js +0 -14
- package/dist/esm/src/models/dati-anagrafici.d.ts +0 -18
- package/dist/esm/src/models/dati-anagrafici.js +0 -14
- package/dist/esm/src/models/dati-beni-servizi.d.ts +0 -17
- package/dist/esm/src/models/dati-beni-servizi.js +0 -14
- package/dist/esm/src/models/dati-bollo.d.ts +0 -15
- package/dist/esm/src/models/dati-bollo.js +0 -14
- package/dist/esm/src/models/dati-cassa-previdenziale.d.ts +0 -21
- package/dist/esm/src/models/dati-cassa-previdenziale.js +0 -14
- package/dist/esm/src/models/dati-contratto.d.ts +0 -20
- package/dist/esm/src/models/dati-contratto.js +0 -14
- package/dist/esm/src/models/dati-convenzione.d.ts +0 -20
- package/dist/esm/src/models/dati-convenzione.js +0 -14
- package/dist/esm/src/models/dati-ddt.d.ts +0 -16
- package/dist/esm/src/models/dati-ddt.js +0 -14
- package/dist/esm/src/models/dati-fatture-collegate.d.ts +0 -20
- package/dist/esm/src/models/dati-fatture-collegate.js +0 -14
- package/dist/esm/src/models/dati-generali-documento.d.ts +0 -29
- package/dist/esm/src/models/dati-generali-documento.js +0 -14
- package/dist/esm/src/models/dati-generali.d.ts +0 -33
- package/dist/esm/src/models/dati-generali.js +0 -14
- package/dist/esm/src/models/dati-ordine-acquisto.d.ts +0 -20
- package/dist/esm/src/models/dati-ordine-acquisto.js +0 -14
- package/dist/esm/src/models/dati-pagamento.d.ts +0 -16
- package/dist/esm/src/models/dati-pagamento.js +0 -14
- package/dist/esm/src/models/dati-ricezione.d.ts +0 -20
- package/dist/esm/src/models/dati-ricezione.js +0 -14
- package/dist/esm/src/models/dati-riepilogo.d.ts +0 -21
- package/dist/esm/src/models/dati-riepilogo.js +0 -14
- package/dist/esm/src/models/dati-ritenuta.d.ts +0 -17
- package/dist/esm/src/models/dati-ritenuta.js +0 -14
- package/dist/esm/src/models/dati-sal.d.ts +0 -14
- package/dist/esm/src/models/dati-sal.js +0 -14
- package/dist/esm/src/models/dati-trasmissione.d.ts +0 -21
- package/dist/esm/src/models/dati-trasmissione.js +0 -14
- package/dist/esm/src/models/dati-trasporto.d.ts +0 -28
- package/dist/esm/src/models/dati-trasporto.js +0 -14
- package/dist/esm/src/models/dati-veicoli.d.ts +0 -15
- package/dist/esm/src/models/dati-veicoli.js +0 -14
- package/dist/esm/src/models/dettaglio-linee.d.ts +0 -32
- package/dist/esm/src/models/dettaglio-linee.js +0 -14
- package/dist/esm/src/models/dettaglio-pagamento.d.ts +0 -34
- package/dist/esm/src/models/dettaglio-pagamento.js +0 -14
- package/dist/esm/src/models/fattura-elettronica-body.d.ts +0 -23
- package/dist/esm/src/models/fattura-elettronica-body.js +0 -14
- package/dist/esm/src/models/fattura-elettronica-header.d.ts +0 -24
- package/dist/esm/src/models/fattura-elettronica-header.js +0 -14
- package/dist/esm/src/models/fattura-ordinaria.d.ts +0 -18
- package/dist/esm/src/models/fattura-ordinaria.js +0 -14
- package/dist/esm/src/models/fattura-principale.d.ts +0 -15
- package/dist/esm/src/models/fattura-principale.js +0 -14
- package/dist/esm/src/models/id-fiscale-iva.d.ts +0 -15
- package/dist/esm/src/models/id-fiscale-iva.js +0 -14
- package/dist/esm/src/models/id-trasmittente.d.ts +0 -15
- package/dist/esm/src/models/id-trasmittente.js +0 -14
- package/dist/esm/src/models/indirizzo-resa.d.ts +0 -19
- package/dist/esm/src/models/indirizzo-resa.js +0 -14
- package/dist/esm/src/models/iscrizione-rea.d.ts +0 -18
- package/dist/esm/src/models/iscrizione-rea.js +0 -14
- package/dist/esm/src/models/rappresentante-fiscale-cessionario-committente.d.ts +0 -18
- package/dist/esm/src/models/rappresentante-fiscale-cessionario-committente.js +0 -14
- package/dist/esm/src/models/rappresentante-fiscale.d.ts +0 -15
- package/dist/esm/src/models/rappresentante-fiscale.js +0 -14
- package/dist/esm/src/models/sconto-maggiorazione.d.ts +0 -16
- package/dist/esm/src/models/sconto-maggiorazione.js +0 -14
- package/dist/esm/src/models/sede-cedente-prestatore.d.ts +0 -19
- package/dist/esm/src/models/sede-cedente-prestatore.js +0 -14
- package/dist/esm/src/models/sede-cessionario-committente.d.ts +0 -19
- package/dist/esm/src/models/sede-cessionario-committente.js +0 -14
- package/dist/esm/src/models/stabile-organizzazione.d.ts +0 -19
- package/dist/esm/src/models/stabile-organizzazione.js +0 -14
- package/dist/esm/src/models/terzo-intermediario-osoggetto-emittente.d.ts +0 -15
- package/dist/esm/src/models/terzo-intermediario-osoggetto-emittente.js +0 -14
- package/dist/src/models/allegati.d.ts +0 -18
- package/dist/src/models/allegati.js +0 -15
- package/dist/src/models/altri-dati-gestionali.d.ts +0 -17
- package/dist/src/models/altri-dati-gestionali.js +0 -15
- package/dist/src/models/anagrafica.d.ts +0 -18
- package/dist/src/models/anagrafica.js +0 -15
- package/dist/src/models/cedente-prestatore.d.ts +0 -24
- package/dist/src/models/cedente-prestatore.js +0 -15
- package/dist/src/models/cessionario-committente.d.ts +0 -21
- package/dist/src/models/cessionario-committente.js +0 -15
- package/dist/src/models/codice-articolo.d.ts +0 -15
- package/dist/src/models/codice-articolo.js +0 -15
- package/dist/src/models/contatti-trasmittente.d.ts +0 -15
- package/dist/src/models/contatti-trasmittente.js +0 -15
- package/dist/src/models/contatti.d.ts +0 -16
- package/dist/src/models/contatti.js +0 -15
- package/dist/src/models/dati-anagrafici-cedente-prestatore.d.ts +0 -23
- package/dist/src/models/dati-anagrafici-cedente-prestatore.js +0 -15
- package/dist/src/models/dati-anagrafici-cessionario-committente.d.ts +0 -18
- package/dist/src/models/dati-anagrafici-cessionario-committente.js +0 -15
- package/dist/src/models/dati-anagrafici-vettore.d.ts +0 -19
- package/dist/src/models/dati-anagrafici-vettore.js +0 -15
- package/dist/src/models/dati-anagrafici.d.ts +0 -18
- package/dist/src/models/dati-anagrafici.js +0 -15
- package/dist/src/models/dati-beni-servizi.d.ts +0 -17
- package/dist/src/models/dati-beni-servizi.js +0 -15
- package/dist/src/models/dati-bollo.d.ts +0 -15
- package/dist/src/models/dati-bollo.js +0 -15
- package/dist/src/models/dati-cassa-previdenziale.d.ts +0 -21
- package/dist/src/models/dati-cassa-previdenziale.js +0 -15
- package/dist/src/models/dati-contratto.d.ts +0 -20
- package/dist/src/models/dati-contratto.js +0 -15
- package/dist/src/models/dati-convenzione.d.ts +0 -20
- package/dist/src/models/dati-convenzione.js +0 -15
- package/dist/src/models/dati-ddt.d.ts +0 -16
- package/dist/src/models/dati-ddt.js +0 -15
- package/dist/src/models/dati-fatture-collegate.d.ts +0 -20
- package/dist/src/models/dati-fatture-collegate.js +0 -15
- package/dist/src/models/dati-generali-documento.d.ts +0 -29
- package/dist/src/models/dati-generali-documento.js +0 -15
- package/dist/src/models/dati-generali.d.ts +0 -33
- package/dist/src/models/dati-generali.js +0 -15
- package/dist/src/models/dati-ordine-acquisto.d.ts +0 -20
- package/dist/src/models/dati-ordine-acquisto.js +0 -15
- package/dist/src/models/dati-pagamento.d.ts +0 -16
- package/dist/src/models/dati-pagamento.js +0 -15
- package/dist/src/models/dati-ricezione.d.ts +0 -20
- package/dist/src/models/dati-ricezione.js +0 -15
- package/dist/src/models/dati-riepilogo.d.ts +0 -21
- package/dist/src/models/dati-riepilogo.js +0 -15
- package/dist/src/models/dati-ritenuta.d.ts +0 -17
- package/dist/src/models/dati-ritenuta.js +0 -15
- package/dist/src/models/dati-sal.d.ts +0 -14
- package/dist/src/models/dati-sal.js +0 -15
- package/dist/src/models/dati-trasmissione.d.ts +0 -21
- package/dist/src/models/dati-trasmissione.js +0 -15
- package/dist/src/models/dati-trasporto.d.ts +0 -28
- package/dist/src/models/dati-trasporto.js +0 -15
- package/dist/src/models/dati-veicoli.d.ts +0 -15
- package/dist/src/models/dati-veicoli.js +0 -15
- package/dist/src/models/dettaglio-linee.d.ts +0 -32
- package/dist/src/models/dettaglio-linee.js +0 -15
- package/dist/src/models/dettaglio-pagamento.d.ts +0 -34
- package/dist/src/models/dettaglio-pagamento.js +0 -15
- package/dist/src/models/fattura-elettronica-body.d.ts +0 -23
- package/dist/src/models/fattura-elettronica-body.js +0 -15
- package/dist/src/models/fattura-elettronica-header.d.ts +0 -24
- package/dist/src/models/fattura-elettronica-header.js +0 -15
- package/dist/src/models/fattura-ordinaria.d.ts +0 -18
- package/dist/src/models/fattura-ordinaria.js +0 -15
- package/dist/src/models/fattura-principale.d.ts +0 -15
- package/dist/src/models/fattura-principale.js +0 -15
- package/dist/src/models/id-fiscale-iva.d.ts +0 -15
- package/dist/src/models/id-fiscale-iva.js +0 -15
- package/dist/src/models/id-trasmittente.d.ts +0 -15
- package/dist/src/models/id-trasmittente.js +0 -15
- package/dist/src/models/indirizzo-resa.d.ts +0 -19
- package/dist/src/models/indirizzo-resa.js +0 -15
- package/dist/src/models/iscrizione-rea.d.ts +0 -18
- package/dist/src/models/iscrizione-rea.js +0 -15
- package/dist/src/models/rappresentante-fiscale-cessionario-committente.d.ts +0 -18
- package/dist/src/models/rappresentante-fiscale-cessionario-committente.js +0 -15
- package/dist/src/models/rappresentante-fiscale.d.ts +0 -15
- package/dist/src/models/rappresentante-fiscale.js +0 -15
- package/dist/src/models/sconto-maggiorazione.d.ts +0 -16
- package/dist/src/models/sconto-maggiorazione.js +0 -15
- package/dist/src/models/sede-cedente-prestatore.d.ts +0 -19
- package/dist/src/models/sede-cedente-prestatore.js +0 -15
- package/dist/src/models/sede-cessionario-committente.d.ts +0 -19
- package/dist/src/models/sede-cessionario-committente.js +0 -15
- package/dist/src/models/stabile-organizzazione.d.ts +0 -19
- package/dist/src/models/stabile-organizzazione.js +0 -15
- package/dist/src/models/terzo-intermediario-osoggetto-emittente.d.ts +0 -15
- package/dist/src/models/terzo-intermediario-osoggetto-emittente.js +0 -15
- package/docs/Allegati.md +0 -28
- package/docs/AltriDatiGestionali.md +0 -26
- package/docs/Anagrafica.md +0 -28
- package/docs/CedentePrestatore.md +0 -30
- package/docs/CessionarioCommittente.md +0 -26
- package/docs/CodiceArticolo.md +0 -22
- package/docs/Contatti.md +0 -24
- package/docs/ContattiTrasmittente.md +0 -22
- package/docs/DatiAnagrafici.md +0 -24
- package/docs/DatiAnagraficiCedentePrestatore.md +0 -34
- package/docs/DatiAnagraficiCessionarioCommittente.md +0 -24
- package/docs/DatiAnagraficiVettore.md +0 -26
- package/docs/DatiBeniServizi.md +0 -22
- package/docs/DatiBollo.md +0 -22
- package/docs/DatiCassaPrevidenziale.md +0 -34
- package/docs/DatiContratto.md +0 -32
- package/docs/DatiConvenzione.md +0 -32
- package/docs/DatiDDT.md +0 -24
- package/docs/DatiFattureCollegate.md +0 -32
- package/docs/DatiGenerali.md +0 -38
- package/docs/DatiGeneraliDocumento.md +0 -42
- package/docs/DatiOrdineAcquisto.md +0 -32
- package/docs/DatiPagamento.md +0 -22
- package/docs/DatiRicezione.md +0 -32
- package/docs/DatiRiepilogo.md +0 -34
- package/docs/DatiRitenuta.md +0 -26
- package/docs/DatiSAL.md +0 -20
- package/docs/DatiTrasmissione.md +0 -30
- package/docs/DatiTrasporto.md +0 -44
- package/docs/DatiVeicoli.md +0 -22
- package/docs/DettaglioLinee.md +0 -50
- package/docs/DettaglioPagamento.md +0 -60
- package/docs/FatturaElettronicaBody.md +0 -28
- package/docs/FatturaElettronicaHeader.md +0 -30
- package/docs/FatturaOrdinaria.md +0 -24
- package/docs/FatturaPrincipale.md +0 -22
- package/docs/IdFiscaleIVA.md +0 -22
- package/docs/IdTrasmittente.md +0 -22
- package/docs/IndirizzoResa.md +0 -30
- package/docs/IscrizioneREA.md +0 -28
- package/docs/RappresentanteFiscale.md +0 -20
- package/docs/RappresentanteFiscaleCessionarioCommittente.md +0 -26
- package/docs/ScontoMaggiorazione.md +0 -24
- package/docs/SedeCedentePrestatore.md +0 -30
- package/docs/SedeCessionarioCommittente.md +0 -30
- package/docs/StabileOrganizzazione.md +0 -30
- package/docs/TerzoIntermediarioOSoggettoEmittente.md +0 -20
- package/src/models/allegati.ts +0 -24
- package/src/models/altri-dati-gestionali.ts +0 -23
- package/src/models/anagrafica.ts +0 -24
- package/src/models/cedente-prestatore.ts +0 -40
- package/src/models/cessionario-committente.ts +0 -35
- package/src/models/codice-articolo.ts +0 -21
- package/src/models/contatti-trasmittente.ts +0 -21
- package/src/models/contatti.ts +0 -22
- package/src/models/dati-anagrafici-cedente-prestatore.ts +0 -33
- package/src/models/dati-anagrafici-cessionario-committente.ts +0 -28
- package/src/models/dati-anagrafici-vettore.ts +0 -29
- package/src/models/dati-anagrafici.ts +0 -28
- package/src/models/dati-beni-servizi.ts +0 -27
- package/src/models/dati-bollo.ts +0 -21
- package/src/models/dati-cassa-previdenziale.ts +0 -27
- package/src/models/dati-contratto.ts +0 -26
- package/src/models/dati-convenzione.ts +0 -26
- package/src/models/dati-ddt.ts +0 -22
- package/src/models/dati-fatture-collegate.ts +0 -26
- package/src/models/dati-generali-documento.ts +0 -43
- package/src/models/dati-generali.ts +0 -59
- package/src/models/dati-ordine-acquisto.ts +0 -26
- package/src/models/dati-pagamento.ts +0 -24
- package/src/models/dati-ricezione.ts +0 -26
- package/src/models/dati-riepilogo.ts +0 -27
- package/src/models/dati-ritenuta.ts +0 -23
- package/src/models/dati-sal.ts +0 -20
- package/src/models/dati-trasmissione.ts +0 -31
- package/src/models/dati-trasporto.ts +0 -38
- package/src/models/dati-veicoli.ts +0 -21
- package/src/models/dettaglio-linee.ts +0 -44
- package/src/models/dettaglio-pagamento.ts +0 -40
- package/src/models/fattura-elettronica-body.ts +0 -39
- package/src/models/fattura-elettronica-header.ts +0 -40
- package/src/models/fattura-ordinaria.ts +0 -28
- package/src/models/fattura-principale.ts +0 -21
- package/src/models/id-fiscale-iva.ts +0 -21
- package/src/models/id-trasmittente.ts +0 -21
- package/src/models/indirizzo-resa.ts +0 -25
- package/src/models/iscrizione-rea.ts +0 -24
- package/src/models/rappresentante-fiscale-cessionario-committente.ts +0 -26
- package/src/models/rappresentante-fiscale.ts +0 -23
- package/src/models/sconto-maggiorazione.ts +0 -22
- package/src/models/sede-cedente-prestatore.ts +0 -25
- package/src/models/sede-cessionario-committente.ts +0 -25
- package/src/models/stabile-organizzazione.ts +0 -25
- package/src/models/terzo-intermediario-osoggetto-emittente.ts +0 -23
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# HealthApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**healthGet**](#healthget) | **GET** /health | Health check|
|
|
8
|
+
|
|
9
|
+
# **healthGet**
|
|
10
|
+
> healthGet()
|
|
11
|
+
|
|
12
|
+
Returns the health status of the API and its dependencies. No authentication required. Rate limited to 12 requests per minute.
|
|
13
|
+
|
|
14
|
+
### Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import {
|
|
18
|
+
HealthApi,
|
|
19
|
+
Configuration
|
|
20
|
+
} from '@invoicetronic/ts-sdk';
|
|
21
|
+
|
|
22
|
+
const configuration = new Configuration();
|
|
23
|
+
const apiInstance = new HealthApi(configuration);
|
|
24
|
+
|
|
25
|
+
const { status, data } = await apiInstance.healthGet();
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### Parameters
|
|
29
|
+
This endpoint does not have any parameters.
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
### Return type
|
|
33
|
+
|
|
34
|
+
void (empty response body)
|
|
35
|
+
|
|
36
|
+
### Authorization
|
|
37
|
+
|
|
38
|
+
[Basic](../README.md#Basic)
|
|
39
|
+
|
|
40
|
+
### HTTP request headers
|
|
41
|
+
|
|
42
|
+
- **Content-Type**: Not defined
|
|
43
|
+
- **Accept**: Not defined
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
### HTTP response details
|
|
47
|
+
| Status code | Description | Response headers |
|
|
48
|
+
|-------------|-------------|------------------|
|
|
49
|
+
|**200** | OK | - |
|
|
50
|
+
|**429** | Too Many Requests | - |
|
|
51
|
+
|**503** | Service Unavailable | - |
|
|
52
|
+
|
|
53
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
54
|
+
|
package/docs/Receive.md
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
# Receive
|
|
2
2
|
|
|
3
|
+
A received invoice.
|
|
3
4
|
|
|
4
5
|
## Properties
|
|
5
6
|
|
|
@@ -20,6 +21,7 @@ Name | Type | Description | Notes
|
|
|
20
21
|
**date_sent** | **string** | When the invoice was sent to SDI. | [optional] [default to undefined]
|
|
21
22
|
**documents** | [**Array<DocumentData>**](DocumentData.md) | The invoices included in the payload. This is set by the system, based on the xml content. | [optional] [default to undefined]
|
|
22
23
|
**encoding** | **string** | Whether the payload is Base64 encoded or a plain XML (text). | [optional] [default to undefined]
|
|
24
|
+
**nome_prestatore** | **string** | Business name of the prestatore (supplier/seller) extracted from the invoice XML. | [optional] [default to undefined]
|
|
23
25
|
**is_read** | **boolean** | Whether the invoice has been read at least once. Set to true only when the invoice is requested with include_payload=true. | [optional] [default to undefined]
|
|
24
26
|
**message_id** | **string** | SDI message id. | [optional] [default to undefined]
|
|
25
27
|
|
|
@@ -44,6 +46,7 @@ const instance: Receive = {
|
|
|
44
46
|
date_sent,
|
|
45
47
|
documents,
|
|
46
48
|
encoding,
|
|
49
|
+
nome_prestatore,
|
|
47
50
|
is_read,
|
|
48
51
|
message_id,
|
|
49
52
|
};
|
package/docs/ReceiveApi.md
CHANGED
|
@@ -7,11 +7,12 @@ All URIs are relative to *http://localhost*
|
|
|
7
7
|
|[**receiveGet**](#receiveget) | **GET** /receive | List incoming invoices|
|
|
8
8
|
|[**receiveIdDelete**](#receiveiddelete) | **DELETE** /receive/{id} | Delete an incoming invoice by id|
|
|
9
9
|
|[**receiveIdGet**](#receiveidget) | **GET** /receive/{id} | Get an incoming invoice by id|
|
|
10
|
+
|[**receiveIdPayloadGet**](#receiveidpayloadget) | **GET** /receive/{id}/payload | Get a receive invoice payload by id|
|
|
10
11
|
|
|
11
12
|
# **receiveGet**
|
|
12
13
|
> Array<Receive> receiveGet()
|
|
13
14
|
|
|
14
|
-
Retrieve a paginated list of receive invoices. Results can be filtered by various criteria such as company, date ranges, sender, and
|
|
15
|
+
Retrieve a paginated list of receive invoices. Results can be filtered by various criteria such as company, date ranges, sender, document number, and free-text search (`q`). Returns invoice metadata; set `include_payload` to true to include the full invoice content. Invoices are marked as read (`is_read` = true) only when `include_payload` is true. **Receive** invoices are inbound purchase invoices received from suppliers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 24 hours in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
|
|
15
16
|
|
|
16
17
|
### Example
|
|
17
18
|
|
|
@@ -41,6 +42,7 @@ let includePayload: boolean; //Include payload in the response. Defaults to fals
|
|
|
41
42
|
let page: number; //Page number. (optional) (default to 1)
|
|
42
43
|
let pageSize: number; //Items per page. Cannot be greater than 200. (optional) (default to 100)
|
|
43
44
|
let sort: string; //Sort by field. Prefix with \'-\' for descending order. (optional) (default to undefined)
|
|
45
|
+
let q: string; //Full-text search across committente, prestatore, identifier, and file name. (optional) (default to undefined)
|
|
44
46
|
|
|
45
47
|
const { status, data } = await apiInstance.receiveGet(
|
|
46
48
|
companyId,
|
|
@@ -59,7 +61,8 @@ const { status, data } = await apiInstance.receiveGet(
|
|
|
59
61
|
includePayload,
|
|
60
62
|
page,
|
|
61
63
|
pageSize,
|
|
62
|
-
sort
|
|
64
|
+
sort,
|
|
65
|
+
q
|
|
63
66
|
);
|
|
64
67
|
```
|
|
65
68
|
|
|
@@ -84,6 +87,7 @@ const { status, data } = await apiInstance.receiveGet(
|
|
|
84
87
|
| **page** | [**number**] | Page number. | (optional) defaults to 1|
|
|
85
88
|
| **pageSize** | [**number**] | Items per page. Cannot be greater than 200. | (optional) defaults to 100|
|
|
86
89
|
| **sort** | [**string**] | Sort by field. Prefix with \'-\' for descending order. | (optional) defaults to undefined|
|
|
90
|
+
| **q** | [**string**] | Full-text search across committente, prestatore, identifier, and file name. | (optional) defaults to undefined|
|
|
87
91
|
|
|
88
92
|
|
|
89
93
|
### Return type
|
|
@@ -219,3 +223,55 @@ const { status, data } = await apiInstance.receiveIdGet(
|
|
|
219
223
|
|
|
220
224
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
221
225
|
|
|
226
|
+
# **receiveIdPayloadGet**
|
|
227
|
+
> receiveIdPayloadGet()
|
|
228
|
+
|
|
229
|
+
Retrieve only the payload of a receive invoice, without the full invoice metadata. This is useful when you already have the invoice metadata and only need the XML content. The response is a `text/plain` string, identical to the `payload` field returned by the standard GET endpoint with `include_payload=true`. The invoice is marked as read (`is_read` = true) and counted as an operation, same as when retrieving the full invoice with `include_payload=true`.
|
|
230
|
+
|
|
231
|
+
### Example
|
|
232
|
+
|
|
233
|
+
```typescript
|
|
234
|
+
import {
|
|
235
|
+
ReceiveApi,
|
|
236
|
+
Configuration
|
|
237
|
+
} from '@invoicetronic/ts-sdk';
|
|
238
|
+
|
|
239
|
+
const configuration = new Configuration();
|
|
240
|
+
const apiInstance = new ReceiveApi(configuration);
|
|
241
|
+
|
|
242
|
+
let id: number; //Item id (default to undefined)
|
|
243
|
+
|
|
244
|
+
const { status, data } = await apiInstance.receiveIdPayloadGet(
|
|
245
|
+
id
|
|
246
|
+
);
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
### Parameters
|
|
250
|
+
|
|
251
|
+
|Name | Type | Description | Notes|
|
|
252
|
+
|------------- | ------------- | ------------- | -------------|
|
|
253
|
+
| **id** | [**number**] | Item id | defaults to undefined|
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
### Return type
|
|
257
|
+
|
|
258
|
+
void (empty response body)
|
|
259
|
+
|
|
260
|
+
### Authorization
|
|
261
|
+
|
|
262
|
+
[Basic](../README.md#Basic)
|
|
263
|
+
|
|
264
|
+
### HTTP request headers
|
|
265
|
+
|
|
266
|
+
- **Content-Type**: Not defined
|
|
267
|
+
- **Accept**: application/problem+json
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
### HTTP response details
|
|
271
|
+
| Status code | Description | Response headers |
|
|
272
|
+
|-------------|-------------|------------------|
|
|
273
|
+
|**200** | OK | - |
|
|
274
|
+
|**404** | Not Found | - |
|
|
275
|
+
|
|
276
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
277
|
+
|
package/docs/Send.md
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
# Send
|
|
2
2
|
|
|
3
|
+
A sent invoice.
|
|
3
4
|
|
|
4
5
|
## Properties
|
|
5
6
|
|
|
@@ -20,6 +21,7 @@ Name | Type | Description | Notes
|
|
|
20
21
|
**date_sent** | **string** | When the invoice was sent to SDI. | [optional] [default to undefined]
|
|
21
22
|
**documents** | [**Array<DocumentData>**](DocumentData.md) | The invoices included in the payload. This is set by the system, based on the xml content. | [optional] [default to undefined]
|
|
22
23
|
**encoding** | **string** | Whether the payload is Base64 encoded or a plain XML (text). | [optional] [default to undefined]
|
|
24
|
+
**nome_committente** | **string** | Business name of the committente (client/buyer) extracted from the invoice XML. | [optional] [default to undefined]
|
|
23
25
|
**meta_data** | **{ [key: string]: string; }** | Optional metadata, as json. | [optional] [default to undefined]
|
|
24
26
|
**company** | [**Company**](Company.md) | | [optional] [default to undefined]
|
|
25
27
|
|
|
@@ -44,6 +46,7 @@ const instance: Send = {
|
|
|
44
46
|
date_sent,
|
|
45
47
|
documents,
|
|
46
48
|
encoding,
|
|
49
|
+
nome_committente,
|
|
47
50
|
meta_data,
|
|
48
51
|
company,
|
|
49
52
|
};
|
package/docs/SendApi.md
CHANGED
|
@@ -7,6 +7,7 @@ All URIs are relative to *http://localhost*
|
|
|
7
7
|
|[**sendFilePost**](#sendfilepost) | **POST** /send/file | Add an invoice by file|
|
|
8
8
|
|[**sendGet**](#sendget) | **GET** /send | List invoices|
|
|
9
9
|
|[**sendIdGet**](#sendidget) | **GET** /send/{id} | Get a invoice by id|
|
|
10
|
+
|[**sendIdPayloadGet**](#sendidpayloadget) | **GET** /send/{id}/payload | Get a send invoice payload by id|
|
|
10
11
|
|[**sendIdentifierGet**](#sendidentifierget) | **GET** /send/{identifier} | Get a invoice by identifier|
|
|
11
12
|
|[**sendJsonPost**](#sendjsonpost) | **POST** /send/json | Add an invoice by json|
|
|
12
13
|
|[**sendPost**](#sendpost) | **POST** /send | Add an invoice|
|
|
@@ -78,7 +79,7 @@ const { status, data } = await apiInstance.sendFilePost(
|
|
|
78
79
|
# **sendGet**
|
|
79
80
|
> Array<Send> sendGet()
|
|
80
81
|
|
|
81
|
-
Retrieve a paginated list of send invoices. Results can be filtered by various criteria such as company, date ranges, and
|
|
82
|
+
Retrieve a paginated list of send invoices. Results can be filtered by various criteria such as company, date ranges, document number, and free-text search (`q`). Returns invoice metadata; set `include_payload` to true to include the full invoice content. **Send** invoices are outbound sales invoices transmitted to customers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 15 days in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
|
|
82
83
|
|
|
83
84
|
### Example
|
|
84
85
|
|
|
@@ -107,6 +108,7 @@ let includePayload: boolean; //Include payload in the response. Defaults to fals
|
|
|
107
108
|
let page: number; //Page number. (optional) (default to 1)
|
|
108
109
|
let pageSize: number; //Items per page. Cannot be greater than 200. (optional) (default to 100)
|
|
109
110
|
let sort: string; //Sort by field. Prefix with \'-\' for descending order. (optional) (default to undefined)
|
|
111
|
+
let q: string; //Full-text search across committente, prestatore, identifier, and file name. (optional) (default to undefined)
|
|
110
112
|
|
|
111
113
|
const { status, data } = await apiInstance.sendGet(
|
|
112
114
|
companyId,
|
|
@@ -124,7 +126,8 @@ const { status, data } = await apiInstance.sendGet(
|
|
|
124
126
|
includePayload,
|
|
125
127
|
page,
|
|
126
128
|
pageSize,
|
|
127
|
-
sort
|
|
129
|
+
sort,
|
|
130
|
+
q
|
|
128
131
|
);
|
|
129
132
|
```
|
|
130
133
|
|
|
@@ -148,6 +151,7 @@ const { status, data } = await apiInstance.sendGet(
|
|
|
148
151
|
| **page** | [**number**] | Page number. | (optional) defaults to 1|
|
|
149
152
|
| **pageSize** | [**number**] | Items per page. Cannot be greater than 200. | (optional) defaults to 100|
|
|
150
153
|
| **sort** | [**string**] | Sort by field. Prefix with \'-\' for descending order. | (optional) defaults to undefined|
|
|
154
|
+
| **q** | [**string**] | Full-text search across committente, prestatore, identifier, and file name. | (optional) defaults to undefined|
|
|
151
155
|
|
|
152
156
|
|
|
153
157
|
### Return type
|
|
@@ -220,6 +224,58 @@ const { status, data } = await apiInstance.sendIdGet(
|
|
|
220
224
|
- **Accept**: application/json
|
|
221
225
|
|
|
222
226
|
|
|
227
|
+
### HTTP response details
|
|
228
|
+
| Status code | Description | Response headers |
|
|
229
|
+
|-------------|-------------|------------------|
|
|
230
|
+
|**200** | OK | - |
|
|
231
|
+
|**404** | Not Found | - |
|
|
232
|
+
|
|
233
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
234
|
+
|
|
235
|
+
# **sendIdPayloadGet**
|
|
236
|
+
> sendIdPayloadGet()
|
|
237
|
+
|
|
238
|
+
Retrieve only the payload of a send invoice, without the full invoice metadata. This is useful when you already have the invoice metadata and only need the XML content. The response is a `text/plain` string, identical to the `payload` field returned by the standard GET endpoint with `include_payload=true`. Depending on how the invoice was originally submitted, the payload may be Base64-encoded or plain XML.
|
|
239
|
+
|
|
240
|
+
### Example
|
|
241
|
+
|
|
242
|
+
```typescript
|
|
243
|
+
import {
|
|
244
|
+
SendApi,
|
|
245
|
+
Configuration
|
|
246
|
+
} from '@invoicetronic/ts-sdk';
|
|
247
|
+
|
|
248
|
+
const configuration = new Configuration();
|
|
249
|
+
const apiInstance = new SendApi(configuration);
|
|
250
|
+
|
|
251
|
+
let id: number; //Item id (default to undefined)
|
|
252
|
+
|
|
253
|
+
const { status, data } = await apiInstance.sendIdPayloadGet(
|
|
254
|
+
id
|
|
255
|
+
);
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
### Parameters
|
|
259
|
+
|
|
260
|
+
|Name | Type | Description | Notes|
|
|
261
|
+
|------------- | ------------- | ------------- | -------------|
|
|
262
|
+
| **id** | [**number**] | Item id | defaults to undefined|
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
### Return type
|
|
266
|
+
|
|
267
|
+
void (empty response body)
|
|
268
|
+
|
|
269
|
+
### Authorization
|
|
270
|
+
|
|
271
|
+
[Basic](../README.md#Basic)
|
|
272
|
+
|
|
273
|
+
### HTTP request headers
|
|
274
|
+
|
|
275
|
+
- **Content-Type**: Not defined
|
|
276
|
+
- **Accept**: application/problem+json
|
|
277
|
+
|
|
278
|
+
|
|
223
279
|
### HTTP response details
|
|
224
280
|
| Status code | Description | Response headers |
|
|
225
281
|
|-------------|-------------|------------------|
|
|
@@ -285,7 +341,7 @@ const { status, data } = await apiInstance.sendIdentifierGet(
|
|
|
285
341
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
286
342
|
|
|
287
343
|
# **sendJsonPost**
|
|
288
|
-
> Send sendJsonPost(
|
|
344
|
+
> Send sendJsonPost(body)
|
|
289
345
|
|
|
290
346
|
Add a new invoice using a FatturaPA JSON representation. The invoice will be signed (if requested), validated (if requested), and queued for delivery to SDI. Status updates from SDI will be available in the `update` endpoint. **Send** invoices are outbound sales invoices transmitted to customers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 15 days in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/). You can also upload invoices via the [Dashboard](https://dashboard.invoicetronic.com).
|
|
291
347
|
|
|
@@ -294,19 +350,18 @@ Add a new invoice using a FatturaPA JSON representation. The invoice will be sig
|
|
|
294
350
|
```typescript
|
|
295
351
|
import {
|
|
296
352
|
SendApi,
|
|
297
|
-
Configuration
|
|
298
|
-
FatturaOrdinaria
|
|
353
|
+
Configuration
|
|
299
354
|
} from '@invoicetronic/ts-sdk';
|
|
300
355
|
|
|
301
356
|
const configuration = new Configuration();
|
|
302
357
|
const apiInstance = new SendApi(configuration);
|
|
303
358
|
|
|
304
|
-
let
|
|
359
|
+
let body: object; //
|
|
305
360
|
let validate: boolean; //Validate the document first, and reject it on failure. (optional) (default to false)
|
|
306
361
|
let signature: 'None' | 'Apply' | 'Force' | 'Auto'; //Whether to digitally sign the document. (optional) (default to 'Auto')
|
|
307
362
|
|
|
308
363
|
const { status, data } = await apiInstance.sendJsonPost(
|
|
309
|
-
|
|
364
|
+
body,
|
|
310
365
|
validate,
|
|
311
366
|
signature
|
|
312
367
|
);
|
|
@@ -316,7 +371,7 @@ const { status, data } = await apiInstance.sendJsonPost(
|
|
|
316
371
|
|
|
317
372
|
|Name | Type | Description | Notes|
|
|
318
373
|
|------------- | ------------- | ------------- | -------------|
|
|
319
|
-
| **
|
|
374
|
+
| **body** | **object**| | |
|
|
320
375
|
| **validate** | [**boolean**] | Validate the document first, and reject it on failure. | (optional) defaults to false|
|
|
321
376
|
| **signature** | [**'None' | 'Apply' | 'Force' | 'Auto'**]**Array<'None' | 'Apply' | 'Force' | 'Auto'>** | Whether to digitally sign the document. | (optional) defaults to 'Auto'|
|
|
322
377
|
|
|
@@ -458,7 +513,7 @@ void (empty response body)
|
|
|
458
513
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
459
514
|
|
|
460
515
|
# **sendValidateJsonPost**
|
|
461
|
-
> sendValidateJsonPost(
|
|
516
|
+
> sendValidateJsonPost(body)
|
|
462
517
|
|
|
463
518
|
Validate a JSON invoice without sending it to SDI. Use this to check for errors before actual submission. Returns validation results with any errors found. **Send** invoices are outbound sales invoices transmitted to customers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 15 days in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
|
|
464
519
|
|
|
@@ -467,17 +522,16 @@ Validate a JSON invoice without sending it to SDI. Use this to check for errors
|
|
|
467
522
|
```typescript
|
|
468
523
|
import {
|
|
469
524
|
SendApi,
|
|
470
|
-
Configuration
|
|
471
|
-
FatturaOrdinaria
|
|
525
|
+
Configuration
|
|
472
526
|
} from '@invoicetronic/ts-sdk';
|
|
473
527
|
|
|
474
528
|
const configuration = new Configuration();
|
|
475
529
|
const apiInstance = new SendApi(configuration);
|
|
476
530
|
|
|
477
|
-
let
|
|
531
|
+
let body: object; //
|
|
478
532
|
|
|
479
533
|
const { status, data } = await apiInstance.sendValidateJsonPost(
|
|
480
|
-
|
|
534
|
+
body
|
|
481
535
|
);
|
|
482
536
|
```
|
|
483
537
|
|
|
@@ -485,7 +539,7 @@ const { status, data } = await apiInstance.sendValidateJsonPost(
|
|
|
485
539
|
|
|
486
540
|
|Name | Type | Description | Notes|
|
|
487
541
|
|------------- | ------------- | ------------- | -------------|
|
|
488
|
-
| **
|
|
542
|
+
| **body** | **object**| | |
|
|
489
543
|
|
|
490
544
|
|
|
491
545
|
### Return type
|
|
@@ -566,7 +620,7 @@ void (empty response body)
|
|
|
566
620
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
567
621
|
|
|
568
622
|
# **sendValidateXmlPost**
|
|
569
|
-
> sendValidateXmlPost(
|
|
623
|
+
> sendValidateXmlPost(body)
|
|
570
624
|
|
|
571
625
|
Validate an XML invoice document without sending it to SDI. Use this to check for errors before actual submission. Returns validation results with any errors found. **Send** invoices are outbound sales invoices transmitted to customers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 15 days in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/).
|
|
572
626
|
|
|
@@ -575,17 +629,16 @@ Validate an XML invoice document without sending it to SDI. Use this to check fo
|
|
|
575
629
|
```typescript
|
|
576
630
|
import {
|
|
577
631
|
SendApi,
|
|
578
|
-
Configuration
|
|
579
|
-
FatturaOrdinaria
|
|
632
|
+
Configuration
|
|
580
633
|
} from '@invoicetronic/ts-sdk';
|
|
581
634
|
|
|
582
635
|
const configuration = new Configuration();
|
|
583
636
|
const apiInstance = new SendApi(configuration);
|
|
584
637
|
|
|
585
|
-
let
|
|
638
|
+
let body: object; //
|
|
586
639
|
|
|
587
640
|
const { status, data } = await apiInstance.sendValidateXmlPost(
|
|
588
|
-
|
|
641
|
+
body
|
|
589
642
|
);
|
|
590
643
|
```
|
|
591
644
|
|
|
@@ -593,7 +646,7 @@ const { status, data } = await apiInstance.sendValidateXmlPost(
|
|
|
593
646
|
|
|
594
647
|
|Name | Type | Description | Notes|
|
|
595
648
|
|------------- | ------------- | ------------- | -------------|
|
|
596
|
-
| **
|
|
649
|
+
| **body** | **object**| | |
|
|
597
650
|
|
|
598
651
|
|
|
599
652
|
### Return type
|
|
@@ -620,7 +673,7 @@ void (empty response body)
|
|
|
620
673
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
621
674
|
|
|
622
675
|
# **sendXmlPost**
|
|
623
|
-
> Send sendXmlPost(
|
|
676
|
+
> Send sendXmlPost(body)
|
|
624
677
|
|
|
625
678
|
Add a new invoice using a raw XML document in FatturaPA format. The invoice will be signed (if requested), validated (if requested), and queued for delivery to SDI. Status updates from SDI will be available in the `update` endpoint. **Send** invoices are outbound sales invoices transmitted to customers through Italy\'s SDI (Sistema di Interscambio). Preserved for two years in the live environment and 15 days in the [Sandbox](https://invoicetronic.com/en/docs/sandbox/). You can also upload invoices via the [Dashboard](https://dashboard.invoicetronic.com).
|
|
626
679
|
|
|
@@ -629,19 +682,18 @@ Add a new invoice using a raw XML document in FatturaPA format. The invoice will
|
|
|
629
682
|
```typescript
|
|
630
683
|
import {
|
|
631
684
|
SendApi,
|
|
632
|
-
Configuration
|
|
633
|
-
FatturaOrdinaria
|
|
685
|
+
Configuration
|
|
634
686
|
} from '@invoicetronic/ts-sdk';
|
|
635
687
|
|
|
636
688
|
const configuration = new Configuration();
|
|
637
689
|
const apiInstance = new SendApi(configuration);
|
|
638
690
|
|
|
639
|
-
let
|
|
691
|
+
let body: object; //
|
|
640
692
|
let validate: boolean; //Validate the document first, and reject it on failure. (optional) (default to false)
|
|
641
693
|
let signature: 'None' | 'Apply' | 'Force' | 'Auto'; //Whether to digitally sign the document. (optional) (default to 'Auto')
|
|
642
694
|
|
|
643
695
|
const { status, data } = await apiInstance.sendXmlPost(
|
|
644
|
-
|
|
696
|
+
body,
|
|
645
697
|
validate,
|
|
646
698
|
signature
|
|
647
699
|
);
|
|
@@ -651,7 +703,7 @@ const { status, data } = await apiInstance.sendXmlPost(
|
|
|
651
703
|
|
|
652
704
|
|Name | Type | Description | Notes|
|
|
653
705
|
|------------- | ------------- | ------------- | -------------|
|
|
654
|
-
| **
|
|
706
|
+
| **body** | **object**| | |
|
|
655
707
|
| **validate** | [**boolean**] | Validate the document first, and reject it on failure. | (optional) defaults to false|
|
|
656
708
|
| **signature** | [**'None' | 'Apply' | 'Force' | 'Auto'**]**Array<'None' | 'Apply' | 'Force' | 'Auto'>** | Whether to digitally sign the document. | (optional) defaults to 'Auto'|
|
|
657
709
|
|
package/docs/Status.md
CHANGED
package/docs/Update.md
CHANGED
package/docs/UpdateApi.md
CHANGED
|
@@ -10,7 +10,7 @@ All URIs are relative to *http://localhost*
|
|
|
10
10
|
# **updateGet**
|
|
11
11
|
> Array<Update> updateGet()
|
|
12
12
|
|
|
13
|
-
Retrieve a paginated list of updates. Results can be filtered by various criteria such as company, send item, SDI state, and date ranges. **Updates** are status notifications from Italy\'s SDI (Sistema di Interscambio) about invoices you sent. Multiple updates can exist for the same send item as the invoice progresses through the SDI workflow. The `state` field is the most important property and can have the following values: | Value | Name | Description | |-------|------|-------------| | 2 | `Inviato` | Sent to the SDI. | | 5 | `Consegnato` | Delivered to the recipient. | | 6 | `NonConsegnato` | Not delivered to the recipient. Only relevant for public administration entities. | | 7 | `Scartato` | Rejected by the SDI. | | 8 | `AccettatoDalDestinatario` | Accepted by the recipient. Only relevant for public administration entities. | | 9 | `RifiutatoDalDestinatario` | Rejected by the recipient. Only relevant for public administration entities. | | 10 | `ImpossibilitaDiRecapito` | Available on the recipient\'s tax drawer, but it was not possible to deliver it to the recipient\'s reception system. | | 11 | `DecorrenzaTermini` | A public administration entity has not responded for more than 15 days. The document is considered delivered. | | 12 | `AttestazioneTrasmissioneFattura` | A public administration entity has received the document, but has not yet processed it. | **Important:** Always monitor the state of your sent invoices. A state of `Inviato` only means the invoice has been submitted to SDI, not that it has been delivered. A state like `Scartato` indicates that the invoice was **not** successfully delivered and may require corrective action, such as fixing validation errors and resubmitting. In that case, `description` contains the reason for the rejection.
|
|
13
|
+
Retrieve a paginated list of updates. Results can be filtered by various criteria such as company, send item, SDI state, and date ranges. **Updates** are status notifications from Italy\'s SDI (Sistema di Interscambio) about invoices you sent. Multiple updates can exist for the same send item as the invoice progresses through the SDI workflow. The `state` field is the most important property and can have the following values: | Value | Name | Description | |-------|------|-------------| | 2 | `Inviato` | Sent to the SDI. | | 5 | `Consegnato` | Delivered to the recipient. | | 6 | `NonConsegnato` | Not delivered to the recipient. Only relevant for public administration entities. | | 7 | `Scartato` | Rejected by the SDI. | | 8 | `AccettatoDalDestinatario` | Accepted by the recipient. Only relevant for public administration entities. | | 9 | `RifiutatoDalDestinatario` | Rejected by the recipient. Only relevant for public administration entities. | | 10 | `ImpossibilitaDiRecapito` | Available on the recipient\'s tax drawer, but it was not possible to deliver it to the recipient\'s reception system. | | 11 | `DecorrenzaTermini` | A public administration entity has not responded for more than 15 days. The document is considered delivered. | | 12 | `AttestazioneTrasmissioneFattura` | A public administration entity has received the document, but has not yet processed it. | **Cost:** Querying this endpoint is free and does not count as an operation against your plan limits. **Important:** Always monitor the state of your sent invoices. A state of `Inviato` only means the invoice has been submitted to SDI, not that it has been delivered. A state like `Scartato` indicates that the invoice was **not** successfully delivered and may require corrective action, such as fixing validation errors and resubmitting. In that case, `description` contains the reason for the rejection.
|
|
14
14
|
|
|
15
15
|
### Example
|
|
16
16
|
|
|
@@ -99,7 +99,7 @@ const { status, data } = await apiInstance.updateGet(
|
|
|
99
99
|
# **updateIdGet**
|
|
100
100
|
> Update updateIdGet()
|
|
101
101
|
|
|
102
|
-
Retrieve an update by its internal id. **Updates** are status notifications from Italy\'s SDI (Sistema di Interscambio) about invoices you sent. Multiple updates can exist for the same send item as the invoice progresses through the SDI workflow. The `state` field is the most important property and can have the following values: | Value | Name | Description | |-------|------|-------------| | 2 | `Inviato` | Sent to the SDI. | | 5 | `Consegnato` | Delivered to the recipient. | | 6 | `NonConsegnato` | Not delivered to the recipient. Only relevant for public administration entities. | | 7 | `Scartato` | Rejected by the SDI. | | 8 | `AccettatoDalDestinatario` | Accepted by the recipient. Only relevant for public administration entities. | | 9 | `RifiutatoDalDestinatario` | Rejected by the recipient. Only relevant for public administration entities. | | 10 | `ImpossibilitaDiRecapito` | Available on the recipient\'s tax drawer, but it was not possible to deliver it to the recipient\'s reception system. | | 11 | `DecorrenzaTermini` | A public administration entity has not responded for more than 15 days. The document is considered delivered. | | 12 | `AttestazioneTrasmissioneFattura` | A public administration entity has received the document, but has not yet processed it. | **Important:** Always monitor the state of your sent invoices. A state of `Inviato` only means the invoice has been submitted to SDI, not that it has been delivered. A state like `Scartato` indicates that the invoice was **not** successfully delivered and may require corrective action, such as fixing validation errors and resubmitting. In that case, `description` contains the reason for the rejection.
|
|
102
|
+
Retrieve an update by its internal id. **Updates** are status notifications from Italy\'s SDI (Sistema di Interscambio) about invoices you sent. Multiple updates can exist for the same send item as the invoice progresses through the SDI workflow. The `state` field is the most important property and can have the following values: | Value | Name | Description | |-------|------|-------------| | 2 | `Inviato` | Sent to the SDI. | | 5 | `Consegnato` | Delivered to the recipient. | | 6 | `NonConsegnato` | Not delivered to the recipient. Only relevant for public administration entities. | | 7 | `Scartato` | Rejected by the SDI. | | 8 | `AccettatoDalDestinatario` | Accepted by the recipient. Only relevant for public administration entities. | | 9 | `RifiutatoDalDestinatario` | Rejected by the recipient. Only relevant for public administration entities. | | 10 | `ImpossibilitaDiRecapito` | Available on the recipient\'s tax drawer, but it was not possible to deliver it to the recipient\'s reception system. | | 11 | `DecorrenzaTermini` | A public administration entity has not responded for more than 15 days. The document is considered delivered. | | 12 | `AttestazioneTrasmissioneFattura` | A public administration entity has received the document, but has not yet processed it. | **Cost:** Querying this endpoint is free and does not count as an operation against your plan limits. **Important:** Always monitor the state of your sent invoices. A state of `Inviato` only means the invoice has been submitted to SDI, not that it has been delivered. A state like `Scartato` indicates that the invoice was **not** successfully delivered and may require corrective action, such as fixing validation errors and resubmitting. In that case, `description` contains the reason for the rejection.
|
|
103
103
|
|
|
104
104
|
### Example
|
|
105
105
|
|
package/docs/WebHook.md
CHANGED