ACG Vision4 · o contof (String): conto cliente/fornitore o dittaf (String): azienda o numovf...

13
© Copyright ACG Srl 2014 Tutti i diritti riservati. Pagina 1 di 13 ACG Vision4 Web Services Amministrazione

Transcript of ACG Vision4 · o contof (String): conto cliente/fornitore o dittaf (String): azienda o numovf...

© Copyright ACG Srl 2014 Tutti i diritti riservati. Pagina 1 di 13

ACG Vision4

Web Services

Amministrazione

© Copyright ACG Srl 2014 Tutti i diritti riservati. Pagina 2 di 13

Seconda Edizione (Giugno 2014)

Questa edizione si riferisce alla Versione 1 Rilascio 4 livello di modifica 0 e alla Versione 1 Rilascio 5 livello di modifica

0 di ACG Vision4 e a tutti i successivi rilasci e modifiche, se non altrimenti indicati in nuove edizioni o lettere di

accompagnamento.

© Copyright ACG Srl 2014 Tutti i diritti riservati. Pagina 3 di 13

Note e Trademarks © Copyright ACG S.r.l. 2014. Tutti i diritti riservati. ACG e ACG Vision4 sono marchi di ACG S.r.l., con socio unico e soggetta all’attività di direzione e coordinamento di TeamSystem S.p.A., sede legale in in via Yuri Gagarin, 205 – 61122 Pesaro (PU), Cap. Soc. € 100.000 i.v., codice fiscale e iscrizione al Registro delle Imprese di Milano n. 08419500965 (di seguito “ACG”) - Tutti i diritti riservati. I marchi e loghi riportati nel presente documento diversi da ACG e ACG Vision4 (ivi inclusi, a mero titolo esemplificativo e non esaustivo, IBM, il logo IBM, Adobe, il logo Adobe, PostScript, il logo PostScript, Intel, il logo Intel, Intel Inside, il logo Intel Inside, Intel Centrino, il logo Intel Centrino, Celeron, Intel Xeon, Intel SpeedStep, Itanium e Pentium, Linux, Microsoft, Windows, Windows NT e il logo di Windows, UNIX, Java, Novell, il logo Novell, openSUSE e il logo openSUSE, AS/400, BladeCenter, Cognos, DB2, DB2 Universal Database, eServer, i5/OS, iSeries, OpenPower, OS/400, POWER, Power Systems, pSeries, Rational, System i, System i5, System p, System p5, System Storage, System x, WebSphere, etc.) sono di titolarità di soggetti terzi. ACG rispetta i diritti di proprietà intellettuale di terzi. Tutti i contenuti del presente documento e i diritti ad essi correlati sono riservati. Tali contenuti pertanto possono essere consultati esclusivamente per finalità d’informazione personale, essendo espressamente vietato ogni diverso utilizzo senza il preventivo consenso scritto di ACG. Sebbene sia stata usata ogni ragionevole cura nel raccogliere e presentare le informazioni contenute nel presente documento, nessuna garanzia è prestata in ordine alla loro esattezza, completezza, utilità, né ai loro possibili impieghi da parte degli utenti; è pertanto esclusa ogni responsabilità di ACG per errori, inesattezze od omissioni relative a dette informazioni. I contenuti del presente documento sono soggetti a continuo aggiornamento e sono da ritenersi puramente indicativi e suscettibili di eventuali errori e/o imprecisioni. ACG può introdurre miglioramenti e/o variazioni ai prodotti e/o programmi descritti nel presente documento in qualsiasi momento e senza preavviso. Il presente documento può contenere informazioni che riguardano programmi e propositi futuri, che vengono descritti di volta in volta mediante l’utilizzo di termini come "attendersi", "stimare", "prevedere", "prospettare" e "programmare". Tali dichiarazioni per loro natura non comportano alcun impegno a carico di ACG, che pertanto non assume in relazione ad essi alcuna responsabilità di realizzazione. Qualunque riferimento a siti web diversi da www.acginfo.it è fornito a solo titolo esemplificativo e non costituisce invito all’utilizzo e/o navigazione. I contenuti dei siti web referenziati non sono parte dei prodotti ACG e il loro eventuale utilizzo da parte dell’utente è effettuato a suo esclusivo rischio. Le informazioni relative a prodotti non ACG contenute nel presente documento sono fornite dai rispettivi fornitori, dagli annunci pubblicitari e da informazioni liberamente disponibili. ACG non ha collaudato tali prodotti e non può confermarne l’accuratezza delle prestazioni, la compatibilità con i prodotti ACG o qualunque altra caratteristica. Qualunque richiesta sulle caratteristiche operative dei prodotti non ACG deve essere rivolta direttamente ai rispettivi fornitori. Fatti salvi i danni causati da dolo o colpa grave, ACG non assume nessuna responsabilità circa i contenuti del presente documento. In particolare, tali contenuti non rappresentano una promessa o garanzia relativa all’idoneità a determinati scopi dei prodotti ACG oppure alla non violazione, da parte dei prodotti ACG stessi, di leggi di qualsivoglia natura.

© Copyright ACG Srl 2014 Tutti i diritti riservati. Pagina 4 di 13

INDICE

Note e Trademarks ............................................................................................................................... 3 1. Introduzione ................................................................................................................................... 5 2. WS0002 - Calcolo rate ................................................................................................................. 6

3. WS0003 - Calcolo protocollo iva .............................................................................................. 7 4. WS0004 - Estratto conto/Situaz. contabile cliente/fornitore ............................................. 8

5. WS0009 - Servizio di Stato del Cliente ................................................................................. 11 6. WS0010 - Servizio di Stato della Partita ............................................................................... 12

7. WS0011 - Lista Clienti Bloccabili ........................................................................................... 13

Tabella degli aggiornamenti

Data PTF id Descrizione

© Copyright ACG Srl 2014 Tutti i diritti riservati. Pagina 5 di 13

1. Introduzione

Il documento descrive i web services presenti in ACG Vision4 – Amministrazione che è possibile

richiamare da un applicativo esterno.

Uno dei parametri standard utilizzato per invocare i web services ACG Vision4 è rappresentato dalla

classe com.ibm.acgv4.baseACGV4Context. Si tratta di un bean che contiene le credenziali di accesso

con le quali il client del servizio web si autentica al sistema ACG Vision4 e con le quale viene eseguito

il servizio. Il bean ACGV4Context contiene i seguenti attributi:

2 user: identificativo del profilo utente di accesso al sistema

3 password: password del profilo utente di accesso al sistema

4 systemType: tipo di sistema in cui risiede il DB Vision4 (AS400 per DB2/400 su System i, DB2 per

DB2 su System p/x); il parametro è facoltativo (può essere passato a null)

5 systemAddress: indirizzo IP del sistema in cui risiede il DB Vision4 (nella forma “xxx.xxx.xxx.xxx

per DB/400 e “xxx.xxx.xxx.xxx:pppp/VISION4/DB2” per DB2) ); il parametro è facoltativo (può

essere passato a null)

6 informationSystem: nome del sistema informativo al quale collegarsi; se passato a null, viene

assunto il sistema informativo di default dell’utente

© Copyright ACG Srl 2014 Tutti i diritti riservati. Pagina 6 di 13

2. WS0002 - Calcolo rate

Nome servizio WS0002.runService Descrizione Espone i risultati dell’elaborazione della funzione calcolo rate Input

ACGV4Context: tramite questo parametro devono essere passate le credenziali di accesso al sistema (password, systemAddress, systemType, user, informationSystem)

WS0002Input (com.ibm.acgv4.ws.fin.parameters.WS0002Input): bean contenente i seguenti parametri

o cvalr (String): codice divisa o cpagr (String): codice modalità di pagamento o dpart (BigDecimal): data partenza calcolo (aaaammgg) o impmr (BigDecimal): importo in divisa o impeu (BigDecimal): importo divisa di conto o impnrv (BigDecimal): importo in seconda divisa di conto o impmv (BigDecimal): imposta in divisa (opzionale) o impie (BigDecimal):imposta in divisa di conto (opzionale) o impiv (BigDecimal):imposta in seconda divisa di conto

(opzionale)

Output Il servizio web restituisce il parametro:

WS0002Output (com.ibm.acgv4.ws.fin.parameters.WS0002Output): bean contenente i seguenti parametri

o rateType (String): vettori tipi rate o billType (String): vettore tipi effetti o expirationDate (BigDecimal): vettore data scadenza o dpart (BigDecimal): data partenza calcolo o amountCurrencyRate (BigDecimal): vettore importo rata in

divisa o amountActualCurrencyRate (BigDecimal): vettore importo rata

in divisa di conto o amountSecondCurrencyRate (BigDecimal): vettore importo rata

in seconda divisa di conto

Riferimento PTF Release 1.4.0

© Copyright ACG Srl 2014 Tutti i diritti riservati. Pagina 7 di 13

3. WS0003 - Calcolo protocollo iva

Nome servizio WS0003.runService Descrizione Il servizio ha lo scopo di fornire il numero di protocollo IVA per la generazione di

una fattura passiva. Viene utilizzato dai verticali nelle operazioni inerenti il controllo della fattura passiva. Espone i risultati dell’elaborazione della funzione calcolo protocollo.

Input

ACGV4Context: tramite questo parametro devono essere passate le credenziali di accesso al sistema (password, systemAddress, systemType, user, informationSystem)

WS0003Input (com.ibm.acgv4.ws.fin.parameters.WS0003Input): bean contenente i seguenti parametri

o davovz (String): data registrazione (aaaammgg) o cdrivz (String): codice registro IVA (opzionale) o provez (String): numero protocollo (opzionale)

Output Il servizio web restituisce il parametro:

WS0003Output (com.ibm.acgv4.ws.fin.parameters.WS0003Output): bean contenente i seguenti parametri

o cdrivz (String): codice registro IVA o provez (String): numero protocollo o errorz (String): codice di ritorno ‘1’=Protoc. errato, ‘2’=Prot.

Non disponibile o protfz (String): protocollo reperito

Riferimento PTF Release 1.4.0

© Copyright ACG Srl 2014 Tutti i diritti riservati. Pagina 8 di 13

4. WS0004 - Estratto conto/Situaz. contabile cliente/fornitore

Nome servizio WS0004.runService Descrizione Il servizio ha lo scopo di rendere disponibile, in base al codice cliente o fornitore

richiesto, la situazione contabile con annesso l'estratto conto.

Viene utilizzato dai verticali in ogni operazione afferente la Logistica delle Vendite (Ordini Cliente, Bollettazione, Fatturazione, etc.) o il ciclo passivo.

La presentazione all’ utente dei valori risultato della logica di elaborazione del servizio saranno a carico dell’applicativo richiedente.

Input

ACGV4Context: tramite questo parametro devono essere passate le credenziali di accesso al sistema (password, systemAddress, systemType, user, informationSystem)

WS0004Input (com.ibm.acgv4.ws.fin.parameters.WS0004Input): bean contenente i seguenti parametri

o sconry (String): codice cliente o pdalim (String): data limite o flprv (String): movimenti provvisori (Opzionale). Valori possibili

‘S’=Si ‘N’=No

o division (String): codice divisione (Opzionale) o cambio (String): tipo cambio (Opzionale). Valori possibili

‘S’=Storico ‘G’=Giornaliero

o ecin (String): tipo divisa (Opzionale). Valori possibili ‘PD’=Prima divisa ‘SD’=Seconda divisa ‘UD’=Singola divisa

o divisa (String): codice divisa (Opzionale) o partite (String): tipo partite. Valori possibili

‘A’=Aperte ‘M’=Aperte superiore minino ‘T’=Tutte ‘N’=Non eliminate ‘E’=Aperte o con effetti senza esito ‘F’=Aperte superiore minimo o con effetti senza esito

o fclfoy (String): cliente/fornitore. Valori possibili ‘C’=Cliente ‘F’=Fornitore

o rate (String): rate. Valori possibili ‘T’=Tutte ‘S’=Solo scadute ‘N’=No

Output Il servizio web restituisce il parametro:

Gecf400x (com.ibm.acgv4.ca.model.Gecf400x): vettore righe estratti conto così composto

o livef (String): Tipo record. Valori ammessi '05' Testata agente o categoria o contrassegno '10' Testata cliente/fornitore '20' Registrazione '22' Descrizione supplementare

© Copyright ACG Srl 2014 Tutti i diritti riservati. Pagina 9 di 13

'25' Scadenza '30' Saldo partita '41' Totale cli./for. per divisa '42' Totale cli/for. consolidato

o nrejn (Long): numero elaborazione o numref (Long): numero riga o cdclif (String): codice cliente/fornitore o fclfof (String): Cliente/Fornitore o categf (String): categoria contabile o cdagef (String): codice agente o cfparf (String): contrassegno o descrf (String): descrizione codice (Per i record da 10 a 42 la

ragione sociale del cliente/fornitore) o statof (String): stato per visualizzazione. Valori ammessi

‘P’ movimento provvisorio ‘B’ per rata totalmente/parzialmente bloccata ‘I’ per rata fornitore in fase di pagamento ‘*’ su saldo per partita multidivisa

o flprvf (String): movimento/rata provvisorio o ratblf (String): rata bloccata o frapff (String): rata impegnata in proposta o dadocf (int): data documento aaaammgg o dadocm (int): data documento ggmmaaaa o nudocf (int): numero documento o riffof (String): riferimento originale. Valido solo per i Fornitori o derigf (String): descrizione. Per LIVEF=30 contiene la scritta:

“Partita anno riferimento/numero rif.” Se gestita la divisione “Div XX Partita anno rif/num. Rif.”

o impmof (BigDecimal): importo/saldo in divisa o impnaf (BigDecimal): importo/saldo controvalore o imdadf (BigDecimal): importo/saldo dare. Controvalore in

moneta di conto o seconda moneta di conto o imavdf (BigDecimal): importo/saldo avere o daravf (String): segno o cdvaxf (String): divisa del primo movimento o cdvarf (String): divisa movimento o cambrf (BigDecimal): cambio o cdcrgf (String): divisa di conto/2a DdC o damovf (int): data registrazione aaaammgg o damovm (int): data registrazione ggmmaaaa o cddvsf (String): divisione o newpaf (String): prima riga partita. Per indicare che inizia una

nuova partita o aariff (int): anno riferimento o nuriff (int): numero riferimento o rpartf (String): riga posizione partita o causaf (String): causale o contof (String): conto cliente/fornitore o dittaf (String): azienda o numovf (int): numero movimento contabile o rimovf (int): riga movimento contabile o nrpraf (String): numero pratica contabile o nrpgcf (String): esitenza pratica G.Crediti o tpardf (BigDecimal): partite segno opposto o teffdf (BigDecimal): effetti da emettere o trimdf (BigDecimal): rimborsi o tespdf (BigDecimal): esposizione o timpdf (BigDecimal): impegno

© Copyright ACG Srl 2014 Tutti i diritti riservati. Pagina 10 di 13

o totrdf (BigDecimal): rischio o tscadf (BigDecimal): totale scaduto o tiprtf (String): tipo rata o nuratf (int): numero rata o fsteff (String): stato effetto o tdistf (String): tipo distinta o fscadf (String): segnalazione rata scaduta.

Valore ‘SC’ in caso di rata scaduta o dtscaf (int): data scadenza aaaammgg o dtscam (int): data scadenza ggmmaaaa o imporf (BigDecimal): Importo originale rata o fdivif (String): partita multidivisa o davalf (int): data valuta aaaammgg o davalm (int): data valuta ggmmaaaa o ggin6f (int): giorni scaduto a n. 6 o ggin5f (int): giorni scaduto a n. 5 o ggin4f (int): giorni scaduto a n. 4 o ggin3f (int): giorni scaduto a n. 3 o ggin2f (int): giorni scaduto a n. 2 o ggin1f (int): giorni scaduto a n. 1 o sca6df (BigDecimal): importo scaduto a n. 6 o sca5df (BigDecimal): importo scaduto a n. 5 o sca4df (BigDecimal): importo scaduto a n. 4 o sca3df (BigDecimal): importo scaduto a n. 3 o sca2df (BigDecimal): importo scaduto a n. 2 o sca1df (BigDecimal): importo scaduto a n. 1 o tascaf (BigDecimal): totale a scadere o asc6df (BigDecimal): importo a scadere n. 6 o asc5df (BigDecimal): importo a scadere n. 5 o asc4df (BigDecimal): importo a scadere n. 4 o asc3df (BigDecimal): importo a scadere n. 3 o asc2df (BigDecimal): importo a scadere n. 2 o asc1df (BigDecimal): importo a scadere n. 1 o dasc6f (int): data int. scaduto 6 ggmmaaaa o dasc5f (int): data int. scaduto 5 ggmmaaaa o dasc4f (int): data int. scaduto 4 ggmmaaaa o dasc3f (int): data int. scaduto 3 ggmmaaaa o dasc2f (int): data int. scaduto 2 ggmmaaaa o dasc1f (int): data int. scaduto 1 ggmmaaaa o cdvamf (String): divisa conv. partita multi o dasa6f (int): data int. a scad. 6 ggmmaaaa o dasa5f (int): data int. a scad. 5 ggmmaaaa o dasa4f (int): data int. a scad. 4 ggmmaaaa o dasa3f (int): data int. a scad. 3 ggmmaaaa o dasa2f (int): data int. a scad. 2 ggmmaaaa o dasa1f (int): data int. a scad. 1 ggmmaaaa o flstaf (String): eslusione riepil. duplicati o rascff (String): ragione sociale cliente/fornitore o indcff (String): indirizzo cliente/fornitore o capcff (String): CAP cliente/fornitore o loccff (String): località cliente/fornitore o ntecff (String): n. telefono cliente/fornitore o version (int): versione o tiforf (String): tipo formato

Si riporta la struttura tipica dell’array Gecf400x:

© Copyright ACG Srl 2014 Tutti i diritti riservati. Pagina 11 di 13

-> 1 record con TR=05 testata agente/categoria/contrassegno (facoltativo, presente solo per la stampa) ! -> 1 record con TR = 10 Testata e/c cliente/fornitore ! ! ! ! da 1 a n record con TR = 20, 22 Registrazioni ! ! da 1 a n record don TR = 25 Scadenze ! ! 1 record con TR = 30 Saldo partita ! ! ! ! ... idem per le altre partite ... ! ! ! ! da 1 a n record con TR = 41 Saldi e/c (uno per divisa) ! -> 1 record con TR = 42 Controv. saldo consolidato

Riferimento PTF Release 1.4.0

5. WS0009 - Servizio di Stato del Cliente

Nome servizio WS0009.runService Descrizione Fornisce lo stato del cliente nell’ambito del dominio Crediti.

In particolare, i sistemi esterni a Crediti possono avere interesse a conoscere se il cliente è gestito nel sistema Crediti e se al momento ha pratiche aperte, lo stato situazione creditizia dello stesso cliente e la sua data di aggiornamento, lo stato di avanzamento di ciascuna pratica.

Input

ACGV4Context: tramite questo parametro devono essere passate le credenziali di accesso al sistema (password, systemAddress, systemType, user, informationSystem)

WS0009Input (com.ibm.acgv4.ws.fin.gec.parameters.WS0009Input): bean contenente i seguenti parametri

o cliente (String): codice cliente o azienda (String): codice azienda o divisione (String): codice divisione

Output Il servizio web restituisce il parametro:

WS0009Output (com.ibm.acgv4.ws.fin.gec.parameters.WS0009Output): bean contenente i seguenti parametri

o collector (CollectorObjWS): lista dei Collector che lo gestiscono (azienda, divisione, codice e descrizione)

o geccli (boolean): Flag Cliente Gestito da Crediti o note (NotaObjWS): lista delle Note inserite sul cliente (azienda,

divisione, testo della nota) o pestd (BigDecimal): data di aggiornamento dello stato o pratiche (PraticaObjWS): la lista delle sue Pratiche aperte e

bloccate con lo stato di avanzamento dei relativi task (Azienda, Divisione, Progressivo pratica, Stato pratica, Data apertura, lista Task – in corso, precedente, successivo - con codice, descrizione, stato, tipo, nota e step, Agente con codice e descrizione, Totale scaduto in Euro, Piano di Attività con

© Copyright ACG Srl 2014 Tutti i diritti riservati. Pagina 12 di 13

codice e descrizione, Nota) o sccod (String): Stato Situazione Creditizia (codice) o scdes (String): Stato Situazione Creditizia (descrizione)

Riferimento PTF Release 1.4.0

6. WS0010 - Servizio di Stato della Partita

Nome servizio WS0010.runService Descrizione Fornisce lo stato della partita nell’ambito del dominio Crediti.

In particolare, i sistemi esterni a Crediti possono avere interesse a conoscere lo stato di una partita nel sistema Crediti e lo stato di avanzamento della pratica in cui è inclusa.

Input

ACGV4Context: tramite questo parametro devono essere passate le credenziali di accesso al sistema (password, systemAddress, systemType, user, informationSystem)

WS0010Input (com.ibm.acgv4.ws.fin.gec.parameters.WS0010Input): bean contenente i seguenti parametri

o cliente (String): codice cliente o azienda (String): codice azienda o divisione (String): codice divisione o annoRif (BigDecimal): anno riferimento o numeroRif (BigDecimal): numero riferimento

Output Il servizio web restituisce il parametro:

WS0010Output (com.ibm.acgv4.ws.fin.gec.parameters.WS0010Output): bean contenente i seguenti parametri

o pratica (PraticaObjWS): la Pratica in cui è inserita la partita con lo stato di avanzamento dei relativi task (Progressivo pratica, Stato pratica, Data apertura, lista Task – in corso, precedente, successivo - con codice, descrizione, stato, tipo , nota e step, Agente con codice e descrizione, Totale scaduto in Euro, Piano di Attività con codice e descrizione, Nota)

Riferimento PTF Release 1.4.0

© Copyright ACG Srl 2014 Tutti i diritti riservati. Pagina 13 di 13

7. WS0011 - Lista Clienti Bloccabili

Nome servizio WS0011.runService Descrizione Determina se il cliente è bloccabile in base ai dati dell’analisi del credito e a

quanto scelto in tabella di personalizzazione Finance (Tabbed “Analisi del Credito”). Se in tabella di personalizzazione si è scelto il “Tipo Controllo” = “Standard” le condizione che vengono usate per verificare se il cliente è bloccabile sono quelle specificate in tabella di personalizzazione finance nella lista “Condizioni controllo Standard”. Se in tabella di personalizzazione si è scelto il “Tipo Controllo” = “Altro” per verificare se il cliente è bloccabile viene eseguita la policy specificata in tabella di personalizzazione.

Input

ACGV4Context: tramite questo parametro devono essere passate le credenziali di accesso al sistema (password, systemAddress, systemType, user, informationSystem)

WS0011Input (com.ibm.acgv4.ws.fin.gec.parameters.WS0011Input): bean contenente i seguenti parametri

o cliente (String): codice cliente o azienda (String): codice azienda o divisione (String): codice divisione

Output Il servizio web restituisce il parametro:

WS0011Output (com.ibm.acgv4.ws.fin.gec.parameters.WS0011Output): bean contenente i seguenti parametri

o customereBlockable (boolean): indica se il cliente e’ bloccabile

Riferimento PTF Release 1.4.0