Funzione: CustomersOrders -> Get
Questa funzione permette di ottenere le informazioni di un ordine cliente specifico inserito nel database.
Parametri
Campo | Obbligatorio | Descrizione | Valori Ammessi |
customer_order_id | obbligatorio | Il codice identificativo dell'ordine cliente. | Numero |
Risultato
Campo | Obbligatorio | Descrizione | Valori Ammessi |
customer_order_id | obbligatorio | Il codice identificativo dell'ordine associato all'anagrafica cliente. | Il codice è un numero progressivo |
customer_id | obbligatorio | Il codice identificativo dell'anagrafica cliente a cui è associato l'ordine | Numero |
product_id | obbligatorio | Il codice identificativo del prodotto associato a questo ordine. | Il codice è un numero progressivo |
product_name | obbligatorio | Il nome del Prodotto. | Stringa di testo. Es.: "Ultradolce alla Camomilla" |
contact_name | obbligatorio | Nome del Cliente o dell'amministratore a cui l'ordine è assciato | Stringa |
entity_type | obbligatorio | La tipologia di anagrafica, deve essere popolata con il numero identificativo |
100 → Persona fisica 200 → Libero Professionista 300 → Ditta individuale 400 → Società 500 → Ente no profit 800 → Ente pubblico |
description | obbligatorio | Descrizione attribuita al prodotto. | Stringa di testo. Es.: "Garnier Ultradolce alla Camomilla - 200ml" |
unit | obbligatorio | Codice identificativo dell'unità di misura utilizzata per il prodotto. | Codice numerico: 1 → Kg 2 → mt 3 → Lt 4 → nr 5 → ore 6 → pz 7 → anni 8 → minuti 9 → giorni 10 → settimane 11 → mesi 12 → m² 13 → m³ |
quantity | obbligatorio | Quantità | Numero |
price | obbligatorio | Prezzo unitario raccomandato. | Numero |
discount | obbligatorio | Sconto unitario. | Numero |
vat_rate | obbligatorio | Aliquota dell'imposta IVA applicata all'ordine. | Numero intero. Es.: 22 (significa 22%) |
vat_type | obbligatorio | Tipologia di imposta IVA applicata al prodotto in condizioni normali. | Codice numerico: 0 → Imponibile 1 → Escluse ex art. 15 2 → Non soggetta 3 → Non imponibile 4 → Esente ex art. 10 5 → Regime del margine |
socialsurcharge_rate Rivalsa INPS |
facoltativo | In caso l'ordine sia soggetto alla Rivalsa INPS è necessario inserire l'aliquota. | Numero intero. Es.: 4 (significa 4%) |
socialfund_rate Cassa Previdenziale |
facoltativo | In caso l'ordine sia soggetto alla Cassa Previdenziale di un ordine è necessario inserire l'aliquota. | Numero intero. Es.: 4 (significa 4%) |
withholding_base Ritenuta Fiscale - base |
facoltativo | Base imponibile della ritenuta fiscale applicata all'ordine. | Numero intero. Es.: 50 (significa 50%) Es.: 100 (significa 100%) |
withholding_rate Ritenuta Fiscale - aliquota |
facoltativo | Aliquota della ritenuta fiscale applicata all'ordine. | Numero intero. Es.: 20 (significa 20%) Es.: 23 (significa 23%) |
manager_id | facoltativo | Il codice identificicativo dell'utente che gestisce l'ordine. | Numero: se è stato assegnato in precedenza |
manager_name | facoltativo | Il nome utente che gestisce l'ordine. | Compare in automatico se è stato assegnato in precedenza |
shop_id | obbligatorio | Il codice identificativo del negozio a cui è associato l'ordine. | Numero |
shop_name | obbligatorio | Il codice identificativo del negozio a cui è associato l'ordine. | Stringa |
code | facoltativo | Codice per uso interno. In caso se ne faccia uso per riconciliare il prodotto con altri software. |
Codice alfanumerico |
code_ean | facoltativo | Codice EAN, in caso il prodotto ne sia dotato. | Codice EAN valido |
code_taric | facoltativo | Codice TARIC, in caso il prodotto ne sia dotato. | Codice TARIC valido |
code_cpv | facoltativo | Codice CPV, in caso il prodotto ne sia dotato. | Codice CPV valido |
code_ssc | facoltativo | Codice SSC, in caso il prodotto ne sia dotato. | Codice SSC valido |
status | obbligatorio | Stato dell'ordine associato all'anagrafica cliente | Codice numerico: 0 → Inevaso 1 → Assegnato 2 → In lavorazione 3 → Bloccato 4 → Sospeso 5 → Completato |
num_invoices | obbligatorio | Numero delle fatture generate per questo specifico ordine. | Numero |
invoiced_percentage | obbligatorio | Percentuale dell'importo fatturato per questo specifico ordine. | Numero/Numero percentuale |
date_start | facoltativo | La data di inizio del servizio. | Null: se vuoto |
date_end | facoltativo | La data di conclusione del servizio. | Null: se vuoto |
date_created | facoltativo | La data in cui è stato acquisito il cliente associato a questo specifico ordine | Se vuoto viene inserita la data dell'importazione |
amounts.order_unit.price | obbligatorio | Prezzo Unitario assegnato all'ordine | Importo |
amounts.order_unit.discount | obbligatorio | Sconto Unitario assegnato all'ordine | Importo |
amounts.order_unit.net | obbligatorio | importo Netto Unitario assegnato all'ordine | Importo |
amounts.order_unit.vat | obbligatorio | Importo IVA Unitario assegnato all'ordine | Importo |
amounts.order_unit.gross | obbligatorio | Importo Lordo Unitario assegnato all'ordine | Importo |
amounts.order_total.price | obbligatorio | Prezzo Totale assegnato all'ordine | Importo |
amounts.order_total.discount | obbligatorio | Sconto Totale assegnato all'ordine | Importo |
amounts.order_total.net | obbligatorio | Importo Netto Totale assegnato all'ordine | Importo |
amounts.order_total.vat | obbligatorio | Importo IVA Totale assegnato all'ordine | Importo |
amounts.order_total.gross | obbligatorio | Importo Lordo Totale assegnato all'ordine | Importo |
amounts.invoiced.price | obbligatorio | Importo fatturato | Importo |
amounts.invoiced.discount | obbligatorio | Sconto fatturato | Importo |
amounts.invoiced.net | obbligatorio | Importo netto fatturato | Importo |
amounts.invoiced.vat | obbligatorio | Importo IVA fatturato | Importo |
amounts.invoiced.gross | obbligatorio | Importo Lordo fatturato | Importo |
Esempi
Esempio delle informazioni restituite dalla funzione get per un Ordine associato ad un'anagrafica cliente.
require("SirioService.php");
//Creo l'oggetto per eseguire il servizio
$sirio = new SirioService();
//Parametri
$dataset = [
"customer_order_id" => 95
];
//Eseguo il comando
$customer_order_id = $sirio->sendCommand("customersOrders", "get", $dataset);
/*
dataset: {
customer_order_id: 95,
customer_id: 273,
product_id: 963,
description: srg,
contact_name: Bianchi Mario,
entity_type: 100,
product_name: Design Interno Casa Tipo E,
code: null,
code_ean: null,
code_cpv: null,
code_taric: null,
code_ssc: null,
status: 5,
unit: 4,
quantity: 10,
price: 100,
discount: 0,
vat_rate: 22,
vat_type: 0,
socialsurcharge_rate: 0,
socialfund_rate: 0,
withholding_base: 100,
withholding_rate: 0,
manager_id: null,
manager_name: null,
shop_id: 3,
shop_name: Negozio Roma,
num_invoices: 0,
invoiced_percentage: 0,
date_start: null,
date_end: null,
date_created: 2018-09-13 09:34:28,
amounts: {
order_unit: {
price: 100,
discount: 0,
net: 100,
vat: 22,
gross: 122
},
order_total: {
price: 1000,
discount: 0,
net: 1000,
vat: 220,
gross: 1220
}
invoiced: {
price: 0,
discount: 0,
net: 0,
vat: 0,
gross: 0,
withholding: 0
}
}
}
Sirio - Il Gestionale è anche social!