Funzione: SuppliersInvoices -> 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 fornitore, numero documento della fattura fornitore che si desidera ricercare.	Stringa di testo
supplier_id	facoltativo	estesa	Nome del Fornitore che si desidera ricercare.	Stringa di testo
num	facoltativo	esatta	Numero del documento presente in fattura.	Numero
date_invoice	facoltativo	La data in cui la fattura è stata emessa	Se vuoto viene inserita la data dell'importazione
year_invoice	facoltativo	estesa	Anno di emissione della fattura fornitore che si desidera ricercare.	Numero

Chiavi OrderBy Supportate

OrderBy	Descrizione
num\|ASC	Ordinato per numero documento ascendente
num\|DES	Ordinato per numero documento discendente
date_invoice\|ASC	Ordinato per data della fattura ascendente
date_invoice\|DES	Ordinato per data della fattura discendente
n_orders\|ASC	Ordinato per il numero degli ordini associati alla fattura ascendente
n_orders\|DES	Ordinato per il numero degli ordini associati alla fattura discendente
currency\|ASC	Ordinato per tipologia di divisa ascendente
currency\|DES	Ordinato per tipologia di divisa discendente
total\|ASC	Ordinato per l'importo totale ascendente
total\|DES	Ordinato per l'importo totale discendente
total_orders\|ASC	Ordinato per l'importo totale in euro ascendente
total_orders\|DES	Ordinato per l'importo totale in euro discendente
deadline\|ASC	Ordinato per data di scadenza pagamento ascendente
deadline\|DES	Ordinato per per data di scadenza pagamento 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 fatture fornitori genera come risultati oggetti "Fatture Registrate". Per visualizzare la struttura di un oggetto Fattura Fornitore, guarda il risultato della funzione suppliersInvoices->get

Esempi

Esempio di ricerca di una fattura fornitore su Sirio.


require("SirioService.php");

//Creo l'oggetto per eseguire il servizio
$sirio = new SirioService();

//Parametri
$dataset = [
	"q" => [									// "q" sta per "query"
		"year_invoice" => 2017
	],
	"r" => 4,									// "r" sta per "results" , numero risultati per pagina
	"p"   => 1,								// "p" sta per "page", numero della pagina da visualizzare
	"s"	=> "supplier_invoice_id|DES"				// "s" sta per "sort"
];

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

/*
{
	nav: {
		page: 1,
		tot_pages: 1,
		results: 20,
		tot_results: 3,
		orderBy: "supplier_invoice_id|DES"
	},
	dataset: {
		0: {
			supplier_invoice_id: 8,
			supplier_id: 73,
			num: 1234,
			total: 61.00,
			currency: EUR,
			payment_method: 1,
			date_invoice: 2017-12-20,
			invoice_year: 2017,
			deadline: 2018-02-11,
			contact_name: Milani Marco,
			orders: {
				0: 32
			},
			total_currency_orders: 61.00,
			total_euro_orders: 50.00,
			total_vat: 11.00,
			total_document: 61.00
		},
		1: {
			...
		},
		2: {
			...
		}
		3: {
			...
		}
	}
}

*/

Manuale Utenti

Manuale Sviluppatori