API (1.9.15)
Autorisatie ¶
Token based ¶
Access tokens worden door Faster Forward Elements gebruikt om te identificeren welke partij de webservices bevraagt en om bepaalde delen van de API af te schermen.
Een access token is uniek binnen het systeem en wordt pas aangemaakt zodra een derde partij deze opvraagt. De access token heeft daarnaast als functie om diverse delen van de API af te schermen middels rechten, oftewel scopes.
Welke webservices en delen van de API u kunt gebruiken, hangt geheel af welke gegevens u nodig heeft. Dit wordt bepaald door Faster Forward zelf en onze klant, welke uw opdrachtgever is.
Flows ¶
Access tokens kunnen via verschillende flows verkregen worden. Welke flow u moet gebruiken hangt af van de voor soort applicatie en wat voor soort data u wilt gaan bevragen.
Faster Forward Elements API kent op dit moment de volgende flows:
-
Organisation flow
-
Authorization code flow
-
Implicit flow
Organisation flow
Deze flow wordt gebruikt indien u gegevens wilt ophalen die zich in de scope van een organisatie bevinden.
U kunt deze flow alleen gebruiken indien u een online server side applicatie heeft.
De flow is op te delen in 5 stappen welke hieronder staan beschreven:
-
De eerste stap in het bevragen van een webservice is het verkrijgen van een zogenaamde access token. Het verkrijgen van een access token verloopt via een HTTP POST request.
-
Indien succesvol zal de token server een access token terugsturen naar uw applicatie.
-
Indien u een webservice wilt gaan bevragen, zult u de access token die in stap 2 verkregen is, mee moeten sturen.
-
Afhankelijk van welke webservice u bevraagd heeft, wordt er door webservice een response teruggeven.
-
De laatste stap is het verwerken van het response object op het betreffende platform. Hoe dit wordt vormgegeven is uiteraard geheel aan u.
De eerste stap in het bevragen van een webservice is het verkrijgen van een zogenaamde Access en Refresh token.
Authorization code flow
Deze flow wordt gebruikt indien u als derde partij gegevens wilt ophalen ten behoeve van een Elements gebruiker, vanuit een omgeving waar client credentials veilig kunnen worden opgeslagen.
De flow is op te delen de stappen die hieronder staan beschreven:
-
Voor het verkrijgen van gegevens uit Elements via een derde partij kan een autorizatie code worden opgevraagd, via een HTTP GET request.
-
Als de gebruiker nog niet is ingelogd in de Elements omgeving wordt hij doorverwezen naar het inlog scherm, waar hij zijn gebruikersnaam en wachtwoord dient op te geven.
-
Daarna ziet de gebruiker een overzicht van scopes waarvoor hij Elements toestemming verleent om gegevens te delen. Nadat de gebruiker toestemming heeft verleend wordt er een autorizatie code naar de redirect url gestuurd.
-
Deze autorizatie code kunt u inwisselen voor een access token via een HTTP POST request.
-
Indien succesvol zal de token server een access token terugsturen naar uw applicatie.
-
Indien u een webservice wilt gaan bevragen, zult u de access token die in stap 5 verkregen is, mee moeten sturen.
-
Afhankelijk van welke webservice u bevraagd heeft, wordt er door webservice een response teruggeven.
-
De laatste stap is het verwerken van het response object op het betreffende platform. Hoe dit wordt vormgegeven is uiteraard geheel aan u.
Implicit flow
Deze flow wordt gebruikt indien u als derde partij gegevens wilt ophalen ten behoeve van een Elements gebruiker, vanuit een omgeving waar client credentials niet veilig kunnen worden opgeslagen.
De flow is op te delen de stappen die hieronder staan beschreven:
-
Met de configuratie gegevens kan een access token worden opgevraagd, via een HTTP GET request.
-
Als de gebruiker nog niet is ingelogd in de Elements omgeving wordt hij doorverwezen naar het inlog scherm, waar hij zijn gebruikersnaam en wachtwoord dient op te geven.
-
Daarna ziet de gebruiker een overzicht van scopes waarvoor hij Faster Forward toestemming verleent om gegevens te delen. Nadat de gebruiker toestemming heeft verleend wordt er een access token verschaft.
-
Indien u een webservice wilt gaan bevragen, zult u de access token die in stap 2 verkregen is, mee moeten sturen.
-
Afhankelijk van welke webservice u bevraagd heeft, wordt er door webservice een response teruggeven.
-
De laatste stap is het verwerken van het response object op het betreffende platform. Hoe dit wordt vormgegeven is uiteraard geheel aan u.
Organisation flow ¶
Organisation flowPOST/oauth/access_token
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/oauth/access_token
Request
Access TokenVerbergBekijk
Headers
Content-Type: application/x-www-form-urlencoded
PHP_AUTH_USER: Faster Forward
PHP_AUTH_PW: ***************Body
grant_type=organisation&organisation={ORGANISATIE_ID}&webservice={WEBSERVICE}&scope={SCOPES}Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"access_token": "5db1cf97f8fd66f295c33eae616227e69de4d",
"expires_in": 3600,
"token_type": "Bearer",
"scope": "{SCOPES}",
"refresh_token": "6ebffce35d81e24463336fc2a8c8cc9d23b8c"
}Response
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"error_description" : {ERROR_MESSAGE_DESCRIPTION},
"error" :{ERROR_MESSAGE_CODE}
}Authorization code flow ¶
Authorization code flowGET/oauth/authorize?response_type=code&client_id={CLIENT_ID}&webservice={WEBSERVICE}&scope={SCOPE}&state={STATE}&redirect_uri={REDIRECT_URI}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/oauth/authorize?response_type=code&client_id=Faster Forward&webservice=data&scope=klantdossier.read&state=1234&redirect_uri=urn:ietf:wg:oauth:2.0:oob
URI Parameters
VerbergBekijk
- CLIENT_ID
string(verplicht) Voorbeeld: Faster Forward- WEBSERVICE
string(verplicht) Voorbeeld: data- SCOPE
string(verplicht) Voorbeeld: klantdossier.read- STATE
string(verplicht) Voorbeeld: 1234- REDIRECT_URI
string(optioneel) Voorbeeld: urn:ietf:wg:oauth:2.0:oob
Response
200VerbergBekijk
Er zal worden redirect naar de opgegeven REDIRECT_URI, met de code toegevoegd als query parameter. Als de REQUEST_URI wordt weggelaten, of gelijk is aan ‘urn:ietf:wg:oauth:2.0:oob’ zal de titel van het venster de code bevatten.
Authorization code inwisselen ¶
Authorization code inwisselenPOST/oauth/access_token
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/oauth/access_token
Request
VerbergBekijk
Headers
Content-Type: application/x-www-form-urlencoded
PHP_AUTH_USER: Faster Forward
PHP_AUTH_PW: ***************Body
grant_type=authorization_code&code={CODE}Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"access_token": "5db1cf97f8fd66f295c33eae616227e69de4d",
"expires_in": 3600,
"token_type": "Bearer",
"scope": "{SCOPES}",
"refresh_token": "6ebffce35d81e24463336fc2a8c8cc9d23b8c"
}Response
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"error_description" : {ERROR_MESSAGE_DESCRIPTION},
"error" :{ERROR_MESSAGE_CODE}
}Refresh token ¶
Refresh tokenPOST/oauth/access_token
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/oauth/access_token
Request
VerbergBekijk
Headers
Content-Type: application/x-www-form-urlencoded
PHP_AUTH_USER: Faster Forward
PHP_AUTH_PW: ***************Body
grant_type=refresh_token&refresh_token=6ebffce35d81e24463336fc2a8c8cc9d23b8cResponse
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"access_token": "5db1cf97f8fd66f295c33eae616227e69de4d",
"expires_in": 3600,
"token_type": "Bearer",
"scope": "{SCOPES}",
"refresh_token": "6ebffce35d81e24463336fc2a8c8cc9d23b8c"
}Response
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"error_description" : {ERROR_MESSAGE_DESCRIPTION},
"error" :{ERROR_MESSAGE_CODE}
}Implicit flow ¶
Implicit flowGET/oauth/authorize?response_type=token&client_id={CLIENT_ID}&webservice={WEBSERVICE}&scope={SCOPE}&state={STATE}&redirect_uri={REDIRECT_URI}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/oauth/authorize?response_type=token&client_id=Faster Forward&webservice=data&scope=klantdossier.read&state=1234&redirect_uri=urn:ietf:wg:oauth:2.0:oob
URI Parameters
VerbergBekijk
- CLIENT_ID
string(verplicht) Voorbeeld: Faster Forward- WEBSERVICE
string(verplicht) Voorbeeld: data- SCOPE
string(verplicht) Voorbeeld: klantdossier.read- STATE
string(verplicht) Voorbeeld: 1234- REDIRECT_URI
string(optioneel) Voorbeeld: urn:ietf:wg:oauth:2.0:oob
Response
200VerbergBekijk
Er zal worden redirect naar de opgegeven REDIRECT_URI, met het access token toegevoegd als query parameter. Als de REQUEST_URI wordt weggelaten, of gelijk is aan ‘urn:ietf:wg:oauth:2.0:oob’ zal de titel van het venster het access token bevatten.
Klantdossier ¶
Klantdossier ¶
Klantdossier collectieGET/api/data/klantdossiers{?access_token,relatienummer,omschrijving,dossierstatus,kantoor,achternaam,geboortedatum,organisatie,kvknummer,straat,nummer,postcode,plaatsnaam,telefoonnummer,emailadres,contractnummer,kenteken,zoekwaarde}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers?access_token=3b57bd2db21c46d2875508b982968d26&relatienummer=4815162342&omschrijving=dossier 5526&dossierstatus=1&kantoor=3888&achternaam=van Test&geboortedatum=1990-03-07&organisatie=Faster Forward B.V.&kvknummer=20128551&straat=Stationsstraat&nummer=14&postcode=4611CC&plaatsnaam=Bergen op Zoom&telefoonnummer=0164210240&emailadres=api@fasterforward.nl&contractnummer=16180339887&kenteken=ECTO-1&zoekwaarde=Janssen
URI Parameters
VerbergBekijk
- access_token
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26- relatienummer
string(optioneel) Voorbeeld: 4815162342- omschrijving
string(optioneel) Voorbeeld: dossier 5526- dossierstatus
string(optioneel) Voorbeeld: 1- kantoor
string(optioneel) Voorbeeld: 3888- achternaam
string(optioneel) Voorbeeld: van Test- geboortedatum
string(optioneel) Voorbeeld: 1990-03-07- organisatie
string(optioneel) Voorbeeld: Faster Forward B.V.- kvknummer
string(optioneel) Voorbeeld: 20128551- straat
string(optioneel) Voorbeeld: Stationsstraat- nummer
string(optioneel) Voorbeeld: 14- postcode
string(optioneel) Voorbeeld: 4611CC- plaatsnaam
string(optioneel) Voorbeeld: Bergen op Zoom- telefoonnummer
string(optioneel) Voorbeeld: 0164210240- emailadres
string(optioneel) Voorbeeld: api@fasterforward.nl- contractnummer
string(optioneel) Voorbeeld: 16180339887- kenteken
string(optioneel) Voorbeeld: ECTO-1- zoekwaarde
string(optioneel) Voorbeeld: Janssen
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers"
}
},
"_embedded": {
"klantdossiers": [
{
"omschrijving": "Klantdossier",
"aanmaakdatum": "2016-07-11T00:00:00+0200",
"deleted": null,
"relatienummer": null,
"id": 5526,
"dossiertype": "klantdossier",
"status": "Lopend",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526"
}
},
"_embedded": {
"standaardcorrespondentieadres": {
"id": 292,
"straat": "Straatnaam",
"nummer": "1",
"toevoeging": "A",
"postcode": "1234AB",
"plaatsnaam": "Plaatsnaam",
"land": "NL"
}
}
}
]
}
}Klantdossier ophalenGET/api/data/klantdossiers/{DOSSIER_ID}?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"omschrijving": "Klantdossier",
"aanmaakdatum": "2016-07-11T00:00:00+0200",
"deleted": null,
"relatienummer": null,
"id": 5526,
"dossiertype": "klantdossier",
"status": "Nieuw",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526"
},
"registraties": {
"href": "/api/data/klantdossiers/5526/registraties"
},
"adviseurs": {
"href": "/api/data/klantdossiers/5526/adviseurs"
},
"kantoor": {
"href": "/api/data/klantdossiers/5526/kantoor"
},
"klanten": {
"href": "/api/data/klantdossiers/5526/klanten",
"deprecation": "http://api.fasterforward.nl"
},
"panden": {
"href": "/api/data/klantdossiers/5526/panden"
},
"bezittingen": {
"href": "/api/data/klantdossiers/5526/bezittingen"
},
"producten": {
"href": "/api/data/klantdossiers/5526/producten"
},
"facturen": {
"href": "/api/data/klantdossiers/5526/facturen"
},
"documenten": {
"href": "/api/data/klantdossiers/5526/documenten"
},
"stukken": {
"href": "/api/data/klantdossiers/5526/stukken"
},
"emails": {
"href": "/api/data/klantdossiers/5526/emails"
},
"taken": {
"href": "/api/data/klantdossiers/5526/taken"
},
"klanten/particulier": {
"href": "/api/data/klantdossiers/5526/klanten/particulier"
},
"klanten/zakelijk": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk"
}
},
"_embedded": {
"standaardcorrespondentieadres": {
"id": 7793,
"straat": "Groenhof",
"nummer": "1",
"toevoeging": "",
"postcode": "1275BB",
"plaatsnaam": "Huizen",
"land": "NL"
}
}
}Klantdossier toevoegenPOST/api/data/klantdossiers/?access_token={ACCESS_TOKEN}]
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"omschrijving": "Test dossier",
"aanmaakdatum": "2017-01-01 10:00:00",
"relatienummer": "12345",
"dossierstatus": {
"id": 1
},
"kantoor": {
"id": 14830
}
}Schema
{
"definitions": {
"dossier": {
"type": "object",
"properties": {
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"aanmaakdatum": {
"type": "string",
"format": "datatype-datetime"
},
"relatienummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"dossierstatus": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"kantoor": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"standaardCorrespondentieadres": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"additionalProperties": false,
"required": [
"omschrijving",
"dossierstatus",
"kantoor"
]
}
}
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526Actie toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/acties?access_token={ACCESS_TOKEN}]
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/acties?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"actie": {
"id": 1
},
"omschrijving": "Omschrijving van de actie"
}Schema
{
"properties": {
"actie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false,
"required": [
"actie"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/acties/2400Object overige toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/bezittingen/overige?access_token={ACCESS_TOKEN}]
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bezittingen/overige?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Voorbeeld Kostbaarheid
{
"omschrijving": "De geboorte van Venus",
"catalogusWaarde": 30000,
"datumAankoop": "2016-01-01",
"aankoopwaarde": 30000,
"huidigeWaardeDatum": "2016-01-01",
"huidigeWaarde": 40000,
"type": "3",
"bezittingtype": "Kostbaarheid",
"plaats": "Overal"
}
Voorbeeld Juwelen
{
"omschrijving": "test api",
"catalogusWaarde": 50000,
"datumAankoop": "2005-02-01",
"aankoopwaarde": 50000,
"huidigeWaardeDatum": "2017-01-01",
"huidigeWaarde": 50000,
"type": "api type",
"bezittingtype": "Overige",
"kostbaarheidType": "Juwelen"
}Schema
{
"title": "",
"type": "object",
"properties": {
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"catalogusWaarde": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"datumAankoop": {
"type": "string",
"format": "datatype-date"
},
"aankoopwaarde": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"huidigeWaardeDatum": {
"type": "string",
"format": "datatype-date"
},
"huidigeWaarde": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"type": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"bezittingtype": {
"enum": [
"Kostbaarheid",
"Overige"
]
},
"kostbaarheidType": {
"enum": [
"Antiek",
"Aquarellen",
"Audio-/Video-apparatuur",
"Autotelefoon",
"Bijzondere bezitting",
"Boek",
"Bont",
"Elektrisch versterkte muziekinstrumenten",
"Foto-Film",
"Golfuitrusting",
"Horloges",
"Juwelen",
"Kunst",
"Lichtreclame",
"Modelbouw",
"Muziekinstrument",
"Optische instrumenten",
"Overige",
"Porselein",
"Postzegels en munten",
"Recreatiezaken",
"Schilderij",
"Sportfiets",
"Stereo-Video binnenshuis",
"Stereo-Video buitenshuis",
"Surfuitrusting",
"(Oosterse) Tapijten",
"Verzameling",
"Visuitrusting"
]
},
"plaats": {
"enum": [
"Overal",
"Adres",
"Overig"
]
},
"adres": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"required": [
"bezittingtype"
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/bezittingen/184Object voertuig toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/bezittingen/voertuigen?access_token={ACCESS_TOKEN}]
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bezittingen/voertuigen?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Voorbeeld Auto
{
"omschrijving": "37GLPD - Volkswagen Golf V5 GTI",
"merk": "Volkswagen",
"catalogusWaarde": 26000,
"datumAankoop": "2016-01-01",
"aankoopwaarde": 7500,
"huidigeWaardeDatum": "2016-01-01",
"huidigeWaarde": 7000,
"kenteken": "37GLPD",
"bouwjaar": "2001-01-01",
"gewicht": 1252,
"type": "Hatchback",
"uitvoering": "V5 GTI",
"model": "Golf",
"kilowatt": 125,
"aantalPk": 170,
"meldcode": "123",
"cilinderinhoud": 2400,
"bezittingtype": "Auto",
"alarminstallatie": "Fabriek ingebouwd alarm klasse 1"
}
Voorbeeld E-bike
{
"omschrijving": "Batavus Barcelona",
"merk": "Batavus",
"catalogusWaarde": 2000,
"datumAankoop": "2005-02-01",
"aankoopwaarde": 900,
"huidigeWaardeDatum": "2017-01-01",
"huidigeWaarde": 500,
"bouwjaar": "2000-06-01",
"model": "Barcelona",
"bezittingtype": "Fiets",
"fietsType": "E-bike"
}
Voorbeeld Catamaran
{
"omschrijving": "Hobie cat tiger 1455",
"merk": "Hobie",
"catalogusWaarde": 10000,
"datumAankoop": "2017-02-01",
"aankoopwaarde": 5000,
"huidigeWaardeDatum": "2017-01-01",
"huidigeWaarde": 5000,
"bouwjaar": "2009-06-01",
"model": "Cat tiger",
"bezittingtype": "Boot",
"bootType": "Catamaran"
}Schema
{
"title": "",
"type": "object",
"properties": {
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"merk": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"catalogusWaarde": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"datumAankoop": {
"type": "string",
"format": "datatype-date"
},
"aankoopwaarde": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"huidigeWaardeDatum": {
"type": "string",
"format": "datatype-date"
},
"huidigeWaarde": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"kenteken": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"bouwjaar": {
"type": "string",
"format": "datatype-date"
},
"gewicht": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
},
"type": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"uitvoering": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"model": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"kilowatt": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
},
"aantalPk": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
},
"meldcode": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"cilinderinhoud": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
},
"bezittingtype": {
"enum": [
"Auto",
"Caravan",
"Brommer",
"Motor",
"Boot",
"Fiets",
"Aanhangwagen",
"Vrachtwagen"
]
},
"bootType": {
"enum": [
"Anders",
"Catamaran",
"Jetski",
"Kano",
"Motor sportboot",
"Motor-sailer",
"Motorboot",
"Motorjacht",
"Motorzeiljacht",
"Opblaas boot",
"Open boot",
"Platbodem",
"Roeiboot",
"Rubberboot",
"Sloep",
"Surf-, zeilplank",
"Trimaran",
"Visboot",
"Vlet",
"Zeilboot"
]
},
"fietsType": {
"enum": [
"Anders",
"Bakfiets",
"Citybike",
"Driewieler",
"E-bike",
"Fiets met hulpmotor",
"High speed E-bike",
"MTB/ATB",
"Racefiets",
"Rijwiel",
"Tandem",
"Vouwfiets"
]
},
"alarminstallatie": {
"enum": [
"Geen",
"Af fabriek Klasse Startonderbreker (voorheen klasse 1)",
"Af fabriek Klasse Alarmsysteem (voorheen klasse 2)",
"Af fabriek Alarmsysteem met hellingshoekdetectie (voorheen klasse 3)",
"Af fabriek SCM Klasse Voertuigvolgsysteem met startonderbreker (voorheen klasse 4)",
"Af fabriek SCM Klasse Voertuigvolgsysteem met alarm met hellingshoekdetectie (voorheen klasse 5)",
"Af fabriek SCM Klasse Voertuigvolgsysteem met alarm met hellingshoekdetectie (voorheen klasse 5) i.c.m. peilzender",
"Af fabriek SCM beveiligingsklasse Terugvindsysteem",
"Af fabriek SCM beveiligingsklasse Terugvindsysteem i.c.m. alarmsysteem met hellingshoekdetectie",
"Klasse Startonderbreker (voorheen klasse 1)",
"Klasse Alarmsysteem (voorheen klasse 2)",
"Alarmsysteem met hellingshoekdetectie (voorheen klasse 3)",
"SCM Klasse Voertuigvolgsysteem met startonderbreker (voorheen klasse 4)",
"SCM Klasse Voertuigvolgsysteem met alarm met hellingshoekdetectie (voorheen klasse 5)",
"SCM Klasse Voertuigvolgsysteem met alarm met hellingshoekdetectie (voorheen klasse 5) i.c.m. peilzender",
"SCM beveiligingsklasse Terugvindsysteem",
"SCM beveiligingsklasse Terugvindsysteem i.c.m. alarmsysteem met hellingshoekdetectie"
]
}
},
"required": [
"bezittingtype"
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/bezittingen/183Object voertuig toevoegen DEPRECATEDPOST/api/data/klantdossiers/{DOSSIER_ID}/bezittingen/voertuig?access_token={ACCESS_TOKEN}]
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bezittingen/voertuig?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"omschrijving": "37GLPD - Volkswagen Golf V5 GTI",
"merk": "Volkswagen",
"catalogusWaarde": 26000,
"datumAankoop": "2016-01-01",
"aankoopwaarde": 7500,
"huidigeWaardeDatum": "2016-01-01",
"huidigeWaarde": 7000,
"kenteken": "37GLPD",
"bouwjaar": "2001-01-01",
"gewicht": 1252,
"type": "Hatchback",
"uitvoering": "V5 GTI",
"model": "Golf",
"kilowatt": 125,
"aantalPk": 170,
"meldcode": "123",
"cilinderinhoud": 2400,
"bezittingtype": "Auto",
"alarminstallatie": "Fabriek ingebouwd alarm klasse 1"
}Schema
{
"title": "",
"type": "object",
"properties": {
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"merk": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"catalogusWaarde": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"datumAankoop": {
"type": "string",
"format": "datatype-date"
},
"aankoopwaarde": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"huidigeWaardeDatum": {
"type": "string",
"format": "datatype-date"
},
"huidigeWaarde": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"kenteken": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"bouwjaar": {
"type": "string",
"format": "datatype-date"
},
"gewicht": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
},
"type": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"uitvoering": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"model": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"kilowatt": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
},
"aantalPk": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
},
"meldcode": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"cilinderinhoud": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
},
"bezittingtype": {
"enum": [
"Auto",
"Caravan",
"Brommer",
"Motor",
"Boot",
"Fiets",
"Aanhangwagen",
"Vrachtwagen"
]
},
"bootType": {
"enum": [
"Anders",
"Catamaran",
"Jetski",
"Kano",
"Motor sportboot",
"Motor-sailer",
"Motorboot",
"Motorjacht",
"Motorzeiljacht",
"Opblaas boot",
"Open boot",
"Platbodem",
"Roeiboot",
"Rubberboot",
"Sloep",
"Surf-, zeilplank",
"Trimaran",
"Visboot",
"Vlet",
"Zeilboot"
]
},
"fietsType": {
"enum": [
"Anders",
"Bakfiets",
"Citybike",
"Driewieler",
"E-bike",
"Fiets met hulpmotor",
"High speed E-bike",
"MTB/ATB",
"Racefiets",
"Rijwiel",
"Tandem",
"Vouwfiets"
]
},
"alarminstallatie": {
"enum": [
"Geen",
"Af fabriek Klasse Startonderbreker (voorheen klasse 1)",
"Af fabriek Klasse Alarmsysteem (voorheen klasse 2)",
"Af fabriek Alarmsysteem met hellingshoekdetectie (voorheen klasse 3)",
"Af fabriek SCM Klasse Voertuigvolgsysteem met startonderbreker (voorheen klasse 4)",
"Af fabriek SCM Klasse Voertuigvolgsysteem met alarm met hellingshoekdetectie (voorheen klasse 5)",
"Af fabriek SCM Klasse Voertuigvolgsysteem met alarm met hellingshoekdetectie (voorheen klasse 5) i.c.m. peilzender",
"Af fabriek SCM beveiligingsklasse Terugvindsysteem",
"Af fabriek SCM beveiligingsklasse Terugvindsysteem i.c.m. alarmsysteem met hellingshoekdetectie",
"Klasse Startonderbreker (voorheen klasse 1)",
"Klasse Alarmsysteem (voorheen klasse 2)",
"Alarmsysteem met hellingshoekdetectie (voorheen klasse 3)",
"SCM Klasse Voertuigvolgsysteem met startonderbreker (voorheen klasse 4)",
"SCM Klasse Voertuigvolgsysteem met alarm met hellingshoekdetectie (voorheen klasse 5)",
"SCM Klasse Voertuigvolgsysteem met alarm met hellingshoekdetectie (voorheen klasse 5) i.c.m. peilzender",
"SCM beveiligingsklasse Terugvindsysteem",
"SCM beveiligingsklasse Terugvindsysteem i.c.m. alarmsysteem met hellingshoekdetectie"
]
}
},
"required": [
"bezittingtype"
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/bezittingen/182Pand toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/panden?access_token={ACCESS_TOKEN}]
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/panden?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Niet-bestaand adres
{
"postcode" : "4651ME",
"nummer" : "3",
"toevoeging" : "B",
"straat" : "Grimbergen",
"plaatsnaam" : "Steenbergen",
"gemeente" : "Steenbergen",
"provincie" : "Noord-Brabant",
"land" : "NL",
"categorie" : "Standaard",
"type" : "Pand"
}
Bestaand adres
{
"id" : 7796,
"type" : "Pand"
}Schema
Niet-bestaand adres:
{
"properties": {
"postcode": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"nummer": {
"type": "string",
"minLength": 1,
"maxLength": 25
},
"toevoeging": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"straat": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"plaatsnaam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"gemeente": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"provincie": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"land": {
"enum": [
"AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX",
"AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR",
"BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM",
"CN","CO","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ",
"EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD",
"GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY",
"HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT",
"JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA",
"LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG",
"MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY",
"MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE",
"PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS",
"RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO",
"SR","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN",
"TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG",
"VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"
]
},
"categorie": {
"enum": [
"Standaard",
"Postbus",
"Antwoordnummer"
]
},
"type": {
"enum": [
"Afleveradres",
"Algemeen",
"Bezoekadres",
"Correspondentieadres",
"Factuuradres",
"Pand",
"Priveadres"
]
}
},
"additionalProperties": false,
"required": [
"plaatsnaam",
"type"
]
}
Bestaand adres:
{
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
},
"type": {
"enum": [
"Afleveradres",
"Algemeen",
"Bezoekadres",
"Correspondentieadres",
"Factuuradres",
"Pand",
"Priveadres"
]
}
},
"additionalProperties": false,
"required": [
"id",
"type"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/panden/7796Propositie toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/proposities?access_token={ACCESS_TOKEN}]
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/proposities?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"naam": "Naam van de propositie"
}Schema
{
"properties": {
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false,
"required": [
"naam"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/proposities/1Registratie ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/registraties?access_token={ACCESS_TOKEN}]&publiek={PUBLIEK}&gearchiveerd={GEARCHIVEERD}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/registraties?access_token=3b57bd2db21c46d2875508b982968d26]&publiek=1&gearchiveerd=0
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26- PUBLIEK
boolean(optioneel) Voorbeeld: 1- GEARCHIVEERD
boolean(optioneel) Voorbeeld: 0
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/registraties"
}
},
"_embedded": {
"registraties": [
{
"omschrijving": "<p>Telefonisch contact opgenomen met de klant, hij komt binnenkort langs voor een orienterend gesprek</p>\n",
"onderwerp": "Contact met klant",
"publiek": true,
"factureerbaar": null,
"boekdatum": "2015-12-30T09:45:00+0100",
"gearchiveerd": false,
"verbruik": 0,
"id": 275814,
"registratietype": "Telefoongesprek",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/registraties/275814"
}
},
"_embedded": {
"persoon": [
{
"id": 120955,
"geslacht": "vrouw",
"initialen": "K.",
"titel": "",
"voornaam": "Kim",
"tussenvoegsel": "",
"achternaam": "Jansen - de Jong",
"bsn": "",
"nationaliteitId": 1,
"burgerlijkestaatId": null,
"weergavenaam": "Medior, Voornaam (I.)",
"geboortedatum": null,
"pensioendatum": null
}
]
}
},
{
"omschrijving": "<p>Klant nogmaals benaderd, was nog niet langs geweest</p>\n",
"onderwerp": "Telefoongesprek Paul",
"publiek": true,
"factureerbaar": true,
"boekdatum": "2016-01-15T09:45:00+0100",
"gearchiveerd": false,
"verbruik": 10,
"id": 275815,
"registratietype": "Telefoongesprek",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/registraties/275815"
}
},
"_embedded": {
"persoon": [
{
"id": 120955,
"geslacht": "vrouw",
"initialen": "K.",
"titel": "",
"voornaam": "Kim",
"tussenvoegsel": "",
"achternaam": "Jansen - de Jong",
"bsn": "",
"nationaliteitId": 1,
"burgerlijkestaatId": null,
"weergavenaam": "Jansen - de Jong, Kim (K.)",
"geboortedatum": null,
"pensioendatum": null
}
]
}
}
]
}
}Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/registraties"
}
},
"_embedded": {
"registraties": [
{
"omschrijving": "Er is een email aangemaakt (en verzonden)",
"onderwerp": "Activeer uw Faster Forward mijnDigimap",
"publiek": false,
"factureerbaar": null,
"boekdatum": "2016-08-05T17:27:11+0200",
"gearchiveerd": false,
"verbruik": null,
"id": 275822,
"registratietype": "E-mail/Brief",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/registraties/275822"
},
"email": {
"href": "/api/data/klantdossiers/5526/emails/9"
},
"product": {
"href": "/api/data/klantdossiers/5526/diensten/6734"
}
}
}
]
}
}Registratie toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/registraties?access_token={ACCESS_TOKEN}]
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/registraties?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"omschrijving": "Dit is de omschrijving",
"onderwerp": "Dit is het onderwerp",
"registratiedatum": "2017-01-01 10:00:00",
"boekdatum": "2017-01-01 10:00:00",
"activiteit": {
"id": 1
},
"registratietype": {
"id": 7
},
"systeemregistratie": false,
"persoon": {
"id": 112794
}
}Schema
{
"title": "Registratie",
"type": "object",
"properties": {
"omschrijving": {
"type": "string",
"minLength": 1
},
"onderwerp": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"registratiedatum": {
"type": "string",
"format": "datatype-datetime"
},
"boekdatum": {
"type": "string",
"format": "datatype-datetime"
},
"activiteit": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"registratietype": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"systeemregistratie": {
"type": "boolean"
},
"persoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"required": [
"omschrijving",
"activiteit",
"registratietype",
"systeemregistratie"
],
"additionalProperties": false,
"oneOf": [
{
"properties": {
"systeemregistratie": {
"enum": [
true
]
}
}
},
{
"properties": {
"systeemregistratie": {
"enum": [
false
]
}
},
"required": [
"persoon"
]
}
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/registraties/275826Standaard correspondentieadres wijzigenPATCH/api/data/klantdossiers/{DOSSIER_ID}?access_token={ACCESS_TOKEN}]
Voorbeeld URI
PATCH https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"standaardCorrespondentieadres": {
"id": 1
}
}Schema
{
"properties": {
"standaardCorrespondentieadres": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"standaardCorrespondentieadres"
]
}Response
200VerbergBekijk
Headers
Content-Type: text/htmlKlant - particulier ¶
Klant collectieGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier"
}
},
"_embedded": {
"particulier": [
{
"id": 120954,
"geslacht": "man",
"initialen": "A.",
"titel": "",
"voornaam": "Aad",
"tussenvoegsel": "",
"achternaam": "Jansen",
"bsn": "559795178",
"nationaliteitId": 1,
"nationaliteit": "Nederlandse",
"burgerlijkestaatId": 1,
"burgerlijkestaat": "Gehuwd (gemeenschap van goederen)",
"weergavenaam": "Jansen, Aad (A.)",
"geboortedatum": "1960-01-01T00:00:00+01:00",
"pensioendatum": "2027-01-01T00:00:00+01:00",
"overleden": "nee",
"datumOverlijden": null,
"dossierrol": "Eerste persoon",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954"
}
}
},
{
"id": 120955,
"geslacht": "vrouw",
"initialen": "K.",
"titel": "",
"voornaam": "Kim",
"tussenvoegsel": "",
"achternaam": "Jansen - de Jong",
"bsn": "004864645",
"nationaliteitId": 1,
"nationaliteit": "Nederlandse",
"burgerlijkestaatId": 1,
"burgerlijkestaat": "Gehuwd (gemeenschap van goederen)",
"weergavenaam": "Jansen - de Jong, Kim (K.)",
"geboortedatum": "1965-04-21T00:00:00+01:00",
"pensioendatum": "2032-04-21T00:00:00+02:00",
"overleden": "nee",
"datumOverlijden": null,
"dossierrol": "Partner",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120955"
}
}
}
]
}
}Klant ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 120954,
"geslacht": "man",
"initialen": "A.",
"titel": "",
"voornaam": "Aad",
"tussenvoegsel": "",
"achternaam": "Jansen",
"bsn": "559795178",
"nationaliteitId": 1,
"nationaliteit": "Nederlandse",
"burgerlijkestaatId": 1,
"burgerlijkestaat": "Gehuwd (gemeenschap van goederen)",
"weergavenaam": "Jansen, Aad (A.)",
"geboortedatum": "1960-01-01T00:00:00+01:00",
"pensioendatum": "2027-01-01T00:00:00+01:00",
"overleden": "nee",
"datumOverlijden": null,
"dossierrol": "Eerste persoon",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954"
},
"profielfoto": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/profielfoto"
},
"adressen": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/adressen"
},
"emailadressen": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/emailadressen"
},
"rekeningnummers": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/rekeningnummers"
},
"telefoonnummers": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/telefoonnummers"
}
}
}Klant toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier?access_token={ACCESS_TOKEN}&rol={ROL_NAAM}
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier?access_token=3b57bd2db21c46d2875508b982968d26&rol=eerste-persoon
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26- ROL_NAAM
string(verplicht) Voorbeeld: eerste-persoonKeuzen:
eerste-persoonpartnerkind
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"geslacht": "Man",
"initialen": "J.",
"titel": "dhr",
"voornaam": "Jan",
"tussenvoegsel": "de",
"achternaam": "Nijs",
"bsn": "695803888",
"geboortedatum": "1980-01-25T00:00:00+01:00"
}Schema
{
"definitions": {
"persoon": {
"type": "object",
"properties": {
"achternaam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"tussenvoegsel": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"voornaam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"volledigeVoornamen": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"initialen": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"titel": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"geboortedatum": {
"type": "string",
"format": "datatype-date"
},
"geboorteplaats": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"geslacht": {
"enum": [
"Man",
"Vrouw"
]
},
"bsn": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"burgerlijkestaat": {
"enum": [
"Gehuwd (gemeenschap van goederen)",
"Gehuwd met huwelijkse voorwaarden",
"Alleenstaand",
"Samenwonend met samenlevingscontract",
"Samenwonend zonder samenlevingscontract",
"Partnerregistratie in gemeenschap van goederen",
"Partnerregistratie onder registratievoorwaarden",
"Gehuwd volgens buitenlands recht",
"Gehuwd in beperkte gemeenschap van goederen",
"Partnerregistratie in beperkte gemeenschap van goederen"
]
},
"nationaliteit": {
"enum": [
"Afgaanse",
"Albanese",
"Algerijnse",
"Amerikaans Burger",
"Amerikaans Onderdaan",
"Andorrese",
"Angolese",
"Argentijnse",
"Australische",
"Bahamaanse",
"Bahreinse",
"Barbadaanse",
"Behandeld als Nederlander",
"Belgische",
"Beliziaanse",
"Beninse",
"Bhutaanse",
"Boliviaanse",
"Botswaanse",
"Braziliaanse",
"British National (Overseas)",
"Brits Burger",
"Brits Onderdaan",
"Brits Overzees Burger",
"Bruneise",
"Bulgaarse",
"Burger Sovjetunie",
"Burger van Antigua en Barbuda",
"Burger van Armenie",
"Burger van Azerbajdsjan",
"Burger van Bangladesh",
"Burger van Belarus (Wit-Rusland)",
"Burger van Bosnië-Herzegovina",
"Burger van Britse Afhankelijke Gebieden",
"Burger van Burkina Faso",
"Burger van De Bondsrepubliek Duitsland",
"Burger van De Marshalleilanden",
"Burger van de Ver. Arabische Emiraten",
"Burger van Dominica",
"Burger van Dominicaanse Republiek",
"Burger van Georgië",
"Burger van India",
"Burger van Kazachstan",
"Burger van Kosovo",
"Burger van Kroatië",
"Burger van Kyrgyzstan",
"Burger van Mauritanië",
"Burger van Mauritius",
"Burger van Moldavië",
"Burger van Montenegro",
"Burger van Niger",
"Burger van Nigeria",
"Burger van Oekraine",
"Burger van Oezbekistan",
"Burger van Papua-Nieuwguinea",
"Burger van Rusland",
"Burger van São Tomé en Principe",
"Burger van Saint Kitts-Nevis",
"Burger van Servië",
"Burger van Servië en Montenegro",
"Burger van Sint Vincent en de Grenadinen",
"Burger van Slovenië",
"Burger van Tadzjikistan",
"Burger van Timor Leste",
"Burger van Toerkmenistan",
"Burger van Trinidad en Tobago",
"Burger van Ver. Arabische Emiraten",
"Burmaanse",
"Burundische",
"Canadese",
"Centrafrikaanse",
"Chileense",
"Chinese",
"Colombiaanse",
"Comorese",
"Costaricaanse",
"Cubaanse",
"Cyprische",
"Deense",
"Djiboutiaanse",
"Ecuadoraanse",
"Egyptische",
"Engelse",
"Equatoriaalguinese",
"Eritrese",
"Estnische",
"Etiopische",
"Fijische",
"Filipijnse",
"Finse",
"Franse",
"Gabonese",
"Gambiaanse",
"Ghanese",
"Grenadaanse",
"Griekse",
"Guatamalteekse",
"Guineebissause",
"Guinese",
"Guyaanse",
"Haïtiaanse",
"Hondurese",
"Hongaarse",
"Ierse",
"IJslandse",
"Indonesische",
"Iraakse",
"Iraanse",
"Israëlische",
"Italiaanse",
"Ivoriaanse",
"Jamaicaanse",
"Japanse",
"Jemenitische",
"Joegoslavische",
"Jordaanse",
"Kaapverdische",
"Kambodjaanse",
"Kameroense",
"Katarese",
"Kenyaanse",
"Kiribatische",
"Koeweitse",
"Kongolese",
"Laotiaanse",
"Lesothaanse",
"Letse",
"Libanese",
"Liberiaanse",
"Libische",
"Liechtensteinse",
"Litouwse",
"Luxemburgse",
"Macedonische",
"Malagassische",
"Malawische",
"Maldivische",
"Maleisische",
"Malinese",
"Maltese",
"Marokkaanse",
"Mexicaanse",
"Monegaskische",
"Mongolische",
"Mozambiquaanse",
"Myanmarese",
"Namibische",
"Nauruaanse",
"Nederlandse",
"Nepalese",
"Nicaraguaanse",
"Nieuwzeelandse",
"Noordjemenitische",
"Noordkoreaanse",
"Noorse",
"Omanitische",
"Onbekend",
"Oostduitse",
"Oostenrijkse",
"Pakistaanse",
"Panamese",
"Paraguayaanse",
"Peruaanse",
"Poolse",
"Portugese",
"Roemeense",
"Rwandese",
"Salvadoraanse",
"Sanmarinese",
"Saoediarabische",
"Senegalese",
"Seychelse",
"Sierraleoonse",
"Singaporaanse",
"Sintluciaanse",
"Slowaakse",
"Soedanese",
"Solomoneilandse",
"Somalische",
"Spaanse",
"Srilankaanse",
"Staatloos",
"Surinaamse",
"Swazische",
"Syrische",
"Taiwanese",
"Tanzaniaanse",
"Thaise",
"Togolese",
"Tongaanse",
"Tsjadische",
"Tsjechische",
"Tsjechoslowaakse",
"Tunesische",
"Turkse",
"Tuvaluaanse",
"Ugandese",
"Uruguayaanse",
"Vanuatuse",
"Vastgesteld niet-Nederlander",
"Vaticaanse",
"Venezolaanse",
"Vietnamese",
"Westsamoaanse",
"Zaïrese",
"Zaïrese (Congolese)",
"Zambiaanse",
"Zimbabwaanse",
"Zuidafrikaanse",
"Zuidjemenitische",
"Zuidkoreaanse",
"Zweedse",
"Zwitserse"
]
},
"overleden": {
"type": "boolean"
},
"datumOverleden": {
"type": "string",
"format": "datatype-date"
}
},
"additionalProperties": false,
"required": [
"achternaam"
]
}
}
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/particulier/120961Response
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"total": 1,
"message": "Validatie fouten",
"_links": {
"help": {
"href": "http://api.fasterforward.nl/",
"title": "Validatie informatie"
}
},
"_embedded": {
"errors": [
{
"path": "",
"message": "Required properties missing: [\"achternaam\"]"
}
]
}
}Klant wijzigenPATCH/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}?access_token={ACCESS_TOKEN}
Voorbeeld URI
PATCH https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120967?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120967- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"standaardCorrespondentieadres": {
"id": 7793
}
}Response
200VerbergBekijk
Headers
Content-Type: application/jsonResponse
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"total": 1,
"message": "Validatie fouten",
"_links": {
"help": {
"href": "http://api.fasterforward.nl/",
"title": "Validatie informatie"
}
},
"_embedded": {
"errors": [
{
"path": "",
"message": "Required properties missing: [\"standaardCorrespondentieadres\"]"
}
]
}
}Adres collectieGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/adressen?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/adressen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/adressen"
}
},
"_embedded": {
"adressen": [
{
"id": 7790,
"straat": "Nieuwemarkt",
"nummer": "2",
"toevoeging": "",
"postcode": "3011HP",
"plaatsnaam": "Rotterdam",
"postcodegebied": "3011",
"longitude": null,
"latitude": null,
"categorie": "default",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/adressen/7790"
}
},
"_embedded": {
"types": [
{
"id": 7,
"naam": "correspondentieadres"
}
]
}
}
]
}
}Adres ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/adressen/{ADRES_ID}?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/adressen/7790?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954- ADRES_ID
int(verplicht) Voorbeeld: 7790- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 7790,
"straat": "Nieuwemarkt",
"nummer": "2",
"toevoeging": "",
"postcode": "3011HP",
"plaatsnaam": "Rotterdam",
"postcodegebied": "3011",
"longitude": null,
"latitude": null,
"categorie": "default",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/adressen/7790"
}
},
"_embedded": {
"types": [
{
"id": 7,
"naam": "correspondentieadres"
}
]
}
}Adres toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/adressen?access_token={ACCESS_TOKEN}
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120955/adressen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120955- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Niet-bestaand adres
{
"postcode" : "4651ME",
"nummer" : "3",
"toevoeging" : "B",
"straat" : "Grimbergen",
"plaatsnaam" : "Steenbergen",
"gemeente" : "Steenbergen",
"provincie" : "Noord-Brabant",
"land" : "NL",
"categorie" : "Standaard",
"type" : "Correspondentieadres"
}
Bestaand adres
{
"id" : 7797,
"type" : "Factuuradres"
}Schema
{
"properties": {
"postcode": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"nummer": {
"type": "string",
"minLength": 1,
"maxLength": 25
},
"toevoeging": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"straat": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"plaatsnaam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"gemeente": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"provincie": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"land": {
"enum": [
"AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX",
"AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR",
"BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM",
"CN","CO","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ",
"EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD",
"GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY",
"HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT",
"JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA",
"LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG",
"MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY",
"MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE",
"PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS",
"RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO",
"SR","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN",
"TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG",
"VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"
]
},
"categorie": {
"enum": [
"Standaard",
"Postbus",
"Antwoordnummer"
]
},
"type": {
"enum": [
"Afleveradres",
"Algemeen",
"Bezoekadres",
"Correspondentieadres",
"Factuuradres",
"Pand",
"Priveadres"
]
}
},
"additionalProperties": false,
"required": [
"plaatsnaam",
"type"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/particulier/120955/adressen/7797Emailadres collectieGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/emailadressen?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/emailadressen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/emailadressen"
}
},
"_embedded": {
"emailadressen": [
{
"id": 40555,
"naam": "aad-jansen@mailprovider.nl",
"omschrijving": null,
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/emailadressen/40555"
}
},
"_embedded": {
"types": [
{
"id": 2,
"naam": "Prive"
}
]
}
}
]
}
}Emailadres ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/emailadressen/{EMAILADRES_ID}?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/emailadressen/40555?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954- EMAILADRES_ID
int(verplicht) Voorbeeld: 40555- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 40555,
"naam": "aad-jansen@mailprovider.nl",
"omschrijving": null,
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/emailadressen/40555"
}
},
"_embedded": {
"types": [
{
"id": 2,
"naam": "Prive"
}
]
}
}Emailadres toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/emailadressen?access_token={ACCESS_TOKEN}
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/emailadressen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Niet-bestaand emailadres
{
"naam": "particulier@home.nl",
"type" : "Algemeen"
}
Bestaand emailadres
{
"id": 40559,
"type" : "Algemeen"
}Schema
{
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
},
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"type": {
"enum": [
"Zakelijk",
"Prive",
"Algemeen"
]
}
},
"additionalProperties": false,
"required": [
"type"
],
"oneOf": [
{
"required" : ["id"]
}, {
"required" : ["naam"]
}
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/particulier/120954/emailadressen/7797Kenmerk collectieGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/kenmerken?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/kenmerken?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/kenmerken"
}
},
"_embedded": {
"kenmerken": [
{
"id": 4,
"naam": "Kenmerk 1",
"vraag": "",
"omschrijving": "",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/kenmerken/4"
}
}
}
]
}
}Kenmerk ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/kenmerken/{KENMERK_ID}?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/kenmerken/4?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954- KENMERK_ID
int(verplicht) Voorbeeld: 4- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 4,
"naam": "Kenmerk 1",
"vraag": "",
"omschrijving": "",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/kenmerken/4"
}
}
}Kenmerk toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/kenmerken?access_token={ACCESS_TOKEN}
Zowel kenmerk als omschrijving zijn optioneel.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/kenmerken?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26- PERSOON_ID
int(verplicht) Voorbeeld: 120954
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"vraag": {
"id": 3
},
"kenmerk": {
"id": 3
},
"omschrijving": "kenmerk omschrijving"
}Schema
{
"title": "PersoonKenmerk",
"type": "object",
"properties": {
"kenmerk": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"vraag": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"omschrijving": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false,
"required": [
"kenmerk"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/particulier/120954/kenmerken/3Response
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"total": 1,
"message": "Validatie fouten",
"_links": {
"help": {
"href": "http://api.fasterforward.nl/",
"title": "Validatie informatie"
}
},
"_embedded": {
"errors": [
{
"path": "",
"message": "Required properties missing: [\"kenmerk\"]"
}
]
}
}Profielfoto meta data ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/profielfoto?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/profielfoto?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26- PERSOON_ID
int(verplicht) Voorbeeld: 120954
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 14,
"naam": "profielfoto.png",
"extensie": "png",
"bestandsgrootte": 98429,
"mimetype": "image/png",
"omschrijving": "",
"aanmaakdatum": "2017-09-07T10:13:47+02:00",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/profielfoto"
},
"download": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/profielfoto/download"
}
}
}Response
404VerbergBekijk
Headers
Content-Type: application/jsonProfielfoto binary downloadenGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/profielfoto/download?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/profielfoto/download?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26- PERSOON_ID
int(verplicht) Voorbeeld: 120954
Response
200VerbergBekijk
Headers
Content-Type: image/pngBody
<binary data>Response
404VerbergBekijk
Headers
Content-Type: application/jsonRekeningnummer collectieGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/rekeningnummers?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/rekeningnummers?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/rekeningnummers"
}
},
"_embedded": {
"rekeningnummers": [
{
"id": 1959,
"nummer": "662456",
"iban": "NL58INGB0000662456",
"bic": "INGBNL2A",
"land_iso": "NL",
"naam": "Jansen, Aad (A.)",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/rekeningnummers/1959"
}
}
}
]
}
}Rekeningnummer ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/rekeningnummers/{REKENINGNUMMER_ID}?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/rekeningnummers/1959?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954- REKENINGNUMMER_ID
int(verplicht) Voorbeeld: 1959- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 1959,
"nummer": "662456",
"iban": "NL58INGB0000662456",
"bic": "INGBNL2A",
"land_iso": "NL",
"naam": "Jansen, Aad (A.)",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/rekeningnummers/1959"
}
}
}Rekeningnummer toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/rekeningnummers?access_token={ACCESS_TOKEN}
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/rekeningnummers?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Niet-bestaand rekeningnummer
{
"iban" : "NL25RABO0136907539",
"bic" : "RABONL2U",
"land" : "NL",
"type" : "Incasso"
}
Bestaand rekeningnummer
{
"id" : 1964,
"type" : "Algemeen"
}Schema
{
"oneOf": [
{
"properties": {
"nummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"iban": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"bic": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"land": {
"enum": [
"AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX",
"AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR",
"BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM",
"CN","CO","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ",
"EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD",
"GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY",
"HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT",
"JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA",
"LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG",
"MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY",
"MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE",
"PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS",
"RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO",
"SR","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN",
"TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG",
"VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"
]
},
"type": {
"enum": [
"Algemeen",
"Incasso"
]
}
},
"additionalProperties": false,
"required": [
"land",
"type"
]
}, {
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
},
"type": {
"enum": [
"Algemeen",
"Incasso"
]
}
},
"additionalProperties": false,
"required": [
"id",
"type"
]
}
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/particulier/120954/rekeningnummers/1964Socialmedia collectieGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/socialmedia?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/socialmedia?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/socialmedia"
}
},
"_embedded": {
"socialmedia": [
{
"id": 1,
"type": "twitter",
"url": "http://www.twitter.com/#!/aad-jansen",
"publiek": "ja",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/socialmedia/1"
}
}
},
{
"id": 2,
"type": "facebook",
"url": "http://www.facebook.com/aad-jansen",
"publiek": "ja",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/socialmedia/2"
}
}
}
]
}
}Socialmedium ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/socialmedia/{SOCIALMEDIA_ID}?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/socialmedia/1?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954- SOCIALMEDIA_ID
int(verplicht) Voorbeeld: 1- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 1,
"type": "twitter",
"url": "http://www.twitter.com/#!/aad-jansen",
"publiek": "ja",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/socialmedia/1"
}
}
}Telefoonnummer collectieGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/telefoonnummers?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/telefoonnummers?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/telefoonnummers"
}
},
"_embedded": {
"telefoonnummers": [
{
"id": 76402,
"naam": "06123456789",
"omschrijving": " ",
"weergavenaam": "06123456789",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/telefoonnummers/76402"
}
},
"_embedded": {
"types": [
{
"id": 1,
"naam": "algemeen"
}
]
}
}
]
}
}Telefoonnummer ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/telefoonnummers/{TELEFOONNUMMER_ID}?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/telefoonnummers/76403?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954- TELEFOONNUMMER_ID
int(verplicht) Voorbeeld: 76403- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 76402,
"naam": "06123456789",
"omschrijving": " ",
"weergavenaam": "06123456789",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/telefoonnummers/76402"
}
},
"_embedded": {
"types": [
{
"id": 1,
"naam": "algemeen"
}
]
}
}Telefoonnummer toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/telefoonnummers?access_token={ACCESS_TOKEN}
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/telefoonnummers?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Niet-bestaand telefoonnummer
{
"naam": "0610485677",
"type": "Algemeen"
}
Bestaand telefoonnummer
{
"id": 76411,
"type": "Algemeen"
}Schema
{
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
},
"naam": {
"type": "string",
"pattern": "^[0-9 ()+-]{1,255}$"
},
"type": {
"enum": [
"Algemeen",
"Storingsnummer",
"Fax",
"Mobiel",
"Zakelijk",
"Skype"
]
}
},
"additionalProperties": false,
"required": [
"type"
],
"oneOf": [
{
"required" : ["id"]
}, {
"required" : ["naam"]
}
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/particulier/120954/telefoonnummers/76411Klant - zakelijk ¶
Klant collectieGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk"
}
},
"_embedded": {
"zakelijk": [
{
"id": 14835,
"type": "BV",
"naam": "AEGON",
"kvknummer": "",
"btwnummer": "",
"statutairenaam": "AEGON",
"handelsnaam": "AEGON",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835"
}
}
}
]
}
}Klant ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{KLANT_ID}?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- KLANT_ID
int(verplicht) Voorbeeld: 14835- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 14835,
"type": "BV",
"naam": "AEGON",
"kvknummer": "",
"btwnummer": "",
"statutairenaam": "AEGON",
"handelsnaam": "AEGON",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835"
},
"adressen": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/adressen"
},
"emailadressen": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/emailadressen"
},
"telefoonnummers": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/telefoonnummers"
},
"profielfoto": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/profielfoto"
},
"rekeningnummers": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/rekeningnummers"
},
"kenmerken": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/kenmerken"
}
}
}Klant toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk?access_token={ACCESS_TOKEN}]
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"naam": "Faster Forward",
"statutairenaam": "Faster Forward",
"handelsnaam": "Faster Forward",
"kvknummer": "12345",
"btwnummer": "67890",
"type": "BV"
}Schema
{
"title": "Organisatie",
"type": "object",
"properties": {
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"statutairenaam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"handelsnaam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"kvknummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"btwnummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"type": {
"enum": [
"BV",
"commanditaire vennootschap",
"Cooperatieve vereniging",
"Eenmanszaak",
"Franchise",
"Inkooporganisatie",
"Loondienst",
"Maatschap",
"NV",
"Onbekend",
"Overig",
"Particulier",
"Rekening Courant",
"Stichting",
"Vereniging",
"VOF"
]
}
},
"additionalProperties": false,
"required": [
"naam"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/zakelijk/16941Adres collectieGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/adressen?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/adressen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/adressen"
}
},
"_embedded": {
"adressen": [
{
"id": 9,
"straat": "Straatnaam",
"nummer": "1",
"toevoeging": "",
"postcode": "1234AB",
"plaatsnaam": "Plaatsnaam",
"postcodegebied": "1234",
"longitude": "52.02824000",
"latitude": "5.06721000",
"categorie": "default",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/adressen/9"
}
},
"_embedded": {
"types": [
{
"id": 1,
"naam": "bezoekadres"
}
]
}
}
]
}
}Adres ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/adressen/{ADRES_ID}?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/adressen/9?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835- ADRES_ID
int(verplicht) Voorbeeld: 9- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 9,
"straat": "Straatnaam",
"nummer": "1",
"toevoeging": "",
"postcode": "1234AB",
"plaatsnaam": "Plaatsnaam",
"postcodegebied": "1234",
"longitude": "52.02824000",
"latitude": "5.06721000",
"categorie": "default",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/adressen/9"
}
},
"_embedded": {
"types": [
{
"id": 1,
"naam": "bezoekadres"
}
]
}
}Adres toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/adressen?access_token={ACCESS_TOKEN}]
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14917/adressen?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14917- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"postcode": "4651ME",
"nummer": "3",
"toevoeging": "B",
"straat": "Grimbergen",
"plaatsnaam": "Steenbergen",
"gemeente": "Steenbergen",
"provincie": "Noord-Brabant",
"land": "NL",
"categorie": "Standaard",
"type": "Correspondentieadres"
}Schema
{
"properties": {
"postcode": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"nummer": {
"type": "string",
"minLength": 1,
"maxLength": 25
},
"toevoeging": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"straat": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"plaatsnaam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"gemeente": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"provincie": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"land": {
"enum": [
"AD",
"AE",
"AF",
"AG",
"AI",
"AL",
"AM",
"AN",
"AO",
"AQ",
"AR",
"AS",
"AT",
"AU",
"AW",
"AX",
"AZ",
"BA",
"BB",
"BD",
"BE",
"BF",
"BG",
"BH",
"BI",
"BJ",
"BL",
"BM",
"BN",
"BO",
"BQ",
"BR",
"BS",
"BT",
"BV",
"BW",
"BY",
"BZ",
"CA",
"CC",
"CD",
"CF",
"CG",
"CH",
"CI",
"CK",
"CL",
"CM",
"CN",
"CO",
"CR",
"CS",
"CU",
"CV",
"CW",
"CX",
"CY",
"CZ",
"DE",
"DJ",
"DK",
"DM",
"DO",
"DZ",
"EC",
"EE",
"EG",
"EH",
"ER",
"ES",
"ET",
"FI",
"FJ",
"FK",
"FM",
"FO",
"FR",
"GA",
"GB",
"GD",
"GE",
"GF",
"GG",
"GH",
"GI",
"GL",
"GM",
"GN",
"GP",
"GQ",
"GR",
"GS",
"GT",
"GU",
"GW",
"GY",
"HK",
"HM",
"HN",
"HR",
"HT",
"HU",
"ID",
"IE",
"IL",
"IM",
"IN",
"IO",
"IQ",
"IR",
"IS",
"IT",
"JE",
"JM",
"JO",
"JP",
"KE",
"KG",
"KH",
"KI",
"KM",
"KN",
"KP",
"KR",
"KW",
"KY",
"KZ",
"LA",
"LB",
"LC",
"LI",
"LK",
"LR",
"LS",
"LT",
"LU",
"LV",
"LY",
"MA",
"MC",
"MD",
"ME",
"MF",
"MG",
"MH",
"MK",
"ML",
"MM",
"MN",
"MO",
"MP",
"MQ",
"MR",
"MS",
"MT",
"MU",
"MV",
"MW",
"MX",
"MY",
"MZ",
"NA",
"NC",
"NE",
"NF",
"NG",
"NI",
"NL",
"NO",
"NP",
"NR",
"NU",
"NZ",
"OM",
"PA",
"PE",
"PF",
"PG",
"PH",
"PK",
"PL",
"PM",
"PN",
"PR",
"PS",
"PT",
"PW",
"PY",
"QA",
"RE",
"RO",
"RS",
"RU",
"RW",
"SA",
"SB",
"SC",
"SD",
"SE",
"SG",
"SH",
"SI",
"SJ",
"SK",
"SL",
"SM",
"SN",
"SO",
"SR",
"ST",
"SV",
"SX",
"SY",
"SZ",
"TC",
"TD",
"TF",
"TG",
"TH",
"TJ",
"TK",
"TL",
"TM",
"TN",
"TO",
"TR",
"TT",
"TV",
"TW",
"TZ",
"UA",
"UG",
"UM",
"US",
"UY",
"UZ",
"VA",
"VC",
"VE",
"VG",
"VI",
"VN",
"VU",
"WF",
"WS",
"YE",
"YT",
"ZA",
"ZM",
"ZW"
]
},
"categorie": {
"enum": [
"Standaard",
"Postbus",
"Antwoordnummer"
]
},
"type": {
"enum": [
"Afleveradres",
"Algemeen",
"Bezoekadres",
"Correspondentieadres",
"Factuuradres",
"Pand",
"Priveadres"
]
}
},
"additionalProperties": false,
"required": [
"plaatsnaam",
"type"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/zakelijk/14917/adressen/7796Emailadres collectieGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/emailadressen?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/emailadressen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/emailadressen"
}
},
"_embedded": {
"emailadressen": [
{
"id": 35969,
"naam": "email00035969@dummy.nl",
"omschrijving": null,
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/emailadressen/35969"
}
},
"_embedded": {
"types": [
{
"id": 1,
"naam": "Zakelijk"
}
]
}
}
]
}
}Emailadres ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/emailadressen/{EMAILADRES_ID}?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/emailadressen/35969?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835- EMAILADRES_ID
int(verplicht) Voorbeeld: 35969- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 35969,
"naam": "email00035969@dummy.nl",
"omschrijving": null,
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/emailadressen/35969"
}
},
"_embedded": {
"types": [
{
"id": 1,
"naam": "Zakelijk"
}
]
}
}Emailadres toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/emailadressen?access_token={ACCESS_TOKEN}]
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/16941/emailadressen?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 16941- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Niet-bestaand emailadres
{
"naam": "emailadres@zakelijk.nl",
"type": "Zakelijk"
}
Bestaand emailadres
{
"id": 40558,
"type" : "Algemeen"
}Schema
{
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
},
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"type": {
"enum": [
"Zakelijk",
"Prive",
"Algemeen"
]
}
},
"additionalProperties": false,
"required": [
"type"
],
"oneOf": [
{
"required" : ["id"]
}, {
"required" : ["naam"]
}
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/zakelijk/16941/emailadressen/40558Kenmerk collectieGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/kenmerken?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/kenmerken?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/kenmerken"
}
},
"_embedded": {
"kenmerken": [
{
"id": 5,
"naam": "Kenmerk 3",
"vraag": "",
"omschrijving": "Kenmerk 3",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/kenmerken/5"
}
}
}
]
}
}Kenmerk ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/kenmerken/{ORGANISATIEKENMERK_ID}?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/kenmerken/5?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835- ORGANISATIEKENMERK_ID
int(verplicht) Voorbeeld: 5- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 5,
"naam": "Kenmerk 3",
"vraag": "",
"omschrijving": "Kenmerk 3",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/kenmerken/5"
}
}
}Medewerker toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/medewerkers?access_token={ACCESS_TOKEN}
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14917/medewerkers?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14917- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"achternaam": "Groen",
"tussenvoegsel": "de",
"voornaam": "Piet",
"volledigeVoornamen": "Piet Cornelis",
"initialen": "P.C.",
"titel": "Dhr.",
"geboortedatum": "1980-05-20",
"geboorteplaats": "Welberg",
"geslacht": "Man",
"bsn": "779382377",
"burgerlijkestaat": "Alleenstaand",
"nationaliteit": "Nederlandse",
"overleden": false,
"functie": [
{
"id": 1
}
]
}Schema
{
"oneOf": [
{
"properties": {
"achternaam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"tussenvoegsel": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"voornaam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"volledigeVoornamen": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"initialen": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"titel": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"geboortedatum": {
"type": "string",
"format": "datatype-date"
},
"geboorteplaats": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"geslacht": {
"enum": [
"Man",
"Vrouw"
]
},
"bsn": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"burgerlijkestaat": {
"enum": [
"Gehuwd (gemeenschap van goederen)",
"Gehuwd met huwelijkse voorwaarden",
"Alleenstaand",
"Samenwonend met samenlevingscontract",
"Samenwonend zonder samenlevingscontract",
"Partnerregistratie in gemeenschap van goederen",
"Partnerregistratie onder registratievoorwaarden",
"Gehuwd volgens buitenlands recht"
]
},
"nationaliteit": {
"enum": [
"Afgaanse",
"Albanese",
"Algerijnse",
"Amerikaans Burger",
"Amerikaans Onderdaan",
"Andorrese",
"Angolese",
"Argentijnse",
"Australische",
"Bahamaanse",
"Bahreinse",
"Barbadaanse",
"Behandeld als Nederlander",
"Belgische",
"Beliziaanse",
"Beninse",
"Bhutaanse",
"Boliviaanse",
"Botswaanse",
"Braziliaanse",
"British National (Overseas)",
"Brits Burger",
"Brits Onderdaan",
"Brits Overzees Burger",
"Bruneise",
"Bulgaarse",
"Burger Sovjetunie",
"Burger van Antigua en Barbuda",
"Burger van Armenie",
"Burger van Azerbajdsjan",
"Burger van Bangladesh",
"Burger van Belarus (Wit-Rusland)",
"Burger van Bosnië-Herzegovina",
"Burger van Britse Afhankelijke Gebieden",
"Burger van Burkina Faso",
"Burger van De Bondsrepubliek Duitsland",
"Burger van De Marshalleilanden",
"Burger van de Ver. Arabische Emiraten",
"Burger van Dominica",
"Burger van Dominicaanse Republiek",
"Burger van Georgië",
"Burger van India",
"Burger van Kazachstan",
"Burger van Kosovo",
"Burger van Kroatië",
"Burger van Kyrgyzstan",
"Burger van Mauritanië",
"Burger van Mauritius",
"Burger van Moldavië",
"Burger van Montenegro",
"Burger van Niger",
"Burger van Nigeria",
"Burger van Oekraine",
"Burger van Oezbekistan",
"Burger van Papua-Nieuwguinea",
"Burger van Rusland",
"Burger van São Tomé en Principe",
"Burger van Saint Kitts-Nevis",
"Burger van Servië",
"Burger van Servië en Montenegro",
"Burger van Sint Vincent en de Grenadinen",
"Burger van Slovenië",
"Burger van Tadzjikistan",
"Burger van Timor Leste",
"Burger van Toerkmenistan",
"Burger van Trinidad en Tobago",
"Burger van Ver. Arabische Emiraten",
"Burmaanse",
"Burundische",
"Canadese",
"Centrafrikaanse",
"Chileense",
"Chinese",
"Colombiaanse",
"Comorese",
"Costaricaanse",
"Cubaanse",
"Cyprische",
"Deense",
"Djiboutiaanse",
"Ecuadoraanse",
"Egyptische",
"Engelse",
"Equatoriaalguinese",
"Eritrese",
"Estnische",
"Etiopische",
"Fijische",
"Filipijnse",
"Finse",
"Franse",
"Gabonese",
"Gambiaanse",
"Ghanese",
"Grenadaanse",
"Griekse",
"Guatamalteekse",
"Guineebissause",
"Guinese",
"Guyaanse",
"Haïtiaanse",
"Hondurese",
"Hongaarse",
"Ierse",
"IJslandse",
"Indonesische",
"Iraakse",
"Iraanse",
"Israëlische",
"Italiaanse",
"Ivoriaanse",
"Jamaicaanse",
"Japanse",
"Jemenitische",
"Joegoslavische",
"Jordaanse",
"Kaapverdische",
"Kambodjaanse",
"Kameroense",
"Katarese",
"Kenyaanse",
"Kiribatische",
"Koeweitse",
"Kongolese",
"Laotiaanse",
"Lesothaanse",
"Letse",
"Libanese",
"Liberiaanse",
"Libische",
"Liechtensteinse",
"Litouwse",
"Luxemburgse",
"Macedonische",
"Malagassische",
"Malawische",
"Maldivische",
"Maleisische",
"Malinese",
"Maltese",
"Marokkaanse",
"Mexicaanse",
"Monegaskische",
"Mongolische",
"Mozambiquaanse",
"Myanmarese",
"Namibische",
"Nauruaanse",
"Nederlandse",
"Nepalese",
"Nicaraguaanse",
"Nieuwzeelandse",
"Noordjemenitische",
"Noordkoreaanse",
"Noorse",
"Omanitische",
"Onbekend",
"Oostduitse",
"Oostenrijkse",
"Pakistaanse",
"Panamese",
"Paraguayaanse",
"Peruaanse",
"Poolse",
"Portugese",
"Roemeense",
"Rwandese",
"Salvadoraanse",
"Sanmarinese",
"Saoediarabische",
"Senegalese",
"Seychelse",
"Sierraleoonse",
"Singaporaanse",
"Sintluciaanse",
"Slowaakse",
"Soedanese",
"Solomoneilandse",
"Somalische",
"Spaanse",
"Srilankaanse",
"Staatloos",
"Surinaamse",
"Swazische",
"Syrische",
"Taiwanese",
"Tanzaniaanse",
"Thaise",
"Togolese",
"Tongaanse",
"Tsjadische",
"Tsjechische",
"Tsjechoslowaakse",
"Tunesische",
"Turkse",
"Tuvaluaanse",
"Ugandese",
"Uruguayaanse",
"Vanuatuse",
"Vastgesteld niet-Nederlander",
"Vaticaanse",
"Venezolaanse",
"Vietnamese",
"Westsamoaanse",
"Zaïrese",
"Zaïrese (Congolese)",
"Zambiaanse",
"Zimbabwaanse",
"Zuidafrikaanse",
"Zuidjemenitische",
"Zuidkoreaanse",
"Zweedse",
"Zwitserse"
]
},
"overleden": {
"type": "boolean"
},
"datumOverleden": {
"type": "string",
"format": "datatype-date"
},
"functie": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
}
},
"additionalProperties": false,
"required": [
"achternaam",
"functie"
]
},
{
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
},
"functie": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
}
},
"additionalProperties": false,
"required": [
"id",
"functie"
]
}
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/zakelijk/14917/medewerkers/120960Medewerker emailadres toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/medewerkers/{PERSOON_ID}/emailadressen?access_token={ACCESS_TOKEN}
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/16941/medewerkers/112794/emailadressen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 16941- PERSOON_ID
int(verplicht) Voorbeeld: 112794- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Niet-bestaand emailadres
{
"naam": "emailadres@zakelijk.nl",
"type": "Zakelijk"
}
Bestaand emailadres
{
"id": 40560,
"type" : "Algemeen"
}Schema
{
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
},
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"type": {
"enum": [
"Zakelijk",
"Prive",
"Algemeen"
]
}
},
"additionalProperties": false,
"required": [
"type"
],
"oneOf": [
{
"required" : ["id"]
}, {
"required" : ["naam"]
}
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/zakelijk/16941/medewerkers/112794/emailadressen/40560Medewerker rekeningnummer toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/medewerkers/{PERSOON_ID}/rekeningnummers?access_token={ACCESS_TOKEN}
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/16941/medewerkers/112794/rekeningnummers?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 16941- PERSOON_ID
int(verplicht) Voorbeeld: 112794- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Niet-bestaand rekeningnummer
{
"iban" : "NL25RABO0136907539",
"bic" : "RABONL2U",
"land" : "NL",
"type" : "Incasso"
}
Bestaand rekeningnummer
{
"id" : 1962,
"type" : "Algemeen"
}Schema
{
"oneOf": [
{
"properties": {
"nummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"iban": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"bic": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"land": {
"enum": [
"AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX",
"AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR",
"BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM",
"CN","CO","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ",
"EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD",
"GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY",
"HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT",
"JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA",
"LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG",
"MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY",
"MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE",
"PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS",
"RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO",
"SR","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN",
"TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG",
"VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"
]
},
"type": {
"enum": [
"Algemeen",
"Incasso"
]
}
},
"additionalProperties": false,
"required": [
"land",
"type"
]
}, {
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
},
"type": {
"enum": [
"Algemeen",
"Incasso"
]
}
},
"additionalProperties": false,
"required": [
"id",
"type"
]
}
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/zakelijk/16941/medewerkers/112794/rekeningnummers/1962Medewerker telefoonnummer toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/medewerkers/{PERSOON_ID}/telefoonnummers?access_token={ACCESS_TOKEN}
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/16941/medewerkers/112794/telefoonnummers?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 16941- PERSOON_ID
int(verplicht) Voorbeeld: 112794- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Niet-bestaand telefoonnummer
{
"naam": "0610485677",
"type": "Algemeen"
}
Bestaand telefoonnummer
{
"id": 76411,
"type": "Mobiel"
}Schema
{
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
},
"naam": {
"type": "string",
"pattern": "^[0-9 ()+-]{1,255}$"
},
"type": {
"enum": [
"Algemeen",
"Storingsnummer",
"Fax",
"Mobiel",
"Zakelijk",
"Skype"
]
}
},
"additionalProperties": false,
"required": [
"type"
],
"oneOf": [
{
"required" : ["id"]
}, {
"required" : ["naam"]
}
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/zakelijk/16941/medewerkers/112794/telefoonnummers/76411Profielfoto meta data ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/profielfoto?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/profielfoto?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 14,
"naam": "profielfoto.png",
"extensie": "png",
"bestandsgrootte": 98429,
"mimetype": "image/png",
"omschrijving": "",
"aanmaakdatum": "2017-09-07T10:13:47+02:00",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/profielfoto"
},
"download": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/profielfoto/download"
}
}
}Response
404VerbergBekijk
Headers
Content-Type: application/jsonProfielfoto binary downloadenGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/profielfoto/download?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/profielfoto/download?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835
Response
200VerbergBekijk
Headers
Content-Type: image/pngBody
<binary data>Response
404VerbergBekijk
Headers
Content-Type: application/jsonRekeningnummer collectieGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/rekeningnummers?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/rekeningnummers?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/rekeningnummers"
}
},
"_embedded": {
"rekeningnummers": [
{
"id": 1962,
"nummer": "",
"iban": "NL02ABNA0123456789",
"bic": "",
"landIso": "NL",
"naam": "AEGON",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/rekeningnummers/1962"
}
}
}
]
}
}Rekeningnummer ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/rekeningnummers/{REKENINGNUMMER_ID}?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/rekeningnummers/1962?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835- REKENINGNUMMER_ID
int(verplicht) Voorbeeld: 1962- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 1962,
"nummer": "",
"iban": "NL02ABNA0123456789",
"bic": "",
"landIso": "NL",
"naam": "AEGON",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/rekeningnummers/1962"
}
}
}Rekeningnummer toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/rekeningnummers?access_token={ACCESS_TOKEN}]
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/16941/rekeningnummers?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 16941- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Niet-bestaand rekeningnummer
{
"iban" : "NL25RABO0136907539",
"bic" : "RABONL2U",
"land" : "NL",
"type" : "Incasso"
}
Bestaand rekeningnummer
{
"id" : 1963,
"type" : "Algemeen"
}Schema
{
"oneOf": [
{
"properties": {
"nummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"iban": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"bic": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"land": {
"enum": [
"AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX",
"AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR",
"BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM",
"CN","CO","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ",
"EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD",
"GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY",
"HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT",
"JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA",
"LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG",
"MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY",
"MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE",
"PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS",
"RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO",
"SR","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN",
"TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG",
"VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"
]
},
"type": {
"enum": [
"Algemeen",
"Incasso"
]
}
},
"additionalProperties": false,
"required": [
"land",
"type"
]
}, {
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
},
"type": {
"enum": [
"Algemeen",
"Incasso"
]
}
},
"additionalProperties": false,
"required": [
"id",
"type"
]
}
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/zakelijk/16941/rekeningnummers/1963Telefoonnummer collectieGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/telefoonnummers?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/telefoonnummers?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/telefoonnummers"
}
},
"_embedded": {
"telefoonnummers": [
{
"id": 69304,
"naam": "999363-933 07 60",
"omschrijving": null,
"weergavenaam": "9993639330760",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/telefoonnummers/69304"
}
},
"_embedded": {
"types": [
{
"id": 1,
"naam": "algemeen"
}
]
}
}
]
}
}Telefoonnummer ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/telefoonnummers/{TELEFOONNUMMER_ID}?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/telefoonnummers/69304?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835- TELEFOONNUMMER_ID
int(verplicht) Voorbeeld: 69304- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 69304,
"naam": "999363-933 07 60",
"omschrijving": null,
"weergavenaam": "9993639330760",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/telefoonnummers/69304"
}
},
"_embedded": {
"types": [
{
"id": 1,
"naam": "algemeen"
}
]
}
}Telefoonnummer toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/telefoonnummers?access_token={ACCESS_TOKEN}]
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/16941/telefoonnummers?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 16941- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Niet-bestaand telefoonnummer
{
"naam": "0610485677",
"type": "Algemeen"
}
Bestaand telefoonnummer
{
"id": 76411,
"type": "Mobiel"
}Schema
{
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
},
"naam": {
"type": "string",
"pattern": "^[0-9 ()+-]{1,255}$"
},
"type": {
"enum": [
"Algemeen",
"Storingsnummer",
"Fax",
"Mobiel",
"Zakelijk",
"Skype"
]
}
},
"additionalProperties": false,
"required": [
"type"
],
"oneOf": [
{
"required" : ["id"]
}, {
"required" : ["naam"]
}
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/zakelijk/16941/telefoonnummers/76411Code collectieGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/codes?access_token={ACCESS_TOKEN}{ACCESS_TOKEN}}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/16319/codes?access_token={ACCESS_TOKEN}3b57bd2db21c46d2875508b982968d26}
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 16319- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/16319/codes"
}
},
"_embedded": {
"codes": [
{
"id": 465,
"code": "123",
"omschrijving": "",
"afgiftedatum": "2018-06-26T00:00:00+02:00",
"type": "Vestigingsnummer"
}
]
}
}Adviseur ¶
Adviseur collectieGET/api/data/klantdossiers/{DOSSIER_ID}/adviseurs?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/adviseurs"
}
},
"_embedded": {
"adviseurs": [
{
"id": 112115,
"geslacht": "man",
"initialen": "I.",
"titel": "",
"voornaam": "Voornaam",
"tussenvoegsel": "",
"achternaam": "Achternaam00112115",
"bsn": "",
"nationaliteitId": 1,
"nationaliteit": "Nederlandse",
"burgerlijkestaatId": 2,
"burgerlijkestaat": "Gehuwd (gemeenschap van goederen)",
"weergavenaam": "Achternaam00112115, Voornaam (I.)",
"geboortedatum": "1976-03-02T00:00:00+01:00",
"pensioendatum": "2043-03-01T00:00:00+01:00",
"overleden": "nee",
"datumOverlijden": null,
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115"
}
}
}
]
}
}Adviseur ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/adviseurs/{ADVISEUR_ID}?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ADVISEUR_ID
int(verplicht) Voorbeeld: 112115- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 112115,
"geslacht": "man",
"initialen": "I.",
"titel": "",
"voornaam": "Voornaam",
"tussenvoegsel": "",
"achternaam": "Achternaam00112115",
"bsn": "",
"nationaliteitId": 1,
"nationaliteit": "Nederlandse",
"burgerlijkestaatId": 2,
"burgerlijkestaat": "Gehuwd (gemeenschap van goederen)",
"weergavenaam": "Achternaam00112115, Voornaam (I.)",
"geboortedatum": "1976-03-02T00:00:00+01:00",
"pensioendatum": "2043-03-01T00:00:00+01:00",
"overleden": "nee",
"datumOverlijden": null,
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115"
},
"profielfoto": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/profielfoto"
},
"adressen": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/adressen"
},
"emailadressen": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/emailadressen"
},
"rekeningnummers": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/rekeningnummers"
},
"telefoonnummers": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/telefoonnummers"
}
}
}Adres collectieGET/api/data/klantdossiers/{DOSSIER_ID}/adviseurs/{ADVISEUR_ID}/adressen?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/adressen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ADVISEUR_ID
int(verplicht) Voorbeeld: 112115- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/adressen"
}
},
"_embedded": {
"adressen": [
{
"id": 7791,
"straat": "Bagijnenstraat",
"nummer": "5",
"toevoeging": "",
"postcode": "3011HA",
"plaatsnaam": "Rotterdam",
"postcodegebied": "3011",
"longitude": "4.48430363",
"latitude": "51.92287754",
"categorie": "default",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/adressen/7792"
}
}
}
]
}
}Adres ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/adviseurs/{ADVISEUR_ID}/adressen/{ADRES_ID}?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/adressen/7792?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ADVISEUR_ID
int(verplicht) Voorbeeld: 112115- ADRES_ID
int(verplicht) Voorbeeld: 7792- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 7792,
"straat": "Bagijnenstraat",
"nummer": "5",
"toevoeging": "",
"postcode": "3011HA",
"plaatsnaam": "Rotterdam",
"postcodegebied": "3011",
"longitude": "4.48430363",
"latitude": "51.92287754",
"categorie": "default",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/adressen/7792"
}
}
}Emailadres collectieGET/api/data/klantdossiers/{DOSSIER_ID}/adviseurs/{ADVISEUR_ID}/emailadressen?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/emailadressen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ADVISEUR_ID
int(verplicht) Voorbeeld: 112115- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/emailadressen"
}
},
"_embedded": {
"emailadressen": [
{
"id": 35897,
"naam": "email00035897@dummy.nl",
"omschrijving": null,
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/emailadressen/35897"
}
},
"_embedded": {
"types": [
{
"id": 3,
"naam": "Algemeen"
}
]
}
}
]
}
}Emailadres ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/adviseurs/{ADVISEUR_ID}/emailadressen/{EMAILADRES_ID}?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/emailadressen/35897?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ADVISEUR_ID
int(verplicht) Voorbeeld: 112115- EMAILADRES_ID
int(verplicht) Voorbeeld: 35897- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 35897,
"naam": "email00035897@dummy.nl",
"omschrijving": "",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/emailadressen/35897"
},
"_embedded": {
"types": [
{
"id": 3,
"naam": "Algemeen"
}
]
}
}
}Profielfoto meta data ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/adviseurs/{ADVISEUR_ID}/profielfoto?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/profielfoto?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ADVISEUR_ID
int(verplicht) Voorbeeld: 112115- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 13,
"naam": "profielfoto.png",
"extensie": "png",
"bestandsgrootte": 98429,
"mimetype": "image/png",
"omschrijving": "",
"aanmaakdatum": "2017-09-07T10:13:47+02:00",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/profielfoto"
},
"download": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/profielfoto/download"
}
}
}Response
404VerbergBekijk
Headers
Content-Type: application/jsonProfielfoto binary downloadenGET/api/data/klantdossiers/{DOSSIER_ID}/adviseurs/{ADVISEUR_ID}/profielfoto/download?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/profielfoto/download?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ADVISEUR_ID
int(verplicht) Voorbeeld: 112115- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: image/pngBody
<binary data>Response
404VerbergBekijk
Headers
Content-Type: application/jsonRekeningnummer collectieGET/api/data/klantdossiers/{DOSSIER_ID}/adviseurs/{ADVISEUR_ID}/rekeningnummers?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/rekeningnummers?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ADVISEUR_ID
int(verplicht) Voorbeeld: 112115- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/rekeningnummers"
}
},
"_embedded": {
"rekeningnummers": [
{
"id": 1958,
"nummer": "662632",
"iban": "NL59INGB0000662632",
"bic": "INGBNL2A",
"land_iso": "NL",
"naam": "Achternaam00112115, Voornaam (I.)",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/rekeningnummers/1958"
}
}
}
]
}
}Rekeningnummer ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/adviseurs/{ADVISEUR_ID}/rekeningnummers/{REKENINGNUMMER_ID}?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/rekeningnummers/1958?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ADVISEUR_ID
int(verplicht) Voorbeeld: 112115- REKENINGNUMMER_ID
int(verplicht) Voorbeeld: 1958- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 1958,
"nummer": "662632",
"iban": "NL59INGB0000662632",
"bic": "INGBNL2A",
"land_iso": "NL",
"naam": "Achternaam00112115, Voornaam (I.)",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/rekeningnummers/1958"
}
}
}Telefoonnummer collectieGET/api/data/klantdossiers/{DOSSIER_ID}/adviseurs/{ADVISEUR_ID}/telefoonnummers?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/telefoonnummers?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ADVISEUR_ID
int(verplicht) Voorbeeld: 112115- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/telefoonnummers"
}
},
"_embedded": {
"telefoonnummers": [
{
"id": 75383,
"naam": "9993693079369",
"omschrijving": null,
"computednaam": "9993693079369",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/telefoonnummers/75383"
}
},
"_embedded": {
"types": [
{
"id": 5,
"naam": "mobiel"
}
]
}
}
]
}
}Telefoonnummer ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/adviseurs/{ADVISEUR_ID}/telefoonnummers/{TELEFOONNUMMER_ID}?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/telefoonnummers/75383?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ADVISEUR_ID
int(verplicht) Voorbeeld: 112115- TELEFOONNUMMER_ID
int(verplicht) Voorbeeld: 75383- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 75383,
"naam": "9993693079369",
"omschrijving": "",
"computednaam": "9993693079369",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/telefoonnummers/75383"
}
},
"_embedded": {
"types": [
{
"id": 5,
"naam": "mobiel"
}
]
}
}Kantoor ¶
Kantoor ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/kantoor?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/kantoor?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 16319,
"type": null,
"naam": "Deelnemer00016319",
"kvknummer": "",
"btwnummer": "",
"statutairenaam": "Deelnemer00016319",
"handelsnaam": "Deelnemer00016319",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/kantoor"
},
"adressen": {
"href": "/api/data/klantdossiers/5526/kantoor/adressen"
},
"emailadressen": {
"href": "/api/data/klantdossiers/5526/kantoor/emailadressen"
},
"profielfoto": {
"href": "/api/data/klantdossiers/5526/kantoor/profielfoto"
},
"telefoonnummers": {
"href": "/api/data/klantdossiers/5526/kantoor/telefoonnummers"
}
}
}Adres collectieGET/api/data/klantdossiers/{DOSSIER_ID}/kantoor/adressen?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/kantoor/adressen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/kantoor/adressen"
}
},
"_embedded": {
"adressen": [
{
"id": 7791,
"straat": "Nieuwemarkt",
"nummer": "3",
"toevoeging": "",
"postcode": "3011HP",
"plaatsnaam": "Rotterdam",
"postcodegebied": "3011",
"longitude": "4.48752316",
"latitude": "51.92270340",
"categorie": "default",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/kantoor/adressen/7791"
}
}
}
]
}
}Adres ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/kantoor/adressen/{ADRES_ID}?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/kantoor/adressen/7791?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ADRES_ID
int(verplicht) Voorbeeld: 7791- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 7791,
"straat": "Nieuwemarkt",
"nummer": "3",
"toevoeging": "",
"postcode": "3011HP",
"plaatsnaam": "Rotterdam",
"postcodegebied": "3011",
"longitude": "4.48752316",
"latitude": "51.92270340",
"categorie": "default",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/kantoor/adressen/7791"
}
}
}Emailadres collectieGET/api/data/klantdossiers/{DOSSIER_ID}/kantoor/emailadressen?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/kantoor/emailadressen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/kantoor/emailadressen"
}
},
"_embedded": {
"emailadressen": [
{
"id": 40557,
"naam": "deelnemer@deelnemer.nl",
"omschrijving": "",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/kantoor/emailadressen/40557"
}
},
"_embedded": {
"types": [
{
"id": 1,
"naam": "Zakelijk"
}
]
}
}
]
}
}Emailadres ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/kantoor/emailadressen/{EMAILADRES_ID}?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/kantoor/emailadressen/40557?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- EMAILADRES_ID
int(verplicht) Voorbeeld: 40557- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 40557,
"naam": "deelnemer@deelnemer.nl",
"omschrijving": "",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/kantoor/emailadressen/40557"
}
},
"_embedded": {
"types": [
{
"id": 1,
"naam": "Zakelijk"
}
]
}
}Profielfoto meta data ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/kantoor/profielfoto?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/kantoor/profielfoto?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 14,
"naam": "profielfoto.png",
"extensie": "png",
"bestandsgrootte": 98429,
"mimetype": "image/png",
"omschrijving": "",
"aanmaakdatum": "2017-09-07T10:13:47+02:00",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/kantoor/profielfoto"
},
"download": {
"href": "/api/data/klantdossiers/5526/kantoor/profielfoto/download"
}
}
}Response
404VerbergBekijk
Headers
Content-Type: application/jsonProfielfoto binary downloadenGET/api/data/klantdossiers/{DOSSIER_ID}/kantoor/profielfoto/download?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/kantoor/profielfoto/download?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: image/pngBody
<binary data>Response
404VerbergBekijk
Headers
Content-Type: application/jsonTelefoonnummer collectieGET/api/data/klantdossiers/{DOSSIER_ID}/kantoor/telefoonnummers?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/kantoor/telefoonnummers?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/kantoor/telefoonnummers"
}
},
"_embedded": {
"telefoonnummers": [
{
"id": 76408,
"naam": "0611112222",
"omschrijving": "",
"weergavenaam": "0611112222",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/kantoor/telefoonnummers/76408"
}
},
"_embedded": {
"types": [
{
"id": 1,
"naam": "algemeen"
}
]
}
}
]
}
}Telefoonnummer ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/kantoor/telefoonnummers/{TELEFOONNUMMER_ID}?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/kantoor/telefoonnummers/76408?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- TELEFOONNUMMER_ID
int(verplicht) Voorbeeld: 76408- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 76408,
"naam": "0611112222",
"omschrijving": "",
"weergavenaam": "0611112222",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/kantoor/telefoonnummers/76408"
}
},
"_embedded": {
"types": [
{
"id": 1,
"naam": "algemeen"
}
]
}
}Code collectieGET/api/data/klantdossiers/{DOSSIER_ID}/kantoor/codes?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/kantoor/codes?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/kantoor/codes"
}
},
"_embedded": {
"codes": [
{
"id": 465,
"code": "123",
"omschrijving": "",
"afgiftedatum": "2018-06-26T00:00:00+02:00",
"type": "Vestigingsnummer"
}
]
}
}Bezitting ¶
Bezitting collectieGET/api/data/klantdossiers/{DOSSIER_ID}/bezittingen?access_token={ACCESS_TOKEN}&gearchiveerd={GEARCHIVEERD}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bezittingen?access_token=3b57bd2db21c46d2875508b982968d26&gearchiveerd=0
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26- GEARCHIVEERD
boolean(optioneel) Voorbeeld: 0
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/bezittingen"
}
},
"_embedded": {
"bezittingen": [
{
"id": 179,
"omschrijving": "Opel Astra",
"merk": "Opel",
"cataloguswaarde": "24000.00",
"aankoopbedrag": "5000.00",
"huidigeWaardedatum": "2014-06-01T00:00:00+02:00",
"huidigeWaarde": "4000.00",
"waardewisseling": "0.0000",
"kenteken": "11-AA-11",
"bouwjaar": "2004-02-20T00:00:00+01:00",
"gewicht": 1160,
"type": "car",
"model": "",
"gearchiveerd": false,
"categorie": "vehicle",
"soort": null,
"aankoopdatum": "2012-03-01T00:00:00+01:00",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/bezittingen/179"
}
}
}
]
}
}Bezitting ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/bezittingen/{BEZITTING_ID}?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bezittingen/179?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- BEZITTING_ID
int(verplicht) Voorbeeld: 179- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 179,
"omschrijving": "Opel Astra",
"merk": "Opel",
"cataloguswaarde": "24000.00",
"aankoopbedrag": "5000.00",
"huidigeWaardedatum": "2014-06-01T00:00:00+02:00",
"huidigeWaarde": "4000.00",
"waardewisseling": "0.0000",
"kenteken": "11-AA-11",
"bouwjaar": "2004-02-20T00:00:00+01:00",
"gewicht": 1160,
"type": "car",
"model": "",
"gearchiveerd": false,
"categorie": "vehicle",
"soort": null,
"aankoopdatum": "2012-03-01T00:00:00+01:00",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/bezittingen/179"
}
}
}Producten ¶
Product collectieGET/api/data/klantdossiers/{DOSSIER_ID}/producten?access_token={ACCESS_TOKEN}&publiek={PUBLIEK}&gearchiveerd={GEARCHIVEERD}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/producten?access_token=3b57bd2db21c46d2875508b982968d26&publiek=1&gearchiveerd=0
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26- PUBLIEK
boolean(optioneel) Voorbeeld: 1- GEARCHIVEERD
boolean(optioneel) Voorbeeld: 0
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/producten"
}
},
"_embedded": {
"producten": [
{
"id": 6732,
"type": 1,
"soort": "hypotheken",
"offertenummer": "",
"omschrijving": "Hypotheek",
"status": "Aanvraag nieuw",
"invoerAanvraag": "2016-07-11T00:00:00+02:00",
"gearchiveerd ": "nee",
"publiek": "ja",
"maatschappij": "ABN AMRO",
"passeerdatum": "2010-09-01T00:00:00+02:00",
"passeerdatumDefinitief": "nee",
"hoofdsom": "200000.00",
"inschrijving": "225000.00",
"renteaanbodAangevraagd": "2010-07-11T00:00:00+02:00",
"ontbindendeVoorwaarden": "2010-07-17T00:00:00+02:00",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/hypotheken/6732"
}
}
},
{
"id": 6733,
"type": 11,
"soort": "profileprints",
"offertenummer": "1010",
"omschrijving": "Profile print",
"status": "Aanvraag compleet",
"invoerAanvraag": "2016-07-11T00:00:00+02:00",
"gearchiveerd ": "nee",
"publiek": "ja",
"leverancier": "Profileprints BV",
"verwachtteLeverdatum": "2010-04-11T00:00:00+02:00",
"verwachtteLeverdatumDefinitief": "ja",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/profileprints/6733"
}
}
},
{
"id": 6734,
"type": 43,
"offertenummer": "120",
"soort": "diensten",
"omschrijving": "Dienst",
"status": "Aanvraag nieuw",
"invoerAanvraag": "2016-07-11T00:00:00+02:00",
"gearchiveerd ": "nee",
"publiek": "ja",
"maatschappij": "CO00014830",
"ingangsdatum": "2011-03-08T00:00:00+01:00",
"ingangsdatumDefinitief": "ja",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/diensten/6734"
}
}
},
{
"id": 6735,
"type": 15,
"soort": "hypotheekadviezen",
"offertenummer": " ",
"omschrijving": "Hypotheekadvies",
"status": "Aanvraag nieuw",
"invoerAanvraag": "2016-07-11T00:00:00+02:00",
"gearchiveerd ": "nee",
"publiek": "ja",
"maatschappij": "Deelnemer00016319",
"startdatum": "2016-07-11T00:00:00+02:00",
"startdatumDefinitief": "nee",
"passeerdatum": null,
"datumOntbindendeVoorwaarden": null,
"koopprijs": "0.00",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/hypotheekadviezen/6735"
}
}
},
{
"id": 6736,
"type": 19,
"soort": "bankgaranties",
"offertenummer": "1234-A",
"omschrijving": "Bankgarantie",
"status": "Aanvraag nieuw",
"invoerAanvraag": "2016-07-11T00:00:00+02:00",
"gearchiveerd ": "nee",
"publiek": "ja",
"maatschappij": "ABN AMRO",
"passeerdatum": "2010-02-22T00:00:00+01:00",
"passeerdatumDefinitief": "nee",
"hoofdsom": null,
"inschrijving": null,
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/bankgaranties/6736"
}
}
},
{
"id": 6741,
"type": 9,
"soort": "contracten",
"offertenummer": "140",
"omschrijving": "Contract",
"status": "Aanvraag nieuw",
"invoerAanvraag": "2016-07-11T00:00:00+02:00",
"gearchiveerd ": "nee",
"publiek": "ja",
"maatschappij": "CO00014830",
"startdatum": "2012-09-08T00:00:00+02:00",
"startdatumDefinitief": "ja",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/contracten/6741"
}
}
},
{
"id": 6742,
"type": 2,
"soort": "levensverzekeringen",
"offertenummer": "111018(1)",
"omschrijving": "ORV annuïtair dalend",
"status": "Aanvraag nieuw",
"invoerAanvraag": "2016-07-11T00:00:00+02:00",
"gearchiveerd ": "nee",
"publiek": "ja",
"garantiekapitaal": "0.00",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/levensverzekeringen/6742"
}
}
},
{
"id": 6743,
"type": 48,
"soort": "consumptiefkredieten",
"offertenummer": "132",
"omschrijving": "Consumptief krediet",
"status": "Aanvraag nieuw",
"invoerAanvraag": "2016-07-11T00:00:00+02:00",
"gearchiveerd ": "nee",
"publiek": "ja",
"maatschappij": "DAK Hypotheken",
"ingangsdatum": "2011-10-14T00:00:00+02:00",
"ingangsdatumDefinitief": "ja",
"gewenstBedrag": "20000.00",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/consumptiefkredieten/6743"
}
}
},
{
"id": 6744,
"type": 5,
"soort": "inkomensverzekeringen",
"offertenummer": "9874F874-B",
"omschrijving": "Inkomensverzekering",
"status": "Aanvraag nieuw",
"invoerAanvraag": "2016-07-11T00:00:00+02:00",
"gearchiveerd ": "nee",
"publiek": "ja",
"maatschappij": "Callas Group",
"ingangsdatum": "2016-09-01T00:00:00+02:00",
"ingangsdatumDefinitief": "ja",
"incassowijze": "Tussenpersoon",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/inkomensverzekeringen/6744"
}
}
},
{
"id": 6745,
"type": 8,
"soort": "pensioenen",
"offertenummer": "134",
"omschrijving": "Pensioen",
"status": "Aanvraag nieuw",
"invoerAanvraag": "2016-07-11T00:00:00+02:00",
"gearchiveerd ": "nee",
"publiek": "ja",
"maatschappij": "Reaal",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/pensioenen/6745"
}
}
},
{
"id": 6747,
"type": 3,
"soort": "vermogenenbancair",
"offertenummer": "144",
"omschrijving": "Vermogen en bancair",
"status": "Aanvraag nieuw",
"invoerAanvraag": "2016-07-11T00:00:00+02:00",
"gearchiveerd ": "nee",
"publiek": "ja",
"leverancier": "ING",
"startdatum": "2014-02-01T00:00:00+01:00",
"verpandAan": null,
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/vermogenenbancair/6747"
}
}
},
{
"id": 6748,
"type": 21,
"soort": "uitvaartverzekeringen",
"offertenummer": "15N27530735",
"omschrijving": "Uitvaartverz. olv dhr.",
"status": "Aanvraag nieuw",
"invoerAanvraag": "2016-07-11T00:00:00+02:00",
"gearchiveerd ": "nee",
"publiek": "ja",
"maatschappij": "Dela Verzekeringen",
"ingangsdatum": "2016-06-06T00:00:00+02:00",
"kinderenMeeverzekeren": "nee",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/uitvaartverzekeringen/6748"
}
}
},
{
"id": 6749,
"type": 4,
"soort": "schadeverzekeringen",
"offertenummer": "98037192",
"omschrijving": "auto 29-KQB-3",
"status": "Aanvraag nieuw",
"invoerAanvraag": "2016-10-04T12:15:18+02:00",
"gearchiveerd": "nee",
"publiek": "ja",
"maatschappij": "Klaverblad",
"ingangsdatum": "2012-10-29T00:00:00+01:00",
"ingangsdatumDefinitief": "ja",
"offerteAanvraagdatum": "2012-10-29T00:00:00+01:00",
"offerteAanvraagdatumDefinitief": "ja",
"isPakket": "nee",
"brutoPremie": "0.00",
"toeslag": "0.00",
"korting": "0.00",
"nettoPremie": "0.00",
"kosten": "0.00",
"tussenpersoonkosten": "0.00",
"assurantiebelasting": "0.00",
"totaal": "0.00",
"pakketkorting": "0.00",
"pakketkortingPercentage": null,
"premietermijn": null,
"incassowijze": "Tussenpersoon",
"beloningpercentageDeelnemer": "0.00",
"beloningpercentageAdviseur": "0.00",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/schadeverzekeringen/6749"
}
}
},
{
"id": 6752,
"type": 4,
"soort": "schadeverzekeringen",
"offertenummer": "",
"omschrijving": "Schadeverzekering - met AEGON",
"status": "Aanvraag nieuw",
"invoerAanvraag": "2017-10-04T00:00:00+02:00",
"gearchiveerd": "nee",
"publiek": "ja",
"maatschappij": "AEGON",
"ingangsdatum": "2012-10-29T00:00:00+01:00",
"ingangsdatumDefinitief": "nee",
"offerteAanvraagdatum": "2012-10-29T00:00:00+01:00",
"offerteAanvraagdatumDefinitief": "ja",
"isPakket": "nee",
"brutoPremie": "10.00",
"toeslag": "2.00",
"korting": "2.00",
"nettoPremie": "10.00",
"kosten": "0.00",
"tussenpersoonkosten": "0.00",
"assurantiebelasting": "2.10",
"totaal": "12.10",
"pakketkorting": "0.00",
"pakketkortingPercentage": null,
"premietermijn": "maand",
"incassowijze": "Tussenpersoon",
"beloningpercentageDeelnemer": "0.00",
"beloningpercentageAdviseur": "0.00",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/schadeverzekeringen/6752"
}
}
}
]
}
}Bankgarantie ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/bankgaranties/{PRODUCT_ID}?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bankgaranties/6736?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6736- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 6736,
"type": 19,
"offertenummer": "1234-A",
"omschrijving": "Bankgarantie",
"status": "Aanvraag nieuw",
"invoerAanvraag": "2016-07-11T00:00:00+02:00",
"maatschappij": "ABN AMRO",
"passeerdatum": "2010-02-22T00:00:00+01:00",
"passeerdatumDefinitief": "nee",
"hoofdsom": "200000.00",
"inschrijving": "225000.00",
"adviseur": "Achternaam, Voornaam (I.)",
"acceptant": "AchternaamTwee, Voornaam (V.)",
"acceptantWorkflowgroep": null,
"behandelaar": "Achternaam, Voornaam (I.)",
"behandelaarWorkflowgroep": null,
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/bankgaranties/6736"
}
},
"_embedded": {
"onderpandadres": [
{
"id": 7790,
"straat": "Nieuwemarkt",
"nummer": "2",
"toevoeging": "",
"postcode": "3011HP",
"plaatsnaam": "Rotterdam",
"postcodegebied": "3011",
"longitude": null,
"latitude": null,
"categorie": "default",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/bankgaranties/6736/adressen/7790"
}
},
"_embedded": {
"types": [
{
"id": 7,
"naam": "correspondentieadres"
},
{
"id": 7,
"naam": "correspondentieadres"
}
]
}
}
],
"correspondentieadres": {
"id": 7793,
"straat": "Groenhof",
"nummer": "1",
"toevoeging": "",
"postcode": "1275BB",
"plaatsnaam": "Huizen",
"postcodegebied": "1275",
"longitude": "5.26394006",
"latitude": "52.28904947",
"categorie": "default",
"_embedded": {
"types": [
{
"id": 1,
"naam": "bezoekadres"
}
]
}
},
"productdelen": [
{
"id": 7896,
"product": "Bankgarantie",
"garantienummer": "4321ZP12",
"garantiebedrag": "180000.00",
"orv": "ja"
}
]
}
}Bankgarantie registratie ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/bankgaranties/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]&publiek={publiek}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bankgaranties/6736/registraties?access_token=3b57bd2db21c46d2875508b982968d26]&publiek=0
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6736- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26- publiek
int(optioneel) Voorbeeld: 0
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/bankgaranties/6736/registraties"
}
},
"_embedded": {
"registraties": [
{
"omschrijving": "Er is een bestand geupload",
"onderwerp": "Koopakte grond geupload",
"publiek": false,
"factureerbaar": false,
"boekdatum": "2016-09-30T10:21:00+0200",
"gearchiveerd": false,
"verbruik": 0,
"id": 275825,
"registratietype": "E-mail/Brief",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/bankgaranties/6736/registraties/275825"
},
"product": {
"href": "/api/data/klantdossiers/5526/bankgaranties/6736"
},
"bestand": {
"href": "/api/data/klantdossiers/5526/documenten/2"
}
}
}
]
}
}Bankgarantie registratie toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/bankgaranties/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bankgaranties/6736/registraties?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6736- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Klantdossier - Registratie toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/bankgaranties/6736/registraties/275826Bankgarantie taak toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/bankgaranties/{PRODUCT_ID}/taken?access_token={ACCESS_TOKEN}]
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bankgaranties/6736/taken?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6736- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"naam": "Naam van de afspraak",
"omschrijving": "Omschrijving van de taak",
"type": "Afspraak",
"status": {
"id": 1
},
"prioriteit": "Middel",
"startdatum": "2016-07-05 17:07:04",
"einddatum": "2016-07-05 18:07:04",
"afgerond": false,
"aanmaakdatum": "2016-07-05 16:00:00",
"initiator": {
"id": 112794
},
"genodigden": [
{
"id": 120954
},
{
"id": 120955
}
],
"verantwoordelijke": "WorkflowgroepMetPersoon",
"verantwoordelijkePersoon": {
"id": 112794
},
"verantwoordelijkeWorkflowgroep": {
"id": 45
}
}Schema
{
"title": "Taak",
"type": "object",
"properties": {
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"omschrijving": {
"type": "string",
"minLength": 1
},
"type": {
"enum": [
"Actie",
"Afspraak",
"Bellen",
"Bezichtiging",
"Doel",
"Klacht",
"Schade"
]
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"prioriteit": {
"enum": [
"Laag",
"Middel",
"Hoog"
]
},
"startdatum": {
"type": "string",
"format": "datatype-datetime"
},
"einddatum": {
"type": "string",
"format": "datatype-datetime"
},
"afgerond": {
"type": "boolean"
},
"aanmaakdatum": {
"type": "string",
"format": "datatype-datetime"
},
"initiator": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"genodigden": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"verantwoordelijke": {
"enum": [
"Persoon",
"Workflowgroep",
"WorkflowgroepMetPersoon"
]
},
"verantwoordelijkePersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verantwoordelijkeWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"required": [
"naam",
"type",
"status",
"prioriteit",
"startdatum",
"einddatum",
"verantwoordelijke"
],
"additionalProperties": false,
"oneOf": [
{
"properties": {
"verantwoordelijke": {
"enum": [
"Persoon"
]
}
},
"required": [
"verantwoordelijkePersoon"
]
},
{
"properties": {
"verantwoordelijke": {
"enum": [
"Workflowgroep"
]
}
},
"required": [
"verantwoordelijkeWorkflowgroep"
]
},
{
"properties": {
"verantwoordelijke": {
"enum": [
"WorkflowgroepMetPersoon"
]
}
},
"required": [
"verantwoordelijkePersoon",
"verantwoordelijkeWorkflowgroep"
]
}
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/bankgaranties/6736/taken/55519Bankgarantie workflow toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/bankgaranties/{PRODUCT_ID}/workflows?access_token={ACCESS_TOKEN}]
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bankgaranties/6736/workflows?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6736- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"workflow": {
"id": 21
}
}Schema
{
"properties": {
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"workflow"
]
}Response
204VerbergBekijk
Headers
Content-Type: application/jsonBankgarantie factuur toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/bankgaranties/{PRODUCT_ID}/facturen?access_token={ACCESS_TOKEN}
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bankgaranties/6736/facturen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6736- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Factuur - Factuur toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/bankgaranties/6736/facturen/1Bankgarantie factuurregel toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/bankgaranties/{PRODUCT_ID}/facturen/{FACTUUR_ID}/regels?access_token={ACCESS_TOKEN}
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bankgaranties/6736/facturen/1/regels?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6736- FACTUUR_ID
int(verplicht) Voorbeeld: 1- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Factuur - Factuurregel toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/bankgaranties/6736/facturen/1Consumptief krediet ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/consumptiefkredieten/{PRODUCT_ID}?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/consumptiefkredieten/6743?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6743- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 6743,
"type": 48,
"offertenummer": "132",
"omschrijving": "Consumptief krediet",
"status": "Aanvraag nieuw",
"invoerAanvraag": "2016-07-11T00:00:00+02:00",
"maatschappij": "DAK Hypotheken",
"ingangsdatum": "2011-10-14T00:00:00+02:00",
"ingangsdatumDefinitief": "ja",
"gewenstBedrag": "20000.00",
"adviseur": "Achternaam, Voornaam (I.)",
"acceptant": "AchternaamTwee, Voornaam (V.)",
"acceptantWorkflowgroep": null,
"behandelaar": "Achternaam, Voornaam (I.)",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/consumptiefkredieten/6743"
}
},
"_embedded": {
"correspondentieadres": {
"id": 7793,
"straat": "Groenhof",
"nummer": "1",
"toevoeging": "",
"postcode": "1275BB",
"plaatsnaam": "Huizen",
"postcodegebied": "1275",
"longitude": "5.26394006",
"latitude": "52.28904947",
"categorie": "default",
"_embedded": {
"types": [
{
"id": 1,
"naam": "bezoekadres"
}
]
}
},
"aanvragers": [
{
"id": 120954,
"geslacht": "man",
"initialen": "A.",
"titel": "",
"voornaam": "Aad",
"tussenvoegsel": "",
"achternaam": "Jansen",
"bsn": "559795178",
"nationaliteitId": 1,
"burgerlijkestaatId": 1,
"weergavenaam": "Jansen, Aad (A.)",
"geboortedatum": "1960-01-01T00:00:00+01:00",
"pensioendatum": "2027-01-01T00:00:00+01:00",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/120954"
},
"adressen": {
"href": "/api/data/klantdossiers/5526/klanten/120954/adressen"
},
"emailadressen": {
"href": "/api/data/klantdossiers/5526/klanten/120954/emailadressen"
},
"rekeningnummers": {
"href": "/api/data/klantdossiers/5526/klanten/120954/rekeningnummers"
},
"telefoonnummers": {
"href": "/api/data/klantdossiers/5526/klanten/120954/telefoonnummers"
}
}
}
],
"productdelen": [
{
"id": 7904,
"product": "Persoonlijke lening",
"productgroep": "Persoonlijke lening",
"leenbedrag": "20000.00",
"contractnummer": "132",
"termijnbedrag": "500.00",
"theoretischeLooptijd": 12,
"theoretischeEinddatum": "2012-10-14T00:00:00+02:00",
"saldo": null,
"periode": null,
"slottermijn": "3330.00",
"kredietvergoeding": null,
"_links": {
"object": {
"href": "/api/data/klantdossiers/5526/bezittingen/183"
}
}
}
]
}
}Consumptief krediet toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/consumptiefkredieten?access_token={ACCESS_TOKEN}]
Wijzigingen met release 1.9.3
-
Het veld eersteAanvrager is deprecated. Gebruik hiervoor eersteAanvragerParticulier. Dit is gedaan om onderscheid te maken tussen particuliere en zakelijke klanten.
-
Het is mogelijk dit product te koppelen aan een zakelijke klant. Hiervoor dient de waarde aanvragerZakelijk gevuld te worden met het id van de zakelijke klant. Daarnaast kan de zakelijke klant ook als eerste aanvrager gemarkeerd worden. Gebruik hiervoor het veld eersteAanvragerZakelijk.
-
Om een eerste aanvrager particulier te koppelen dient het veld eersteAanvragerParticulier gebruikt te worden.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/consumptiefkredieten?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"omschrijving": "Consumptief Krediet",
"status": {
"id": 1
},
"bestaandePropositie": {
"id": 3334
},
"afgeslotenDoor": {
"id": 112115
},
"acceptantWorkflowgroep": {
"id": 45
},
"dossierVerantwoordelijkeWorkflowgroep": {
"id": 45
},
"bronvermelding": {
"id": 3
},
"aanbrengerPersoon": {
"id": 120956
},
"aanbrengerOrganisatie": {
"id": 14851
},
"offertenummer": "12345",
"aanvraagVerzonden": "2016-01-01",
"aanvraagVerzondenDefinitief": true,
"uitbetalingsdatum": "2016-01-01",
"uitbetalingsdatumDefinitief": true,
"akkoordBank": "2016-01-01",
"contractOntvangen": "2016-01-01",
"stukkenOpgevraagd": "2016-01-01",
"contractVerzondenNaarKlant": "2016-01-01",
"stukkenCompleet": "2016-01-01",
"contractGetekendRetour": "2016-01-01",
"getekendContractNaarMaatschappij": "2016-01-01",
"contractVervaldatum": "2016-01-01",
"aanvragerZakelijk": {
"id": 16941
},
"aanvragersParticulier": [
{
"id": 120954
},
{
"id": 120955
}
],
"eersteAanvragerParticulier": {
"id": 120954
},
"correspondentieadres": {
"id": 7793
},
"financieringsdoel": "(Nog) Niet bekend",
"maatschappij": {
"id": 14876
},
"inkoopVia": {
"id": 15100
},
"gewenstbedrag": 2000,
"gewenstMaandbedrag": 100,
"aantalKinderen": 1,
"toelichting": "nvt",
"artikel": {
"id": 20684
},
"codeprovisiemijtype": "CE001",
"contractnummer": "12345",
"leenbedrag": 2000,
"depot": 100,
"blokkade": true,
"inlossaldo": 100,
"uitTeBetalen": 100,
"termijnbedrag": 100,
"percentageDoorlopendKrediet": 100,
"aflossingsvrij": 100,
"nominaleMaandrente": 100,
"effectieveJaarrente": 100,
"kredietvergoeding": 100,
"totaleKredietsom": 100,
"theoretischeLooptijd": 100,
"theoretischeEinddatum": "2016-01-01",
"uitbetalingLand": "AD",
"uitbetalingBank": "RABOBANK NEDERLAND",
"uitbetalingRekeningnummer": "136907539",
"uitbetalingBicnummer": "RABONL2U",
"uitbetalingIbannummer": "NL25RABO0136907539",
"toonindigimap": true,
"gearchiveerd": false,
"slottermijn": 100,
"object": {
"id": 179
}
}Schema
{
"title": "Consumptiefkrediet",
"type": "object",
"properties": {
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bestaandePropositie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"afgeslotenDoor": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"acceptant": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"acceptantWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"dossierVerantwoordelijke": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"dossierVerantwoordelijkeWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bronvermelding": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanbrengerPersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanbrengerOrganisatie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"offertenummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"aanvraagVerzonden": {
"type": "string",
"format": "datatype-date"
},
"aanvraagVerzondenDefinitief": {
"type": "boolean"
},
"uitbetalingsdatum": {
"type": "string",
"format": "datatype-date"
},
"uitbetalingsdatumDefinitief": {
"type": "boolean"
},
"akkoordBank": {
"type": "string",
"format": "datatype-date"
},
"contractOntvangen": {
"type": "string",
"format": "datatype-date"
},
"stukkenOpgevraagd": {
"type": "string",
"format": "datatype-date"
},
"contractVerzondenNaarKlant": {
"type": "string",
"format": "datatype-date"
},
"stukkenCompleet": {
"type": "string",
"format": "datatype-date"
},
"contractGetekendRetour": {
"type": "string",
"format": "datatype-date"
},
"getekendContractNaarMaatschappij": {
"type": "string",
"format": "datatype-date"
},
"contractVervaldatum": {
"type": "string",
"format": "datatype-date"
},
"aanvragersParticulier": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"aanvragerZakelijk": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"eersteAanvrager": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"eersteAanvragerParticulier": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"eersteAanvragerZakelijk": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"correspondentieadres": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"financieringsdoel": {
"enum": [
"(Nog) Niet bekend",
"Aankoop woning",
"Anders, zie toelichting",
"Auto",
"Belasting betaling",
"Boot",
"Financiering kosten hypotheek",
"Motor",
"Overname lopende leningen",
"Restschuld financiering",
"Schuldsanering",
"Toercaravan",
"Woningverbetering",
"Zakelijk doel"
]
},
"maatschappij": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"inkoopVia": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"gewenstbedrag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"gewenstMaandbedrag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"aantalKinderen": {
"type": "integer",
"format": "datatype-int",
"minimum": 0
},
"toelichting": {
"type": "string",
"minLength": 1
},
"artikel": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"codeprovisiemijtype": {
"enum": [
"CE001",
"CE002",
"CE003",
"CE004",
"CE005",
"CE006",
"DM001",
"DM002",
"IT001",
"IT002",
"ME001",
"ME002"
]
},
"contractnummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"leenbedrag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"depot": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"blokkade": {
"type": "boolean"
},
"inlossaldo": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"uitTeBetalen": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"termijnbedrag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"percentageDoorlopendKrediet": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"aflossingsvrij": {
"type": "integer",
"format": "datatype-int",
"minimum": 0
},
"nominaleMaandrente": {
"type": "number",
"multipleOf": "0.000001",
"minimum": -9999999.999999,
"maximum": 9999999.999999
},
"effectieveJaarrente": {
"type": "number",
"multipleOf": 0.1,
"minimum": -999999999.9,
"maximum": 999999999.9
},
"kredietvergoeding": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"totaleKredietsom": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"theoretischeLooptijd": {
"type": "integer",
"format": "datatype-int",
"minimum": 0
},
"theoretischeEinddatum": {
"type": "string",
"format": "datatype-date"
},
"uitbetalingLand": {
"enum": [
"AD",
"AE",
"AF",
"AG",
"AI",
"AL",
"AM",
"AN",
"AO",
"AQ",
"AR",
"AS",
"AT",
"AU",
"AW",
"AX",
"AZ",
"BA",
"BB",
"BD",
"BE",
"BF",
"BG",
"BH",
"BI",
"BJ",
"BL",
"BM",
"BN",
"BO",
"BQ",
"BR",
"BS",
"BT",
"BV",
"BW",
"BY",
"BZ",
"CA",
"CC",
"CD",
"CF",
"CG",
"CH",
"CI",
"CK",
"CL",
"CM",
"CN",
"CO",
"CR",
"CS",
"CU",
"CV",
"CW",
"CX",
"CY",
"CZ",
"DE",
"DJ",
"DK",
"DM",
"DO",
"DZ",
"EC",
"EE",
"EG",
"EH",
"ER",
"ES",
"ET",
"FI",
"FJ",
"FK",
"FM",
"FO",
"FR",
"GA",
"GB",
"GD",
"GE",
"GF",
"GG",
"GH",
"GI",
"GL",
"GM",
"GN",
"GP",
"GQ",
"GR",
"GS",
"GT",
"GU",
"GW",
"GY",
"HK",
"HM",
"HN",
"HR",
"HT",
"HU",
"ID",
"IE",
"IL",
"IM",
"IN",
"IO",
"IQ",
"IR",
"IS",
"IT",
"JE",
"JM",
"JO",
"JP",
"KE",
"KG",
"KH",
"KI",
"KM",
"KN",
"KP",
"KR",
"KW",
"KY",
"KZ",
"LA",
"LB",
"LC",
"LI",
"LK",
"LR",
"LS",
"LT",
"LU",
"LV",
"LY",
"MA",
"MC",
"MD",
"ME",
"MF",
"MG",
"MH",
"MK",
"ML",
"MM",
"MN",
"MO",
"MP",
"MQ",
"MR",
"MS",
"MT",
"MU",
"MV",
"MW",
"MX",
"MY",
"MZ",
"NA",
"NC",
"NE",
"NF",
"NG",
"NI",
"NL",
"NO",
"NP",
"NR",
"NU",
"NZ",
"OM",
"PA",
"PE",
"PF",
"PG",
"PH",
"PK",
"PL",
"PM",
"PN",
"PR",
"PS",
"PT",
"PW",
"PY",
"QA",
"RE",
"RO",
"RS",
"RU",
"RW",
"SA",
"SB",
"SC",
"SD",
"SE",
"SG",
"SH",
"SI",
"SJ",
"SK",
"SL",
"SM",
"SN",
"SO",
"SR",
"ST",
"SV",
"SX",
"SY",
"SZ",
"TC",
"TD",
"TF",
"TG",
"TH",
"TJ",
"TK",
"TL",
"TM",
"TN",
"TO",
"TR",
"TT",
"TV",
"TW",
"TZ",
"UA",
"UG",
"UM",
"US",
"UY",
"UZ",
"VA",
"VC",
"VE",
"VG",
"VI",
"VN",
"VU",
"WF",
"WS",
"YE",
"YT",
"ZA",
"ZM",
"ZW"
]
},
"uitbetalingBank": {
"enum": [
"(Svenska)Handelsbanken AB",
"ABN AMRO BANK N.V.",
"ABN AMRO BANK N.V. (FORMELY KNOWN AS FORTIS BANK (NEDERLAND) N.V.)",
"ACHMEA RETAIL BANK N.V.",
"AEGON BANK N.V.",
"AMSTERDAM TRADE BANK N.V.",
"ANADOLUBANK NEDERLAND N.V.",
"ARGENTA SPAARBANK-BIJKANTOOR NEDERLAND",
"ASN Bank",
"ASR Bank",
"BANK INSINGER DE BEAUFORT N.V.",
"BANK MENDES GANS N.V.",
"BANK OF AMERICA, N.A. AMSTERDAM",
"BANK OF TOKYO-MITSUBISHI UFJ (HOLLAND) N.V.",
"BANQUE CHAABI DU MAROC",
"BINCKBANK N.V.",
"BNP PARIBAS S.A. - THE NETHERLANDS BRANCH",
"CITCO BANK NEDERLAND N.V.",
"CITIBANK INTERNATIONAL PLC NETHERLANDS BRANCH",
"COMMERZBANK AG KANTOOR AMSTERDAM",
"CREDIT EUROPE BANK N.V.",
"DELTA LLOYD BANK N.V.",
"DEMIR-HALK BANK (NEDERLAND) N.V.",
"DEUTSCHE BANK A.G. AMSTERDAM",
"ECONOMY BANK N.V.,THE",
"FNB Bank",
"Friesland bank",
"GARANTIBANK INTERNATIONAL N.V.",
"GE ARTESIA BANK (FORMERLY BANQUE ARTESIA NEDERLAND N.V.)",
"HSBC BANK PLC.",
"ING BANK N.V.",
"ING BELGIUM NV/SA (FORMERLY BANK BRUSSELS LAMBERT SA, BREDA BRANCH)",
"INTESA SANPAOLO S.P.A. (FORMER SANPAOLO IMI), AMSTERDAM BRANCH, AMSTERDAM",
"ISBANK GMBH, AMSTERDAM BRANCH",
"KAS BANK N.V.",
"KBC BANK NEDERLAND N.V.",
"KNAB Bank",
"KOREA EXCHANGE BANK, AMSTERDAM BRANCH",
"LANSCHOT BANKIERS NV F. VAN",
"LEASEPLAN CORPORATION N.V.",
"LEVOB BANK N.V.",
"LLOYDS TSB BANK PLC.",
"MIZUHO CORPORATE BANK NEDERLAND N.V.",
"NEDERLANDSCHE BANK (DE) N.V.",
"NEDERLANDSE WATERSCHAPSBANK N.V.",
"NIBC BANK N.V.",
"NV BANK NEDERLANDSE GEMEENTEN",
"Overige (ZA)",
"RABOBANK NEDERLAND",
"RegioBank",
"SNS BANK N.V. / ASN BANK N.V.",
"SOCIETE GENERALE",
"STAALBANKIERS N.V.",
"Standard Bank",
"THE ROYAL BANK OF SCOTLAND N.V.",
"THEODOOR GILISSEN BANKIERS N.V.",
"TRIODOS BANK N.V.",
"UBS BANK (NETHERLANDS) B.V.",
"YAPI KREDI BANK NEDERLAND N.V."
]
},
"uitbetalingRekeningnummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"uitbetalingBicnummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"uitbetalingIbannummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"toonindigimap": {
"type": "boolean"
},
"gearchiveerd": {
"type": "boolean"
},
"object": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"slottermijn": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
}
},
"required": [
"status",
"bestaandePropositie",
"afgeslotenDoor",
"aanvraagVerzonden",
"aanvraagVerzondenDefinitief",
"uitbetalingsdatum",
"uitbetalingsdatumDefinitief",
"correspondentieadres",
"financieringsdoel",
"maatschappij",
"inkoopVia",
"gewenstbedrag",
"artikel",
"toonindigimap"
],
"oneOf": [
{
"required": [
"dossierVerantwoordelijke"
]
},
{
"required": [
"dossierVerantwoordelijkeWorkflowgroep"
]
}
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/consumptiefkredieten/6758Consumptief krediet registratie ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/consumptiefkredieten/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]&publiek={publiek}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/consumptiefkredieten/6743/registraties?access_token=3b57bd2db21c46d2875508b982968d26]&publiek=0
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6743- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26- publiek
int(optioneel) Voorbeeld: 0
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/consumptiefkredieten/6743/registraties"
}
},
"_embedded": {
"registraties": [
{
"omschrijving": "Er is een bestand geupload",
"onderwerp": "Koopakte grond geupload",
"publiek": false,
"factureerbaar": false,
"boekdatum": "2016-09-30T10:21:00+0200",
"gearchiveerd": false,
"verbruik": 0,
"id": 275825,
"registratietype": "E-mail/Brief",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/consumptiefkredieten/6743/registraties/275825"
},
"product": {
"href": "/api/data/klantdossiers/5526/consumptiefkredieten/6743"
},
"bestand": {
"href": "/api/data/klantdossiers/5526/documenten/2"
}
}
}
]
}
}Consumptief krediet registratie toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/consumptiefkredieten/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/consumptiefkredieten/6743/registraties?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6743- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Klantdossier - Registratie toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/consumptiefkredieten/6743/registraties/275826Consumptief krediet taak toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/consumptiefkredieten/{PRODUCT_ID}/taken?access_token={ACCESS_TOKEN}]
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/consumptiefkredieten/6755/taken?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6755- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"naam": "Naam van de afspraak",
"omschrijving": "Omschrijving van de taak",
"type": "Afspraak",
"status": {
"id": 1
},
"prioriteit": "Middel",
"startdatum": "2016-07-05 17:07:04",
"einddatum": "2016-07-05 18:07:04",
"afgerond": false,
"aanmaakdatum": "2016-07-05 16:00:00",
"initiator": {
"id": 112794
},
"genodigden": [
{
"id": 120954
},
{
"id": 120955
}
],
"verantwoordelijke": "WorkflowgroepMetPersoon",
"verantwoordelijkePersoon": {
"id": 112794
},
"verantwoordelijkeWorkflowgroep": {
"id": 45
}
}Schema
{
"title": "Taak",
"type": "object",
"properties": {
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"omschrijving": {
"type": "string",
"minLength": 1
},
"type": {
"enum": [
"Actie",
"Afspraak",
"Bellen",
"Bezichtiging",
"Doel",
"Klacht",
"Schade"
]
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"prioriteit": {
"enum": [
"Laag",
"Middel",
"Hoog"
]
},
"startdatum": {
"type": "string",
"format": "datatype-datetime"
},
"einddatum": {
"type": "string",
"format": "datatype-datetime"
},
"afgerond": {
"type": "boolean"
},
"aanmaakdatum": {
"type": "string",
"format": "datatype-datetime"
},
"initiator": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"genodigden": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"verantwoordelijke": {
"enum": [
"Persoon",
"Workflowgroep",
"WorkflowgroepMetPersoon"
]
},
"verantwoordelijkePersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verantwoordelijkeWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"required": [
"naam",
"type",
"status",
"prioriteit",
"startdatum",
"einddatum",
"verantwoordelijke"
],
"additionalProperties": false,
"oneOf": [
{
"properties": {
"verantwoordelijke": {
"enum": [
"Persoon"
]
}
},
"required": [
"verantwoordelijkePersoon"
]
},
{
"properties": {
"verantwoordelijke": {
"enum": [
"Workflowgroep"
]
}
},
"required": [
"verantwoordelijkeWorkflowgroep"
]
},
{
"properties": {
"verantwoordelijke": {
"enum": [
"WorkflowgroepMetPersoon"
]
}
},
"required": [
"verantwoordelijkePersoon",
"verantwoordelijkeWorkflowgroep"
]
}
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/consumptiefkredieten/6755/taken/55519Consumptief krediet workflow toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/consumptiefkredieten/{PRODUCT_ID}/workflows?access_token={ACCESS_TOKEN}]
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/consumptiefkredieten/6743/workflows?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6743- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"workflow": {
"id": 21
}
}Schema
{
"properties": {
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"workflow"
]
}Response
204VerbergBekijk
Headers
Content-Type: application/jsonConsumptief krediet factuur toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/consumptiefkredieten/{PRODUCT_ID}/facturen?access_token={ACCESS_TOKEN}
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/consumptiefkredieten/6743/facturen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6743- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Factuur - Factuur toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/consumptiefkredieten/6743/facturen/1Consumptief krediet factuurregel toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/consumptiefkredieten/{PRODUCT_ID}/facturen/{FACTUUR_ID}/regels?access_token={ACCESS_TOKEN}
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/consumptiefkredieten/6743/facturen/1/regels?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6743- FACTUUR_ID
int(verplicht) Voorbeeld: 1- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Factuur - Factuurregel toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/consumptiefkredieten/6743/facturen/1Contract ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/contracten/{PRODUCT_ID}?access_token={ACCESS_TOKEN}
Wijzigingen met release 1.9.12
- De velden factuurverzendwijze, factuurtype en automatischFactureren worden alleen opgehaald indien er van factureren vanuit de kaart gebruik wordt gemaakt.
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/contracten/6741?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6741- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 6741,
"type": 9,
"offertenummer": "140",
"omschrijving": "Contract",
"status": "Aanvraag nieuw",
"invoerAanvraag": "2016-07-11T00:00:00+02:00",
"maatschappij": "CO00014830",
"startdatum": "2012-09-08T00:00:00+02:00",
"startdatumDefinitief": "ja",
"factuurtype": "Overschrijving",
"factuurverzendwijze": "E-mail",
"automatischFactureren": false,
"adviseur": "Achternaam, Voornaam (I.)",
"acceptant": "AchternaamTwee, Voornaam (V.)",
"acceptantWorkflowgroep": null,
"behandelaar": "Achternaam, Voornaam (I.)",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/contracten/6741"
}
},
"_embedded": {
"correspondentieadres": {
"id": 7793,
"straat": "Groenhof",
"nummer": "1",
"toevoeging": "",
"postcode": "1275BB",
"plaatsnaam": "Huizen",
"postcodegebied": "1275",
"longitude": "5.26394006",
"latitude": "52.28904947",
"categorie": "default",
"_embedded": {
"types": [
{
"id": 1,
"naam": "bezoekadres"
}
]
}
},
"aanvragers": [
{
"id": 120954,
"geslacht": "man",
"initialen": "A.",
"titel": "",
"voornaam": "Aad",
"tussenvoegsel": "",
"achternaam": "Jansen",
"bsn": "559795178",
"nationaliteitId": 1,
"burgerlijkestaatId": 1,
"weergavenaam": "Jansen, Aad (A.)",
"geboortedatum": "1960-01-01T00:00:00+01:00",
"pensioendatum": "2027-01-01T00:00:00+01:00",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/120954"
},
"adressen": {
"href": "/api/data/klantdossiers/5526/klanten/120954/adressen"
},
"emailadressen": {
"href": "/api/data/klantdossiers/5526/klanten/120954/emailadressen"
},
"rekeningnummers": {
"href": "/api/data/klantdossiers/5526/klanten/120954/rekeningnummers"
},
"telefoonnummers": {
"href": "/api/data/klantdossiers/5526/klanten/120954/telefoonnummers"
}
}
}
],
"productdelen": [
{
"id": 7902,
"product": "Contract",
"referentie": "cntr",
"verkoopprijs": "125.00",
"premietermijn": "eenmalig",
"contractduur": 12,
"hoofdvervaldatum": "2013-09-08T00:00:00+02:00",
"looptijdVerplichting": 6,
"vervaldatum": "2013-03-08T00:00:00+01:00"
}
]
}
}Contract toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/contracten?access_token={ACCESS_TOKEN}]
Wijzigingen met release 1.9.3
- eersteAanvrager accepteert nu ook een medewerker van de organisatie in aanvragerZakelijk.
Wijzigingen met release 1.9.12
- De velden factuurverzendwijze, factuurtype en automatischfactureren worden alleen overgenomen indien er van factureren vanuit de kaart gebruik wordt gemaakt.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/contracten?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"omschrijving": "Contract",
"status": {
"id": 1
},
"bestaandePropositie": {
"id": 3334
},
"accountmanager": {
"id": 112115
},
"administratieWorkflowgroep": {
"id": 45
},
"accountBeheerderWorkflowgroep": {
"id": 45
},
"bronvermelding": {
"id": 3
},
"aanbrengerPersoon": {
"id": 120956
},
"aanbrengerOrganisatie": {
"id": 14851
},
"aanvragersParticulier": [
{
"id": 120954
},
{
"id": 120955
}
],
"eersteAanvrager": {
"id": 120955
},
"correspondentieadres": {
"id": 7793
},
"contractnummer": "12345",
"contractDatum": "2016-01-01",
"contractDatumDefinitief": true,
"startdatum": "2016-01-01",
"startdatumDefinitief": true,
"eindeTekendatum": "2016-01-01",
"getekendContractOntvangen": "2016-01-01",
"dossierCompleet": "2016-01-01",
"finaalAkkoord": "2016-01-01",
"leverancier": {
"id": 14830
},
"inkoopVia": {
"id": 15100
},
"toelichting": "nvt",
"gearchiveerd": false,
"toonindigimap": true,
"factuurverzendwijze": "e-mail",
"factuurtype": "overschrijving",
"automatischfactureren": false
}Schema
{
"title": "Contract",
"type": "object",
"properties": {
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bestaandePropositie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"accountmanager": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"administratie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"administratieWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"accountBeheerder": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"accountBeheerderWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bronvermelding": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanbrengerPersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanbrengerOrganisatie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanvragerZakelijk": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanvragersParticulier": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"eersteAanvrager": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"correspondentieadres": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"contractnummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"contractDatum": {
"type": "string",
"format": "datatype-date"
},
"contractDatumDefinitief": {
"type": "boolean"
},
"startdatum": {
"type": "string",
"format": "datatype-date"
},
"startdatumDefinitief": {
"type": "boolean"
},
"eindeTekendatum": {
"type": "string",
"format": "datatype-date"
},
"getekendContractOntvangen": {
"type": "string",
"format": "datatype-date"
},
"dossierCompleet": {
"type": "string",
"format": "datatype-date"
},
"finaalAkkoord": {
"type": "string",
"format": "datatype-date"
},
"leverancier": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"inkoopVia": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"toelichting": {
"type": "string",
"minLength": 1
},
"gearchiveerd": {
"type": "boolean"
},
"toonindigimap": {
"type": "boolean"
}
},
"required": [
"bestaandePropositie",
"accountmanager",
"bronvermelding",
"eersteAanvrager",
"correspondentieadres",
"contractDatum",
"contractDatumDefinitief",
"startdatum",
"startdatumDefinitief",
"leverancier",
"inkoopVia",
"gearchiveerd",
"toonindigimap",
"status"
],
"oneOf": [
{
"required": [
"accountBeheerder"
]
},
{
"required": [
"accountBeheerderWorkflowgroep"
]
}
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/contracten/6757Contractdeel toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/contracten/{PRODUCT_ID}/delen?access_token={ACCESS_TOKEN}]
- De velden beloningpercentageadviseur en beloningpercentagedeelnemer worden alleen overgenomen indien er van factureren vanuit de kaart gebruik wordt gemaakt.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/contracten/6757/delen?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6757- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"artikel": {
"id": 16198
},
"referentie": "12345",
"kostprijs": 100,
"btw": {
"id": 5
},
"aantal": 1,
"verkoopprijs": 250,
"premietermijnverkoopprijs": "Maand",
"marge": 0,
"korting": 0,
"kortingtype": "Bedrag",
"incasso": 0,
"betalingstermijn": "Maand",
"looptijdverplichting": 12,
"vervaldatum": "2018-01-01",
"beloningpercentageadviseur": 10.5,
"beloningpercentagedeelnemer": 89.5
}Schema
{
"title": "Contractdeel",
"type": "object",
"properties": {
"artikel": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"referentie": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"kostprijs": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"btw": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aantal": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"verkoopprijs": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"premietermijnverkoopprijs": {
"enum": [
"Maand",
"Kwartaal",
"Semester",
"Jaar",
"2 maanden",
"Eenmalig"
]
},
"marge": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"korting": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"kortingtype": {
"enum": [
"Bedrag",
"Percentage"
]
},
"incasso": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"betalingstermijn": {
"enum": [
"Maand",
"Kwartaal",
"Semester",
"Jaar",
"2 maanden",
"Eenmalig"
]
},
"looptijdverplichting": {
"type": "integer",
"format": "datatype-int",
"minimum": 0
},
"vervaldatum": {
"type": "string",
"format": "datatype-date"
},
"beloningpercentagedeelnemer": {
"type": "number",
"multipleOf": 0.01,
"minimum": 0,
"maximum": 100
},
"beloningpercentageadviseur": {
"type": "number",
"multipleOf": 0.01,
"minimum": 0,
"maximum": 100
}
},
"required": [
"artikel",
"verkoopprijs",
"betalingstermijn",
"premietermijnverkoopprijs"
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/contracten/6757/delen/7919Contract registratie ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/contracten/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]&publiek={publiek}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/contracten/6757/registraties?access_token=3b57bd2db21c46d2875508b982968d26]&publiek=0
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6757- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26- publiek
int(optioneel) Voorbeeld: 0
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/contracten/6757/registraties"
}
},
"_embedded": {
"registraties": [
{
"omschrijving": "Er is een bestand geupload",
"onderwerp": "Koopakte grond geupload",
"publiek": false,
"factureerbaar": false,
"boekdatum": "2016-09-30T10:21:00+0200",
"gearchiveerd": false,
"verbruik": 0,
"id": 275825,
"registratietype": "E-mail/Brief",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/contracten/6757/registraties/275825"
},
"product": {
"href": "/api/data/klantdossiers/5526/contracten/6757"
},
"bestand": {
"href": "/api/data/klantdossiers/5526/documenten/2"
}
}
}
]
}
}Contract registratie toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/contracten/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/contracten/6757/registraties?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6757- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Klantdossier - Registratie toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/contracten/6757/registraties/275826Contract taak toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/contracten/{PRODUCT_ID}/taken?access_token={ACCESS_TOKEN}]
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/contracten/6755/taken?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6755- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"naam": "Naam van de afspraak",
"omschrijving": "Omschrijving van de taak",
"type": "Afspraak",
"status": {
"id": 1
},
"prioriteit": "Middel",
"startdatum": "2016-07-05 17:07:04",
"einddatum": "2016-07-05 18:07:04",
"afgerond": false,
"aanmaakdatum": "2016-07-05 16:00:00",
"initiator": {
"id": 112794
},
"genodigden": [
{
"id": 120954
},
{
"id": 120955
}
],
"verantwoordelijke": "WorkflowgroepMetPersoon",
"verantwoordelijkePersoon": {
"id": 112794
},
"verantwoordelijkeWorkflowgroep": {
"id": 45
}
}Schema
{
"title": "Taak",
"type": "object",
"properties": {
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"omschrijving": {
"type": "string",
"minLength": 1
},
"type": {
"enum": [
"Actie",
"Afspraak",
"Bellen",
"Bezichtiging",
"Doel",
"Klacht",
"Schade"
]
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"prioriteit": {
"enum": [
"Laag",
"Middel",
"Hoog"
]
},
"startdatum": {
"type": "string",
"format": "datatype-datetime"
},
"einddatum": {
"type": "string",
"format": "datatype-datetime"
},
"afgerond": {
"type": "boolean"
},
"aanmaakdatum": {
"type": "string",
"format": "datatype-datetime"
},
"initiator": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"genodigden": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"verantwoordelijke": {
"enum": [
"Persoon",
"Workflowgroep",
"WorkflowgroepMetPersoon"
]
},
"verantwoordelijkePersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verantwoordelijkeWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"required": [
"naam",
"type",
"status",
"prioriteit",
"startdatum",
"einddatum",
"verantwoordelijke"
],
"additionalProperties": false,
"oneOf": [
{
"properties": {
"verantwoordelijke": {
"enum": [
"Persoon"
]
}
},
"required": [
"verantwoordelijkePersoon"
]
},
{
"properties": {
"verantwoordelijke": {
"enum": [
"Workflowgroep"
]
}
},
"required": [
"verantwoordelijkeWorkflowgroep"
]
},
{
"properties": {
"verantwoordelijke": {
"enum": [
"WorkflowgroepMetPersoon"
]
}
},
"required": [
"verantwoordelijkePersoon",
"verantwoordelijkeWorkflowgroep"
]
}
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/contracten/6755/taken/55519Contract workflow toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/contracten/{PRODUCT_ID}/workflows?access_token={ACCESS_TOKEN}]
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/contracten/6757/workflows?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6757- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"workflow": {
"id": 21
}
}Schema
{
"properties": {
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"workflow"
]
}Response
204VerbergBekijk
Headers
Content-Type: application/jsonContract factuur toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/contracten/{PRODUCT_ID}/facturen?access_token={ACCESS_TOKEN}
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/contracten/6757/facturen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6757- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Factuur - Factuur toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/contracten/6757/facturen/1Contract factuurregel toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/contracten/{PRODUCT_ID}/facturen/{FACTUUR_ID}/regels?access_token={ACCESS_TOKEN}
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/contracten/6757/facturen/1/regels?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6757- FACTUUR_ID
int(verplicht) Voorbeeld: 1- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Factuur - Factuurregel toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/contracten/6757/facturen/1Dienst ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/diensten/{PRODUCT_ID}?access_token={ACCESS_TOKEN}
Wijzigingen met release 1.9.12
- De velden factuurverzendwijze en factuurtype worden alleen opgehaald indien er van factureren vanuit de kaart gebruik wordt gemaakt.
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/diensten/6734?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6734- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 6734,
"type": 43,
"offertenummer": "120",
"omschrijving": "Dienst",
"status": "Aanvraag nieuw",
"invoerAanvraag": "2016-07-11T00:00:00+02:00",
"maatschappij": "CO00014830",
"ingangsdatum": "2011-03-08T00:00:00+01:00",
"ingangsdatumDefinitief": "ja",
"factuurtype": "Overschrijving",
"factuurverzendwijze": "E-mail",
"adviseur": "Achternaam, Voornaam (I.)",
"acceptant": "AchternaamTwee, Voornaam (V.)",
"acceptantWorkflowgroep": null,
"behandelaar": "Achternaam, Voornaam (I.)",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/diensten/6734"
}
},
"_embedded": {
"correspondentieadres": {
"id": 7793,
"straat": "Groenhof",
"nummer": "1",
"toevoeging": "",
"postcode": "1275BB",
"plaatsnaam": "Huizen",
"postcodegebied": "1275",
"longitude": "5.26394006",
"latitude": "52.28904947",
"categorie": "default",
"_embedded": {
"types": [
{
"id": 1,
"naam": "bezoekadres"
}
]
}
},
"aanvragers": [
{
"id": 120954,
"geslacht": "man",
"initialen": "A.",
"titel": "",
"voornaam": "Aad",
"tussenvoegsel": "",
"achternaam": "Jansen",
"bsn": "559795178",
"nationaliteitId": 1,
"burgerlijkestaatId": 1,
"weergavenaam": "Jansen, Aad (A.)",
"geboortedatum": "1960-01-01T00:00:00+01:00",
"pensioendatum": "2027-01-01T00:00:00+01:00",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/120954"
}
}
}
],
"productdelen": [
{
"id": 7893,
"product": "Abonnement Comfort Family",
"omschrijving": "Abonnement comfort",
"betalingstermijn": "maand",
"verkoopprijs": "1.46",
"btw": "BTW 19% exclusief"
},
{
"id": 7895,
"product": "Advies - Doorstromer",
"omschrijving": "Hypotheekadvies",
"betalingstermijn": "eenmalig",
"verkoopprijs": "1500.00",
"btw": null
}
]
}
}Dienst toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/diensten?access_token={ACCESS_TOKEN}]
Wijzigingen met release 1.9.3
- eersteAanvrager accepteert nu ook een medewerker van de organisatie in aanvragerZakelijk.
Wijzigingen met release 1.9.12
- De velden factuurverzendwijze en factuurtype worden alleen overgenomen indien er van factureren vanuit de kaart gebruik wordt gemaakt.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/diensten?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"omschrijving": "Dienst",
"status": {
"id": 1
},
"bestaandePropositie": {
"id": 3334
},
"accountmanager": {
"id": 112115
},
"administratieWorkflowgroep": {
"id": 45
},
"accountBeheerderWorkflowgroep": {
"id": 45
},
"bronvermelding": {
"id": 3
},
"aanbrengerPersoon": {
"id": 120956
},
"aanbrengerOrganisatie": {
"id": 14851
},
"offertenummer": "12345",
"tekendatum": "2016-01-01",
"tekendatumDefinitief": true,
"opleverdatum": "2016-01-01",
"opleverdatumDefinitief": true,
"aanvragerRol": "Particulier",
"aanvragersParticulier": [
{
"id": 120954
},
{
"id": 120955
}
],
"eersteAanvrager": {
"id": 120954
},
"correspondentieadres": {
"id": 7793
},
"leverancier": {
"id": 14830
},
"inkoopVia": {
"id": 15100
},
"toelichting": "nvt",
"toonindigimap": true,
"gearchiveerd": false,
"factuurverzendwijze": "e-mail",
"factuurtype": "overschrijving"
}Schema
{
"title": "Dienst",
"type": "object",
"properties": {
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bestaandePropositie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"accountmanager": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"administratie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"administratieWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"accountBeheerder": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"accountBeheerderWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bronvermelding": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanbrengerPersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanbrengerOrganisatie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"offertenummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"tekendatum": {
"type": "string",
"format": "datatype-date"
},
"tekendatumDefinitief": {
"type": "boolean"
},
"opleverdatum": {
"type": "string",
"format": "datatype-date"
},
"opleverdatumDefinitief": {
"type": "boolean"
},
"aanvragerRol": {
"enum": [
"Particulier",
"Zakelijk"
]
},
"aanvragerZakelijk": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanvragersParticulier": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"eersteAanvrager": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"correspondentieadres": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"leverancier": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"inkoopVia": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"toelichting": {
"type": "string",
"minLength": 1
},
"toonindigimap": {
"type": "boolean"
},
"gearchiveerd": {
"type": "boolean"
}
},
"required": [
"toonindigimap",
"tekendatum",
"tekendatumDefinitief",
"opleverdatum",
"opleverdatumDefinitief",
"gearchiveerd",
"correspondentieadres",
"status",
"accountmanager",
"leverancier",
"bestaandePropositie",
"bronvermelding",
"inkoopVia",
"aanvragerRol",
"eersteAanvrager"
],
"oneOf": [
{
"required": [
"accountBeheerder"
]
},
{
"required": [
"accountBeheerderWorkflowgroep"
]
}
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/diensten/6754Dienstdeel toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/diensten/{PRODUCT_ID}/delen?access_token={ACCESS_TOKEN}]
- De velden beloningpercentageadviseur en beloningpercentagedeelnemer worden alleen overgenomen indien er van factureren vanuit de kaart gebruik wordt gemaakt.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/diensten/6754/delen?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6754- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"artikel": {
"id": 20615
},
"omschrijving": "Dienst",
"kostprijs": 80,
"btw": {
"id": 5
},
"aantalStuks": 1,
"verkoopprijs": 100,
"verkoopprijsTermijn": "Maand",
"marge": 0,
"kortingtype": "Bedrag",
"korting": 5,
"betalingstermijn": "Maand",
"looptijd": 1,
"hoofdvervaldatum": "2017-02-01",
"looptijdVerplichting": 100,
"vervaldatum": "2017-02-01",
"beloningpercentageadviseur": 15,
"beloningpercentagedeelnemer": 25
}Schema
{
"title": "Dienstdeel",
"type": "object",
"properties": {
"artikel": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"kostprijs": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"btw": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aantalStuks": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"verkoopprijs": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"verkoopprijsTermijn": {
"enum": [
"Maand",
"Kwartaal",
"Semester",
"Jaar",
"2 maanden",
"Eenmalig"
]
},
"marge": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"kortingtype": {
"enum": [
"Bedrag",
"Percentage"
]
},
"korting": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"betalingstermijn": {
"enum": [
"Maand",
"Kwartaal",
"Semester",
"Jaar",
"2 maanden",
"Eenmalig"
]
},
"betalingsprofiel": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"looptijd": {
"type": "integer",
"format": "datatype-int",
"minimum": 0
},
"hoofdvervaldatum": {
"type": "string",
"format": "datatype-date"
},
"looptijdVerplichting": {
"type": "integer",
"format": "datatype-int",
"minimum": 0
},
"vervaldatum": {
"type": "string",
"format": "datatype-date"
},
"beloningpercentagedeelnemer": {
"type": "number",
"multipleOf": 0.01,
"minimum": 0,
"maximum": 100
},
"beloningpercentageadviseur": {
"type": "number",
"multipleOf": 0.01,
"minimum": 0,
"maximum": 100
}
},
"required": [
"artikel",
"kostprijs",
"btw",
"aantalStuks",
"verkoopprijs",
"verkoopprijsTermijn",
"marge",
"betalingstermijn",
"looptijd",
"hoofdvervaldatum",
"looptijdVerplichting",
"vervaldatum"
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/diensten/6754/delen/7916Dienst registratie toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/diensten/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/diensten/6755/registraties?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6755- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Klantdossier - Registratie toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/diensten/6755/registraties/275826Dienst taak toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/diensten/{PRODUCT_ID}/taken?access_token={ACCESS_TOKEN}]
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/diensten/6755/taken?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6755- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"naam": "Naam van de afspraak",
"omschrijving": "Omschrijving van de taak",
"type": "Afspraak",
"status": {
"id": 1
},
"prioriteit": "Middel",
"startdatum": "2016-07-05 17:07:04",
"einddatum": "2016-07-05 18:07:04",
"afgerond": false,
"aanmaakdatum": "2016-07-05 16:00:00",
"initiator": {
"id": 112794
},
"genodigden": [
{
"id": 120954
},
{
"id": 120955
}
],
"verantwoordelijke": "WorkflowgroepMetPersoon",
"verantwoordelijkePersoon": {
"id": 112794
},
"verantwoordelijkeWorkflowgroep": {
"id": 45
}
}Schema
{
"title": "Taak",
"type": "object",
"properties": {
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"omschrijving": {
"type": "string",
"minLength": 1
},
"type": {
"enum": [
"Actie",
"Afspraak",
"Bellen",
"Bezichtiging",
"Doel",
"Klacht",
"Schade"
]
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"prioriteit": {
"enum": [
"Laag",
"Middel",
"Hoog"
]
},
"startdatum": {
"type": "string",
"format": "datatype-datetime"
},
"einddatum": {
"type": "string",
"format": "datatype-datetime"
},
"afgerond": {
"type": "boolean"
},
"aanmaakdatum": {
"type": "string",
"format": "datatype-datetime"
},
"initiator": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"genodigden": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"verantwoordelijke": {
"enum": [
"Persoon",
"Workflowgroep",
"WorkflowgroepMetPersoon"
]
},
"verantwoordelijkePersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verantwoordelijkeWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"required": [
"naam",
"type",
"status",
"prioriteit",
"startdatum",
"einddatum",
"verantwoordelijke"
],
"additionalProperties": false,
"oneOf": [
{
"properties": {
"verantwoordelijke": {
"enum": [
"Persoon"
]
}
},
"required": [
"verantwoordelijkePersoon"
]
},
{
"properties": {
"verantwoordelijke": {
"enum": [
"Workflowgroep"
]
}
},
"required": [
"verantwoordelijkeWorkflowgroep"
]
},
{
"properties": {
"verantwoordelijke": {
"enum": [
"WorkflowgroepMetPersoon"
]
}
},
"required": [
"verantwoordelijkePersoon",
"verantwoordelijkeWorkflowgroep"
]
}
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/diensten/6755/taken/55519Dienst workflow toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/diensten/{PRODUCT_ID}/workflows?access_token={ACCESS_TOKEN}]
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/diensten/6754/workflows?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6754- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"workflow": {
"id": 21
}
}Schema
{
"properties": {
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"workflow"
]
}Response
204VerbergBekijk
Headers
Content-Type: application/jsonDienst factuur toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/diensten/{PRODUCT_ID}/facturen?access_token={ACCESS_TOKEN}
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/diensten/6754/facturen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6754- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Factuur - Factuur toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/diensten/6754/facturen/1Dienst factuurregel toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/diensten/{PRODUCT_ID}/facturen/{FACTUUR_ID}/regels?access_token={ACCESS_TOKEN}
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/diensten/6754/facturen/1/regels?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6754- FACTUUR_ID
int(verplicht) Voorbeeld: 1- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Factuur - Factuurregel toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/diensten/6754/facturen/1Hypotheek ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/hypotheken/{PRODUCT_ID}?access_token={ACCESS_TOKEN}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheken/6732?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6732- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 6732,
"type": 1,
"offertenummer": "",
"omschrijving": "Hypotheek",
"status": "Aanvraag nieuw",
"invoerAanvraag": "2016-07-11T00:00:00+02:00",
"maatschappij": "ABN AMRO",
"passeerdatum": "2010-09-01T00:00:00+02:00",
"passeerdatumDefinitief": "nee",
"hoofdsom": "200000.00",
"inschrijving": "225000.00",
"renteaanbodAangevraagd": "2010-07-11T00:00:00+02:00",
"ontbindendeVoorwaarden": "2010-07-17T00:00:00+02:00",
"norm": "Geldverstrekker",
"adviseur": "Achternaam, Voornaam (I.)",
"acceptant": "AchternaamTwee, Voornaam (V.)",
"acceptantWorkflowgroep": null,
"behandelaar": "Achternaam, Voornaam (I.)",
"oorspronkelijkeHoofdsom": "250000.00",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/hypotheken/6732"
}
},
"_embedded": {
"onderpandadres": {
"id": 7790,
"straat": "Nieuwemarkt",
"nummer": "2",
"toevoeging": "",
"postcode": "3011HP",
"plaatsnaam": "Rotterdam",
"postcodegebied": "3011",
"longitude": null,
"latitude": null,
"categorie": "default",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/hypotheken/6732/adressen/7790"
}
},
"_embedded": {
"types": [
{
"id": 7,
"naam": "correspondentieadres"
},
{
"id": 7,
"naam": "correspondentieadres"
}
]
}
},
"correspondentieadres": {
"id": 7793,
"straat": "Groenhof",
"nummer": "1",
"toevoeging": "",
"postcode": "1275BB",
"plaatsnaam": "Huizen",
"postcodegebied": "1275",
"longitude": "5.26394006",
"latitude": "52.28904947",
"categorie": "default",
"_embedded": {
"types": [
{
"id": 1,
"naam": "bezoekadres"
}
]
}
},
"aanvrager": [
{
"id": 120954,
"geslacht": "man",
"initialen": "A.",
"titel": "",
"voornaam": "Aad",
"tussenvoegsel": "",
"achternaam": "Jansen",
"bsn": "559795178",
"nationaliteitId": 1,
"burgerlijkestaatId": 1,
"weergavenaam": "Jansen, Aad (A.)",
"geboortedatum": "1960-01-01T00:00:00+01:00",
"pensioendatum": "2027-01-01T00:00:00+01:00",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/120954"
}
}
},
{
"id": 120955,
"geslacht": "vrouw",
"initialen": "K.",
"titel": "",
"voornaam": "Kim",
"tussenvoegsel": "",
"achternaam": "Jansen - de Jong",
"bsn": "004864645",
"nationaliteitId": 1,
"burgerlijkestaatId": 1,
"weergavenaam": "Jansen - de Jong, Kim (K.)",
"geboortedatum": "1965-04-21T00:00:00+01:00",
"pensioendatum": "2032-04-21T00:00:00+02:00",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/120955"
}
}
}
],
"productdelen": [
{
"id": 7891,
"product": "ABN AMRO Aflossingsvrije hypotheek (ABN AMRO Basis Hypotheek - 2)",
"looptijd": 360,
"hypotheeknummer": "ABN-001",
"hypotheekvorm": "Aflossingsvrije hypotheek",
"deelHoofdsom": "80000.00",
"maandelijksBedrag": "400.00",
"einddatum": "2040-09-01T00:00:00+01:00",
"rentepercentage": "5.00",
"rentetype": "Rentevast",
"rentevastperiode": 240,
"rentevastEinddatum": "2030-09-01T00:00:00+02:00",
"rentekorting": "0.10",
"rentebedenktijd": null,
"oorspronkelijkeDeelHoofdsom": "85000.00"
},
{
"id": 7892,
"product": "ABN AMRO Spaargroeihypotheek (ABN AMRO Basis Hypotheek - 2)",
"looptijd": 360,
"hypotheeknummer": "0984-B",
"hypotheekvorm": "Spaarverzekering",
"deelHoofdsom": "120000.00",
"maandelijksBedrag": "0.00",
"einddatum": "2040-09-01T00:00:00+01:00",
"rentepercentage": "5.00",
"rentetype": "Rentevast",
"rentevastperiode": 240,
"rentevastEinddatum": "2030-09-01T00:00:00+02:00",
"rentekorting": null,
"rentebedenktijd": null,
"oorspronkelijkeDeelHoofdsom" "125000.00"
}
]
}
}Hypotheek toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/hypotheken?access_token={ACCESS_TOKEN}]
Wijzigingen met release 1.9.3
-
Het veld eersteAanvrager is deprecated. Gebruik hiervoor eersteAanvragerParticulier. Dit is gedaan om onderscheid te maken tussen particuliere en zakelijke klanten.
-
Het is mogelijk dit product te koppelen aan een zakelijke klant. Hiervoor dient de waarde aanvragerZakelijk gevuld te worden met het id van de zakelijke klant. Daarnaast kan de zakelijke klant ook als eerste aanvrager gemarkeerd worden. Gebruik hiervoor het veld eersteAanvragerZakelijk.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheken?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACCESS_TOKEN
string(verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"portefeuille": "Eigen beheer",
"omschrijving": "Omschrijving",
"status": {
"id": 1
},
"bestaandePropositie": {
"id": 3334
},
"propositietype": "Derde vervolghypotheek (nieuwe geldgever)",
"afgeslotenDoor": {
"id": 112115
},
"acceptantWorkflowgroep": {
"id": 45
},
"dossierVerantwoordelijkeWorkflowgroep": {
"id": 45
},
"bronvermelding": {
"id": 3
},
"aanbrengerPersoon": {
"id": 120956
},
"aanbrengerOrganisatie": {
"id": 14851
},
"offertenummer": "12345",
"renteaanbodAangevraagd": "2016-01-01",
"ontbindendeVoorwaarden": "2016-01-01",
"passeerdatum": "2016-01-01",
"passeerdatumDefinitief": true,
"ontvangstRenteaanbod": "2016-01-01",
"eindeTekendatumRenteaanbod": "2016-01-01",
"verloopdatumRenteaanbod": "2016-01-01",
"getekendRenteaanbodOntvangen": "2016-01-01",
"getekendRenteaanbodNaarMaatschappij": "2016-01-01",
"dossierCompleet": "2016-01-01",
"dossierCompleetNaarMaatschappij": "2016-01-01",
"finaalAkkoord": "2016-01-01",
"ontvangstHypotheekaanbod": "2016-01-01",
"eindeTekendatumHypotheekaanbod": "2016-01-01",
"verloopdatumHypotheekaanbod": "2016-01-01",
"getekendHypotheekaanbodOntvangen": "2016-01-01",
"getekendHypotheekaanbodNaarMaatschappij": "2016-01-01",
"dossierNaarNotaris": "2016-01-01",
"ontvangstAfrekening": "2016-01-01",
"afrekeningGecontroleerd": "2016-01-01",
"einddatumVerlenging": "2016-01-01",
"verhuisdatum": "2016-01-01",
"afgelegd": "2016-01-01",
"aanvragerZakelijk": {
"id": 16941
},
"aanvragersParticulier": [
{
"id": 120954
},
{
"id": 120955
}
],
"eersteAanvragerParticulier": {
"id": 120954
},
"maatschappij": {
"id": 14831
},
"inkoopVia": {
"id": 15100
},
"hoofdsom": 250000,
"norm": "NHG",
"borgtochtprovisieNHG": 100,
"risicoklasse": 100,
"risicoklassebepaling": "Marktwaarde",
"inschrijving": 300000,
"bankgarantieBenodigd": "Ja",
"bankgarantie": 2500,
"bankgarantieSteldatum": "2016-01-01",
"eenmaligeVergoeding": 0,
"koopsomWoonAOV": 100,
"koopsubsidie": true,
"koopsubsidieDossiercode": "Dossier Code",
"koopsubsidieTotaleContanteWaarde": 100,
"koopsubsidieBedrag": 100,
"koopsubsidieBedragPremietermijn": "Maand",
"starterslening": true,
"startersleningBedrag": 100,
"bestaandeHypotheek": true,
"bestaandeHypotheekHoofdsomBox1": 100,
"bestaandeHypotheekHoofdsomBox3": 100,
"bestaandeHypotheekStartdatum": "2016-01-01",
"bestaandeHypotheekRente": 100,
"bestaandeHypotheekBoeterente": 100,
"bestaandeHypotheekInschrijving": 100,
"bestaandeHypotheekNorm": "NHG",
"bestaandeHypotheekMaatschappij": "Aegon",
"notaris": {
"id": 16387
},
"verkopendeMakelaar": {
"id": 16389
},
"taxerendeMakelaar": {
"id": 16427
},
"onderpand": {
"id": 7790
},
"correspondentieadres": {
"id": 7793
},
"toelichting": "Dit is de toelichting",
"toonindigimap": true,
"gearchiveerd": false,
"oorspronkelijkeHoofdsom": "250000.00"
}Schema
{
"title": "Hypotheek",
"type": "object",
"properties": {
"portefeuille": {
"enum": [
"Eigen beheer",
"Extern beheer"
]
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bestaandePropositie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"propositietype": {
"enum": [
"Derde vervolghypotheek (nieuwe geldgever)",
"Derde vervolghypotheek (zelfde geldgever)",
"Doorgeefhypotheek",
"Eerste hypotheek (nieuw)",
"Interne oversluiting",
"Meeneemhypotheek",
"Omzetting",
"Omzetting en verhoging",
"Onderhands",
"Oversluiting",
"Oversluiting andere geldgever",
"Tweede of hoger in rang hypotheek",
"Tweede vervolghypotheek (nieuwe geldgever)",
"Tweede vervolghypotheek (zelfde geldgever)",
"Verbouwing",
"Vervolghypotheek (nieuwe geldgever)",
"Vervolghypotheek (zelfde geldgever)"
]
},
"afgeslotenDoor": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"acceptant": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"acceptantWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"dossierVerantwoordelijke": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"dossierVerantwoordelijkeWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bronvermelding": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanbrengerPersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanbrengerOrganisatie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"offertenummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"renteaanbodAangevraagd": {
"type": "string",
"format": "datatype-date"
},
"ontbindendeVoorwaarden": {
"type": "string",
"format": "datatype-date"
},
"passeerdatum": {
"type": "string",
"format": "datatype-date"
},
"passeerdatumDefinitief": {
"type": "boolean"
},
"ontvangstRenteaanbod": {
"type": "string",
"format": "datatype-date"
},
"eindeTekendatumRenteaanbod": {
"type": "string",
"format": "datatype-date"
},
"verloopdatumRenteaanbod": {
"type": "string",
"format": "datatype-date"
},
"getekendRenteaanbodOntvangen": {
"type": "string",
"format": "datatype-date"
},
"getekendRenteaanbodNaarMaatschappij": {
"type": "string"<