Universal Web Platform · Pagamenti

Pagamenti: le condizioni di pagamento con scadenze, spese e metodi abilitati sul sito

Pagamenti: le condizioni di pagamento con scadenze, spese e metodi abilitati sul sito. Nel web service è il tipo PAGAMENTI (valore 31 di DataType); gli oggetti sono della classe Pagamenti e viaggiano nella lista ObjectListPagamenti della richiesta e della risposta.

Scheda tecnica

VoceValore
Tipo di datoPAGAMENTI = 31
ClassePagamenti
Lista nella richiesta e nella rispostaObjectListPagamenti
Tabella letta da QUERYPagamenti — è il nome da usare davanti alle colonne in SQLFilter
Operazioni ammesseQUERY (3), INSERTORMODIFY (0), DELETE (1), TRUNCATETABLE (2)
Campi chiaveCodice — identificano il record: con gli stessi valori INSERTORMODIFY aggiorna, con valori nuovi crea
Chiave per cancellare con DeletingClassCodice
Chiave per le conferme di ricezioneCodice — come si usa
Controlli prima del salvataggioCodice: «Codice non specificato»
Descrizione: «Descrizione non specificato»

I campi di Pagamenti

La colonna Obbligatorio riporta i campi chiave e quelli controllati dal server prima di salvare; Predefinito è il valore che il campo assume se non lo invii; Colonna è il nome del campo nel database, da usare nei filtri di lettura.

CampoTipoObbligatorioPredefinitoColonnaA cosa serve
CodiceTestoChiave, sìvuotocodiceCodice univoco del record. È la chiave con cui il record viene creato o aggiornato. Se manca il server risponde «Codice non specificato».
DescrizioneTestoSìvuotodescrizioneDescrizione del record, mostrata nel gestionale e sul sito. Se manca il server risponde «Descrizione non specificato».
CalcoloSpeseVero/falso—falsecalcolospeseCalcolo spese.
TipoCalcoloTesto—vuototipocalcModalità di calcolo.
ValoreCalcoloDecimale—0valcalcValore calcolo.
VoceSpesaIntero—0vocespesaVoce spesa.
TipoRimesseTesto—vuototiporimesseTipo rimesse.
ScontoDecimale—0scontoSconto.
RichiediContoAziendaleVero/falso—falsericcontoRichiedi conto aziendale.
ControllaFidoVero/falso—falsecontrollafidoControlla fido.
AbilitaVenditaWEBVero/falso—falseabilitavendwebAbilita vendita web.
AbilitaVenditaBancoVero/falso—falseabilitavendbancAbilita vendita banco.
CalcoloGiorniTesto—vuotocalcologiorniCalcolo giorni.
MesiEsclusiTesto—vuotomesiesclMesi esclusi.
GiornoMeseSuccessivoIntero—0giornomesesuccGiorno mese successivo.
GiornoMeseSuccessivoEsclusiIntero—0giornomesesuccnoesclGiorno mese successivo esclusi.
AggiungiGiornoAScadenzaIntero—0giornoaddscadAggiungi giorno a scadenza.
AbilitaBancaClienteFornitoriVero/falso—falseabilitabancacliforAbilita banca cliente fornitori.
AbilitaPaypalVero/falso—falseabilitapaypalAbilita PayPal.
AbilitaGooglePayVero/falso—falseabilitagooglepayAbilita Google pay.
AbilitaKlarnaVero/falso—falseabilitaklarnaAbilita Klarna.
AbilitaNexiVero/falso—falseabilitanexiAbilita Nexi.
AbilitaCartaVero/falso—falseabilitacartaAbilita carta.
TipocartaTesto—vuototipocartaTipocarta.
UsernameCartaTesto—vuotousernamecartaUsername carta.
PasswordCartaTesto—vuotopasswordcartaPassword carta.
NoteTesto—vuotonoteNote libere.
ValoreScontrinoTesto—vuotovalorescontrinoValore scontrino.
AbilitaClienteGestitoDirettamenteVero/falso—falseabilitaclientegestitoAbilita cliente gestito direttamente.
ListaCorpoElenco di PagamentiCorpo—elenco vuoto—Corpo: elenco di oggetti PagamentiCorpo.

Classe annidata PagamentiCorpo

Elemento usato dentro Pagamenti. I suoi campi si inviano e si ricevono insieme al record principale.

CampoTipoObbligatorioPredefinitoA cosa serve
TipologiaTesto—vuotoTipologia.
InizioRimessaTesto—vuotoInizio rimessa.
NumeroGiorniIntero—0Numero giorni.
ValoreRataDecimale—0Valore rata.
ArrotondamentoDataTesto—vuotoArrotondamento data.
GeneraIncassoContestualeVero/falso—falseGenera incasso contestuale.
SottocontoIncassoTesto—vuotoSottoconto incasso.
SezioneContabileIncassoTesto—vuotoSezione contabile incasso.
ClassificazioneTesto—vuotoCodice della classificazione.

Esempi

Inserimento o aggiornamento di un record (valori di esempio). Ricorda che INSERTORMODIFY riscrive tutti i campi: quelli che non invii tornano al valore predefinito, quindi per modificare un record esistente invia il record completo.

JSON · INSERTORMODIFY
{
  "DataOperation": 0,
  "TypeObject": 31,
  "GuidPC": "gestionale-01",
  "AllInsert": false,
  "ObjectListPagamenti": [
    {
      "Codice": "COD001",
      "Descrizione": "Descrizione di esempio",
      "CalcoloSpese": false,
      "TipoCalcolo": "ESEMPIO",
      "ValoreCalcolo": 1,
      "VoceSpesa": 1
    }
  ]
}

Lettura con filtro: fino a 100 record, ignorando le conferme di ricezione.

JSON · QUERY
{
  "DataOperation": 3,
  "TypeObject": 31,
  "GuidPC": "gestionale-01",
  "SQLFilter": "Pagamenti.codice = 'COD001'",
  "QueryParameter": {
    "IgnoreImportRecord": true,
    "StartingRecord": 1,
    "LimitRecord": 100
  }
}

Cancellazione: bastano i campi chiave.

JSON · DELETE
{
  "DataOperation": 1,
  "TypeObject": 31,
  "GuidPC": "gestionale-01",
  "ObjectListPagamenti": [
    {
      "Codice": "COD001"
    }
  ]
}

Le regole su formati, date, numeri e compressione sono in formato e trasporto; esempi completi in esempi di codice.

PrecedenteSezioni contabiliSuccessivaEsercizi