Mogelijke HTTP methodes: POST
POST
Met deze aanroep kan er een klant bedrijf (prospect) in AuditCase worden aangemaakt. Als dit is gelukt dan komt er in de response een 'ClientKey' terug. Met deze sleutel kunnen er bijvoorbeeld contactpersonen aangemaakt worden voor de nieuw aangemaakte klant.
Tijdens de aanroep zal het dossierstuk in AuditCase worden aangemaakt en zal het door de AuditCase validatie heen lopen. Indien het document niet aangemaakt kan worden dan krijgt de verzender hiervan bericht.
De HTTP status zal 400 zijn indien het document niet succesvol kon worden aangemaakt.
URL
{apiurl}/document/client/create/company_prospect
POST data (type: multipart/form-data)
| key | voorbeeld value | Optioneel | Omschrijving |
| Companyname | "Bigdata b.v." | Nee | Naam van het bedrijf. |
| ChamberOfCommerceNumber | Ja | KvK nummer | |
| City | "Barneveld" | Ja | Plaats van het correspondentieadres. |
| Street | "Straathof" | Ja | Straatnaam van het correspondentieadres. |
| Streetnumber | "1" | Ja | Huisnummer van het correspondentieadres. |
| Postalcode | "1234 AB" | Ja | Postcode van het correspondentieadres. |
Response (voorbeeld)
{
"ClientKey": "4323C35D03983218C1257F340051D361",
"DocumentId": "4323C35D03983218C1257F340051D361",
"PermanentLink": "https://dev01.changetocomm.net/ac/redirect&target=document&clientkey=60CF6DB60A1F7EE7C1256D1E00305ED8&key=4323C35D03983218C1257F340051D361&modulename=DOSSIER",
"Created": true
}
|
Property name |
Value |
Type |
| ClientKey |
Definitieve sleutel van deze klant. Op basis van deze sleutel kunnen er andere calls op deze klant uitgevoerd worden. |
String |
|
Created |
True/false als actie gelukt is. | Boolean |
|
DocumentId |
Directe sleutel naar het aangemaakte document |
String |
|
PermanentLink |
Permanente link naar het aangemaakte document |
String |