Funzione: CutomerInvoice -> List

Questa funzione permette la ricerca dentro al database fatture 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, negozio della fattura cliente che si desidera ricercare.	Stringa di testo
year	facoltativo	estesa	Anno della fattura cliente che si desidera ricercare.	Numero
quarter	facoltativo	flag	Codice numerico: 0 = Tutti i trimestri 1 = Primo trimestre 2 = Secondo trimestre 3 = Terzo trimestre 4 = Quarto trimestre
shop_name	facoltativo	estesa	Nome del negozio a cui è associata la fattura cliente che si desidera ricercare.	Stringa di testo
invoice_num	facoltativo	esatta	Numero della fattura cliente che si desidera ricercare.	Numero

Chiavi OrderBy Supportate

OrderBy	Descrizione
shop_name\|ASC	Ordinato per nome negozio ascendente
shop_name\|DES	Ordinato per nome negozio discendente
invoice_date\|ASC	Ordinato per data della fattura ascendente
invoice_date\|DES	Ordinato per data della fattura discendente
tot_orders\|ASC	Ordinato per il totale degli ordini associati alla fattura ascendente
tot_orders\|DES	Ordinato per il totale degli ordini associati alla fattura ascendente
cache_price\|ASC	Ordinato per totale imponibile ascendente
cache_price\|DES	Ordinato per totale imponibile discendente
cache_vat\|ASC	Ordinato per totale IVA ascendente
cache_vat\|DES	Ordinato per totale IVA discendente
cache_document\|ASC	Ordinato per importo totale ascendente
cache_document\|DES	Ordinato per importo totale discendente
cache_withholding\|ASC	Ordinato per importo ritenuta ascendente
cache_withholding\|DES	Ordinato per importo ritenuta discendente
cache_payable\|ASC	Ordinato per il totale pagamento ascendente
cache_payable\|DES	Ordinato per il totale 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 clienti genera come risultati oggetti "fattura cliente". Per visualizzare la struttura di un oggetto fattura cliente, guarda il risultato della funzione customersInvoices->get

Esempi

Esempio di ricerca di una fattura cliente su Sirio.


require("SirioService.php");

//Creo l'oggetto per eseguire il servizio
$sirio = new SirioService();
	
//Parametri
$dataset = [
	"q" => [						// "q" sta per "query"
		"name" => "Studio"
	],
	"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("customersInvoices", "list", $dataset);

/*
{
	nav: {
		page: 1,
		tot_pages: 1,
		results: 10,
		tot_results: 3,
		orderBy: "name|DES"
	},
	dataset: {
		0: {
			customer_invoice_id: 72,
			invoice_year: 2018,
			invoice_num: 78,
			invoice_date: 2018-07-18,
			invoice_format: 0,
			vat_collettability: 0,
			shop_id: 1,
			shop_name: Prova1,
			header_id: 7,
			einvoice_trasmitted_id:	68,
			einvoice_customer_code: "",
			einvoice_customer_pec: "",
			einvoice_sdi_id:	null,
			einvoice_status:	0,
			einvoice_status_details:"",	
			customer_id: 10,
			customer_entity_type: 200,
			customer_name: Azienda 5,
			vat_code: 00000000000,
			tax_code: 00000000000,
			address_street: Abc,
			address_street_number: 0,
			address_city: Milano,
			address_postalcode: 20120,
			address_province: MI,
			address_countrycode: IT,
			ddt_number: "",
			ddt_date: "",
			ddt_name: "",
			ddt_street: "",
			ddt_street_number: "",
			ddt_city: "",
			ddt_postalcode: "",
			ddt_province: "",
			ddt_countrycode: "",
			payment_method: Pagato,
			supplementary_data: {
				ImportoBollo: 0
			},
			cache_price: 90.00,
			cache_discount: 0.00,
			cache_net: 90.00,
			cache_socialsurcharge: 0.00,
			cache_socialfund: 0.00,
			cache_vat: 19.80,
			cache_withholding: 0.00,
			cache_payable: 109.80,
			tot_discount: 0,
			tot_orders: 1,
			imponibile: 90,
			imposta: 19.8,
			calc_tot: 109.8,
			tot_quantity: 1,
			orders_ids: {
				0: 17
			}
		},
		1: {
			...
		},
		2: {
			...
		}
	}
}

*/

Manuale Utenti

Manuale Sviluppatori