Funzione: Cashbooks -> ListEntries
Questa funzione restituisce tutti i Movimenti/Registrazioni all'interno del database Prima Nota.
Parametri
| Campo | Obbligatorio | Descrizione | Valori Ammessi |
| query | facoltativo |
Parametri di ricerca
Oggetto JSON tramite il quale è possibile specificare le chiavi di ricerca: (chiave = valore).
Vedere sezione oggetto query più sotto per maggiori spiegazioni |
Oggetto JSON |
| results | facoltativo | Numero dei risultati da visualizzare per pagina. |
Numero. Predefinito: 10 risultati |
| page | facoltativo |
Pagina da visualizzare
Il sistema crea un numero di pagine sfogliabili in base al numero di risultati della ricerca
e a quanti risultati si desidera vedere per pagina
results
|
Numero. Predefinito: pagina 1 |
| orderBy | facoltativo |
Ordine di visualizzazione dei risultati
Vedere sezione chiavi OrderBy supportate più sotto per maggiori spiegazioni
|
Stringa di testo contenente una chiave OrderBy supportata |
Oggetto Query
| Campo | Obbligatorio | Tipologia di ricerca | Descrizione | Valori Ammessi |
| general | facoltativo | estesa | Descrizione del movimento/registrazione che si desidera ricercare. | Stringa di testo. |
| entry_type | facoltativo | La tipologia di registrazione/movimento. | Stringa di testo: 0 = Non impostata 1 = incasso 2 = versamento 3 = emolumenti 4 = commissioni 10 = imposte 11 = agevolazioni fiscali 20 = finanziamento 90 = giroconto 97 = conto soci 98 = importi non dovuti 99 = ignora |
|
| referenced | facoltativo | flag | Stato del movimento/registrazione che si desidera ricercare. | Codice numerico: 0 = Non referenziati 1 = Solo referenziati |
| amount_above | facoltativo | estesa | Limite di importo minimo del movimento che si desidera ricercare. | Numero (valore in euro. |
| amount_below | facoltativo | estesa | Limite di importo massimo del movimento che si desidera ricercare. | Numero (valore in euro). |
Chiavi OrderBy Supportate
| OrderBy | Descrizione |
| natural|ASC | Ordinato per data contabile del movimento/registrazione ascendente |
| natural|DES | Ordinato per data contabile del movimento/registrazione discendente |
| amount|ASC | Ordinato per codice valore dell'importo in euro ascendente |
| amount|DES | Ordinato per codice valore dell'importo in euro discendente |
Risultato
| Campo | Obbligatorio | Descrizione | Valori Ammessi |
| nav | obbligatorio | Oggetto contenente i dati di navigazione. | Oggetto JSON |
| nav.page | obbligatorio | Numero di pagina visualizzato | Numero |
| nav.tot_pages | obbligatorio | Numero di pagine totali | Numero |
| nav.results | obbligatorio | Numero di risultati per pagina visualizzati | Numero |
| nav.tot_results | obbligatorio | Numero di risultato totali della ricerca | Numero |
| nav.orderBy | obbligatorio | Ordine di ricerca realmente applicato | Stringa di testo. |
| dataset | obbligatorio | Oggetto contenente i risultati | Oggetto JSON |
| dataset[n] | facoltativo | Oggetto contenente il risultato n | Oggetto JSON |
La ricerca sulle Registrazioni/Movimenti della Prima nota genera come risultati oggetti "Movimenti". Per visualizzare la struttura di un oggetto Movimenti, guarda il risultato della funzione cashbooks->get
Esempi
Esempio di restituzione della lista Movimenti/Registrazioni della Prima Nota inseriti su Sirio.
require("SirioService.php");
//Creo l'oggetto per eseguire il servizio
$sirio = new SirioService();
//Parametri
$dataset[
"q" => [ // "q" sta per "query"
"amount_above" => "50",
"amount_below" => "100"
],
"r" => 30, // "r" sta per "results" , numero risultati per pagina
"p" => 1, // "p" sta per "page", numero della pagina da visualizzare
"s" => "natural|DES" // "s" sta per "sort"
];
//Eseguo il comando
$result = $sirio->sendCommand("cashbooks", "listEntries", $dataset);
/*
{
"nav":{
"page":1,
"tot_pages":1,
"results":30,
"tot_results":2,
"orderBy":"natural|DES"
},
"dataset": {
name: "Unicredit",
type: 1,
cashbook_entry_id: 32,
cashbook_id: 5,
internal_id: 32,
source_type: 0,
entry_type: 97,
ref_analysis: null,
ref_payment_code: null,
ref_customer_id: null,
ref_supplier_id: null,
ref_employee_id: null,
amount: 548.00,
fee: 2.00,
description: "Descrizione della registrazione",
dataset: null,
format: null,
date_entry: 2018-09-26 00:00:00,
date_value: 2018-09-26,
date_created: 2018-09-26 09:46:17,
customer_name: null,
supplier_name: null,
employee_name: null
},
1: {
...
},
2: {
...
}
...
}
*/
Sirio - Il Gestionale è anche social!