Funzione: Customers -> listPayments
Questa funzione permette la ricerca dei pagamenti relativi ai clienti.
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 | Cliente o negozio che si desidera ricercare. | Stringa di testo |
| customer_name | facoltativo | estesa | Nome, cognome o denominazione dell'anagrafica cliente che si desidera ricercare. | Stringa di testo |
| shop_id | facoltativo | estesa | Id del negozio che si desidera ricercare. | Numero |
| year | facoltativo | estesa | Anno della fattura del pagamento che si desidera ricercare. | Stringa di testo |
| invoice_num | facoltativo | estesa | Numero della fattura del pagamento che si desidera ricercare. | Stringa di testo |
Chiavi OrderBy Supportate
| OrderBy | Descrizione |
| shop_name|ASC | Ordinato per nome cliente ascendente |
| shop_name|DES | Ordinato per nome cliente discendente |
| invoice_date|ASC | Ordinato per data fattura ascendente |
| invoice_date|DES | Ordinato per data fattura discendente |
| customer_name|ASC | Ordinato per nome del cliente ascendente |
| customer_name|DES | Ordinato per nome del cliente discendente |
| payment_amount|ASC | Ordinato valore del pagamento ascendente |
| payment_amount|DES | Ordinato valore del pagamento discendente |
| date_expire|ASC | Ordinato per data di scadenza ascendente |
| date_expire|DES | Ordinato per data di scadenza 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 |
Esempi
Esempio di ricerca di un fornitore inserito su Sirio.
require("SirioService.php");
//Creo l'oggetto per eseguire il servizio
$sirio = new SirioService();
//Parametri
$dataset = [
"q" => "null", // "q" sta per "query"
"r" => 10, // "r" sta per "results" , numero risultati per pagina
"p" => 1, // "p" sta per "page", numero della pagina da visualizzare
"s" => "date_expire|DES" // "s" sta per "sort"
];
//Eseguo il comando
$result = $sirio->sendCommand("customers", "listPayments", $dataset);
/*
nav: {
page: 1,
tot_pages: 1,
results: 10,
tot_results: 3,
orderBy: "name|DES"
},
dataset: {
0: {
payment_id: 90,
customer_invoice_id: 72,
invoice_num: 78,
invoice_year: 2018,
invoice_date: 2018-07-18,
number: 0,
shop_id: 1,
shop_name: Prova1,
customer_id: 10,
customer_name: Azienda 5,
delay: 0,
date_expire: 2018-07-18,
days_to_expire: -68,
percentage: 100,
payment_amount: 109.8
},
1: {
...
},
2: {
...
}
...
}
*/
Sirio - Il Gestionale è anche social!