Funzione: SuppliersOrders -> List

Questa funzione permette la ricerca dentro al database degli ordini dei 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
free	facoltativo	estesa	Nome ordine, descrizione, cliente associati all'ordine che si desidera ricercare.	Stringa di testo
status_invoice	facoltativo	flag	Stato di fatturazione dell'ordine.	Codice numerico: 0 = Tutti 1 = Solo fatturati 2 = Solo non fatturati
supplier_id	facoltativo	estesa	Nome del Fornitore associato all'ordine che si desidera ricercare.	Stringa di testo
cost_type_id	facoltativo	estesa	Il nome del Costo associato all'ordine che si desidera ricercare.	Stringa di testo
operation_id	facoltativo	flag	Codice numerico: 0 = Acquisto standard 1 = Acconto/deposito 2 = Acquisto patrimoniale 3 = Rimborso
currency	facoltativo	flag	Codice numerico: 0 = Tutte 1 = EUR
date_start	facoltativo	esatta	Data espressa nel formato: YYYY-MM-GG
date_end	facoltativo	esatta	Data espressa nel formato: YYYY-MM-GG

Chiavi OrderBy Supportate

OrderBy	Descrizione
supplier_order_id\|ASC	Ordinato per codice identificativo ordine ascendente
supplier_order_id\|DES	Ordinato per codice identificativo ordine discendente
contact_name\|ASC	Ordinato per nome del fornitore ascendente
contact_name\|DES	Ordinato per nome del fornitore discendente
operation_id\|ASC	Ordinato per descrizione ascendente
operation_id\|DES	Ordinato per descrizione della linea discendente
currency\|ASC	Ordinato per divisa ascendente
currency\|DES	Ordinato per divisa discendente
calc_imponibile\|ASC	Ordinato per imponibile ascendente
calc_imponibile\|DES	Ordinato per imponibile discendente
calc_tot\|ASC	Ordinato per importo totale ascendente
calc_tot\|DES	Ordinato per importo totale discendente
date_order\|ASC	Ordinato per data ordine ascendente
data_order\|DES	Ordinato per data ordine 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 sugli ordini dei fornitori genera come risultati oggetti "ordine fornitore". Per visualizzare la struttura di un ordine fornitore, guarda il risultato della funzione suppliersOrders->get

Esempi

Esempio di ricerca di un ordine fornitore inserito su Sirio.


require("SirioService.php");

//Creo l'oggetto per eseguire il servizio
$sirio = new SirioService();
	
//Parametri
$dataset = [
	"q" => [							// "q" sta per "query"
		"free" => "spesa"		
	],
	"r"	=> 10,						// "r" sta per "results" , numero risultati per pagina
	"p"	=> 1,						// "p" sta per "page", numero della pagina da visualizzare
	"s"	=> "name|DES"				// "s" sta per "sort"
];

//Eseguo il comando
$result = $sirio->sendCommand("suppliersOrders", "list", $dataset);

/*
{
	nav: {
		page: 1,
		tot_pages: 1,
		results: 10,
		tot_results: 3,
		orderBy: "name|DES"
	},
	dataset: {
		0: {
			supplier_order_id: 44,
			supplier_id: 75,
			supplier_invoice_id: null,
			cost_type_id: 2,
			operation_id: 0,
			asset_id: null,
			description: test,
			currency: USD,
			price_currency: 87.00,
			exchange_rate_forecast: 0.8157,
			exchange_rate_effective: null,
			change_fee: 0.00,
			vat: 0,
			withholding_tax: 0.00,
			date_order: 2018-04-06,
			date_created: 2018-04-06 13:29:01,
			contact_name: Bernardo Giorgio,
			cost_name: Cancelleria,
			cost_num_order: 5,
			hex_color: #2a778d,
			invoice_num: null,
			calc_imponibile: 70.9659,
			calc_vat: 0,
			calc_tot: 70.9659
		},
		1: {
			...
		},
		2: {
			...
		}
	}
}

*/

Manuale Utenti

Manuale Sviluppatori