Funzione: Suppliers -> List
Questa funzione permette la ricerca dentro al database fatture fornitori.
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 | Nome, email,dell'anagrafica fornitore che si desidera ricercare. | Stringa di testo |
| name | facoltativo | estesa | Nome dell'anagrafica fornitore che si desidera ricercare. | Stringa di testo |
| facoltativo | estesa | Indirizzo email dell'anagrafica fornitore che si desidera ricercare. | Stringa di testo | |
| taxcode | facoltativo | estesa | CF/P.IVA dell'anagrafica fornitore che si desidera ricercare. | Stringa di testo |
Chiavi OrderBy Supportate
| OrderBy | Descrizione |
| supplier_id|ASC | Ordinato per codice identificativo fornitore ascendente |
| supplier_id|DES | Ordinato per codice identificativo fornitore discendente |
| contact_name|ASC | Ordinato per nome fornitore ascendente |
| contact_name|DES | Ordinato per nome fornitore discendente |
| date_created|ASC | Ordinato per data di creazione del fornitore ascendente |
| date_created|DES | Ordinato per data di creazione del fornitore 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 sui fornitori genera come risultati oggetti "Anagrafiche Fornitori". Per visualizzare la struttura di un oggetto "Anagrafiche Fornitori" , guarda il risultato della funzione customers->get
Esempi
Esempio di ricerca di un cliente inserito su Sirio.
require("SirioService.php");
//Creo l'oggetto per eseguire il servizio
$sirio = new SirioService();
//Parametri
$dataset = [
"q" => "Mil", // "q" sta per "query"
"r" => 10, // "r" sta per "results" , numero risultati per pagin
"p" => 1, // "p" sta per "page", numero della pagina da visualizzare
"s" => "name|DES" // "s" sta per "sort"
];
//Eseguo il comando
$result = $sirio->sendCommand("suppliers", "list", $dataset);
/*
{
nav: {
page: 1,
tot_pages: 1,
results: 10,
tot_results: 3,
orderBy: "name|DES"
},
dataset: {
0: {
supplier_id: 82,
default_currency: EUR,
default_tax: 0,
contact_name: AOL Time Warner Inc.,
entity_code: 92875c6e5bd0ea06821fb41e244c0275,
entity_type: 400,
entity_nationalitycode: BW,
org_name: AOL Time Warner Inc.,
org_vat_code: SZXDMEDPGLGULSSK,
org_tax_code: BUDAOHBHELSCERGF,
name: Elena,
surname: Pellegrini,
tax_code: BPUHTHNEPGAEIDUU,
address_street: Via Alighieri,
address_street_number: 94,
address_city: Ancona,
address_province: AN,
address_postalcode: 83934,
address_countrycode: IT,
contact_tel: 3923668650,
contact_fax: "",
contact_mobile: "",
contact_email: info@email-dverypgx.com,
date_created: 2018-04-06 13:28:06,
date_updated: 2018-04-06 13:28:06,
balance: null
},
1: {
...
},
2: {
...
}
}
}
*/
Sirio - Il Gestionale è anche social!