API Gestionale: Configurazione
Perche recuperare la configurazione
Le modalita di pagamento sono configurate per singolo account FattureWeb. Le aliquote e le nature IVA vengono invece validate rispetto alle configurazioni disponibili nel sistema.
Per una nuova integrazione e consigliato recuperare questi dati prima di creare clienti e bozze.
Configurazione.listaPagamenti
Restituisce le modalita di pagamento disponibili per l'account autenticato.
Input
Nessun parametro specifico.
{
"action": "call",
"key": "LA_TUA_API_KEY",
"code": "abcdef",
"payload": {
"api_name": "Configurazione",
"method": "listaPagamenti",
"input": {}
}
}
Risposta
{
"code": "200",
"result": {
"status": "success",
"pagamenti": [
{
"id": 37,
"id_tipo_pagamento": 82,
"codice_sdi": "MP05",
"descrizione": "Bonifico-Banca aziendale",
"iban": "IT00...",
"predefinito": true
}
]
}
}
pagamento_id corrisponde al campo id restituito da questa API, non al codice SDI e non a id_tipo_pagamento.Configurazione.salvaPagamento
Crea una modalita di pagamento personale dell'account. Il tipo SDI non viene creato o modificato: MP01, MP05 e gli altri codici restano quelli standard di FattureWeb.
FattureWeb crea automaticamente il relativo conto contabile e restituisce l'id concreto da usare come pagamento_id nelle API cliente e fattura.
Campi
| Campo | Obbligo | Descrizione |
|---|---|---|
categoria | obbligatorio | banca oppure liquidita. Determina la sezione del piano dei conti. |
descrizione | obbligatorio | Nome scelto dall'utente, ad esempio "Banca Intesa" o "Cassa negozio". |
codice_sdi | condizionale | Codice standard, ad esempio MP05. Indicare questo campo oppure id_tipo_pagamento. |
id_tipo_pagamento | condizionale | ID del tipo SDI standard. Se sono presenti entrambi i campi devono identificare lo stesso tipo. |
iban | opzionale | Valido solo con categoria banca. Spazi rimossi e valore normalizzato in maiuscolo. |
predefinito | opzionale | Se true rende questo pagamento il predefinito dell'account. Se non esiste alcun predefinito, il primo creato viene impostato automaticamente. |
Esempio banca
{
"action": "call",
"key": "LA_TUA_API_KEY",
"code": "abcdef",
"payload": {
"api_name": "Configurazione",
"method": "salvaPagamento",
"input": {
"categoria": "banca",
"codice_sdi": "MP05",
"descrizione": "Banca Intesa",
"iban": "IT60X0542811101000000123456",
"predefinito": true
}
}
}
Esempio liquidita / forma personale
{
"action": "call",
"key": "LA_TUA_API_KEY",
"code": "abcdef",
"payload": {
"api_name": "Configurazione",
"method": "salvaPagamento",
"input": {
"categoria": "liquidita",
"codice_sdi": "MP01",
"descrizione": "Cassa negozio"
}
}
}
Risposta
{
"code": "200",
"result": {
"status": "success",
"pagamento": {
"id": 208,
"id_tipo_pagamento": 82,
"codice_sdi": "MP05",
"descrizione": "Bonifico-Banca Intesa",
"iban": "IT60X0542811101000000123456",
"predefinito": true
}
}
}
Configurazione.listaAliquoteIva
Restituisce aliquote IVA e nature IVA configurate in FattureWeb.
Input
Nessun parametro specifico.
{
"action": "call",
"key": "LA_TUA_API_KEY",
"code": "abcdef",
"payload": {
"api_name": "Configurazione",
"method": "listaAliquoteIva",
"input": {}
}
}
Risposta
{
"code": "200",
"result": {
"status": "success",
"aliquote": [
{ "id": 1, "aliquota": 22 },
{ "id": 5, "aliquota": 0 }
],
"nature": [
{ "id": 10, "codice": "N2.2", "descrizione": "..." }
]
}
}
Nelle righe fattura e sufficiente passare il valore percentuale tramite iva. Per aliquota zero e possibile indicare natura_iva con il relativo codice, ad esempio N2.2, oppure id_natura_iva.