Algemeen

Per omgeving zijn er unieke authenticatiegegevens nodig. De URL voor de API
zal deze authenticatie bevatten.

https://c06.secure.zolive.nl/api/1234/token/

In dit voorbeeld zal 1234 vervangen worden door het omgevingsnummer en token door
de desbetreffende token die hoort bij deze omgeving. Deze url is de basis voor de Zolive
API

Facturen & offertes

Voor het aanmaken van een factuur of offerte zijn er de "Create invoice"- en "Create offer"-endpoints.
De belangrijkste punten van deze endpoints

Bij het meegeven van "Invoice_Id" wordt niet een nieuwe factuur/offerte gemaakt.
"Invoice_IType_Id" bepaalt de entiteit waaraan de offerte/factuur gekoppeld wordt.
Met "Generated" en "Paid" kan een bestaande factuur als betaald genoteerd worden.
Met "Generated Type" wordt een factuur/offerte gegenereerd.

Relaties

Het zoeken naar realties kan met de "Clients"-endpoint.
Voor het aanmaken van een relatie kan de "Save Client" endpoint gebruikt worden.

de "try_to_find_client" kan meerdere velden bevatten. De velden die hier benoemd worden, worden gebruikt om eerst het bestaande relatiebestand te doorzoeken naar een gelijke match.
Wanneer velden matchen met een bestaande relatie, wordt deze relatie teruggegeven en niet een nieuwe aangemaakt.
Bij het meegeven van "Client_Id" wordt een bestaande relatie bewerkt.

Medewerkers

Met de "Employees"-endpoint kunnen alle actieve medewerkers opgehaald worden.

Notities

Een notitie kan aangemaakt worden voor verschillende plekken. Bij een offerte of factuur, bij een relatie en bij een workflow.
De notitie kan gekoppeld zijn aan een of alle van de eerder genoemde opties. "Save note"

Het veld "dealid" is voor het koppelen van een workflow.

Met de endpoint "Save note - Attachment" kunnen bestanden toegevoegd worden aan een bestaande notitie.

Workflow

Een relatie kan toegevoegd worden aan een workflow. Dit kan met de endpoint "Save workflow".

"clientid" is de betreffende realtie.
"typeid" is de id van de soort workflow waar aan de realtie toegevoegd moet worden.
"statusid" is de id van de stap in de workflow waaraan de realtie toegevoegd wordt.