Overview Persone Aziende Campi custom Azioni Carrelli Corsi edizioni Tags Stati trattativa Sms Esempi

Hai dei dubbi o delle domande ? Non esitare a contattarci, inviandoci una email a support@brainlead.it

Aziende

Sommario

GET /companies/
POST /companies/add
POST /companies/{:id}/update
DELETE /companies/{:id}/delete

GET /companies/

Invia una chiamata GET a questo indirizzo per ricercare le SOCIETA' in archivio.

Richiesta

Parametro	Tipo	Descrizione
`page`	integer	Pagina dei risultati che si vuole visualizzare. Per ogni pagina vengono restituiti un massimo di 30 records.
`query`	string	Testo di ricerca. Per ogni parte del testo, verrà ricercata l'eventuale corrispondenza nei campi: nome ed email della scheda società.
`emails`	string	Emails. Per ogni email inserita, verrà ricercata l'eventuale presenza nella scheda società. Nel caso si vogliano ricercare più email, queste devono essere separate dal carattere ",". La ricerca di più email verrà effettuata applicando la logica OR.

Risposta

La chiamata restituirà un array con le società che sono state trovate utilizzando i parametri impostati nella chiamata.
Per ogni società verrà fornito un tracciato con le seguenti informazioni:

Parametro	Tipo	Descrizione
`id`	integer	Id della società.
`name`	string	Nome della società (lunghezza 0-255).
`vat`	string	Partita iva della società (lunghezza 0-20).
`fiscal_code`	string	Codice fiscale della società (lunghezza 0-20).
`email` `email_work` `email_private`	email	Email associata alla società (lunghezza 0-100). Il parametro indica la tipologia di email associata alla società: `email` Altro `email_work` Lavoro `email_private` Privata Possono essere presenti più tipologie di email associate alla stessa società.
`phone` `phone_work` `phone_home` `phone_mobile` `fax` `fax_home` `fax_work`	string	Telefono associato alla società (lunghezza 0-50). Il parametro indica la tipologia di telefono associata alla società: `phone` Altro `phone_work` Lavoro `phone_home` Casa `phone_mobile` Cellulare `fax` Fax `fax_home` Fax casa `fax_work` Fax lavoro Possono essere presenti più tipologie di telefono associate alla stessa società.
`address` `address_primary` `address_alternative` `address_work` `address_home` `address_billing` `address_shipping`	string	Via dell'indirizzo associato alla società (lunghezza 0-255). Il parametro indica la tipologia di via associata alla società: `address` Altro `address_primary` Primario `address_alternative` Alternativo `address_work` Lavoro `address_home` Casa `address_billing` Fatturazione `address_shipping` Spedizione Possono essere presenti più tipologie di via associate alla stessa società.
`city` `city_primary` `city_alternative` `city_work` `city_home` `city_billing` `city_shipping`	string	Città dell'indirizzo associato alla società (lunghezza 0-100). Il parametro indica la tipologia di città associata alla società: `city` Altro `city_primary` Primario `city_alternative` Alternativo `city_work` Lavoro `city_home` Casa `city_billing` Fatturazione `city_shipping` Spedizione Possono essere presenti più tipologie di città associate alla stessa società.
`province` `province_primary` `province_alternative` `province_work` `province_home` `province_billing` `province_shipping`	string	Provincia dell'indirizzo associato alla società (lunghezza 0-2). Il parametro indica la tipologia di provincia associata alla società: `province` Altro `province_primary` Primario `province_alternative` Alternativo `province_work` Lavoro `province_home` Casa `province_billing` Fatturazione `province_shipping` Spedizione Possono essere presenti più tipologie di provincia associate alla stessa società.
`zipcode` `zipcode_primary` `zipcode_alternative` `zipcode_work` `zipcode_home` `zipcode_billing` `zipcode_shipping`	string	CAP dell'indirizzo associato alla società (lunghezza 0-5). Il parametro indica la tipologia di CAP associata alla società: `zipcode` Altro `zipcode_primary` Primario `zipcode_alternative` Alternativo `zipcode_work` Lavoro `zipcode_home` Casa `zipcode_billing` Fatturazione `zipcode_shipping` Spedizione Possono essere presenti più tipologie di CAP associate alla stessa società.
`region` `region_primary` `region_alternative` `region_work` `region_home` `region_billing` `region_shipping`	string	Regione dell'indirizzo associato alla società (lunghezza 0-45). Il parametro indica la tipologia di regione associata alla società: `region` Altro `region_primary` Primario `region_alternative` Alternativo `region_work` Lavoro `region_home` Casa `region_billing` Fatturazione `region_shipping` Spedizione Possono essere presenti più tipologie di regione associate alla stessa società.
`country` `country_primary` `country_alternative` `country_work` `country_home` `country_billing` `country_shipping`	string	Nazione dell'indirizzo associato alla società (lunghezza 0-45). Il parametro indica la tipologia di nazione associata alla società: `country` Altro `country_primary` Primario `country_alternative` Alternativo `country_work` Lavoro `country_home` Casa `country_billing` Fatturazione `country_shipping` Spedizione Possono essere presenti più tipologie di nazione associate alla stessa società.
`external_id`	string	Id sorgente esterna a cui associare la società. Se il parametro contiene una stringa vuota, vuol dire che la società al momento non ha nessun Id sorgente esterna associato.

POST /companies/add

Invia una chiamata POST a questo indirizzo per creare una nuova SOCIETA'.

Richiesta

Parametro	Tipo	Descrizione
`name`	string (Obbligatorio)	Nome della società (lunghezza 1-255).
`vat`	string	Partita iva della società (lunghezza 0-20).
`fiscal_code`	string	Codice fiscale della società (lunghezza 0-20).
`email` `email_work` `email_private`	email	Email associata alla società (lunghezza 0-100). Per indicare la tipologia dell'email, utilizzare il parametro associato: `email` Altro `email_work` Lavoro `email_private` Privata Il parametro è obbligatorio e deve essere presente nella chiamata in almeno una delle sue tipologie. Sono consentite più tipologie di email associate alla stessa società.
`phone` `phone_work` `phone_home` `phone_mobile` `fax` `fax_home` `fax_work`	string	Telefono associato alla società (lunghezza 0-50). Per indicare la tipologia del telefono, utilizzare il parametro associato: `phone` Altro `phone_work` Lavoro `phone_home` Casa `phone_mobile` Cellulare `fax` Fax `fax_home` Fax casa `fax_work` Fax lavoro Sono consentite più tipologie di telefono associate alla stessa società.
`address` `address_primary` `address_alternative` `address_work` `address_home` `address_billing` `address_shipping`	string	Via dell'indirizzo associato alla società (lunghezza 0-255). Per indicare la tipologia di via, utilizzare il parametro associato: `address` Altro `address_primary` Primario `address_alternative` Alternativo `address_work` Lavoro `address_home` Casa `address_billing` Fatturazione `address_shipping` Spedizione Nel caso in cui si voglia inserire un indirizzo con indicata la via, il campo città della stessa tipologia, diventa obbligatorio. Sono consentite più tipologie di via associate alla stessa società.
`city` `city_primary` `city_alternative` `city_work` `city_home` `city_billing` `city_shipping`	string	Città dell'indirizzo associato alla società (lunghezza 0-100). Per indicare la tipologia di città, utilizzare il parametro associato: `city` Altro `city_primary` Primario `city_alternative` Alternativo `city_work` Lavoro `city_home` Casa `city_billing` Fatturazione `city_shipping` Spedizione Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia della stessa tipologia, deve essere valorizzato. Nel caso in cui si voglia inserire un indirizzo con indicata la via, il campo città della stessa tipologia, diventa obbligatorio. Sono consentite più tipologie di città associate alla stessa società.
`province` `province_primary` `province_alternative` `province_work` `province_home` `province_billing` `province_shipping`	string	Provincia dell'indirizzo associato alla società (lunghezza 0-2). Nel campo va indicata la sigla della provincia, es: MI. Per indicare la tipologia di provincia, utilizzare il parametro associato: `province` Altro `province_primary` Primario `province_alternative` Alternativo `province_work` Lavoro `province_home` Casa `province_billing` Fatturazione `province_shipping` Spedizione Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia della stessa tipologia, deve essere valorizzato. Sono consentite più tipologie di provincia associate alla stessa società.
`zipcode` `zipcode_primary` `zipcode_alternative` `zipcode_work` `zipcode_home` `zipcode_billing` `zipcode_shipping`	string	CAP dell'indirizzo associato alla società (lunghezza 0-5). Per indicare la tipologia di CAP, utilizzare il parametro associato: `zipcode` Altro `zipcode_primary` Primario `zipcode_alternative` Alternativo `zipcode_work` Lavoro `zipcode_home` Casa `zipcode_billing` Fatturazione `zipcode_shipping` Spedizione Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia della stessa tipologia, deve essere valorizzato. Sono consentite più tipologie di CAP associate alla stessa società.
`region` `region_primary` `region_alternative` `region_work` `region_home` `region_billing` `region_shipping`	string	Regione dell'indirizzo associato alla società (lunghezza 0-45). Per indicare la tipologia di regione, utilizzare il parametro associato: `region` Altro `region_primary` Primario `region_alternative` Alternativo `region_work` Lavoro `region_home` Casa `region_billing` Fatturazione `region_shipping` Spedizione Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia della stessa tipologia, deve essere valorizzato. Sono consentite più tipologie di regione associate alla stessa società.
`country` `country_primary` `country_alternative` `country_work` `country_home` `country_billing` `country_shipping`	string	Nazione dell'indirizzo associato alla società (lunghezza 0-45). Per indicare la tipologia di nazione, utilizzare il parametro associato: `country` Altro `country_primary` Primario `country_alternative` Alternativo `country_work` Lavoro `country_home` Casa `country_billing` Fatturazione `country_shipping` Spedizione Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia della stessa tipologia, deve essere valorizzato. Sono consentite più tipologie di nazione associate alla stessa società.
`custom_field_ID`	string boolean numeric date enum money	sostituisci ID con l'ID campo custom, es: custom_field_123.
`external_id`	string	Id sorgente esterna a cui associare la società.

Risposta

Parametro	Tipo	Descrizione
`id`	integer	Id della nuova società.

POST /companies/{:id}/update

Invia una chiamata POST a questo indirizzo per modificare una SOCIETA'.
Nella chiamata sostituire {:id} con l'id società da modificare.

Richiesta

Parametro	Tipo	Descrizione
`name`	string	Nome della società (lunghezza 1-255).
`vat`	string	Partita iva della società (lunghezza 0-20).
`fiscal_code`	string	Codice fiscale della società (lunghezza 0-20).
`email` `email_work` `email_private`	email	Email associata alla società (lunghezza 0-100). Per indicare la tipologia dell'email, utilizzare il parametro associato: `email` Altro `email_work` Lavoro `email_private` Privata Il parametro è obbligatorio e deve essere presente nella chiamata in almeno una delle sue tipologie. Sono consentite più tipologie di email associate alla stessa società.
`phone` `phone_work` `phone_home` `phone_mobile` `fax` `fax_home` `fax_work`	string	Telefono associato alla società (lunghezza 0-50). Per indicare la tipologia del telefono, utilizzare il parametro associato: `phone` Altro `phone_work` Lavoro `phone_home` Casa `phone_mobile` Cellulare `fax` Fax `fax_home` Fax casa `fax_work` Fax lavoro Sono consentite più tipologie di telefono associate alla stessa società.
`address` `address_primary` `address_alternative` `address_work` `address_home` `address_billing` `address_shipping`	string	Via dell'indirizzo associato alla società (lunghezza 0-255). Per indicare la tipologia di via, utilizzare il parametro associato: `address` Altro `address_primary` Primario `address_alternative` Alternativo `address_work` Lavoro `address_home` Casa `address_billing` Fatturazione `address_shipping` Spedizione Nel caso in cui si voglia inserire un indirizzo con indicata la via, il campo città della stessa tipologia, diventa obbligatorio. Sono consentite più tipologie di via associate alla stessa società.
`city` `city_primary` `city_alternative` `city_work` `city_home` `city_billing` `city_shipping`	string	Città dell'indirizzo associato alla società (lunghezza 0-100). Per indicare la tipologia di città, utilizzare il parametro associato: `city` Altro `city_primary` Primario `city_alternative` Alternativo `city_work` Lavoro `city_home` Casa `city_billing` Fatturazione `city_shipping` Spedizione Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia della stessa tipologia, deve essere valorizzato. Nel caso in cui si voglia inserire un indirizzo con indicata la via, il campo città della stessa tipologia, diventa obbligatorio. Sono consentite più tipologie di città associate alla stessa società.
`province` `province_primary` `province_alternative` `province_work` `province_home` `province_billing` `province_shipping`	string	Provincia dell'indirizzo associato alla società (lunghezza 0-2). Nel campo va indicata la sigla della provincia, es: MI. Per indicare la tipologia di provincia, utilizzare il parametro associato: `province` Altro `province_primary` Primario `province_alternative` Alternativo `province_work` Lavoro `province_home` Casa `province_billing` Fatturazione `province_shipping` Spedizione Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia della stessa tipologia, deve essere valorizzato. Sono consentite più tipologie di provincia associate alla stessa società.
`zipcode` `zipcode_primary` `zipcode_alternative` `zipcode_work` `zipcode_home` `zipcode_billing` `zipcode_shipping`	string	CAP dell'indirizzo associato alla società (lunghezza 0-5). Per indicare la tipologia di CAP, utilizzare il parametro associato: `zipcode` Altro `zipcode_primary` Primario `zipcode_alternative` Alternativo `zipcode_work` Lavoro `zipcode_home` Casa `zipcode_billing` Fatturazione `zipcode_shipping` Spedizione Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia della stessa tipologia, deve essere valorizzato. Sono consentite più tipologie di CAP associate alla stessa società.
`region` `region_primary` `region_alternative` `region_work` `region_home` `region_billing` `region_shipping`	string	Regione dell'indirizzo associato alla società (lunghezza 0-45). Per indicare la tipologia di regione, utilizzare il parametro associato: `region` Altro `region_primary` Primario `region_alternative` Alternativo `region_work` Lavoro `region_home` Casa `region_billing` Fatturazione `region_shipping` Spedizione Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia della stessa tipologia, deve essere valorizzato. Sono consentite più tipologie di regione associate alla stessa società.
`country` `country_primary` `country_alternative` `country_work` `country_home` `country_billing` `country_shipping`	string	Nazione dell'indirizzo associato alla società (lunghezza 0-45). Per indicare la tipologia di nazione, utilizzare il parametro associato: `country` Altro `country_primary` Primario `country_alternative` Alternativo `country_work` Lavoro `country_home` Casa `country_billing` Fatturazione `country_shipping` Spedizione Nel caso in cui si voglia inserire un indirizzo, un campo tra città e provincia della stessa tipologia, deve essere valorizzato. Sono consentite più tipologie di nazione associate alla stessa società.
`custom_field_ID`	string boolean numeric date enum money	sostituisci ID con l'ID campo custom, es: custom_field_123.
`external_id`	string	Id sorgente esterna a cui associare la società.

Risposta

Parametro	Tipo	Descrizione
`updated`	boolean	Contiene true se la chiamata ha prodotto un aggiornamento della scheda della società, altrimenti sarà false.

DELETE /companies/{:id}/delete

Invia una chiamata DELETE a questo indirizzo per eliminare una società.
Nella chiamata sostituire {:id} con l'id società da eliminare.

Risposta

Parametro	Tipo	Descrizione
`deleted`	boolean	Contiene true se l'eliminazione è andata a buon fine.