API (1.16.3)
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{?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?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
- 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"
},
"volgende": {
"href": "/api/data/klantdossiers?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers?pagina=5&per_pagina=20"
}
},
"_embedded": {
"klantdossiers": [
{
"omschrijving": "Price, Senior",
"aanmaakdatum": "2012-10-24T00:00:00+0200",
"relatienummer": "",
"laatsteBezoekdatum": "2020-10-24T00:00:00+0200",
"volgendeBezoekdatum": "2021-10-24T00:00:00+0200",
"notitie": "uw notitie",
"id": 1,
"dossiertype": "klantdossier",
"status": "Actief",
"_links": {
"self": {
"href": "/api/data/klantdossiers/1"
}
},
"_embedded": {
"standaardcorrespondentieadres": {
"id": 2779,
"straat": "Straatnaam",
"nummer": "1",
"toevoeging": "A",
"postcode": "1234AB",
"plaatsnaam": "Plaatsnaam",
"land": "NL",
"postcodegebied": "4611",
"longitude": "4.29358014",
"latitude": "51.49513316",
"categorie": "default"
},
"herkomst": {
"omschrijving": "waarde",
"url": "waarde"
}
}
},
{
"omschrijving": "Cole, Medior",
"aanmaakdatum": "2013-10-11T00:00:00+0200",
"relatienummer": "",
"laatsteBezoekdatum": null,
"volgendeBezoekdatum": null,
"notitie": "uw notitie",
"id": 2,
"dossiertype": "klantdossier",
"status": "Prospect",
"_links": {
"self": {
"href": "/api/data/klantdossiers/2"
}
}
},
{
"omschrijving": "Maldonado (P.), Maldonado, Dirjanne van (D.L.)",
"aanmaakdatum": "2019-08-19T15:20:50+0200",
"relatienummer": null,
"laatsteBezoekdatum": null,
"volgendeBezoekdatum": null,
"notitie": "uw notitie",
"id": 3,
"dossiertype": "klantdossier",
"status": "Actief",
"_links": {
"self": {
"href": "/api/data/klantdossiers/3"
}
},
"_embedded": {
"standaardcorrespondentieadres": {
"id": 2797,
"straat": "Straatnaam",
"nummer": "1",
"toevoeging": "A",
"postcode": "1234AB",
"plaatsnaam": "Plaatsnaam",
"land": "NL",
"postcodegebied": "2225",
"longitude": null,
"latitude": null,
"categorie": "default"
}
}
}
]
}
}Klantdossier ophalenGET/api/data/klantdossiers/{DOSSIER_ID}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"omschrijving": "Conner, Wouter (W)",
"aanmaakdatum": "2019-08-19T19:21:03+0200",
"relatienummer": null,
"laatsteBezoekdatum": "2019-08-19T19:21:03+0200",
"volgendeBezoekdatum": "2021-08-19T19:21:03+0200",
"notitie": "uw notitie",
"id": 5526,
"dossiertype": "klantdossier",
"status": "Actief",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526"
},
"overzicht": {
"href": "/api/data/klantdossiers/5526/overzicht"
},
"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"
},
"schademeldingen": {
"href": "/api/data/klantdossiers/5526/schademeldingen"
},
"events": {
"href": "/api/data/klantdossiers/5526/events"
},
"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": 8297,
"straat": "Straatnaam",
"nummer": "1",
"toevoeging": "A",
"postcode": "1234AB",
"plaatsnaam": "Plaatsnaam",
"land": "NL",
"postcodegebied": "2215",
"longitude": null,
"latitude": null,
"categorie": "default"
},
"herkomst": {
"omschrijving": "waarde",
"url": "waarde"
}
}
}NAWTE gegevens ophalen dossierGET/api/data/klantdossiers/{DOSSIER_ID}/overzicht
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/overzicht
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
Zakelijk
{
"omschrijving": "Webwinkel in huis- en tuinartikelen",
"aanmaakdatum": "2020-07-30T00:00:00+0200",
"relatienummer": null,
"laatsteBezoekdatum": null,
"volgendeBezoekdatum": "2020-07-30T00:00:00+0200",
"id": 27358,
"dossiertype": "klantdossier",
"status": "Actief",
"_links": {
"self": {
"href": "/api/data/klantdossiers/27358/overzicht"
}
},
"_embedded": {
"standaardcorrespondentieadres": {
"id": 42897,
"straat": "",
"nummer": "48",
"toevoeging": "",
"postcode": "2231CD",
"plaatsnaam": "",
"land": "NL",
"postcodegebied": "2231",
"longitude": null,
"latitude": null,
"categorie": "default",
"_embedded": {
"types": [
{
"id": 7,
"naam": "correspondentieadres",
"startdatum": null,
"einddatum": null
}
]
}
},
"klantenZakelijk": [
{
"id": 21573,
"type": "VOF",
"naam": "StayRelaxed Outdoor Living",
"kvknummer": "78115361",
"btwnummer": "",
"statutairenaam": "StayRelaxed Outdoor Living",
"handelsnaam": "StayRelaxed Outdoor Living",
"kleur1": null,
"kleur2": null,
"kleur3": null,
"kleur4": null,
"_links": {
"self": {
"href": ""
}
},
"_embedded": {
"adressen": [
{
"id": 42897,
"straat": "",
"nummer": "48",
"toevoeging": "",
"postcode": "2231CD",
"plaatsnaam": "",
"land": "NL",
"postcodegebied": "2231",
"longitude": null,
"latitude": null,
"categorie": "default",
"_embedded": {
"types": [
{
"id": 7,
"naam": "correspondentieadres",
"startdatum": null,
"einddatum": null
}
]
}
},
{
"id": 42937,
"straat": "Sandtlaan",
"nummer": "48",
"toevoeging": "",
"postcode": "2231CD",
"plaatsnaam": "Rijnsburg",
"land": "NL",
"postcodegebied": "2231",
"longitude": "4.43825082",
"latitude": "52.18945192",
"categorie": "default",
"_embedded": {
"types": [
{
"id": 7,
"naam": "correspondentieadres",
"startdatum": null,
"einddatum": null
}
]
}
}
],
"telefoonnummers": [
{
"id": 105130,
"naam": "0623745325",
"omschrijving": "",
"weergavenaam": "0623745325",
"_embedded": {
"types": [
{
"id": 5,
"naam": "mobiel"
}
]
}
},
{
"id": 80754,
"naam": "0623745325",
"omschrijving": null,
"weergavenaam": "0623745325",
"_embedded": {
"types": [
{
"id": 6,
"naam": "zakelijk"
}
]
}
}
],
"emailadressen": [
{
"id": 53524,
"naam": "info@stayrelaxed.nl",
"omschrijving": "",
"_embedded": {
"types": [
{
"id": 1,
"naam": "Zakelijk"
}
]
}
},
{
"id": 54581,
"naam": "info@stayrelaxed.nl",
"omschrijving": "",
"_embedded": {
"types": [
{
"id": 2,
"naam": "Prive"
}
]
}
}
]
}
}
]
}
}
Particulier
{
"omschrijving": "Wieland, Johan-Jan (JJ), Meesters, Sandrina (SK)",
"aanmaakdatum": "2021-03-08T00:00:00+0100",
"relatienummer": null,
"id": 27383,
"dossiertype": "klantdossier",
"status": "Actief",
"_links": {
"self": {
"href": "/api/data/klantdossiers/27383/overzicht"
}
},
"_embedded": {
"standaardcorrespondentieadres": {
"id": 42953,
"straat": "Straatnaam",
"nummer": "1",
"toevoeging": "A",
"postcode": "1234AB",
"plaatsnaam": "Plaatsnaam",
"land": "NL",
"postcodegebied": "5555",
"longitude": null,
"latitude": null,
"categorie": "default"
},
"klantenParticulier": [
{
"id": 148991,
"geslacht": "man",
"initialen": "JJ",
"titel": null,
"voornaam": "Johan-Jan",
"volledigeVoornamen": "",
"tussenvoegsel": "",
"achternaam": "Wieland",
"nationaliteitId": 1,
"nationaliteit": "Nederlandse",
"burgerlijkestaatId": 1,
"burgerlijkestaat": "Gehuwd (gemeenschap van goederen)",
"weergavenaam": "Wieland, Johan-Jan (JJ)",
"geboortedatum": "1966-12-16T00:00:00+01:00",
"pensioendatum": null,
"overleden": "nee",
"datumOverlijden": null,
"_embedded": {
"adressen": [
{
"id": 42953,
"straat": "Straatnaam",
"nummer": "1",
"toevoeging": "A",
"postcode": "1234AB",
"plaatsnaam": "Plaatsnaam",
"land": "NL",
"postcodegebied": "1234",
"longitude": null,
"latitude": null,
"categorie": "default",
"_embedded": {
"types": [
{
"id": 7,
"naam": "correspondentieadres",
"startdatum": null,
"einddatum": null
}
]
}
},
{
"id": 43953,
"straat": "",
"nummer": "6",
"toevoeging": "",
"postcode": "5555MM",
"plaatsnaam": "",
"land": "NL",
"postcodegebied": "5555",
"longitude": "0.00000000",
"latitude": "0.00000000",
"categorie": "default",
"_embedded": {
"types": [
{
"id": 1,
"naam": "bezoekadres",
"startdatum": null,
"einddatum": null
},
{
"id": 3,
"naam": "factuuradres",
"startdatum": "2021-01-01T00:00:00+01:00",
"einddatum": "2021-07-01T00:00:00+02:00"
}
]
}
}
],
"telefoonnummers": [
{
"id": 105143,
"naam": "0352210402",
"omschrijving": null,
"weergavenaam": "0352210402",
"_embedded": {
"types": [
{
"id": 1,
"naam": "algemeen"
}
]
}
}
],
"emailadressen": [
{
"id": 53581,
"naam": "xxx@hotmailxxx.com",
"omschrijving": null,
"_embedded": {
"types": [
{
"id": 3,
"naam": "Algemeen"
}
]
}
}
]
}
},
{
"id": 148992,
"geslacht": "vrouw",
"initialen": "SK",
"titel": null,
"voornaam": "Persoon",
"volledigeVoornamen": "",
"tussenvoegsel": "",
"achternaam": "Meesters",
"nationaliteitId": 1,
"nationaliteit": "Nederlandse",
"burgerlijkestaatId": 1,
"burgerlijkestaat": "Gehuwd (gemeenschap van goederen)",
"weergavenaam": "Meesters, Persoon (SK)",
"geboortedatum": "1970-09-27T00:00:00+01:00",
"pensioendatum": null,
"overleden": "nee",
"datumOverlijden": null,
"_embedded": {
"adressen": [
{
"id": 42953,
"straat": "Straatnaam",
"nummer": "1",
"toevoeging": "A",
"postcode": "1234AB",
"plaatsnaam": "Plaatsnaam",
"land": "NL",
"postcodegebied": "5555",
"longitude": null,
"latitude": null,
"categorie": "default",
"_embedded": {
"types": [
{
"id": 7,
"naam": "correspondentieadres",
"startdatum": null,
"einddatum": null
}
]
}
}
],
"telefoonnummers": [
{
"id": 105143,
"naam": "0252210402",
"omschrijving": null,
"weergavenaam": "0252210402",
"_embedded": {
"types": [
{
"id": 1,
"naam": "algemeen"
}
]
}
}
],
"emailadressen": [
{
"id": 53581,
"naam": "xxx@hotmailxxx.com",
"omschrijving": null,
"_embedded": {
"types": [
{
"id": 3,
"naam": "Algemeen"
}
]
}
}
]
}
}
]
}
}Response
404VerbergBekijk
Headers
Content-Type: text/jsonKlantdossier toevoegenPOST/api/data/klantdossiers/
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/
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
},
"notitie": "plaats hier uw notitie"
}Schema
{
"definitions": {
"dossier": {
"type": "object",
"properties": {
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"aanmaakdatum": {
"type": "string",
"format": "date-time"
},
"relatienummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"dossierstatus": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"kantoor": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"standaardCorrespondentieadres": {
"type": "integer",
"minimum": 1
},
"notitie": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false,
"required": [
"omschrijving",
"dossierstatus",
"kantoor"
]
}
}
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526Actie collectieGET/api/data/klantdossiers/{DOSSIER_ID}/acties
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/acties
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/13987/acties"
},
"eerste": {
"href": "/api/data/klantdossiers/13987/acties?pagina=1&per_pagina=20"
},
"vorige": {
"href": "/api/data/klantdossiers/13987/acties?pagina=1&per_pagina=20"
}
},
"_embedded": {
"acties": [
{
"omschrijving": "Ja",
"aanmaakdatum": "2022-06-10T11:30:43+0200",
"id": 53806,
"actie": "Basis & Verz",
"_links": {
"self": {
"href": "/api/data/klantdossiers/13987/acties/53806"
}
}
},
{
"omschrijving": "Gaat er nog over denken, later terug bellen",
"aanmaakdatum": "2022-06-10T11:30:49+0200",
"id": 53807,
"actie": "Klant heeft interesse in makelaardij",
"_links": {
"self": {
"href": "/api/data/klantdossiers/13987/acties/53807"
}
}
}
]
}
}Actie ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/acties/{ACTIE_ID}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/acties/8400
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ACTIE_ID
int(verplicht) Voorbeeld: 8400
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"omschrijving": "Basis & Verz.",
"aanmaakdatum": "2020-05-15T10:12:00+0200",
"id": 8400,
"actie": "Relatiecode",
"_links": {
"self": {
"href": "/api/data/klantdossiers/13987/acties/8400"
}
}
}Actie toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/acties
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/acties
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"actie": {
"id": 1
},
"omschrijving": "Omschrijving van de actie"
}Schema
{
"properties": {
"actie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bezittingen/overige
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
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": "date"
},
"aankoopwaarde": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"huidigeWaardeDatum": {
"type": "string",
"format": "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",
"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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bezittingen/voertuigen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
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",
"jaarkilometrage" : 100,
"alarminstallatie": "Fabriek ingebouwd alarm klasse 1",
"bedragAudiovisueleApparatuur": 0.00,
"gebruikParticulierOfZakelijk": "Particulier"
}
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": "date"
},
"aankoopwaardeIncBtw": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"aankoopwaardeExBtw": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"aankoopwaardeBtw": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"huidigeWaardeDatum": {
"type": "string",
"format": "date"
},
"huidigeWaarde": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"kenteken": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"bouwjaar": {
"type": "string",
"format": "date"
},
"gewicht": {
"type": "integer",
"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",
"minimum": 1
},
"aantalPk": {
"type": "integer",
"minimum": 1
},
"meldcode": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"cilinderinhoud": {
"type": "integer",
"minimum": 1
},
"kmstand": {
"type": "string",
"minLength": 1,
"maxLength": 7
},
"ottCode": {
"type": "string",
"minLength": 1,
"maxLength": 25
},
"jaarkilometrage": {
"type": "integer",
"minimum": 1
},
"bedragAudiovisueleApparatuur": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"bezittingtype": {
"enum": [
"Auto",
"Caravan",
"Brommer",
"Motor",
"Boot",
"Fiets",
"Aanhangwagen",
"Vrachtwagen"
]
},
"bootType": {
"enum": [
"Anders",
"Catamaran",
"Charterboot",
"Jetski",
"Kajuit motorboot",
"Kajuit zeilboot",
"Kano",
"Kite (board + kite)",
"Motor sportboot - snelvarend",
"Motor sportboot / speedboot",
"Motor sportboot",
"Motor-sailer",
"Motorboot",
"Motorjacht",
"Motorvrachtschip",
"Motorzeiljacht",
"Opblaas boot",
"Open Trimaran",
"Open boot",
"Open motorboot",
"Open zeilboot",
"Platbodem",
"Powerboat (RIB)",
"Roeiboot",
"Rubberboot",
"Sleepschip met duwbak",
"Sleep- en duwboot",
"Sloep",
"Sportcruiser",
"Supboard (board + paddle)",
"Surf-, zeilplank",
"Trimaran",
"Visboot",
"Vlet",
"Waterscooter",
"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",
"BearLock (SCM klasse ST mechanisch)",
"BearLock + SCM klasse 1",
"BearLock + SCM klasse 2",
"BearLock + SCM klasse 3",
"BearLock + SCM klasse 4",
"BearLock + SCM klasse 5"
]
},
"gebruikParticulierOfZakelijk": {
"enum": [
"Particulier",
"Zakelijk",
"Onbekend"
]
},
"hagelbestendigDak": {
"enum": [
"Ja",
"Nee",
"Onbekend"
]
},
"brandstof": {
"enum": [
"Onbekend",
"Benzine",
"Diesel",
"Elektrisch",
"Hybride",
"LPG",
"Waterstof"
]
},
"gebruikAlsStacaravan": {
"type": "boolean"
},
"isBedrijfsAuto": {
"type": "boolean"
},
"isGrijsKenteken ": {
"type": "boolean"
},
"btwMargeAuto ": {
"enum": [
"Onbekend",
"BTW",
"Marge"
]
},
"staat": {
"enum": [
"Occasion",
"Nieuw",
"Import"
]
},
"chassisNummer": {
"type": "string",
"minLength": 1,
"maxLength": 17
}
},
"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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bezittingen/voertuig
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
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": "date"
},
"aankoopwaardeIncBtw": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"aankoopwaardeExBtw": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"aankoopwaardeBtw": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"huidigeWaardeDatum": {
"type": "string",
"format": "date"
},
"huidigeWaarde": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"kenteken": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"bouwjaar": {
"type": "string",
"format": "date"
},
"gewicht": {
"type": "integer",
"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",
"minimum": 1
},
"aantalPk": {
"type": "integer",
"minimum": 1
},
"meldcode": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"cilinderinhoud": {
"type": "integer",
"minimum": 1
},
"kmstand": {
"type": "string",
"minLength": 1,
"maxLength": 7
},
"ottCode": {
"type": "string",
"minLength": 1,
"maxLength": 25
},
"jaarkilometrage": {
"type": "integer",
"minimum": 1
},
"bedragAudiovisueleApparatuur": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"bezittingtype": {
"enum": [
"Auto",
"Caravan",
"Brommer",
"Motor",
"Boot",
"Fiets",
"Aanhangwagen",
"Vrachtwagen"
]
},
"bootType": {
"enum": [
"Anders",
"Catamaran",
"Charterboot",
"Jetski",
"Kajuit motorboot",
"Kajuit zeilboot",
"Kano",
"Kite (board + kite)",
"Motor sportboot - snelvarend",
"Motor sportboot / speedboot",
"Motor sportboot",
"Motor-sailer",
"Motorboot",
"Motorjacht",
"Motorvrachtschip",
"Motorzeiljacht",
"Opblaas boot",
"Open Trimaran",
"Open boot",
"Open motorboot",
"Open zeilboot",
"Platbodem",
"Powerboat (RIB)",
"Roeiboot",
"Rubberboot",
"Sleepschip met duwbak",
"Sleep- en duwboot",
"Sloep",
"Sportcruiser",
"Supboard (board + paddle)",
"Surf-, zeilplank",
"Trimaran",
"Visboot",
"Vlet",
"Waterscooter",
"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",
"BearLock (SCM klasse ST mechanisch)",
"BearLock + SCM klasse 1",
"BearLock + SCM klasse 2",
"BearLock + SCM klasse 3",
"BearLock + SCM klasse 4",
"BearLock + SCM klasse 5"
]
},
"gebruikParticulierOfZakelijk": {
"enum": [
"Particulier",
"Zakelijk",
"Onbekend"
]
},
"hagelbestendigDak": {
"enum": [
"Ja",
"Nee",
"Onbekend"
]
},
"brandstof": {
"enum": [
"Onbekend",
"Benzine",
"Diesel",
"Elektrisch",
"Hybride",
"LPG",
"Waterstof"
]
},
"gebruikAlsStacaravan": {
"type": "boolean"
},
"isBedrijfsAuto": {
"type": "boolean"
},
"isGrijsKenteken ": {
"type": "boolean"
},
"btwMargeAuto ": {
"enum": [
"Onbekend",
"BTW",
"Marge"
]
},
"staat": {
"enum": [
"Occasion",
"Nieuw",
"Import"
]
},
"chassisNummer": {
"type": "string",
"minLength": 1,
"maxLength": 17
}
},
"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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/panden
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
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",
"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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/proposities
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
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&publiek={PUBLIEK}&gearchiveerd={GEARCHIVEERD}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/registraties&publiek=1&gearchiveerd=0
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- 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",
"volledigeVoornamen": "",
"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",
"volledigeVoornamen": "",
"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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/registraties
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
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",
"verbruik": 4,
"activiteit": {
"id": 1
},
"registratietype": {
"id": 7
},
"systeemregistratie": false,
"persoon": {
"id": 112794
},
"urgent": false
}Schema
{
"title": "Registratie",
"type": "object",
"properties": {
"omschrijving": {
"type": "string",
"minLength": 1
},
"onderwerp": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"registratiedatum": {
"type": "string",
"format": "date"
},
"boekdatum": {
"type": "string",
"format": "date"
},
"activiteit": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"registratietype": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"systeemregistratie": {
"type": "boolean"
},
"persoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"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}
Voorbeeld URI
PATCH https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"standaardCorrespondentieadres": {
"id": 1
}
}Schema
{
"properties": {
"standaardCorrespondentieadres": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"standaardCorrespondentieadres"
]
}Response
200VerbergBekijk
Headers
Content-Type: text/htmlWorkflowstarter uitvoerenPOST/api/data/klantdossiers/{DOSSIER_ID}/workflowstarters
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/workflowstarters
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Systeem starter voor Nationale Hypotheekbond
{
"type": "systeem",
"naam": "hypotheekbond"
}
Eigen starter voor koppeling met website
{
"type": "eigen",
"naam": "website"
}Schema
{
"title": "Workflowstarter",
"type": "object",
"properties": {
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"type": {
"enum": [
"systeem",
"eigen"
]
}
},
"additionalProperties": false,
"required": [
"naam",
"type"
]
}Response
200Response
404VerbergBekijk
Headers
Content-Type: text/jsonResponse
409VerbergBekijk
Headers
Content-Type: text/jsonBody
{
"error": "Geen workflow gekoppeld aan deze workflowstarter",
"url": "?data=zTWfb40FxUAHjaVtKrs77RF2iElsTB7pq5ZmC2COPmuyBmEdFXaiI%2ByirMPSzybkapw6%2Fh8frO0qo4yEKYXvjQ%3D%3D"
}Workflowbericht inschietenPOST/api/data/klantdossiers/{DOSSIER_ID}/workflowbericht
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/workflowbericht
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"parameter": "waarde"
}Schema
{
"title": "Workflowbericht",
"type": "object",
"properties": {
"parameter": {
"type": "string",
"minLength": 1,
"maxLength": 50
}
},
"additionalProperties": false,
"required": [
"parameter"
]
}Response
200Volmacht verzekering gebeurtenis insturenPOST/api/data/klantdossiers/{DOSSIER_ID}/volmachtverzekeringen/{VOLMACHT_VERZEKERING_ID}/gebeurtenissen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/volmachtverzekeringen/2345/gebeurtenissen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- VOLMACHT_VERZEKERING_ID
int(verplicht) Voorbeeld: 2345
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"gebeurtenis":4,
"verzekeringId":2345,
"polisnummer":"6613134234",
"branchecode":"021",
"voertuigOmschrijving":"Volkswagen Golf V5 GTI",
"voertuigKenteken":"XXX-99-X",
"regelmatigeBestuurderOmschrijving":"Klaassen, Jan",
}Schema
{
"properties": {
"gebeurtenis": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
},
"verzekeringId": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
},
"polisnummer": {
"type": "string"
},
"pakketnummer": {
"type": "string"
},
"branchecode": {
"type": "string"
},
"voertuigOmschrijving": {
"type": "string"
},
"voertuigKenteken": {
"type": "string"
},
"objectOmschrijving": {
"type": "string"
},
"objectPostcode": {
"type": "string"
},
"objectHuisnummer": {
"type": "string"
},
"objectToevoeging": {
"type": "string"
},
"regelmatigeBestuurderOmschrijving": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"gebeurtenis"
]
}Response
200Response
403VerbergBekijk
Headers
Content-Type: text/jsonBody
{
"error": "Volmacht verzekeringen worden niet gesynchroniseerd"
}Response
404VerbergBekijk
Headers
Content-Type: text/jsonResponse
409VerbergBekijk
Headers
Content-Type: text/jsonBody
{
"error": "Geen workflow gekoppeld voor deze gebeurtenis"
}Volmacht scenario gebeurtenis insturenPOST/api/data/klantdossiers/{DOSSIER_ID}/volmachtverzekeringscenarios/{VOLMACHT_SCENARIO_ID}/gebeurtenissen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/volmachtverzekeringscenarios/2345/gebeurtenissen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- VOLMACHT_SCENARIO_ID
int(verplicht) Voorbeeld: 2345
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"gebeurtenis": 4
}Schema
{
"properties": {
"gebeurtenis": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": false,
"required": [
"gebeurtenis"
]
}Response
200Response
403VerbergBekijk
Headers
Content-Type: text/jsonBody
{
"error": "Volmacht verzekeringen worden niet gesynchroniseerd"
}Response
404VerbergBekijk
Headers
Content-Type: text/jsonResponse
409VerbergBekijk
Headers
Content-Type: text/jsonBody
{
"error": "Geen workflow gekoppeld voor deze gebeurtenis"
}Volmacht verzekering schademelding gebeurtenis insturenPOST/api/data/klantdossiers/{DOSSIER_ID}/volmachtverzekeringen/{VOLMACHT_VERZEKERING_ID}/schademeldingen/{SCHADEMELDING_ID}/gebeurtenissen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/volmachtverzekeringen/2345/schademeldingen/1234/gebeurtenissen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- VOLMACHT_VERZEKERING_ID
int(verplicht) Voorbeeld: 2345- SCHADEMELDING_ID
int(verplicht) Voorbeeld: 1234
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"gebeurtenis":4,
"verzekeringId":2345,
"polisnummer":"6613134234",
"branchecode":"021",
"voertuigOmschrijving":"Volkswagen Golf V5 GTI",
"voertuigKenteken":"XXX-99-X",
"regelmatigeBestuurderOmschrijving":"Klaassen, Jan",
}Schema
{
"properties": {
"gebeurtenis": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
},
"verzekeringId": {
"type": "integer",
"format": "datatype-int",
"minimum": 1
},
"polisnummer": {
"type": "string"
},
"pakketnummer": {
"type": "string"
},
"branchecode": {
"type": "string"
},
"voertuigOmschrijving": {
"type": "string"
},
"voertuigKenteken": {
"type": "string"
},
"objectOmschrijving": {
"type": "string"
},
"objectPostcode": {
"type": "string"
},
"objectHuisnummer": {
"type": "string"
},
"objectToevoeging": {
"type": "string"
},
"regelmatigeBestuurderOmschrijving": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"gebeurtenis"
]
}Response
200Response
403VerbergBekijk
Headers
Content-Type: text/jsonBody
{
"error": "Volmacht verzekeringen worden niet gesynchroniseerd"
}Response
404VerbergBekijk
Headers
Content-Type: text/jsonResponse
409VerbergBekijk
Headers
Content-Type: text/jsonBody
{
"error": "Geen workflow gekoppeld voor deze gebeurtenis"
}Overige partijen ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/overigepartijen
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/overigepartijen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/klanten/particulier?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/klanten/particulier?pagina=31&per_pagina=20"
}
},
"_embedded": {
"overigepartijen": [
{
"id": 145201,
"geslacht": "man",
"initialen": "G.C.",
"titel": "heer",
"voornaam": "",
"volledigeVoornamen": "",
"tussenvoegsel": "",
"achternaam": "Ramirez",
"nationaliteitId": null,
"nationaliteit": null,
"burgerlijkestaatId": 4,
"burgerlijkestaat": "Samenwonend met samenlevingscontract",
"weergavenaam": "Ramirez (G.C.)",
"geboortedatum": "1984-04-09T00:00:00+02:00",
"pensioendatum": null,
"overleden": "nee",
"datumOverlijden": null,
"geboorteplaats": null,
"burgerlijkestaatdatum": null,
"voormaligHuwelijkOpgeheven": null,
"gezinssamenstelling": null,
"roker": null,
"dossierrol": 24,
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/145201"
}
}
},
{
"id": 129703,
"geslacht": "vrouw",
"initialen": "J.",
"titel": "mevrouw",
"voornaam": "",
"volledigeVoornamen": "",
"tussenvoegsel": "",
"achternaam": "Ramirez",
"nationaliteitId": null,
"nationaliteit": null,
"burgerlijkestaatId": 5,
"burgerlijkestaat": "Samenwonend zonder samenlevingscontract",
"weergavenaam": "Ramirez (J.)",
"geboortedatum": "1984-05-13T00:00:00+02:00",
"pensioendatum": null,
"overleden": "nee",
"datumOverlijden": null,
"geboorteplaats": null,
"burgerlijkestaatdatum": null,
"voormaligHuwelijkOpgeheven": null,
"gezinssamenstelling": null,
"roker": null,
"dossierrol": 25,
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/129703"
}
}
}
]
}
}Klant - particulier ¶
Klant collectieGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/klanten/particulier?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/klanten/particulier?pagina=31&per_pagina=20"
}
},
"_embedded": {
"particulier": [
{
"id": 120954,
"geslacht": "man",
"initialen": "A.",
"titel": "",
"voornaam": "Aad",
"volledigeVoornamen": "",
"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",
"volledigeVoornamen": "",
"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}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 120954,
"geslacht": "man",
"initialen": "A.",
"titel": "",
"voornaam": "Aad",
"volledigeVoornamen": "",
"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,
"geboorteplaats": "ROTTERDAM",
"burgerlijkestaatdatum": "1995-01-01T00:00:00+01:00",
"voormaligHuwelijkOpgeheven": "1990-01-01T00:00:00+01:00",
"gezinssamenstelling": "Zelfstandig met partner",
"roker": "nee",
"dossierrol": "Eerste persoon",
"voorkeurstaal": "nld",
"_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&rol={ROL_NAAM}
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier&rol=eerste-persoon
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ROL_NAAM
string(verplicht) Voorbeeld: eerste-persoonKeuzen:
eerste-persoonpartnerkind
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"geslacht": "Man",
"initialen": "J.",
"titel": "dhr",
"voornaam": "Jan",
"volledigeVoornamen": "",
"tussenvoegsel": "de",
"achternaam": "Nijs",
"bsn": "695803888",
"geboortedatum": "1980-01-25",
"voorkeurstaal": "nld"
}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": "date"
},
"geboorteplaats": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"geslacht": {
"enum": [
"Man",
"Vrouw",
"X"
]
},
"voorkeurstaal": {
"enum": [
"nld",
"eng"
]
},
"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": "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\"]"
}
]
}
}Overige partij toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier&dossierrol_id={DOSSIERROL_ID}
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier&dossierrol_id=23
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- DOSSIERROL_ID
int(verplicht) Voorbeeld: 23
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"geslacht": "Man",
"initialen": "J.",
"titel": "dhr",
"voornaam": "Jan",
"volledigeVoornamen": "",
"tussenvoegsel": "de",
"achternaam": "Nijs",
"bsn": "695803888",
"geboortedatum": "1980-01-25"
}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": "date"
},
"geboorteplaats": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"geslacht": {
"enum": [
"Man",
"Vrouw",
"X"
]
},
"voorkeurstaal": {
"enum": [
"nld",
"eng"
]
},
"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": "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}
Voorbeeld URI
PATCH https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120967
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120967
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
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/adressen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/adressen"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/adressen?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/adressen?pagina=31&per_pagina=20"
}
},
"_embedded": {
"adressen": [
{
"id": 7790,
"straat": "Nieuwemarkt",
"nummer": "2",
"toevoeging": "",
"postcode": "3011HP",
"plaatsnaam": "Rotterdam",
"land": "NL",
"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}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/adressen/7790
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954- ADRES_ID
int(verplicht) Voorbeeld: 7790
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 7790,
"straat": "Nieuwemarkt",
"nummer": "2",
"toevoeging": "",
"postcode": "3011HP",
"plaatsnaam": "Rotterdam",
"land": "NL",
"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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120955/adressen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120955
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
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/emailadressen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/emailadressen"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/emailadressen?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/emailadressen?pagina=31&per_pagina=20"
}
},
"_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}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/emailadressen/40555
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954- EMAILADRES_ID
int(verplicht) Voorbeeld: 40555
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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/emailadressen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954
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",
"minimum": 1
},
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"type": {
"enum": [
"Zakelijk",
"Prive",
"Algemeen"
]
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"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
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/kenmerken
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/kenmerken"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/kenmerken?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/kenmerken?pagina=31&per_pagina=20"
}
},
"_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}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/kenmerken/4
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954- KENMERK_ID
int(verplicht) Voorbeeld: 4
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
Zowel vraag als omschrijving zijn optioneel.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/kenmerken
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- 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",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"vraag": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"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
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/profielfoto
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- 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
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/profielfoto/download
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954
Response
200VerbergBekijk
Headers
Content-Type: image/pngBody
<binary data>Response
404VerbergBekijk
Headers
Content-Type: application/jsonProfielfoto binary uploadenPOST/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/profielfoto
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/profielfoto
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954
Request
VerbergBekijk
Body
{
"naam": "fasterforward.png",
"extensie": "png",
"data": "iVBORw0KGgoAAAANSUhEUgAAAP0AAAAbCAYAAAC3KIljAAAKsElEQVR42u2dC3BVxRnH82gCISQk
0ZYEUHTCDBrBBJESmbakVMI7Kj4KDFhGwlBtlUzk2RYIAUGbalHEYnl4DdACSSB1EhsBBwTpRAUa
ERIVWu4QCO88KTQ3Cem/M19mvjmze3bPuWdyL/F+M7/Jze73fbvnsv9z9uzZE4LanbP6oID5xNLT
Rx8A7V6SFRSw2/Hffg1oB26VLzTanz58N0WP/o4CxQIiA6IPWBcVfa/vuuhnApHF3MaivwjSbNIv
KGBdWvQ07nsHRN+1RO8OClhA9CYWuNIHRB+wgOi9E3BA9AHRBywg+v/nDwEPgxdAHtgEXODPYDmY
Du61kC8UjABzwevARawFL4NHQXhniB6+3cFEsAxspH68AWaD/g5+h2HgByC0s0WPnNHgWbAefAj2
g50gBwzvokIKBengFVAI9oKPwFawGAzupH50A0kgFQwC3f1a9MjRAywGF4GOlYNxJvm6gYWa+erA
CtDTkCMXVBBnJbFfMZ8KSV+iwGrQAMysFNxvcky/BmsMjGT1o0EZuEn5TnWW6JErDCwF1ym3jM/A
MJM8mcAFMg3lI8A68Dlwg35UnkP+uZr9nAlcxFAN/yjm/7Sg/jFwBrQrKAEJJu3kUhvprCwEPA62
gePgU0nsRLAHeAxttoAykO53okf8APA1sGMLBPl6gsM2clWCeJbHZTWBoC8PgTO68STYKZLv6YDA
PwuES/rq7gzRI08vcIgNtisk0NlgKpgP9rF6D5guyeUiHxebORQIRHQP1f+efm8DsRp9Pc5yvKHh
/yTzH22oy2Z1jeA98Dx4BsyiK/9XzKcKREraqSCfLPp9ADhqOGa3ISYS7DL41FCub0ErK98AQn0t
en6FrwLe2FBDzg3Arh1wQvQUnwIagFVrAxkWRL8NtPtC9DSQ9rLBtRb0kPimgjNMpOPMRE+D+guW
+xIoBBtBHMvZTkxT9LWfQSCVGsf3HvnWgjBWngzaqG4/iJfEB4OFrM0lKtGT4K+wmNN0tV9lmMof
ZD47QJLgVisT1JDP2/4i+nmSnCUgFcSCaJBsMrjfYvniQIvApwwMB5EgBgwFWyT5HvV2ek+zjX8L
/G+Bj2m6vwwUAY/A7xrorSH6/QDmM9G/xAbeK1SsEl41+V8A0Saif7ujnzTNDZaI6jz5/UXRdib5
NbA+323iHwIukV++oW4DlV8DcRrHvZ/8TypEPw8coc+HQarEfxU7hsWKtu9kJ89PnBJ9G6iwwECW
74gg35cgVLQoJ5kq72E+44HI+kqOZ5/AN8/bhTxaIzBaA0gT+A4GV6QnMy56PWsBzRqiPwtiLBLF
7+PZVaQChGqeKCawAZstEf1B0EpT3DsU+dZSTJ1ZH9hU+E3gps9zTPyHs35mGOrOUfk6zWNeQP7N
CtGX0898ECbxjQfN5Ldbs/0+oIlifPKcPoXluwTqDbxs0v7fhFNytTjHSPI9DooN/Nau6Mk3AtQK
fJ8yOa7pAv8mEKkp+kawkD8FoL45vQ23guV5ipVPsjhDOExxp0WiJ+rBXRq5fsZiRposNDaSzxiw
jj4Xm+RdQT7XQYRhau0m2NqEepZBRMtETxwD4aoTCDHQwne+1Leit2E01T+vEP04ILL/gFwwSLtB
+6KfJPCrBsEm+cNBnSAuQ0P0TUD9WMh50a+nssvgexZFP4cvyklEv9zCusJVismT+Iyk+hugO5tt
NDGByYRYEOSlddyqEDEK0Y9R5PoH+R222Ie7/V709NjtfjAZrGaCNxN9FGhUtH8RFIL54IcgxGHR
vyrwqwJZCv4liMvREP08m5tzakCKRQYKVsKLbYjgPjYAn5GIfoCFfJsoplJSv5rqP6DfI8BNKhul
WPSb4sVTjWFgJWjVFP1lEGL2aJT1O9dGn75xSvS3gNsCSZINJRPAH2lwn7Oz4k65ZlCfdO0q2AyS
HRJ9AXDKtitE3wrifLEjjy1yvWojNoTf1wtEX2cx30SWL9FEVM+zslIq+4PA/5dU1wyiNe6Xp4E8
UAz+CWpBO8OjKfoPLTyB+LmN732XvzynnwJqHHjMxnOOBacs5rkFXgPBXop+H3DKPlKI/oSvtuGy
q9cim/H1FJ8jEH2Vjd1oDRSbJRBlO9Gflf+Kyo4L8pVQXYlJm+Npqn2LfDlN4CjYSu3M1RT9+4rj
HMz3Ddj4zjf6wyO7bGBmHnAC7ARzQJmG6PmW3nSwBlQCXVvipegLgVN2QCH6Ml+Jnl3NVtiMb6H4
BQLRV9jIt51i9xrKn6PyE4bye5iA+rFyPvWfZbbIxzgEfgfSQV/RTkBN0bsUx5jE8oy18R25fCp6
xPUBHsnC1HKQAkINMcVSYajb+z54jG4hzipWwiO8EP16gd9eu+JSiL7Yh6I/RXnybcQmsMH7nEOi
f5pNpaNZeaFskQ9lJ6kuk5VNYhuI7hDEjGV9P6LYW++06Pn3NsPGd1Tqa9G/JMmXahJTqhS9fvs/
pQ00IhvmheizBH7nu6Dod1Ceb2zETmaDd4hDou/JrtBPUlkou41IE8TkUd0uwVOJjyXtFFH9VRCr
2bcsh0QfzI7ndRvfUbWvRf+WINfXiphvFVPg/aDewFSTfCOByNI0RR8ryDlI4vuI4tieAC4DyX4r
eronJlJsnTBoQ40Toqf4Dwx793/E9saHCfzTeD0IZhtvXpS0cZrqN1no12YnRE++e8hXoBX1eoAP
RK+cBrsVV2bVfe92QX2BSc40Sc4HNEU/SJL3C4HvMRAl8U8WbOipBz38WPRx7Mq63ULcQLaa/SYV
OyX6Z9lLPyFgJf1eJPEP4zMBMIQJo48ohp0U3tHsUyyoc1D0s4SbkdRx7/qD6H8jyTdb4PsTcEHi
Xy7Z2cYtB4Qbct4Fjgp8L4EQg+80Sd5PwFQwHszQ2A58CswG94G+tE8gD9wQ+C7z2+k9WcfONmKi
hn8oa98DEh0WfRxbIEwFx9i6gdDYW3yrwRL6XG7iX04+lSBEYzqeT/5OiT4SXGNrCmEaMQ+DVtDm
a9EPATKrAgWgCJwEZlbFd7aZvKZbC0rBNnAIeCR+ixS3Abpv2W0Edq0SRNwGoo9jV74bYJLinruQ
DX7a7uyQ6MnYW3+b+FVbY5GtAnxOn+eb+Ofyt+YU7+JvIb8tfA1DIXqr23r/CrqZ+A4BF8h3sz88
stsBrFitaIed4AWWq8COlYEwyTbZy6pgQcxuYNXOgUQ/X8jj+R7s2AZLFIEJIAHEgAdANqhmPvkg
2GnR84017Kp2TOHfu+NZO/uZqHhrjR/vbjCKyuNpHWEluEz1pSCO5a4GO0GKXdFTzJ9YH06CX4A+
7LXaH5NPS8dJFsz0B9H3An/XfHPsNTBZUh9vyJtIeXXtJuUPN+lrBmi2+Ec0gkE2aARKoz4n+N3q
vTpnInuJxoybYJFB8E6LPsGwYWalRgx/b/+4hv9w9kqvGVtBOMVsM9SleSn6YBKyR9GHho7bG5+I
XiGoXYb99ddooC8D95JfDMgR8KAk70NgFThouFJ7gBuUgLkgXrOfSeBduoVoNpyUzpnExYAXSdQ1
hheBvgTvgEf8/pGdehCOo8HtZsK7Dj4DSwE7oTkuep7nUzboR2j45zD/pRb+HuB82pXXxGYKbppy
pwnWMzJAFngB3OmN6Flsf7AKHAX/ZSfXcrDI0E4KyLHyn5X8D8jtDvnJzJ4qAAAAAElFTkSuQmCC"
}Schema
{
"properties": {
"data": {
"type": "string",
"minLength": 1
},
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"extensie": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"aanmaakdatum": {
"type": "string",
"format": "date"
}
},
"additionalProperties": false,
"required": [
"data",
"naam",
"extensie"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/particulier/120954/profielfotoResponse
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"total": 1,
"message": "Validatie fouten",
"_links": {
"help": {
"href": "http://api.fasterforward.nl/",
"title": "Validatie informatie"
}
},
"_embedded": {
"errors": [
{
"path": "/extensie",
"message": "bestand.extensie.verplicht"
}
]
}
}Rekeningnummer collectieGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/rekeningnummers
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/rekeningnummers
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/rekeningnummers"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/rekeningnummers?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/rekeningnummers?pagina=31&per_pagina=20"
}
},
"_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}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/rekeningnummers/1959
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954- REKENINGNUMMER_ID
int(verplicht) Voorbeeld: 1959
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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/rekeningnummers
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954
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",
"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
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/socialmedia
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/socialmedia"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/socialmedia?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/socialmedia?pagina=31&per_pagina=20"
}
},
"_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}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/socialmedia/1
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954- SOCIALMEDIA_ID
int(verplicht) Voorbeeld: 1
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
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/telefoonnummers
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/telefoonnummers"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/telefoonnummers?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/telefoonnummers?pagina=31&per_pagina=20"
}
},
"_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}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/telefoonnummers/76403
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954- TELEFOONNUMMER_ID
int(verplicht) Voorbeeld: 76403
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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/telefoonnummers
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954
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",
"minimum": 1
},
"naam": {
"type": "string",
"pattern": "^[0-9 ()+-]{1,255}$"
},
"type": {
"enum": [
"Algemeen",
"Storingsnummer",
"Fax",
"Mobiel",
"Zakelijk",
"Skype"
]
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"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/76411Schadevrije jaren ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/schadevrijejaren
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/schadevrijejaren
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/schadevrijejaren"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/schadevrijejaren?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954/schadevrijejaren?pagina=31&per_pagina=20"
}
},
"_embedded": {
"schadevrijejaren": [
{
"id": 2,
"aantalJaren": 2,
"omschrijving": "Omschrijving 2",
"aanmaakDatum": "2020-12-21T15:13:40+01:00",
"vervalDatum": "2020-12-30T00:00:00+01:00"
},
{
"id": 1,
"aantalJaren": 10,
"omschrijving": "Omschrijving 1",
"aanmaakDatum": "2020-12-21T09:07:34+01:00",
"vervalDatum": null
}
]
}
}Klantonderzoek ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/klantonderzoek
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/klantonderzoek
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120954
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"identificatieVerificatie": {
"resultaat": "In behandeling",
"aanmaakdatum": "2022-10-28T16:05:22+02:00"
},
"PEPEnSanctiecheck": {
"resultaat": "Bevinding",
"aanmaakdatum": "2022-10-31T08:35:15+01:00"
},
"doelEnAardeRelatie": {
"resultaat": null,
"aanmaakdatum": null
},
"verklaringInbrengEigenVermogen": {
"resultaat": "Goed",
"aanmaakdatum": null
},
"identificatieUrl": "https://wwft.debiteurenzeker.nl/public/person/identitycheck/dcf98e66-9d6e-4507-b9cf-64e5a9c4937e",
"_links": {
"self": {
"href": "/api/data/klantdossiers/28390/klanten/particulier/150998/klantonderzoek"
}
}
}Klant - zakelijk ¶
Klant collectieGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk?pagina=31&per_pagina=20"
}
},
"_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}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- KLANT_ID
int(verplicht) Voorbeeld: 14835
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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
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
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/adressen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/adressen"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/adressen?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/adressen?pagina=31&per_pagina=20"
}
},
"_embedded": {
"adressen": [
{
"id": 9,
"straat": "Straatnaam",
"nummer": "1",
"toevoeging": "",
"postcode": "1234AB",
"plaatsnaam": "Plaatsnaam",
"land": "NL",
"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}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/adressen/9
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835- ADRES_ID
int(verplicht) Voorbeeld: 9
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 9,
"straat": "Straatnaam",
"nummer": "1",
"toevoeging": "",
"postcode": "1234AB",
"plaatsnaam": "Plaatsnaam",
"land": "NL",
"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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14917/adressen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14917
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
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/emailadressen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/emailadressen"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/emailadressen?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/emailadressen?pagina=31&per_pagina=20"
}
},
"_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}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/emailadressen/35969
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835- EMAILADRES_ID
int(verplicht) Voorbeeld: 35969
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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/16941/emailadressen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 16941
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",
"minimum": 1
},
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"type": {
"enum": [
"Zakelijk",
"Prive",
"Algemeen"
]
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"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
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/kenmerken
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/kenmerken"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/kenmerken?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/kenmerken?pagina=31&per_pagina=20"
}
},
"_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}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/kenmerken/5
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835- ORGANISATIEKENMERK_ID
int(verplicht) Voorbeeld: 5
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"
}
}
}Kenmerk toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/kenmerken
Zowel de vraag als omschrijving zijn optioneel.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/120954/kenmerken
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 120954
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"vraag": {
"id": 3
},
"kenmerk": {
"id": 3
},
"omschrijving": "kenmerk omschrijving"
}Schema
{
"title": "OrganisatieKenmerk",
"type": "object",
"properties": {
"kenmerk": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"vraag": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"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/zakelijk/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\"]"
}
]
}
}Medewerker toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/medewerkers
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14917/medewerkers
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14917
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": "date"
},
"geboorteplaats": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"geslacht": {
"enum": [
"Man",
"Vrouw",
"X"
]
},
"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": "date"
},
"functie": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
}
},
"additionalProperties": false,
"required": [
"achternaam",
"functie"
]
},
{
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"functie": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/16941/medewerkers/112794/emailadressen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 16941- PERSOON_ID
int(verplicht) Voorbeeld: 112794
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",
"minimum": 1
},
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"type": {
"enum": [
"Zakelijk",
"Prive",
"Algemeen"
]
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/16941/medewerkers/112794/rekeningnummers
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 16941- PERSOON_ID
int(verplicht) Voorbeeld: 112794
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",
"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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/16941/medewerkers/112794/telefoonnummers
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 16941- PERSOON_ID
int(verplicht) Voorbeeld: 112794
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",
"minimum": 1
},
"naam": {
"type": "string",
"pattern": "^[0-9 ()+-]{1,255}$"
},
"type": {
"enum": [
"Algemeen",
"Storingsnummer",
"Fax",
"Mobiel",
"Zakelijk",
"Skype"
]
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"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
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/profielfoto
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- 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
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/profielfoto/download
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835
Response
200VerbergBekijk
Headers
Content-Type: image/pngBody
<binary data>Response
404VerbergBekijk
Headers
Content-Type: application/jsonProfielfoto binary uploadenPOST/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/profielfoto
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/profielfoto
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835
Request
VerbergBekijk
Body
{
"naam": "fasterforward.png",
"extensie": "png",
"data": "iVBORw0KGgoAAAANSUhEUgAAAP0AAAAbCAYAAAC3KIljAAAKsElEQVR42u2dC3BVxRnH82gCISQk
0ZYEUHTCDBrBBJESmbakVMI7Kj4KDFhGwlBtlUzk2RYIAUGbalHEYnl4DdACSSB1EhsBBwTpRAUa
ERIVWu4QCO88KTQ3Cem/M19mvjmze3bPuWdyL/F+M7/Jze73fbvnsv9z9uzZE4LanbP6oID5xNLT
Rx8A7V6SFRSw2/Hffg1oB26VLzTanz58N0WP/o4CxQIiA6IPWBcVfa/vuuhnApHF3MaivwjSbNIv
KGBdWvQ07nsHRN+1RO8OClhA9CYWuNIHRB+wgOi9E3BA9AHRBywg+v/nDwEPgxdAHtgEXODPYDmY
Du61kC8UjABzwevARawFL4NHQXhniB6+3cFEsAxspH68AWaD/g5+h2HgByC0s0WPnNHgWbAefAj2
g50gBwzvokIKBengFVAI9oKPwFawGAzupH50A0kgFQwC3f1a9MjRAywGF4GOlYNxJvm6gYWa+erA
CtDTkCMXVBBnJbFfMZ8KSV+iwGrQAMysFNxvcky/BmsMjGT1o0EZuEn5TnWW6JErDCwF1ym3jM/A
MJM8mcAFMg3lI8A68Dlwg35UnkP+uZr9nAlcxFAN/yjm/7Sg/jFwBrQrKAEJJu3kUhvprCwEPA62
gePgU0nsRLAHeAxttoAykO53okf8APA1sGMLBPl6gsM2clWCeJbHZTWBoC8PgTO68STYKZLv6YDA
PwuES/rq7gzRI08vcIgNtisk0NlgKpgP9rF6D5guyeUiHxebORQIRHQP1f+efm8DsRp9Pc5yvKHh
/yTzH22oy2Z1jeA98Dx4BsyiK/9XzKcKREraqSCfLPp9ADhqOGa3ISYS7DL41FCub0ErK98AQn0t
en6FrwLe2FBDzg3Arh1wQvQUnwIagFVrAxkWRL8NtPtC9DSQ9rLBtRb0kPimgjNMpOPMRE+D+guW
+xIoBBtBHMvZTkxT9LWfQSCVGsf3HvnWgjBWngzaqG4/iJfEB4OFrM0lKtGT4K+wmNN0tV9lmMof
ZD47QJLgVisT1JDP2/4i+nmSnCUgFcSCaJBsMrjfYvniQIvApwwMB5EgBgwFWyT5HvV2ek+zjX8L
/G+Bj2m6vwwUAY/A7xrorSH6/QDmM9G/xAbeK1SsEl41+V8A0Saif7ujnzTNDZaI6jz5/UXRdib5
NbA+323iHwIukV++oW4DlV8DcRrHvZ/8TypEPw8coc+HQarEfxU7hsWKtu9kJ89PnBJ9G6iwwECW
74gg35cgVLQoJ5kq72E+44HI+kqOZ5/AN8/bhTxaIzBaA0gT+A4GV6QnMy56PWsBzRqiPwtiLBLF
7+PZVaQChGqeKCawAZstEf1B0EpT3DsU+dZSTJ1ZH9hU+E3gps9zTPyHs35mGOrOUfk6zWNeQP7N
CtGX0898ECbxjQfN5Ldbs/0+oIlifPKcPoXluwTqDbxs0v7fhFNytTjHSPI9DooN/Nau6Mk3AtQK
fJ8yOa7pAv8mEKkp+kawkD8FoL45vQ23guV5ipVPsjhDOExxp0WiJ+rBXRq5fsZiRposNDaSzxiw
jj4Xm+RdQT7XQYRhau0m2NqEepZBRMtETxwD4aoTCDHQwne+1Leit2E01T+vEP04ILL/gFwwSLtB
+6KfJPCrBsEm+cNBnSAuQ0P0TUD9WMh50a+nssvgexZFP4cvyklEv9zCusJVismT+Iyk+hugO5tt
NDGByYRYEOSlddyqEDEK0Y9R5PoH+R222Ie7/V709NjtfjAZrGaCNxN9FGhUtH8RFIL54IcgxGHR
vyrwqwJZCv4liMvREP08m5tzakCKRQYKVsKLbYjgPjYAn5GIfoCFfJsoplJSv5rqP6DfI8BNKhul
WPSb4sVTjWFgJWjVFP1lEGL2aJT1O9dGn75xSvS3gNsCSZINJRPAH2lwn7Oz4k65ZlCfdO0q2AyS
HRJ9AXDKtitE3wrifLEjjy1yvWojNoTf1wtEX2cx30SWL9FEVM+zslIq+4PA/5dU1wyiNe6Xp4E8
UAz+CWpBO8OjKfoPLTyB+LmN732XvzynnwJqHHjMxnOOBacs5rkFXgPBXop+H3DKPlKI/oSvtuGy
q9cim/H1FJ8jEH2Vjd1oDRSbJRBlO9Gflf+Kyo4L8pVQXYlJm+Npqn2LfDlN4CjYSu3M1RT9+4rj
HMz3Ddj4zjf6wyO7bGBmHnAC7ARzQJmG6PmW3nSwBlQCXVvipegLgVN2QCH6Ml+Jnl3NVtiMb6H4
BQLRV9jIt51i9xrKn6PyE4bye5iA+rFyPvWfZbbIxzgEfgfSQV/RTkBN0bsUx5jE8oy18R25fCp6
xPUBHsnC1HKQAkINMcVSYajb+z54jG4hzipWwiO8EP16gd9eu+JSiL7Yh6I/RXnybcQmsMH7nEOi
f5pNpaNZeaFskQ9lJ6kuk5VNYhuI7hDEjGV9P6LYW++06Pn3NsPGd1Tqa9G/JMmXahJTqhS9fvs/
pQ00IhvmheizBH7nu6Dod1Ceb2zETmaDd4hDou/JrtBPUlkou41IE8TkUd0uwVOJjyXtFFH9VRCr
2bcsh0QfzI7ndRvfUbWvRf+WINfXiphvFVPg/aDewFSTfCOByNI0RR8ryDlI4vuI4tieAC4DyX4r
eronJlJsnTBoQ40Toqf4Dwx793/E9saHCfzTeD0IZhtvXpS0cZrqN1no12YnRE++e8hXoBX1eoAP
RK+cBrsVV2bVfe92QX2BSc40Sc4HNEU/SJL3C4HvMRAl8U8WbOipBz38WPRx7Mq63ULcQLaa/SYV
OyX6Z9lLPyFgJf1eJPEP4zMBMIQJo48ohp0U3tHsUyyoc1D0s4SbkdRx7/qD6H8jyTdb4PsTcEHi
Xy7Z2cYtB4Qbct4Fjgp8L4EQg+80Sd5PwFQwHszQ2A58CswG94G+tE8gD9wQ+C7z2+k9WcfONmKi
hn8oa98DEh0WfRxbIEwFx9i6gdDYW3yrwRL6XG7iX04+lSBEYzqeT/5OiT4SXGNrCmEaMQ+DVtDm
a9EPATKrAgWgCJwEZlbFd7aZvKZbC0rBNnAIeCR+ixS3Abpv2W0Edq0SRNwGoo9jV74bYJLinruQ
DX7a7uyQ6MnYW3+b+FVbY5GtAnxOn+eb+Ofyt+YU7+JvIb8tfA1DIXqr23r/CrqZ+A4BF8h3sz88
stsBrFitaIed4AWWq8COlYEwyTbZy6pgQcxuYNXOgUQ/X8jj+R7s2AZLFIEJIAHEgAdANqhmPvkg
2GnR84017Kp2TOHfu+NZO/uZqHhrjR/vbjCKyuNpHWEluEz1pSCO5a4GO0GKXdFTzJ9YH06CX4A+
7LXaH5NPS8dJFsz0B9H3An/XfHPsNTBZUh9vyJtIeXXtJuUPN+lrBmi2+Ec0gkE2aARKoz4n+N3q
vTpnInuJxoybYJFB8E6LPsGwYWalRgx/b/+4hv9w9kqvGVtBOMVsM9SleSn6YBKyR9GHho7bG5+I
XiGoXYb99ddooC8D95JfDMgR8KAk70NgFThouFJ7gBuUgLkgXrOfSeBduoVoNpyUzpnExYAXSdQ1
hheBvgTvgEf8/pGdehCOo8HtZsK7Dj4DSwE7oTkuep7nUzboR2j45zD/pRb+HuB82pXXxGYKbppy
pwnWMzJAFngB3OmN6Flsf7AKHAX/ZSfXcrDI0E4KyLHyn5X8D8jtDvnJzJ4qAAAAAElFTkSuQmCC"
}Schema
{
"properties": {
"data": {
"type": "string",
"minLength": 1
},
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"extensie": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"aanmaakdatum": {
"type": "string",
"format": "date"
}
},
"additionalProperties": false,
"required": [
"data",
"naam",
"extensie"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/zakelijk/112794/profielfotoResponse
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"total": 1,
"message": "Validatie fouten",
"_links": {
"help": {
"href": "http://api.fasterforward.nl/",
"title": "Validatie informatie"
}
},
"_embedded": {
"errors": [
{
"path": "/extensie",
"message": "bestand.extensie.verplicht"
}
]
}
}Rekeningnummer collectieGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/rekeningnummers
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/rekeningnummers
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/rekeningnummers"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/rekeningnummers?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/rekeningnummers?pagina=31&per_pagina=20"
}
},
"_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}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/rekeningnummers/1962
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835- REKENINGNUMMER_ID
int(verplicht) Voorbeeld: 1962
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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/16941/rekeningnummers
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 16941
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",
"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
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/telefoonnummers
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/telefoonnummers"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/telefoonnummers?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/telefoonnummers?pagina=31&per_pagina=20"
}
},
"_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}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/telefoonnummers/69304
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835- TELEFOONNUMMER_ID
int(verplicht) Voorbeeld: 69304
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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/16941/telefoonnummers
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 16941
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",
"minimum": 1
},
"naam": {
"type": "string",
"pattern": "^[0-9 ()+-]{1,255}$"
},
"type": {
"enum": [
"Algemeen",
"Storingsnummer",
"Fax",
"Mobiel",
"Zakelijk",
"Skype"
]
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"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}}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/16319/codes?access_token={ACCESS_TOKEN}}
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 16319
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/16319/codes"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/16319/codes?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/klanten/zakelijk/16319/codes?pagina=31&per_pagina=20"
}
},
"_embedded": {
"codes": [
{
"id": 465,
"code": "123",
"omschrijving": "",
"afgiftedatum": "2018-06-26T00:00:00+02:00",
"type": "Vestigingsnummer"
}
]
}
}Schadevrije jaren ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/schadevrijejaren
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5531/klanten/zakelijk/16944/schadevrijejaren
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5531- ORGANISATIE_ID
int(verplicht) Voorbeeld: 16944
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5531/klanten/zakelijk/16944/schadevrijejaren"
},
"volgende": {
"href": "/api/data/klantdossiers/5531/klanten/zakelijk/16944/schadevrijejaren?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5531/klanten/zakelijk/16944/schadevrijejaren?pagina=31&per_pagina=20"
}
},
"_embedded": {
"schadevrijejaren": [
{
"id": 3,
"aantalJaren": 1,
"omschrijving": "dit is een test",
"aanmaakDatum": "2020-12-23T15:30:03+01:00",
"vervalDatum": "2020-12-10T00:00:00+01:00"
}
]
}
}Adviseur ¶
Adviseur collectieGET/api/data/klantdossiers/{DOSSIER_ID}/adviseurs
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/adviseurs"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/adviseurs?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/adviseurs?pagina=31&per_pagina=20"
}
},
"_embedded": {
"adviseurs": [
{
"id": 112115,
"geslacht": "man",
"initialen": "I.",
"titel": "",
"voornaam": "Voornaam",
"volledigeVoornamen": "",
"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}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ADVISEUR_ID
int(verplicht) Voorbeeld: 112115
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 112115,
"geslacht": "man",
"initialen": "I.",
"titel": "",
"voornaam": "Voornaam",
"volledigeVoornamen": "",
"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
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/adressen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ADVISEUR_ID
int(verplicht) Voorbeeld: 112115
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/adressen"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/adressen?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/adressen?pagina=31&per_pagina=20"
}
},
"_embedded": {
"adressen": [
{
"id": 7791,
"straat": "Bagijnenstraat",
"nummer": "5",
"toevoeging": "",
"postcode": "3011HA",
"plaatsnaam": "Rotterdam",
"land": "NL",
"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}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/adressen/7792
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ADVISEUR_ID
int(verplicht) Voorbeeld: 112115- ADRES_ID
int(verplicht) Voorbeeld: 7792
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 7792,
"straat": "Bagijnenstraat",
"nummer": "5",
"toevoeging": "",
"postcode": "3011HA",
"plaatsnaam": "Rotterdam",
"land": "NL",
"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
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/emailadressen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ADVISEUR_ID
int(verplicht) Voorbeeld: 112115
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/emailadressen"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/emailadressen?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/emailadressen?pagina=31&per_pagina=20"
}
},
"_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}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/emailadressen/35897
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ADVISEUR_ID
int(verplicht) Voorbeeld: 112115- EMAILADRES_ID
int(verplicht) Voorbeeld: 35897
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
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/profielfoto
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ADVISEUR_ID
int(verplicht) Voorbeeld: 112115
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
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/profielfoto/download
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ADVISEUR_ID
int(verplicht) Voorbeeld: 112115
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
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/rekeningnummers
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ADVISEUR_ID
int(verplicht) Voorbeeld: 112115
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/rekeningnummers"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/rekeningnummers?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/rekeningnummers?pagina=31&per_pagina=20"
}
},
"_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}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/rekeningnummers/1958
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ADVISEUR_ID
int(verplicht) Voorbeeld: 112115- REKENINGNUMMER_ID
int(verplicht) Voorbeeld: 1958
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
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/telefoonnummers
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ADVISEUR_ID
int(verplicht) Voorbeeld: 112115
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/telefoonnummers"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/telefoonnummers?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/adviseurs/112115/telefoonnummers?pagina=31&per_pagina=20"
}
},
"_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}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/telefoonnummers/75383
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ADVISEUR_ID
int(verplicht) Voorbeeld: 112115- TELEFOONNUMMER_ID
int(verplicht) Voorbeeld: 75383
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
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/kantoor
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
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
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/kantoor/adressen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/kantoor/adressen"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/kantoor/adressen?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/kantoor/adressen?pagina=31&per_pagina=20"
}
},
"_embedded": {
"adressen": [
{
"id": 7791,
"straat": "Nieuwemarkt",
"nummer": "3",
"toevoeging": "",
"postcode": "3011HP",
"plaatsnaam": "Rotterdam",
"land": "NL",
"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}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/kantoor/adressen/7791
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ADRES_ID
int(verplicht) Voorbeeld: 7791
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 7791,
"straat": "Nieuwemarkt",
"nummer": "3",
"toevoeging": "",
"postcode": "3011HP",
"plaatsnaam": "Rotterdam",
"land": "NL",
"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
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/kantoor/emailadressen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/kantoor/emailadressen"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/kantoor/emailadressen?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/kantoor/emailadressen?pagina=31&per_pagina=20"
}
},
"_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}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/kantoor/emailadressen/40557
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- EMAILADRES_ID
int(verplicht) Voorbeeld: 40557
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
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/kantoor/profielfoto
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
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
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/kantoor/profielfoto/download
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Response
200VerbergBekijk
Headers
Content-Type: image/pngBody
<binary data>Response
404VerbergBekijk
Headers
Content-Type: application/jsonTelefoonnummer collectieGET/api/data/klantdossiers/{DOSSIER_ID}/kantoor/telefoonnummers
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/kantoor/telefoonnummers
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/kantoor/telefoonnummers"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/kantoor/telefoonnummers?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/kantoor/telefoonnummers?pagina=31&per_pagina=20"
}
},
"_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}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/kantoor/telefoonnummers/76408
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- TELEFOONNUMMER_ID
int(verplicht) Voorbeeld: 76408
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
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/kantoor/codes
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/kantoor/codes"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/kantoor/codes?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/kantoor/codes?pagina=31&per_pagina=20"
}
},
"_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&gearchiveerd={GEARCHIVEERD}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bezittingen&gearchiveerd=0
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- GEARCHIVEERD
boolean(optioneel) Voorbeeld: 0
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/bezittingen"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/bezittingen?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/bezittingen?pagina=31&per_pagina=20"
}
},
"_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": "",
"jaarkilometrage": 100,
"gearchiveerd": false,
"categorie": "vehicle",
"soort": null,
"aankoopdatum": "2012-03-01T00:00:00+01:00",
"bedragAudiovisueleApparatuur": "0.00",
"gebruikParticulierOfZakelijk": "Particulier",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/bezittingen/179"
}
}
}
]
}
}Bezitting ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/bezittingen/{BEZITTING_ID}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bezittingen/179
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- BEZITTING_ID
int(verplicht) Voorbeeld: 179
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": "",
"jaarkilometrage": null,
"gearchiveerd": false,
"categorie": "vehicle",
"soort": null,
"aankoopdatum": "2012-03-01T00:00:00+01:00",
"bedragAudiovisueleApparatuur": "0.00",
"gebruikParticulierOfZakelijk": "Particulier",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/bezittingen/179"
}
}
}Producten ¶
Product collectieGET/api/data/klantdossiers/{DOSSIER_ID}/producten&publiek={PUBLIEK}&gearchiveerd={GEARCHIVEERD}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/producten&publiek=1&gearchiveerd=0
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- 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"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/producten?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/producten?pagina=31&per_pagina=20"
}
},
"_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}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bankgaranties/6736
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6736
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"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": "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]&publiek={publiek}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bankgaranties/6736/registraties]&publiek=0
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6736- 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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bankgaranties/6736/registraties
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6736
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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bankgaranties/6736/taken
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6736
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",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"prioriteit": {
"enum": [
"Laag",
"Middel",
"Hoog"
]
},
"startdatum": {
"type": "string",
"format": "date"
},
"einddatum": {
"type": "string",
"format": "date"
},
"afgerond": {
"type": "boolean"
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"initiator": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"genodigden": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"verantwoordelijke": {
"enum": [
"Persoon",
"Workflowgroep",
"WorkflowgroepMetPersoon"
]
},
"verantwoordelijkePersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verantwoordelijkeWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bankgaranties/6736/workflows
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6736
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"workflow": {
"id": 21
}
}Schema
{
"properties": {
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bankgaranties/6736/facturen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6736
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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bankgaranties/6736/facturen/1/regels
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6736- FACTUUR_ID
int(verplicht) Voorbeeld: 1
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/1Bankgarantiedocument toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/bankgaranties/{PRODUCT_ID}/documenten
Let op: Als het protocol HDN is, zijn alleen PDF bestanden toegestaan.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/2818/bankgaranties/6732/documenten
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 2818- PRODUCT_ID
int(verplicht) Voorbeeld: 6732
Request
VerbergBekijk
Body
{
"naam": "fasterforward.png",
"extensie": "png",
"soortdocument": {
"id": 1
},
"data": "iVBORw0KGgoAAAANSUhEUgAAAP0AAAAbCAYAAAC3KIljAAAKsElEQVR42u2dC3BVxRnH82gCISQk
0ZYEUHTCDBrBBJESmbakVMI7Kj4KDFhGwlBtlUzk2RYIAUGbalHEYnl4DdACSSB1EhsBBwTpRAUa
ERIVWu4QCO88KTQ3Cem/M19mvjmze3bPuWdyL/F+M7/Jze73fbvnsv9z9uzZE4LanbP6oID5xNLT
Rx8A7V6SFRSw2/Hffg1oB26VLzTanz58N0WP/o4CxQIiA6IPWBcVfa/vuuhnApHF3MaivwjSbNIv
KGBdWvQ07nsHRN+1RO8OClhA9CYWuNIHRB+wgOi9E3BA9AHRBywg+v/nDwEPgxdAHtgEXODPYDmY
Du61kC8UjABzwevARawFL4NHQXhniB6+3cFEsAxspH68AWaD/g5+h2HgByC0s0WPnNHgWbAefAj2
g50gBwzvokIKBengFVAI9oKPwFawGAzupH50A0kgFQwC3f1a9MjRAywGF4GOlYNxJvm6gYWa+erA
CtDTkCMXVBBnJbFfMZ8KSV+iwGrQAMysFNxvcky/BmsMjGT1o0EZuEn5TnWW6JErDCwF1ym3jM/A
MJM8mcAFMg3lI8A68Dlwg35UnkP+uZr9nAlcxFAN/yjm/7Sg/jFwBrQrKAEJJu3kUhvprCwEPA62
gePgU0nsRLAHeAxttoAykO53okf8APA1sGMLBPl6gsM2clWCeJbHZTWBoC8PgTO68STYKZLv6YDA
PwuES/rq7gzRI08vcIgNtisk0NlgKpgP9rF6D5guyeUiHxebORQIRHQP1f+efm8DsRp9Pc5yvKHh
/yTzH22oy2Z1jeA98Dx4BsyiK/9XzKcKREraqSCfLPp9ADhqOGa3ISYS7DL41FCub0ErK98AQn0t
en6FrwLe2FBDzg3Arh1wQvQUnwIagFVrAxkWRL8NtPtC9DSQ9rLBtRb0kPimgjNMpOPMRE+D+guW
+xIoBBtBHMvZTkxT9LWfQSCVGsf3HvnWgjBWngzaqG4/iJfEB4OFrM0lKtGT4K+wmNN0tV9lmMof
ZD47QJLgVisT1JDP2/4i+nmSnCUgFcSCaJBsMrjfYvniQIvApwwMB5EgBgwFWyT5HvV2ek+zjX8L
/G+Bj2m6vwwUAY/A7xrorSH6/QDmM9G/xAbeK1SsEl41+V8A0Saif7ujnzTNDZaI6jz5/UXRdib5
NbA+323iHwIukV++oW4DlV8DcRrHvZ/8TypEPw8coc+HQarEfxU7hsWKtu9kJ89PnBJ9G6iwwECW
74gg35cgVLQoJ5kq72E+44HI+kqOZ5/AN8/bhTxaIzBaA0gT+A4GV6QnMy56PWsBzRqiPwtiLBLF
7+PZVaQChGqeKCawAZstEf1B0EpT3DsU+dZSTJ1ZH9hU+E3gps9zTPyHs35mGOrOUfk6zWNeQP7N
CtGX0898ECbxjQfN5Ldbs/0+oIlifPKcPoXluwTqDbxs0v7fhFNytTjHSPI9DooN/Nau6Mk3AtQK
fJ8yOa7pAv8mEKkp+kawkD8FoL45vQ23guV5ipVPsjhDOExxp0WiJ+rBXRq5fsZiRposNDaSzxiw
jj4Xm+RdQT7XQYRhau0m2NqEepZBRMtETxwD4aoTCDHQwne+1Leit2E01T+vEP04ILL/gFwwSLtB
+6KfJPCrBsEm+cNBnSAuQ0P0TUD9WMh50a+nssvgexZFP4cvyklEv9zCusJVismT+Iyk+hugO5tt
NDGByYRYEOSlddyqEDEK0Y9R5PoH+R222Ie7/V709NjtfjAZrGaCNxN9FGhUtH8RFIL54IcgxGHR
vyrwqwJZCv4liMvREP08m5tzakCKRQYKVsKLbYjgPjYAn5GIfoCFfJsoplJSv5rqP6DfI8BNKhul
WPSb4sVTjWFgJWjVFP1lEGL2aJT1O9dGn75xSvS3gNsCSZINJRPAH2lwn7Oz4k65ZlCfdO0q2AyS
HRJ9AXDKtitE3wrifLEjjy1yvWojNoTf1wtEX2cx30SWL9FEVM+zslIq+4PA/5dU1wyiNe6Xp4E8
UAz+CWpBO8OjKfoPLTyB+LmN732XvzynnwJqHHjMxnOOBacs5rkFXgPBXop+H3DKPlKI/oSvtuGy
q9cim/H1FJ8jEH2Vjd1oDRSbJRBlO9Gflf+Kyo4L8pVQXYlJm+Npqn2LfDlN4CjYSu3M1RT9+4rj
HMz3Ddj4zjf6wyO7bGBmHnAC7ARzQJmG6PmW3nSwBlQCXVvipegLgVN2QCH6Ml+Jnl3NVtiMb6H4
BQLRV9jIt51i9xrKn6PyE4bye5iA+rFyPvWfZbbIxzgEfgfSQV/RTkBN0bsUx5jE8oy18R25fCp6
xPUBHsnC1HKQAkINMcVSYajb+z54jG4hzipWwiO8EP16gd9eu+JSiL7Yh6I/RXnybcQmsMH7nEOi
f5pNpaNZeaFskQ9lJ6kuk5VNYhuI7hDEjGV9P6LYW++06Pn3NsPGd1Tqa9G/JMmXahJTqhS9fvs/
pQ00IhvmheizBH7nu6Dod1Ceb2zETmaDd4hDou/JrtBPUlkou41IE8TkUd0uwVOJjyXtFFH9VRCr
2bcsh0QfzI7ndRvfUbWvRf+WINfXiphvFVPg/aDewFSTfCOByNI0RR8ryDlI4vuI4tieAC4DyX4r
eronJlJsnTBoQ40Toqf4Dwx793/E9saHCfzTeD0IZhtvXpS0cZrqN1no12YnRE++e8hXoBX1eoAP
RK+cBrsVV2bVfe92QX2BSc40Sc4HNEU/SJL3C4HvMRAl8U8WbOipBz38WPRx7Mq63ULcQLaa/SYV
OyX6Z9lLPyFgJf1eJPEP4zMBMIQJo48ohp0U3tHsUyyoc1D0s4SbkdRx7/qD6H8jyTdb4PsTcEHi
Xy7Z2cYtB4Qbct4Fjgp8L4EQg+80Sd5PwFQwHszQ2A58CswG94G+tE8gD9wQ+C7z2+k9WcfONmKi
hn8oa98DEh0WfRxbIEwFx9i6gdDYW3yrwRL6XG7iX04+lSBEYzqeT/5OiT4SXGNrCmEaMQ+DVtDm
a9EPATKrAgWgCJwEZlbFd7aZvKZbC0rBNnAIeCR+ixS3Abpv2W0Edq0SRNwGoo9jV74bYJLinruQ
DX7a7uyQ6MnYW3+b+FVbY5GtAnxOn+eb+Ofyt+YU7+JvIb8tfA1DIXqr23r/CrqZ+A4BF8h3sz88
stsBrFitaIed4AWWq8COlYEwyTbZy6pgQcxuYNXOgUQ/X8jj+R7s2AZLFIEJIAHEgAdANqhmPvkg
2GnR84017Kp2TOHfu+NZO/uZqHhrjR/vbjCKyuNpHWEluEz1pSCO5a4GO0GKXdFTzJ9YH06CX4A+
7LXaH5NPS8dJFsz0B9H3An/XfHPsNTBZUh9vyJtIeXXtJuUPN+lrBmi2+Ec0gkE2aARKoz4n+N3q
vTpnInuJxoybYJFB8E6LPsGwYWalRgx/b/+4hv9w9kqvGVtBOMVsM9SleSn6YBKyR9GHho7bG5+I
XiGoXYb99ddooC8D95JfDMgR8KAk70NgFThouFJ7gBuUgLkgXrOfSeBduoVoNpyUzpnExYAXSdQ1
hheBvgTvgEf8/pGdehCOo8HtZsK7Dj4DSwE7oTkuep7nUzboR2j45zD/pRb+HuB82pXXxGYKbppy
pwnWMzJAFngB3OmN6Flsf7AKHAX/ZSfXcrDI0E4KyLHyn5X8D8jtDvnJzJ4qAAAAAElFTkSuQmCC"
}Schema
{
"properties": {
"data": {
"type": "string",
"minLength": 1
},
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"extensie": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"soortdocument": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"isContractDocument": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"data",
"naam",
"extensie",
"soortdocument"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/bankgaranties/6732/documenten/16Response
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"total": 1,
"message": "Validatie fouten",
"_links": {
"help": {
"href": "http://api.fasterforward.nl/",
"title": "Validatie informatie"
}
},
"_embedded": {
"errors": [
{
"path": "/extensie",
"message": "bestand.extensie.verplicht"
}
]
}
}Consumptief krediet ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/consumptiefkredieten/{PRODUCT_ID}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/consumptiefkredieten/6743
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6743
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"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",
"adviseur": "Achternaam, Voornaam (I.)",
"acceptant": "AchternaamTwee, Voornaam (V.)",
"acceptantWorkflowgroep": null,
"behandelaar": "Achternaam, Voornaam (I.)",
"doelVanFinanciering": "Auto",
"toelichtingDoelVanFinanciering": "",
"_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",
"volledigeVoornamen": "",
"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,
"effectieveJaarrente": "10",
"_links": {
"object": {
"href": "/api/data/klantdossiers/5526/bezittingen/183"
}
}
}
]
}
}Consumptief krediet toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/consumptiefkredieten
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
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"omschrijving": "Consumptief Krediet",
"status": {
"id": 1
},
"bestaandePropositie": {
"id": 3334
},
"adviseur": {
"id": 115193
},
"acceptantWorkflowgroep": {
"id": 45
},
"behandelaarWorkflowgroep": {
"id": 45
},
"bronvermelding": {
"id": 3
},
"aanbrengerPersoon": {
"id": 120956
},
"offertenummer": "12345",
"aanvraagVerzonden": "2024-01-01",
"aanvraagVerzondenDefinitief": true,
"uitbetalingsdatum": "2024-01-01",
"uitbetalingsdatumDefinitief": true,
"akkoordBank": "2024-01-01",
"contractOntvangen": "2024-01-01",
"stukkenOpgevraagd": "2024-01-01",
"contractVerzondenNaarKlant": "2024-01-01",
"stukkenCompleet": "2024-01-01",
"contractGetekendRetour": "2024-01-01",
"getekendContractNaarMaatschappij": "2024-01-01",
"contractVervaldatum": "2024-01-01",
"aanvragersParticulier": [
{
"id": 121340
}
],
"eersteAanvragerParticulier": {
"id": 121340
},
"correspondentieadres": {
"id": 7793
},
"financieringsdoel": "Anders, zie toelichting",
"toelichtingFinancieringsdoel": "Dit is een toelichting",
"maatschappij": {
"id": 16272
},
"inkoopVia": {
"id": 16741
},
"gewenstbedrag": 2000,
"gewenstMaandbedrag": 100,
"aantalKinderen": 1,
"toelichting": "nvt",
"artikel": {
"id": 32634
},
"codeprovisiemijtype": "CE001",
"contractnummer": "12345",
"leenbedrag": 2000,
"depot": 100,
"blokkade": true,
"inlossaldo": 100,
"uitTeBetalen": 100,
"termijnbedrag": 100,
"percentageDoorlopendKrediet": 100,
"aflossingsvrij": 100,
"nominaleMaandrente": 100,
"effectieveJaarrente": 1.01,
"kredietvergoeding": 100,
"totaleKredietsom": 100,
"theoretischeLooptijd": 100,
"theoretischeEinddatum": "2023-01-01",
"uitbetalingLand": "NL",
"uitbetalingBank": "RABOBANK NEDERLAND",
"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",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bestaandePropositie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"adviseur": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"behandelaar": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"behandelaarWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"acceptant": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"acceptantWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bronvermelding": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanbrengerPersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanbrengerOrganisatie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"offertenummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"aanvraagVerzonden": {
"type": "string",
"format": "date"
},
"aanvraagVerzondenDefinitief": {
"type": "boolean"
},
"uitbetalingsdatum": {
"type": "string",
"format": "date"
},
"uitbetalingsdatumDefinitief": {
"type": "boolean"
},
"akkoordBank": {
"type": "string",
"format": "date"
},
"contractOntvangen": {
"type": "string",
"format": "date"
},
"stukkenOpgevraagd": {
"type": "string",
"format": "date"
},
"contractVerzondenNaarKlant": {
"type": "string",
"format": "date"
},
"stukkenCompleet": {
"type": "string",
"format": "date"
},
"contractGetekendRetour": {
"type": "string",
"format": "date"
},
"getekendContractNaarMaatschappij": {
"type": "string",
"format": "date"
},
"contractVervaldatum": {
"type": "string",
"format": "date"
},
"aanvragersParticulier": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"aanvragerZakelijk": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"eersteAanvrager": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"eersteAanvragerParticulier": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"eersteAanvragerZakelijk": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"correspondentieadres": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"financieringsdoel": {
"enum": [
"(Nog) Niet bekend",
"Auto",
"Boot",
"Motor",
"Overname lopende leningen",
"Aanschaf woning",
"Restschuld financiering",
"Toercaravan",
"Woningverbetering",
"Zakelijk doel",
"Camper",
"Verduurzaming",
"Recreatiewoning/2e woning",
"Huishoudelijk apparatuur/inboedel",
"Bijkomende kosten woning",
"Extra financiële ruimte",
"Anders, zie toelichting"
]
},
"toelichtingFinancieringsdoel": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"maatschappij": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"inkoopVia": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"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",
"minimum": 0
},
"toelichting": {
"type": "string",
"minLength": 1
},
"artikel": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"codeprovisiemijtype": {
"enum": [
"AA001",
"AA002",
"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",
"minimum": 0
},
"nominaleMaandrente": {
"type": "number",
"multipleOf": 0.000001,
"minimum": -9999999.999999,
"maximum": 9999999.999999
},
"effectieveJaarrente": {
"type": "number",
"multipleOf": 0.01,
"minimum": -9999.99,
"maximum": 9999.99
},
"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",
"minimum": 0
},
"theoretischeEinddatum": {
"type": "string",
"format": "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",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"slottermijn": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
}
},
"required": [
"status",
"bestaandePropositie",
"adviseur",
"aanvraagVerzonden",
"aanvraagVerzondenDefinitief",
"uitbetalingsdatum",
"uitbetalingsdatumDefinitief",
"financieringsdoel",
"maatschappij",
"inkoopVia",
"gewenstbedrag",
"artikel",
"toonindigimap"
],
"allOf": [
{
"oneOf": [
{
"required": [
"acceptant"
]
},
{
"required": [
"acceptantWorkflowgroep"
]
}
]
},
{
"oneOf": [
{
"required": [
"behandelaar"
]
},
{
"required": [
"behandelaarWorkflowgroep"
]
}
]
}
],
"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]&publiek={publiek}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/consumptiefkredieten/6743/registraties]&publiek=0
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6743- 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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/consumptiefkredieten/6743/registraties
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6743
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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/consumptiefkredieten/6755/taken
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6755
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",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"prioriteit": {
"enum": [
"Laag",
"Middel",
"Hoog"
]
},
"startdatum": {
"type": "string",
"format": "date"
},
"einddatum": {
"type": "string",
"format": "date"
},
"afgerond": {
"type": "boolean"
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"initiator": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"genodigden": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"verantwoordelijke": {
"enum": [
"Persoon",
"Workflowgroep",
"WorkflowgroepMetPersoon"
]
},
"verantwoordelijkePersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verantwoordelijkeWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/consumptiefkredieten/6743/workflows
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6743
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"workflow": {
"id": 21
}
}Schema
{
"properties": {
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/consumptiefkredieten/6743/facturen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6743
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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/consumptiefkredieten/6743/facturen/1/regels
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6743- FACTUUR_ID
int(verplicht) Voorbeeld: 1
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/1Consumptiefkredietdocument toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/consumptiefkredieten/{PRODUCT_ID}/documenten
Let op: Als het protocol HDN is, zijn alleen PDF bestanden toegestaan.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/2818/consumptiefkredieten/6732/documenten
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 2818- PRODUCT_ID
int(verplicht) Voorbeeld: 6732
Request
VerbergBekijk
Body
{
"naam": "fasterforward.png",
"extensie": "png",
"soortdocument": {
"id": 1
},
"data": "iVBORw0KGgoAAAANSUhEUgAAAP0AAAAbCAYAAAC3KIljAAAKsElEQVR42u2dC3BVxRnH82gCISQk
0ZYEUHTCDBrBBJESmbakVMI7Kj4KDFhGwlBtlUzk2RYIAUGbalHEYnl4DdACSSB1EhsBBwTpRAUa
ERIVWu4QCO88KTQ3Cem/M19mvjmze3bPuWdyL/F+M7/Jze73fbvnsv9z9uzZE4LanbP6oID5xNLT
Rx8A7V6SFRSw2/Hffg1oB26VLzTanz58N0WP/o4CxQIiA6IPWBcVfa/vuuhnApHF3MaivwjSbNIv
KGBdWvQ07nsHRN+1RO8OClhA9CYWuNIHRB+wgOi9E3BA9AHRBywg+v/nDwEPgxdAHtgEXODPYDmY
Du61kC8UjABzwevARawFL4NHQXhniB6+3cFEsAxspH68AWaD/g5+h2HgByC0s0WPnNHgWbAefAj2
g50gBwzvokIKBengFVAI9oKPwFawGAzupH50A0kgFQwC3f1a9MjRAywGF4GOlYNxJvm6gYWa+erA
CtDTkCMXVBBnJbFfMZ8KSV+iwGrQAMysFNxvcky/BmsMjGT1o0EZuEn5TnWW6JErDCwF1ym3jM/A
MJM8mcAFMg3lI8A68Dlwg35UnkP+uZr9nAlcxFAN/yjm/7Sg/jFwBrQrKAEJJu3kUhvprCwEPA62
gePgU0nsRLAHeAxttoAykO53okf8APA1sGMLBPl6gsM2clWCeJbHZTWBoC8PgTO68STYKZLv6YDA
PwuES/rq7gzRI08vcIgNtisk0NlgKpgP9rF6D5guyeUiHxebORQIRHQP1f+efm8DsRp9Pc5yvKHh
/yTzH22oy2Z1jeA98Dx4BsyiK/9XzKcKREraqSCfLPp9ADhqOGa3ISYS7DL41FCub0ErK98AQn0t
en6FrwLe2FBDzg3Arh1wQvQUnwIagFVrAxkWRL8NtPtC9DSQ9rLBtRb0kPimgjNMpOPMRE+D+guW
+xIoBBtBHMvZTkxT9LWfQSCVGsf3HvnWgjBWngzaqG4/iJfEB4OFrM0lKtGT4K+wmNN0tV9lmMof
ZD47QJLgVisT1JDP2/4i+nmSnCUgFcSCaJBsMrjfYvniQIvApwwMB5EgBgwFWyT5HvV2ek+zjX8L
/G+Bj2m6vwwUAY/A7xrorSH6/QDmM9G/xAbeK1SsEl41+V8A0Saif7ujnzTNDZaI6jz5/UXRdib5
NbA+323iHwIukV++oW4DlV8DcRrHvZ/8TypEPw8coc+HQarEfxU7hsWKtu9kJ89PnBJ9G6iwwECW
74gg35cgVLQoJ5kq72E+44HI+kqOZ5/AN8/bhTxaIzBaA0gT+A4GV6QnMy56PWsBzRqiPwtiLBLF
7+PZVaQChGqeKCawAZstEf1B0EpT3DsU+dZSTJ1ZH9hU+E3gps9zTPyHs35mGOrOUfk6zWNeQP7N
CtGX0898ECbxjQfN5Ldbs/0+oIlifPKcPoXluwTqDbxs0v7fhFNytTjHSPI9DooN/Nau6Mk3AtQK
fJ8yOa7pAv8mEKkp+kawkD8FoL45vQ23guV5ipVPsjhDOExxp0WiJ+rBXRq5fsZiRposNDaSzxiw
jj4Xm+RdQT7XQYRhau0m2NqEepZBRMtETxwD4aoTCDHQwne+1Leit2E01T+vEP04ILL/gFwwSLtB
+6KfJPCrBsEm+cNBnSAuQ0P0TUD9WMh50a+nssvgexZFP4cvyklEv9zCusJVismT+Iyk+hugO5tt
NDGByYRYEOSlddyqEDEK0Y9R5PoH+R222Ie7/V709NjtfjAZrGaCNxN9FGhUtH8RFIL54IcgxGHR
vyrwqwJZCv4liMvREP08m5tzakCKRQYKVsKLbYjgPjYAn5GIfoCFfJsoplJSv5rqP6DfI8BNKhul
WPSb4sVTjWFgJWjVFP1lEGL2aJT1O9dGn75xSvS3gNsCSZINJRPAH2lwn7Oz4k65ZlCfdO0q2AyS
HRJ9AXDKtitE3wrifLEjjy1yvWojNoTf1wtEX2cx30SWL9FEVM+zslIq+4PA/5dU1wyiNe6Xp4E8
UAz+CWpBO8OjKfoPLTyB+LmN732XvzynnwJqHHjMxnOOBacs5rkFXgPBXop+H3DKPlKI/oSvtuGy
q9cim/H1FJ8jEH2Vjd1oDRSbJRBlO9Gflf+Kyo4L8pVQXYlJm+Npqn2LfDlN4CjYSu3M1RT9+4rj
HMz3Ddj4zjf6wyO7bGBmHnAC7ARzQJmG6PmW3nSwBlQCXVvipegLgVN2QCH6Ml+Jnl3NVtiMb6H4
BQLRV9jIt51i9xrKn6PyE4bye5iA+rFyPvWfZbbIxzgEfgfSQV/RTkBN0bsUx5jE8oy18R25fCp6
xPUBHsnC1HKQAkINMcVSYajb+z54jG4hzipWwiO8EP16gd9eu+JSiL7Yh6I/RXnybcQmsMH7nEOi
f5pNpaNZeaFskQ9lJ6kuk5VNYhuI7hDEjGV9P6LYW++06Pn3NsPGd1Tqa9G/JMmXahJTqhS9fvs/
pQ00IhvmheizBH7nu6Dod1Ceb2zETmaDd4hDou/JrtBPUlkou41IE8TkUd0uwVOJjyXtFFH9VRCr
2bcsh0QfzI7ndRvfUbWvRf+WINfXiphvFVPg/aDewFSTfCOByNI0RR8ryDlI4vuI4tieAC4DyX4r
eronJlJsnTBoQ40Toqf4Dwx793/E9saHCfzTeD0IZhtvXpS0cZrqN1no12YnRE++e8hXoBX1eoAP
RK+cBrsVV2bVfe92QX2BSc40Sc4HNEU/SJL3C4HvMRAl8U8WbOipBz38WPRx7Mq63ULcQLaa/SYV
OyX6Z9lLPyFgJf1eJPEP4zMBMIQJo48ohp0U3tHsUyyoc1D0s4SbkdRx7/qD6H8jyTdb4PsTcEHi
Xy7Z2cYtB4Qbct4Fjgp8L4EQg+80Sd5PwFQwHszQ2A58CswG94G+tE8gD9wQ+C7z2+k9WcfONmKi
hn8oa98DEh0WfRxbIEwFx9i6gdDYW3yrwRL6XG7iX04+lSBEYzqeT/5OiT4SXGNrCmEaMQ+DVtDm
a9EPATKrAgWgCJwEZlbFd7aZvKZbC0rBNnAIeCR+ixS3Abpv2W0Edq0SRNwGoo9jV74bYJLinruQ
DX7a7uyQ6MnYW3+b+FVbY5GtAnxOn+eb+Ofyt+YU7+JvIb8tfA1DIXqr23r/CrqZ+A4BF8h3sz88
stsBrFitaIed4AWWq8COlYEwyTbZy6pgQcxuYNXOgUQ/X8jj+R7s2AZLFIEJIAHEgAdANqhmPvkg
2GnR84017Kp2TOHfu+NZO/uZqHhrjR/vbjCKyuNpHWEluEz1pSCO5a4GO0GKXdFTzJ9YH06CX4A+
7LXaH5NPS8dJFsz0B9H3An/XfHPsNTBZUh9vyJtIeXXtJuUPN+lrBmi2+Ec0gkE2aARKoz4n+N3q
vTpnInuJxoybYJFB8E6LPsGwYWalRgx/b/+4hv9w9kqvGVtBOMVsM9SleSn6YBKyR9GHho7bG5+I
XiGoXYb99ddooC8D95JfDMgR8KAk70NgFThouFJ7gBuUgLkgXrOfSeBduoVoNpyUzpnExYAXSdQ1
hheBvgTvgEf8/pGdehCOo8HtZsK7Dj4DSwE7oTkuep7nUzboR2j45zD/pRb+HuB82pXXxGYKbppy
pwnWMzJAFngB3OmN6Flsf7AKHAX/ZSfXcrDI0E4KyLHyn5X8D8jtDvnJzJ4qAAAAAElFTkSuQmCC"
}Schema
{
"properties": {
"data": {
"type": "string",
"minLength": 1
},
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"extensie": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"soortdocument": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"isContractDocument": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"data",
"naam",
"extensie",
"soortdocument"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/consumptiefkredieten/6732/documenten/16Response
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"total": 1,
"message": "Validatie fouten",
"_links": {
"help": {
"href": "http://api.fasterforward.nl/",
"title": "Validatie informatie"
}
},
"_embedded": {
"errors": [
{
"path": "/extensie",
"message": "bestand.extensie.verplicht"
}
]
}
}Contract ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/contracten/{PRODUCT_ID}
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
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6741
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"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",
"contractdatum": "2012-07-14T00:00:00+02:00",
"contractdatumDefinitief": "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",
"volledigeVoornamen": "",
"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",
"verlengenOfAflopend": "Aflopend",
"beloningpercentageDeelnemer": "10.00",
"beloningpercentageAdviseur": "20.00"
}
]
}
}Contract toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/contracten
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
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"omschrijving": "Contract",
"status": {
"id": 1
},
"bestaandePropositie": {
"id": 3334
},
"adviseur": {
"id": 112115
},
"acceptantWorkflowgroep": {
"id": 45
},
"behandelaarWorkflowgroep": {
"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",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bestaandePropositie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"adviseur": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"acceptant": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"acceptantWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"behandelaar": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"behandelaarWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bronvermelding": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanbrengerPersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanbrengerOrganisatie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanvragerZakelijk": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanvragersParticulier": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"eersteAanvrager": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"correspondentieadres": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"contractnummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"contractDatum": {
"type": "string",
"format": "date"
},
"contractDatumDefinitief": {
"type": "boolean"
},
"startdatum": {
"type": "string",
"format": "date"
},
"startdatumDefinitief": {
"type": "boolean"
},
"eindeTekendatum": {
"type": "string",
"format": "date"
},
"getekendContractOntvangen": {
"type": "string",
"format": "date"
},
"dossierCompleet": {
"type": "string",
"format": "date"
},
"finaalAkkoord": {
"type": "string",
"format": "date"
},
"leverancier": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"inkoopVia": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"toelichting": {
"type": "string",
"minLength": 1
},
"gearchiveerd": {
"type": "boolean"
},
"toonindigimap": {
"type": "boolean"
},
"factuurtype": {
"enum": [
"Overschrijving",
"Incasso"
]
},
"factuurverzendwijze": {
"enum": [
"E-mail",
"Post",
"Geen"
]
},
"automatischFactureren": {
"type": "boolean"
}
},
"required": [
"bestaandePropositie",
"adviseur",
"bronvermelding",
"contractDatum",
"contractDatumDefinitief",
"startdatum",
"startdatumDefinitief",
"leverancier",
"inkoopVia",
"gearchiveerd",
"toonindigimap",
"status"
],
"allOf": [
{
"oneOf": [
{
"required": [
"aanvragerZakelijk"
]
},
{
"required": [
"aanvragersParticulier"
]
}
]
},
{
"oneOf": [
{
"required": [
"acceptant"
]
},
{
"required": [
"acceptantWorkflowgroep"
]
}
]
},
{
"oneOf": [
{
"required": [
"behandelaar"
]
},
{
"required": [
"behandelaarWorkflowgroep"
]
}
]
}
],
"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
- 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
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6757
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",
"beloningpercentageadviseur": 10.5,
"beloningpercentagedeelnemer": 89.5,
"verlengenOfAflopend": "Verlengen",
"hoofdvervaldatum": "2021-03-25",
"looptijd": 12
}Schema
{
"title": "Contractdeel",
"type": "object",
"properties": {
"artikel": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"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",
"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"
]
},
"looptijd": {
"type": "integer",
"minimum": 1
},
"beloningpercentagedeelnemer": {
"type": "number",
"multipleOf": 0.01,
"minimum": 0,
"maximum": 100
},
"beloningpercentageadviseur": {
"type": "number",
"multipleOf": 0.01,
"minimum": 0,
"maximum": 100
},
"hoofdvervaldatum": {
"type": "string",
"format": "date"
},
"verlengenOfAflopend": {
"enum": [
"Verlengen",
"Aflopend"
]
}
},
"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]&publiek={publiek}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/contracten/6757/registraties]&publiek=0
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6757- 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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/contracten/6757/registraties
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6757
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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/contracten/6755/taken
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6755
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",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"prioriteit": {
"enum": [
"Laag",
"Middel",
"Hoog"
]
},
"startdatum": {
"type": "string",
"format": "date"
},
"einddatum": {
"type": "string",
"format": "date"
},
"afgerond": {
"type": "boolean"
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"initiator": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"genodigden": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"verantwoordelijke": {
"enum": [
"Persoon",
"Workflowgroep",
"WorkflowgroepMetPersoon"
]
},
"verantwoordelijkePersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verantwoordelijkeWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/contracten/6757/workflows
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6757
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"workflow": {
"id": 21
}
}Schema
{
"properties": {
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/contracten/6757/facturen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6757
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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/contracten/6757/facturen/1/regels
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6757- FACTUUR_ID
int(verplicht) Voorbeeld: 1
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/1Contractdocument toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/contracten/{PRODUCT_ID}/documenten
Let op: Als het protocol HDN is, zijn alleen PDF bestanden toegestaan.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/2818/contracten/6732/documenten
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 2818- PRODUCT_ID
int(verplicht) Voorbeeld: 6732
Request
VerbergBekijk
Body
{
"naam": "fasterforward.png",
"extensie": "png",
"soortdocument": {
"id": 1
},
"data": "iVBORw0KGgoAAAANSUhEUgAAAP0AAAAbCAYAAAC3KIljAAAKsElEQVR42u2dC3BVxRnH82gCISQk
0ZYEUHTCDBrBBJESmbakVMI7Kj4KDFhGwlBtlUzk2RYIAUGbalHEYnl4DdACSSB1EhsBBwTpRAUa
ERIVWu4QCO88KTQ3Cem/M19mvjmze3bPuWdyL/F+M7/Jze73fbvnsv9z9uzZE4LanbP6oID5xNLT
Rx8A7V6SFRSw2/Hffg1oB26VLzTanz58N0WP/o4CxQIiA6IPWBcVfa/vuuhnApHF3MaivwjSbNIv
KGBdWvQ07nsHRN+1RO8OClhA9CYWuNIHRB+wgOi9E3BA9AHRBywg+v/nDwEPgxdAHtgEXODPYDmY
Du61kC8UjABzwevARawFL4NHQXhniB6+3cFEsAxspH68AWaD/g5+h2HgByC0s0WPnNHgWbAefAj2
g50gBwzvokIKBengFVAI9oKPwFawGAzupH50A0kgFQwC3f1a9MjRAywGF4GOlYNxJvm6gYWa+erA
CtDTkCMXVBBnJbFfMZ8KSV+iwGrQAMysFNxvcky/BmsMjGT1o0EZuEn5TnWW6JErDCwF1ym3jM/A
MJM8mcAFMg3lI8A68Dlwg35UnkP+uZr9nAlcxFAN/yjm/7Sg/jFwBrQrKAEJJu3kUhvprCwEPA62
gePgU0nsRLAHeAxttoAykO53okf8APA1sGMLBPl6gsM2clWCeJbHZTWBoC8PgTO68STYKZLv6YDA
PwuES/rq7gzRI08vcIgNtisk0NlgKpgP9rF6D5guyeUiHxebORQIRHQP1f+efm8DsRp9Pc5yvKHh
/yTzH22oy2Z1jeA98Dx4BsyiK/9XzKcKREraqSCfLPp9ADhqOGa3ISYS7DL41FCub0ErK98AQn0t
en6FrwLe2FBDzg3Arh1wQvQUnwIagFVrAxkWRL8NtPtC9DSQ9rLBtRb0kPimgjNMpOPMRE+D+guW
+xIoBBtBHMvZTkxT9LWfQSCVGsf3HvnWgjBWngzaqG4/iJfEB4OFrM0lKtGT4K+wmNN0tV9lmMof
ZD47QJLgVisT1JDP2/4i+nmSnCUgFcSCaJBsMrjfYvniQIvApwwMB5EgBgwFWyT5HvV2ek+zjX8L
/G+Bj2m6vwwUAY/A7xrorSH6/QDmM9G/xAbeK1SsEl41+V8A0Saif7ujnzTNDZaI6jz5/UXRdib5
NbA+323iHwIukV++oW4DlV8DcRrHvZ/8TypEPw8coc+HQarEfxU7hsWKtu9kJ89PnBJ9G6iwwECW
74gg35cgVLQoJ5kq72E+44HI+kqOZ5/AN8/bhTxaIzBaA0gT+A4GV6QnMy56PWsBzRqiPwtiLBLF
7+PZVaQChGqeKCawAZstEf1B0EpT3DsU+dZSTJ1ZH9hU+E3gps9zTPyHs35mGOrOUfk6zWNeQP7N
CtGX0898ECbxjQfN5Ldbs/0+oIlifPKcPoXluwTqDbxs0v7fhFNytTjHSPI9DooN/Nau6Mk3AtQK
fJ8yOa7pAv8mEKkp+kawkD8FoL45vQ23guV5ipVPsjhDOExxp0WiJ+rBXRq5fsZiRposNDaSzxiw
jj4Xm+RdQT7XQYRhau0m2NqEepZBRMtETxwD4aoTCDHQwne+1Leit2E01T+vEP04ILL/gFwwSLtB
+6KfJPCrBsEm+cNBnSAuQ0P0TUD9WMh50a+nssvgexZFP4cvyklEv9zCusJVismT+Iyk+hugO5tt
NDGByYRYEOSlddyqEDEK0Y9R5PoH+R222Ie7/V709NjtfjAZrGaCNxN9FGhUtH8RFIL54IcgxGHR
vyrwqwJZCv4liMvREP08m5tzakCKRQYKVsKLbYjgPjYAn5GIfoCFfJsoplJSv5rqP6DfI8BNKhul
WPSb4sVTjWFgJWjVFP1lEGL2aJT1O9dGn75xSvS3gNsCSZINJRPAH2lwn7Oz4k65ZlCfdO0q2AyS
HRJ9AXDKtitE3wrifLEjjy1yvWojNoTf1wtEX2cx30SWL9FEVM+zslIq+4PA/5dU1wyiNe6Xp4E8
UAz+CWpBO8OjKfoPLTyB+LmN732XvzynnwJqHHjMxnOOBacs5rkFXgPBXop+H3DKPlKI/oSvtuGy
q9cim/H1FJ8jEH2Vjd1oDRSbJRBlO9Gflf+Kyo4L8pVQXYlJm+Npqn2LfDlN4CjYSu3M1RT9+4rj
HMz3Ddj4zjf6wyO7bGBmHnAC7ARzQJmG6PmW3nSwBlQCXVvipegLgVN2QCH6Ml+Jnl3NVtiMb6H4
BQLRV9jIt51i9xrKn6PyE4bye5iA+rFyPvWfZbbIxzgEfgfSQV/RTkBN0bsUx5jE8oy18R25fCp6
xPUBHsnC1HKQAkINMcVSYajb+z54jG4hzipWwiO8EP16gd9eu+JSiL7Yh6I/RXnybcQmsMH7nEOi
f5pNpaNZeaFskQ9lJ6kuk5VNYhuI7hDEjGV9P6LYW++06Pn3NsPGd1Tqa9G/JMmXahJTqhS9fvs/
pQ00IhvmheizBH7nu6Dod1Ceb2zETmaDd4hDou/JrtBPUlkou41IE8TkUd0uwVOJjyXtFFH9VRCr
2bcsh0QfzI7ndRvfUbWvRf+WINfXiphvFVPg/aDewFSTfCOByNI0RR8ryDlI4vuI4tieAC4DyX4r
eronJlJsnTBoQ40Toqf4Dwx793/E9saHCfzTeD0IZhtvXpS0cZrqN1no12YnRE++e8hXoBX1eoAP
RK+cBrsVV2bVfe92QX2BSc40Sc4HNEU/SJL3C4HvMRAl8U8WbOipBz38WPRx7Mq63ULcQLaa/SYV
OyX6Z9lLPyFgJf1eJPEP4zMBMIQJo48ohp0U3tHsUyyoc1D0s4SbkdRx7/qD6H8jyTdb4PsTcEHi
Xy7Z2cYtB4Qbct4Fjgp8L4EQg+80Sd5PwFQwHszQ2A58CswG94G+tE8gD9wQ+C7z2+k9WcfONmKi
hn8oa98DEh0WfRxbIEwFx9i6gdDYW3yrwRL6XG7iX04+lSBEYzqeT/5OiT4SXGNrCmEaMQ+DVtDm
a9EPATKrAgWgCJwEZlbFd7aZvKZbC0rBNnAIeCR+ixS3Abpv2W0Edq0SRNwGoo9jV74bYJLinruQ
DX7a7uyQ6MnYW3+b+FVbY5GtAnxOn+eb+Ofyt+YU7+JvIb8tfA1DIXqr23r/CrqZ+A4BF8h3sz88
stsBrFitaIed4AWWq8COlYEwyTbZy6pgQcxuYNXOgUQ/X8jj+R7s2AZLFIEJIAHEgAdANqhmPvkg
2GnR84017Kp2TOHfu+NZO/uZqHhrjR/vbjCKyuNpHWEluEz1pSCO5a4GO0GKXdFTzJ9YH06CX4A+
7LXaH5NPS8dJFsz0B9H3An/XfHPsNTBZUh9vyJtIeXXtJuUPN+lrBmi2+Ec0gkE2aARKoz4n+N3q
vTpnInuJxoybYJFB8E6LPsGwYWalRgx/b/+4hv9w9kqvGVtBOMVsM9SleSn6YBKyR9GHho7bG5+I
XiGoXYb99ddooC8D95JfDMgR8KAk70NgFThouFJ7gBuUgLkgXrOfSeBduoVoNpyUzpnExYAXSdQ1
hheBvgTvgEf8/pGdehCOo8HtZsK7Dj4DSwE7oTkuep7nUzboR2j45zD/pRb+HuB82pXXxGYKbppy
pwnWMzJAFngB3OmN6Flsf7AKHAX/ZSfXcrDI0E4KyLHyn5X8D8jtDvnJzJ4qAAAAAElFTkSuQmCC"
}Schema
{
"properties": {
"data": {
"type": "string",
"minLength": 1
},
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"extensie": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"soortdocument": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"isContractDocument": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"data",
"naam",
"extensie",
"soortdocument"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/contracten/6732/documenten/16Response
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"total": 1,
"message": "Validatie fouten",
"_links": {
"help": {
"href": "http://api.fasterforward.nl/",
"title": "Validatie informatie"
}
},
"_embedded": {
"errors": [
{
"path": "/extensie",
"message": "bestand.extensie.verplicht"
}
]
}
}Dienst ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/diensten/{PRODUCT_ID}
Wijzigingen met release 1.12.1
- Korting en kortingtype toegevoegd
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/diensten/6734
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6734
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 77108,
"type": 43,
"soort": "diensten",
"offertenummer": "",
"omschrijving": "Aankoopopdracht",
"status": "Intake",
"invoerAanvraag": "2023-02-13T00:00:00+01:00",
"gearchiveerd": "nee",
"publiek": "ja",
"maatschappij": "Smaragd Hypøthëken",
"ingangsdatum": "2023-02-13T00:00:00+01:00",
"ingangsdatumDefinitief": "nee",
"toelichting": "Regel 1\nRegel 2",
"factuurtype": "Overschrijving",
"factuurverzendwijze": "E-mail",
"adviseur": "Adviseur, Pëtèr de (P.)",
"acceptant": "Adviseur, Pëtèr de (P.)",
"acceptantWorkflowgroep": null,
"behandelaar": "Adviseur, Pëtèr de (P.)",
"behandelaarWorkflowgroep": null,
"_links": {
"self": {
"href": "/api/data/klantdossiers/13987/diensten/77108"
}
},
"_embedded": {
"correspondentieadres": {
"id": 23111,
"straat": "De Poel",
"nummer": "32",
"toevoeging": null,
"postcode": "2231TK",
"plaatsnaam": "RIJNSBURG",
"land": null,
"postcodegebied": "2231TK",
"longitude": null,
"latitude": null,
"categorie": "default"
},
"aanvragers": [
{
"id": 133339,
"geslacht": "man",
"initialen": "R.",
"titel": "heer",
"voornaam": "",
"volledigeVoornamen": "",
"tussenvoegsel": "",
"achternaam": "Rosa",
"nationaliteitId": 1,
"nationaliteit": "Nederlandse",
"burgerlijkestaatId": 3,
"burgerlijkestaat": "Alleenstaand",
"weergavenaam": "Rosa (R.)",
"geboortedatum": "1983-06-14T00:00:00+02:00",
"pensioendatum": null,
"overleden": "nee",
"datumOverlijden": null,
"geboorteplaats": null,
"burgerlijkestaatdatum": null,
"voormaligHuwelijkOpgeheven": null,
"gezinssamenstelling": null,
"roker": null,
"dossierrol": "Eerste persoon",
"_links": {
"self": {
"href": "/api/data/klantdossiers/13987/klanten/particulier/133339"
}
}
}
],
"productdelen": [
{
"id": 108273,
"product": "Aankoopopdracht",
"omschrijving": "omschrijving",
"betalingstermijn": "eenmalig",
"verkoopprijs": "990.00",
"btw": "BTW 0% (alleen grondslag)",
"beloningpercentageDeelnemer": "0.00",
"beloningpercentageAdviseur": "0.00",
"aantalStuks": "1.00",
"kortingtype": "Percentage",
"korting": "90.00"
},
{
"id": 108274,
"product": "Aankoopopdracht",
"omschrijving": "",
"betalingstermijn": "eenmalig",
"verkoopprijs": "60.00",
"btw": "BTW 21% inclusief",
"beloningpercentageDeelnemer": "20.00",
"beloningpercentageAdviseur": "0.00",
"aantalStuks": "1.00",
"kortingtype": "Bedrag",
"korting": "70.00"
},
{
"id": 108275,
"product": "Advies AO",
"omschrijving": "",
"betalingstermijn": "eenmalig",
"verkoopprijs": "900.00",
"btw": null,
"beloningpercentageDeelnemer": "0.00",
"beloningpercentageAdviseur": "9.00",
"aantalStuks": "1.00",
"kortingtype": null,
"korting": "0.00"
}
]
}
}Dienst toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/diensten
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
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"omschrijving": "Dienst",
"status": {
"id": 1
},
"bestaandePropositie": {
"id": 3334
},
"adviseur": {
"id": 112115
},
"acceptantWorkflowgroep": {
"id": 45
},
"behandelaarWorkflowgroep": {
"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",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bestaandePropositie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"adviseur": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"acceptant": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"acceptantWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"behandelaar": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"behandelaarWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bronvermelding": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanbrengerPersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanbrengerOrganisatie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"offertenummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"tekendatum": {
"type": "string",
"format": "date"
},
"tekendatumDefinitief": {
"type": "boolean"
},
"opleverdatum": {
"type": "string",
"format": "date"
},
"opleverdatumDefinitief": {
"type": "boolean"
},
"datumOpdrachtbevestiging": {
"type": "string",
"format": "date"
},
"datumOpdrachtbevestigingGetekend": {
"type": "string",
"format": "date"
},
"aanvragerRol": {
"enum": [
"Particulier",
"Zakelijk"
]
},
"aanvragerZakelijk": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanvragersParticulier": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"eersteAanvrager": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"correspondentieadres": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"leverancier": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"inkoopVia": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"toelichting": {
"type": "string",
"minLength": 1
},
"toonindigimap": {
"type": "boolean"
},
"gearchiveerd": {
"type": "boolean"
},
"factuurtype": {
"enum": [
"Overschrijving",
"Incasso",
"Notaris"
]
},
"factuurverzendwijze": {
"enum": [
"E-mail",
"Post"
]
}
},
"required": [
"toonindigimap",
"tekendatum",
"tekendatumDefinitief",
"opleverdatum",
"opleverdatumDefinitief",
"gearchiveerd",
"status",
"adviseur",
"leverancier",
"bestaandePropositie",
"inkoopVia",
"aanvragerRol"
],
"allOf": [
{
"oneOf": [
{
"properties": {
"aanvragerRol": {
"enum": [
"Particulier"
]
}
},
"required": [
"aanvragersParticulier"
]
},
{
"properties": {
"aanvragerRol": {
"enum": [
"Zakelijk"
]
}
},
"required": [
"aanvragerZakelijk"
]
}
]
},
{
"oneOf": [
{
"required": [
"acceptant"
]
},
{
"required": [
"acceptantWorkflowgroep"
]
}
]
},
{
"oneOf": [
{
"required": [
"behandelaar"
]
},
{
"required": [
"behandelaarWorkflowgroep"
]
}
]
}
],
"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
- 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
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6754
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",
"beloningpercentageadviseur": 15,
"beloningpercentagedeelnemer": 25
}Schema
{
"title": "Dienstdeel",
"type": "object",
"properties": {
"artikel": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"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",
"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",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"looptijd": {
"type": "integer",
"minimum": 0
},
"hoofdvervaldatum": {
"type": "string",
"format": "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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/diensten/6755/registraties
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6755
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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/diensten/6755/taken
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6755
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",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"prioriteit": {
"enum": [
"Laag",
"Middel",
"Hoog"
]
},
"startdatum": {
"type": "string",
"format": "date"
},
"einddatum": {
"type": "string",
"format": "date"
},
"afgerond": {
"type": "boolean"
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"initiator": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"genodigden": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"verantwoordelijke": {
"enum": [
"Persoon",
"Workflowgroep",
"WorkflowgroepMetPersoon"
]
},
"verantwoordelijkePersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verantwoordelijkeWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/diensten/6754/workflows
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6754
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"workflow": {
"id": 21
}
}Schema
{
"properties": {
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/diensten/6754/facturen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6754
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
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/diensten/6754/facturen/1/regels
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6754- FACTUUR_ID
int(verplicht) Voorbeeld: 1
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/1Dienstdocument toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/diensten/{PRODUCT_ID}/documenten
Let op: Als het protocol HDN is, zijn alleen PDF bestanden toegestaan.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/2818/diensten/6732/documenten
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 2818- PRODUCT_ID
int(verplicht) Voorbeeld: 6732
Request
VerbergBekijk
Body
{
"naam": "fasterforward.png",
"extensie": "png",
"soortdocument": {
"id": 1
},
"data": "iVBORw0KGgoAAAANSUhEUgAAAP0AAAAbCAYAAAC3KIljAAAKsElEQVR42u2dC3BVxRnH82gCISQk
0ZYEUHTCDBrBBJESmbakVMI7Kj4KDFhGwlBtlUzk2RYIAUGbalHEYnl4DdACSSB1EhsBBwTpRAUa
ERIVWu4QCO88KTQ3Cem/M19mvjmze3bPuWdyL/F+M7/Jze73fbvnsv9z9uzZE4LanbP6oID5xNLT
Rx8A7V6SFRSw2/Hffg1oB26VLzTanz58N0WP/o4CxQIiA6IPWBcVfa/vuuhnApHF3MaivwjSbNIv
KGBdWvQ07nsHRN+1RO8OClhA9CYWuNIHRB+wgOi9E3BA9AHRBywg+v/nDwEPgxdAHtgEXODPYDmY
Du61kC8UjABzwevARawFL4NHQXhniB6+3cFEsAxspH68AWaD/g5+h2HgByC0s0WPnNHgWbAefAj2
g50gBwzvokIKBengFVAI9oKPwFawGAzupH50A0kgFQwC3f1a9MjRAywGF4GOlYNxJvm6gYWa+erA
CtDTkCMXVBBnJbFfMZ8KSV+iwGrQAMysFNxvcky/BmsMjGT1o0EZuEn5TnWW6JErDCwF1ym3jM/A
MJM8mcAFMg3lI8A68Dlwg35UnkP+uZr9nAlcxFAN/yjm/7Sg/jFwBrQrKAEJJu3kUhvprCwEPA62
gePgU0nsRLAHeAxttoAykO53okf8APA1sGMLBPl6gsM2clWCeJbHZTWBoC8PgTO68STYKZLv6YDA
PwuES/rq7gzRI08vcIgNtisk0NlgKpgP9rF6D5guyeUiHxebORQIRHQP1f+efm8DsRp9Pc5yvKHh
/yTzH22oy2Z1jeA98Dx4BsyiK/9XzKcKREraqSCfLPp9ADhqOGa3ISYS7DL41FCub0ErK98AQn0t
en6FrwLe2FBDzg3Arh1wQvQUnwIagFVrAxkWRL8NtPtC9DSQ9rLBtRb0kPimgjNMpOPMRE+D+guW
+xIoBBtBHMvZTkxT9LWfQSCVGsf3HvnWgjBWngzaqG4/iJfEB4OFrM0lKtGT4K+wmNN0tV9lmMof
ZD47QJLgVisT1JDP2/4i+nmSnCUgFcSCaJBsMrjfYvniQIvApwwMB5EgBgwFWyT5HvV2ek+zjX8L
/G+Bj2m6vwwUAY/A7xrorSH6/QDmM9G/xAbeK1SsEl41+V8A0Saif7ujnzTNDZaI6jz5/UXRdib5
NbA+323iHwIukV++oW4DlV8DcRrHvZ/8TypEPw8coc+HQarEfxU7hsWKtu9kJ89PnBJ9G6iwwECW
74gg35cgVLQoJ5kq72E+44HI+kqOZ5/AN8/bhTxaIzBaA0gT+A4GV6QnMy56PWsBzRqiPwtiLBLF
7+PZVaQChGqeKCawAZstEf1B0EpT3DsU+dZSTJ1ZH9hU+E3gps9zTPyHs35mGOrOUfk6zWNeQP7N
CtGX0898ECbxjQfN5Ldbs/0+oIlifPKcPoXluwTqDbxs0v7fhFNytTjHSPI9DooN/Nau6Mk3AtQK
fJ8yOa7pAv8mEKkp+kawkD8FoL45vQ23guV5ipVPsjhDOExxp0WiJ+rBXRq5fsZiRposNDaSzxiw
jj4Xm+RdQT7XQYRhau0m2NqEepZBRMtETxwD4aoTCDHQwne+1Leit2E01T+vEP04ILL/gFwwSLtB
+6KfJPCrBsEm+cNBnSAuQ0P0TUD9WMh50a+nssvgexZFP4cvyklEv9zCusJVismT+Iyk+hugO5tt
NDGByYRYEOSlddyqEDEK0Y9R5PoH+R222Ie7/V709NjtfjAZrGaCNxN9FGhUtH8RFIL54IcgxGHR
vyrwqwJZCv4liMvREP08m5tzakCKRQYKVsKLbYjgPjYAn5GIfoCFfJsoplJSv5rqP6DfI8BNKhul
WPSb4sVTjWFgJWjVFP1lEGL2aJT1O9dGn75xSvS3gNsCSZINJRPAH2lwn7Oz4k65ZlCfdO0q2AyS
HRJ9AXDKtitE3wrifLEjjy1yvWojNoTf1wtEX2cx30SWL9FEVM+zslIq+4PA/5dU1wyiNe6Xp4E8
UAz+CWpBO8OjKfoPLTyB+LmN732XvzynnwJqHHjMxnOOBacs5rkFXgPBXop+H3DKPlKI/oSvtuGy
q9cim/H1FJ8jEH2Vjd1oDRSbJRBlO9Gflf+Kyo4L8pVQXYlJm+Npqn2LfDlN4CjYSu3M1RT9+4rj
HMz3Ddj4zjf6wyO7bGBmHnAC7ARzQJmG6PmW3nSwBlQCXVvipegLgVN2QCH6Ml+Jnl3NVtiMb6H4
BQLRV9jIt51i9xrKn6PyE4bye5iA+rFyPvWfZbbIxzgEfgfSQV/RTkBN0bsUx5jE8oy18R25fCp6
xPUBHsnC1HKQAkINMcVSYajb+z54jG4hzipWwiO8EP16gd9eu+JSiL7Yh6I/RXnybcQmsMH7nEOi
f5pNpaNZeaFskQ9lJ6kuk5VNYhuI7hDEjGV9P6LYW++06Pn3NsPGd1Tqa9G/JMmXahJTqhS9fvs/
pQ00IhvmheizBH7nu6Dod1Ceb2zETmaDd4hDou/JrtBPUlkou41IE8TkUd0uwVOJjyXtFFH9VRCr
2bcsh0QfzI7ndRvfUbWvRf+WINfXiphvFVPg/aDewFSTfCOByNI0RR8ryDlI4vuI4tieAC4DyX4r
eronJlJsnTBoQ40Toqf4Dwx793/E9saHCfzTeD0IZhtvXpS0cZrqN1no12YnRE++e8hXoBX1eoAP
RK+cBrsVV2bVfe92QX2BSc40Sc4HNEU/SJL3C4HvMRAl8U8WbOipBz38WPRx7Mq63ULcQLaa/SYV
OyX6Z9lLPyFgJf1eJPEP4zMBMIQJo48ohp0U3tHsUyyoc1D0s4SbkdRx7/qD6H8jyTdb4PsTcEHi
Xy7Z2cYtB4Qbct4Fjgp8L4EQg+80Sd5PwFQwHszQ2A58CswG94G+tE8gD9wQ+C7z2+k9WcfONmKi
hn8oa98DEh0WfRxbIEwFx9i6gdDYW3yrwRL6XG7iX04+lSBEYzqeT/5OiT4SXGNrCmEaMQ+DVtDm
a9EPATKrAgWgCJwEZlbFd7aZvKZbC0rBNnAIeCR+ixS3Abpv2W0Edq0SRNwGoo9jV74bYJLinruQ
DX7a7uyQ6MnYW3+b+FVbY5GtAnxOn+eb+Ofyt+YU7+JvIb8tfA1DIXqr23r/CrqZ+A4BF8h3sz88
stsBrFitaIed4AWWq8COlYEwyTbZy6pgQcxuYNXOgUQ/X8jj+R7s2AZLFIEJIAHEgAdANqhmPvkg
2GnR84017Kp2TOHfu+NZO/uZqHhrjR/vbjCKyuNpHWEluEz1pSCO5a4GO0GKXdFTzJ9YH06CX4A+
7LXaH5NPS8dJFsz0B9H3An/XfHPsNTBZUh9vyJtIeXXtJuUPN+lrBmi2+Ec0gkE2aARKoz4n+N3q
vTpnInuJxoybYJFB8E6LPsGwYWalRgx/b/+4hv9w9kqvGVtBOMVsM9SleSn6YBKyR9GHho7bG5+I
XiGoXYb99ddooC8D95JfDMgR8KAk70NgFThouFJ7gBuUgLkgXrOfSeBduoVoNpyUzpnExYAXSdQ1
hheBvgTvgEf8/pGdehCOo8HtZsK7Dj4DSwE7oTkuep7nUzboR2j45zD/pRb+HuB82pXXxGYKbppy
pwnWMzJAFngB3OmN6Flsf7AKHAX/ZSfXcrDI0E4KyLHyn5X8D8jtDvnJzJ4qAAAAAElFTkSuQmCC"
}Schema
{
"properties": {
"data": {
"type": "string",
"minLength": 1
},
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"extensie": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"soortdocument": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"isContractDocument": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"data",
"naam",
"extensie",
"soortdocument"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/diensten/6732/documenten/16Response
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"total": 1,
"message": "Validatie fouten",
"_links": {
"help": {
"href": "http://api.fasterforward.nl/",
"title": "Validatie informatie"
}
},
"_embedded": {
"errors": [
{
"path": "/extensie",
"message": "bestand.extensie.verplicht"
}
]
}
}Hypotheek ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/hypotheken/{PRODUCT_ID}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheken/6732
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6732
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 6732,
"type": 1,
"soort": "hypotheken",
"offertenummer": "",
"omschrijving": "Hypotheek",
"status": "Aanvraag nieuw",
"invoerAanvraag": "2021-01-01T00:00:00+02:00",
"gearchiveerd": "nee",
"publiek": "ja",
"maatschappij": "ABN AMRO",
"passeerdatum": "2021-01-01T00:00:00+02:00",
"passeerdatumDefinitief": "nee",
"hoofdsom": "200000.00",
"inschrijving": "225000.00",
"renteaanbodAangevraagd": "2021-01-01T00:00:00+02:00",
"ontbindendeVoorwaarden": "2021-01-01T00:00:00+02:00",
"norm": "Geldverstrekker",
"oorspronkelijkeHoofdsom": "250000.00",
"bankgarantieBenodigd": "Ja",
"bankgarantie": "0.00",
"bankgarantieSteldatum": null,
"acceptatiedatumRenteaanbod": "2021-01-01T00:00:00+02:00",
"acceptatiedatumHypotheekaanbod": "2021-01-01T00:00:00+02:00",
"uitersteVerlengingsdatum": "2021-01-01T00:00:00+02:00",
"uiterstePasseerdatum": "2021-01-01T00:00:00+02:00",
"uiterstePasseerdatumNaVerlenging": "2021-01-01T00:00:00+02:00",
"moetGetekendRenteaanbodRetour": "nee",
"moetGetekendHypotheekaanbodRetour": "nee",
"verlengingMogelijk": "nee",
"automatischeVerlenging": "ja",
"verlengd": "nee",
"beheerrelatie": "onbekend",
"notaris": "Naam notaris",
"verkopendeMakelaar": "Naam verkopende makelaar",
"taxerendeMakelaar": "Naam taxerende makelaar",
"toelichting": "Toelichting",
"adviseur": "Achternaam, Voornaam (I.)",
"acceptant": "AchternaamTwee, Voornaam (V.)",
"acceptantWorkflowgroep": null,
"behandelaar": "Achternaam, Voornaam (I.)",
"behandelaarWorkflowgroep": null,
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/hypotheken/6732"
}
},
"_embedded": {
"onderpandadres": {
"id": 7790,
"straat": "Nieuwemarkt",
"nummer": "2",
"toevoeging": "",
"postcode": "3011HP",
"plaatsnaam": "Rotterdam",
"land": "NL",
"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",
"land": "NL",
"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",
"volledigeVoornamen": "",
"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",
"studieleningInventarisatie": "Ja, er is sprake van een studielening",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954"
}
}
},
{
"id": 120955,
"geslacht": "X",
"initialen": "K.",
"titel": "",
"voornaam": "Kim",
"volledigeVoornamen": "",
"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",
"studieleningInventarisatie": "Onbekend",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120955"
}
}
}
],
"eersteAanvrager": [
{
"id": 120954,
"geslacht": "man",
"initialen": "A.",
"titel": "",
"voornaam": "Aad",
"volledigeVoornamen": "",
"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",
"studieleningInventarisatie": "Ja, er is sprake van een studielening",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954"
}
}
}
],
"productdelen": [
{
"id": 7891,
"product": "ABN AMRO Aflossingsvrije hypotheek (ABN AMRO Basis Hypotheek - 2)",
"looptijd": 360,
"hypotheeknummer": "ABN-001",
"hypotheekvorm": "Aflossingsvrije hypotheek",
"deelHoofdsom": "80000.00",
"hoofdsomPer": null,
"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",
"hoofdsomPer": null,
"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
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.
Wijzigingen met release 1.10.3
-
Het veld eindeTekendatumRenteaanbod is deprecated. Gebruik hiervoor acceptatiedatumRenteaanbod.
-
Het veld eindeTekendatumHypotheekaanbod is deprecated. Gebruik hiervoor acceptatiedatumHypotheekaanbod.
-
Het veld verloopdatumRenteaanbod is deprecated. Gebruik hiervoor uiterstePasseerdatum.
-
Het veld verloopdatumHypotheekaanbod is deprecated. Gebruik hiervoor uiterstePasseerdatum.
-
Het veld einddatumVerlenging is deprecated. Gebruik hiervoor uitersteVerlengingsdatum.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheken
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"portefeuille": "Eigen beheer",
"omschrijving": "Omschrijving",
"status": {
"id": 1
},
"bestaandePropositie": {
"id": 3334
},
"propositietype": "Derde vervolghypotheek (nieuwe geldgever)",
"adviseur": {
"id": 112115
},
"acceptantWorkflowgroep": {
"id": 45
},
"behandelaarWorkflowgroep": {
"id": 45
},
"bronvermelding": {
"id": 3
},
"aanbrengerPersoon": {
"id": 120956
},
"aanbrengerOrganisatie": {
"id": 14851
},
"offertenummer": "12345",
"renteaanbodAangevraagd": "2021-01-01",
"ontbindendeVoorwaarden": "2021-01-01",
"passeerdatum": "2021-01-01",
"passeerdatumDefinitief": true,
"ontvangstRenteaanbod": "2021-01-01",
"eindeTekendatumRenteaanbod": "2021-01-01",
"verloopdatumRenteaanbod": "2021-01-01",
"acceptatiedatumRenteaanbod": "2021-01-01",
"getekendRenteaanbodOntvangen": "2021-01-01",
"getekendRenteaanbodNaarMaatschappij": "2021-01-01",
"moetGetekendRenteaanbodRetour": false,
"dossierCompleet": "2021-01-01",
"dossierCompleetNaarMaatschappij": "2021-01-01",
"finaalAkkoord": "2021-01-01",
"ontvangstHypotheekaanbod": "2021-01-01",
"eindeTekendatumHypotheekaanbod": "2021-01-01",
"verloopdatumHypotheekaanbod": "2021-01-01",
"acceptatiedatumHypotheekaanbod": "2021-01-01",
"getekendHypotheekaanbodOntvangen": "2021-01-01",
"getekendHypotheekaanbodNaarMaatschappij": "2021-01-01",
"moetGetekendHypotheekaanbodRetour": true,
"dossierNaarNotaris": "2021-01-01",
"ontvangstAfrekening": "2021-01-01",
"afrekeningGecontroleerd": "2021-01-01",
"einddatumVerlenging": "2021-01-01",
"verhuisdatum": "2021-01-01",
"afgelegd": "2021-01-01",
"uitersteVerlengingsdatum": "2021-01-01",
"uiterstePasseerdatum": "2021-01-01",
"uiterstePasseerdatumNaVerlenging": "2021-01-01",
"verlengingMogelijk": true,
"automatischeVerlenging": false,
"verlengd": false,
"beheerrelatie": true,
"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": "2021-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": "2021-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
}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",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bestaandePropositie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"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)"
]
},
"adviseur": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"acceptant": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"acceptantWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"behandelaar": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"behandelaarWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bronvermelding": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanbrengerPersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanbrengerOrganisatie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"offertenummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"renteaanbodAangevraagd": {
"type": "string",
"format": "date"
},
"ontbindendeVoorwaarden": {
"type": "string",
"format": "date"
},
"passeerdatum": {
"type": "string",
"format": "date"
},
"passeerdatumDefinitief": {
"type": "boolean"
},
"ontvangstRenteaanbod": {
"type": "string",
"format": "date"
},
"acceptatiedatumRenteaanbod": {
"type": "string",
"format": "date"
},
"getekendRenteaanbodOntvangen": {
"type": "string",
"format": "date"
},
"getekendRenteaanbodNaarMaatschappij": {
"type": "string",
"format": "date"
},
"dossierCompleet": {
"type": "string",
"format": "date"
},
"dossierCompleetNaarMaatschappij": {
"type": "string",
"format": "date"
},
"finaalAkkoord": {
"type": "string",
"format": "date"
},
"ontvangstHypotheekaanbod": {
"type": "string",
"format": "date"
},
"acceptatiedatumHypotheekaanbod": {
"type": "string",
"format": "date"
},
"getekendHypotheekaanbodOntvangen": {
"type": "string",
"format": "date"
},
"getekendHypotheekaanbodNaarMaatschappij": {
"type": "string",
"format": "date"
},
"dossierNaarNotaris": {
"type": "string",
"format": "date"
},
"ontvangstAfrekening": {
"type": "string",
"format": "date"
},
"afrekeningGecontroleerd": {
"type": "string",
"format": "date"
},
"verhuisdatum": {
"type": "string",
"format": "date"
},
"afgelegd": {
"type": "string",
"format": "date"
},
"aanvragersParticulier": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"aanvragerZakelijk": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"eersteAanvrager": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"eersteAanvragerParticulier": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"eersteAanvragerZakelijk": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"maatschappij": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"inkoopVia": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"hoofdsom": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"norm": {
"enum" : [
"NHG",
"CHF",
"Geldverstrekker",
"Maatwerk"
]
},
"borgtochtprovisieNHG": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"risicoklasse": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"risicoklassebepaling": {
"enum" : [
"Marktwaarde",
"Executiewaarde"
]
},
"inschrijving": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"bankgarantieBenodigd": {
"enum" : [
"Ja",
"Nee",
"Waarborgsom"
]
},
"bankgarantie": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"bankgarantieSteldatum": {
"type": "string",
"format": "date"
},
"eenmaligeVergoeding": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"koopsomWoonAOV": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"aantalDagenRespijt": {
"type": "integer",
"minimum": 0
},
"koopsubsidie": {
"type": "boolean"
},
"koopsubsidieDossiercode": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"koopsubsidieTotaleContanteWaarde": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"koopsubsidieBedrag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"koopsubsidieBedragPremietermijn": {
"enum" : [
"Maand",
"Kwartaal",
"Halfjaar",
"Jaar",
"2 maanden",
"Eenmalig"
]
},
"starterslening": {
"type": "boolean"
},
"startersleningBedrag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"bestaandeHypotheek": {
"type": "boolean"
},
"bestaandeHypotheekHoofdsomBox1": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"bestaandeHypotheekHoofdsomBox3": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"bestaandeHypotheekStartdatum": {
"type": "string",
"format": "date"
},
"bestaandeHypotheekRente": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"bestaandeHypotheekBoeterente": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"bestaandeHypotheekInschrijving": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"bestaandeHypotheekNorm": {
"enum" : [
"CHF",
"Geldverstrekker"
]
},
"bestaandeHypotheekMaatschappij": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"notaris": {
"type": "object",
"properties": {
"id": {
"type": "integer",
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verkopendeMakelaar": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"taxerendeMakelaar": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"onderpand": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"correspondentieadres": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"toelichting": {
"type": "string",
"minLength": 1
},
"toonindigimap": {
"type": "boolean"
},
"gearchiveerd": {
"type": "boolean"
},
"oorspronkelijkeHoofdsom": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"uitersteVerlengingsdatum": {
"type": "string",
"format": "date"
},
"uiterstePasseerdatum": {
"type": "string",
"format": "date"
},
"uiterstePasseerdatumNaVerlenging": {
"type": "string",
"format": "date"
},
"moetGetekendRenteaanbodRetour": {
"type": "boolean"
},
"moetGetekendHypotheekaanbodRetour": {
"type": "boolean"
},
"verlengingMogelijk": {
"type": "boolean"
},
"automatischeVerlenging": {
"type": "boolean"
},
"verlengd": {
"type": "boolean"
},
"beheerrelatie": {
"type": "boolean"
},
"eindeTekendatumRenteaanbod": {
"type": "string",
"format": "date"
},
"verloopdatumRenteaanbod": {
"type": "string",
"format": "date"
},
"eindeTekendatumHypotheekaanbod": {
"type": "string",
"format": "date"
},
"verloopdatumHypotheekaanbod": {
"type": "string",
"format": "date"
},
"einddatumVerlenging": {
"type": "string",
"format": "date"
}
},
"required": [
"toonindigimap",
"renteaanbodAangevraagd",
"gearchiveerd",
"portefeuille",
"status",
"adviseur",
"maatschappij",
"bestaandePropositie",
"bronvermelding",
"inkoopVia",
"passeerdatum",
"passeerdatumDefinitief",
"onderpand",
"hoofdsom",
"norm",
"inschrijving",
"propositietype",
"oorspronkelijkeHoofdsom"
],
"allOf": [
{
"oneOf": [
{ "required": ["acceptant"] },
{ "required": ["acceptantWorkflowgroep"] }
]
},
{
"oneOf": [
{ "required": ["behandelaar"] },
{ "required": ["behandelaarWorkflowgroep"] }
]
}
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/hypotheken/6752Hypotheekdeel toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/hypotheken/{PRODUCT_ID}/leningdelen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheken/6752/leningdelen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6752
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"artikel": {
"id": 16324
},
"hypotheeknummer": "12345",
"typeLeningdeel": "Nieuw",
"verhuisregeling": true,
"zeroProduct": true,
"deelHoofdsom": 250000,
"maandelijksBedrag": 700,
"betalingAchteraf": true,
"looptijd": 3600,
"einddatum": "2032-01-01",
"einddatumAftrek": "2032-01-01",
"rentepercentage": 5,
"rentekorting": 0,
"renteType": "Rentevast",
"rentevastEinddatum": "2016-01-01",
"rentevastIngangsdatumIsAfwijkendTenOpzichteVanPasseerdatum": true,
"rentevastIngangsdatum": "2016-01-01",
"betalingsprofiel": {
"id": 1
},
"complex": true,
"leningDoel": "Box 1",
"doelKapitaal": 0,
"dekking": 0,
"tweedeDekking": 0,
"oorspronkelijkeDeelHoofdsom": 250000,
"hoofdsomPer": "2015-11-03"
}Schema
{
"title": "Hypotheekdeel",
"type": "object",
"properties": {
"artikel": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"hypotheeknummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"typeLeningdeel": {
"enum": [
"Nieuw",
"Meeneem (zelfde geldgever, ander object)",
"Doorgeef (zelfde geldgever, zelfde object, andere hypotheekgever)",
"Omzetting (andere aflosvorm)",
"Verhoging (hoger geldbedrag)",
"Ongewijzigd"
]
},
"verhuisregeling": {
"type": "boolean"
},
"zeroProduct": {
"type": "boolean"
},
"deelHoofdsom": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"hoofdsomPer": {
"type": "string",
"format": "date"
},
"maandelijksBedrag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"betalingAchteraf": {
"type": "boolean"
},
"looptijd": {
"type": "integer",
"minimum": 0
},
"einddatum": {
"type": "string",
"format": "date"
},
"einddatumAftrek": {
"type": "string",
"format": "date"
},
"rentepercentage": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"rentekorting": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"renteType": {
"enum": [
"Rentevast",
"Rentedempend systeem",
"Continu variabel",
"Correctierente",
"Plafond/click",
"Samengestelde rente"
]
},
"rentebedenktijd": {
"type": "integer",
"minimum": 0
},
"rentevastPeriode": {
"type": "integer",
"minimum": 0
},
"rentevastEinddatum": {
"type": "string",
"format": "date"
},
"rentevastIngangsdatumIsAfwijkendTenOpzichteVanPasseerdatum": {
"type": "boolean"
},
"rentevastIngangsdatum": {
"type": "string",
"format": "date"
},
"betalingsprofiel": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"complex": {
"type": "boolean"
},
"leningDoel": {
"enum": [
"Box 1",
"Box 3",
"Box 1 / Box 3"
]
},
"doelKapitaal": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"dekking": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"tweedeDekking": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"oorspronkelijkeDeelHoofdsom": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
}
},
"required": [
"artikel",
"deelHoofdsom",
"looptijd",
"rentepercentage",
"einddatum",
"maandelijksBedrag",
"renteType",
"typeLeningdeel",
"leningDoel"
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/hypotheken/6752/leningdelen/7914Hypotheek registratie ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/hypotheken/{PRODUCT_ID}/registraties]&publiek={publiek}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheken/6752/registraties]&publiek=0
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6752- publiek
int(optioneel) Voorbeeld: 0
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/hypotheken/6752/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/hypotheken/6752/registraties/275825"
},
"product": {
"href": "/api/data/klantdossiers/5526/hypotheken/6752"
},
"bestand": {
"href": "/api/data/klantdossiers/5526/documenten/2"
}
}
}
]
}
}Hypotheek registratie toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/hypotheken/{PRODUCT_ID}/registraties
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheken/6752/registraties
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6752
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Klantdossier - Registratie toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/hypotheken/6752/registraties/275826Hypotheek taak toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/hypotheken/{PRODUCT_ID}/taken
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheken/6755/taken
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6755
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",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"prioriteit": {
"enum": [
"Laag",
"Middel",
"Hoog"
]
},
"startdatum": {
"type": "string",
"format": "date"
},
"einddatum": {
"type": "string",
"format": "date"
},
"afgerond": {
"type": "boolean"
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"initiator": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"genodigden": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"verantwoordelijke": {
"enum": [
"Persoon",
"Workflowgroep",
"WorkflowgroepMetPersoon"
]
},
"verantwoordelijkePersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verantwoordelijkeWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"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/hypotheken/6755/taken/55519Hypotheek workflow toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/hypotheken/{PRODUCT_ID}/workflows
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheken/6752/workflows
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6752
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"workflow": {
"id": 21
}
}Schema
{
"properties": {
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"workflow"
]
}Response
204VerbergBekijk
Headers
Content-Type: application/jsonHypotheek factuur toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/hypotheken/{PRODUCT_ID}/facturen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheken/6752/facturen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6752
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Factuur - Factuur toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/hypotheken/6752/facturen/1Hypotheek factuurregel toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/hypotheken/{PRODUCT_ID}/facturen/{FACTUUR_ID}/regels
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheken/6752/facturen/1/regels
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6752- FACTUUR_ID
int(verplicht) Voorbeeld: 1
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Factuur - Factuurregel toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/hypotheken/6752/facturen/1Hypotheekdocument toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/hypotheken/{PRODUCT_ID}/documenten
Let op: Als het protocol HDN is, zijn alleen PDF bestanden toegestaan.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/2818/hypotheken/6732/documenten
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 2818- PRODUCT_ID
int(verplicht) Voorbeeld: 6732
Request
VerbergBekijk
Body
{
"naam": "fasterforward.png",
"extensie": "png",
"soortdocument": {
"id": 1
},
"data": "iVBORw0KGgoAAAANSUhEUgAAAP0AAAAbCAYAAAC3KIljAAAKsElEQVR42u2dC3BVxRnH82gCISQk
0ZYEUHTCDBrBBJESmbakVMI7Kj4KDFhGwlBtlUzk2RYIAUGbalHEYnl4DdACSSB1EhsBBwTpRAUa
ERIVWu4QCO88KTQ3Cem/M19mvjmze3bPuWdyL/F+M7/Jze73fbvnsv9z9uzZE4LanbP6oID5xNLT
Rx8A7V6SFRSw2/Hffg1oB26VLzTanz58N0WP/o4CxQIiA6IPWBcVfa/vuuhnApHF3MaivwjSbNIv
KGBdWvQ07nsHRN+1RO8OClhA9CYWuNIHRB+wgOi9E3BA9AHRBywg+v/nDwEPgxdAHtgEXODPYDmY
Du61kC8UjABzwevARawFL4NHQXhniB6+3cFEsAxspH68AWaD/g5+h2HgByC0s0WPnNHgWbAefAj2
g50gBwzvokIKBengFVAI9oKPwFawGAzupH50A0kgFQwC3f1a9MjRAywGF4GOlYNxJvm6gYWa+erA
CtDTkCMXVBBnJbFfMZ8KSV+iwGrQAMysFNxvcky/BmsMjGT1o0EZuEn5TnWW6JErDCwF1ym3jM/A
MJM8mcAFMg3lI8A68Dlwg35UnkP+uZr9nAlcxFAN/yjm/7Sg/jFwBrQrKAEJJu3kUhvprCwEPA62
gePgU0nsRLAHeAxttoAykO53okf8APA1sGMLBPl6gsM2clWCeJbHZTWBoC8PgTO68STYKZLv6YDA
PwuES/rq7gzRI08vcIgNtisk0NlgKpgP9rF6D5guyeUiHxebORQIRHQP1f+efm8DsRp9Pc5yvKHh
/yTzH22oy2Z1jeA98Dx4BsyiK/9XzKcKREraqSCfLPp9ADhqOGa3ISYS7DL41FCub0ErK98AQn0t
en6FrwLe2FBDzg3Arh1wQvQUnwIagFVrAxkWRL8NtPtC9DSQ9rLBtRb0kPimgjNMpOPMRE+D+guW
+xIoBBtBHMvZTkxT9LWfQSCVGsf3HvnWgjBWngzaqG4/iJfEB4OFrM0lKtGT4K+wmNN0tV9lmMof
ZD47QJLgVisT1JDP2/4i+nmSnCUgFcSCaJBsMrjfYvniQIvApwwMB5EgBgwFWyT5HvV2ek+zjX8L
/G+Bj2m6vwwUAY/A7xrorSH6/QDmM9G/xAbeK1SsEl41+V8A0Saif7ujnzTNDZaI6jz5/UXRdib5
NbA+323iHwIukV++oW4DlV8DcRrHvZ/8TypEPw8coc+HQarEfxU7hsWKtu9kJ89PnBJ9G6iwwECW
74gg35cgVLQoJ5kq72E+44HI+kqOZ5/AN8/bhTxaIzBaA0gT+A4GV6QnMy56PWsBzRqiPwtiLBLF
7+PZVaQChGqeKCawAZstEf1B0EpT3DsU+dZSTJ1ZH9hU+E3gps9zTPyHs35mGOrOUfk6zWNeQP7N
CtGX0898ECbxjQfN5Ldbs/0+oIlifPKcPoXluwTqDbxs0v7fhFNytTjHSPI9DooN/Nau6Mk3AtQK
fJ8yOa7pAv8mEKkp+kawkD8FoL45vQ23guV5ipVPsjhDOExxp0WiJ+rBXRq5fsZiRposNDaSzxiw
jj4Xm+RdQT7XQYRhau0m2NqEepZBRMtETxwD4aoTCDHQwne+1Leit2E01T+vEP04ILL/gFwwSLtB
+6KfJPCrBsEm+cNBnSAuQ0P0TUD9WMh50a+nssvgexZFP4cvyklEv9zCusJVismT+Iyk+hugO5tt
NDGByYRYEOSlddyqEDEK0Y9R5PoH+R222Ie7/V709NjtfjAZrGaCNxN9FGhUtH8RFIL54IcgxGHR
vyrwqwJZCv4liMvREP08m5tzakCKRQYKVsKLbYjgPjYAn5GIfoCFfJsoplJSv5rqP6DfI8BNKhul
WPSb4sVTjWFgJWjVFP1lEGL2aJT1O9dGn75xSvS3gNsCSZINJRPAH2lwn7Oz4k65ZlCfdO0q2AyS
HRJ9AXDKtitE3wrifLEjjy1yvWojNoTf1wtEX2cx30SWL9FEVM+zslIq+4PA/5dU1wyiNe6Xp4E8
UAz+CWpBO8OjKfoPLTyB+LmN732XvzynnwJqHHjMxnOOBacs5rkFXgPBXop+H3DKPlKI/oSvtuGy
q9cim/H1FJ8jEH2Vjd1oDRSbJRBlO9Gflf+Kyo4L8pVQXYlJm+Npqn2LfDlN4CjYSu3M1RT9+4rj
HMz3Ddj4zjf6wyO7bGBmHnAC7ARzQJmG6PmW3nSwBlQCXVvipegLgVN2QCH6Ml+Jnl3NVtiMb6H4
BQLRV9jIt51i9xrKn6PyE4bye5iA+rFyPvWfZbbIxzgEfgfSQV/RTkBN0bsUx5jE8oy18R25fCp6
xPUBHsnC1HKQAkINMcVSYajb+z54jG4hzipWwiO8EP16gd9eu+JSiL7Yh6I/RXnybcQmsMH7nEOi
f5pNpaNZeaFskQ9lJ6kuk5VNYhuI7hDEjGV9P6LYW++06Pn3NsPGd1Tqa9G/JMmXahJTqhS9fvs/
pQ00IhvmheizBH7nu6Dod1Ceb2zETmaDd4hDou/JrtBPUlkou41IE8TkUd0uwVOJjyXtFFH9VRCr
2bcsh0QfzI7ndRvfUbWvRf+WINfXiphvFVPg/aDewFSTfCOByNI0RR8ryDlI4vuI4tieAC4DyX4r
eronJlJsnTBoQ40Toqf4Dwx793/E9saHCfzTeD0IZhtvXpS0cZrqN1no12YnRE++e8hXoBX1eoAP
RK+cBrsVV2bVfe92QX2BSc40Sc4HNEU/SJL3C4HvMRAl8U8WbOipBz38WPRx7Mq63ULcQLaa/SYV
OyX6Z9lLPyFgJf1eJPEP4zMBMIQJo48ohp0U3tHsUyyoc1D0s4SbkdRx7/qD6H8jyTdb4PsTcEHi
Xy7Z2cYtB4Qbct4Fjgp8L4EQg+80Sd5PwFQwHszQ2A58CswG94G+tE8gD9wQ+C7z2+k9WcfONmKi
hn8oa98DEh0WfRxbIEwFx9i6gdDYW3yrwRL6XG7iX04+lSBEYzqeT/5OiT4SXGNrCmEaMQ+DVtDm
a9EPATKrAgWgCJwEZlbFd7aZvKZbC0rBNnAIeCR+ixS3Abpv2W0Edq0SRNwGoo9jV74bYJLinruQ
DX7a7uyQ6MnYW3+b+FVbY5GtAnxOn+eb+Ofyt+YU7+JvIb8tfA1DIXqr23r/CrqZ+A4BF8h3sz88
stsBrFitaIed4AWWq8COlYEwyTbZy6pgQcxuYNXOgUQ/X8jj+R7s2AZLFIEJIAHEgAdANqhmPvkg
2GnR84017Kp2TOHfu+NZO/uZqHhrjR/vbjCKyuNpHWEluEz1pSCO5a4GO0GKXdFTzJ9YH06CX4A+
7LXaH5NPS8dJFsz0B9H3An/XfHPsNTBZUh9vyJtIeXXtJuUPN+lrBmi2+Ec0gkE2aARKoz4n+N3q
vTpnInuJxoybYJFB8E6LPsGwYWalRgx/b/+4hv9w9kqvGVtBOMVsM9SleSn6YBKyR9GHho7bG5+I
XiGoXYb99ddooC8D95JfDMgR8KAk70NgFThouFJ7gBuUgLkgXrOfSeBduoVoNpyUzpnExYAXSdQ1
hheBvgTvgEf8/pGdehCOo8HtZsK7Dj4DSwE7oTkuep7nUzboR2j45zD/pRb+HuB82pXXxGYKbppy
pwnWMzJAFngB3OmN6Flsf7AKHAX/ZSfXcrDI0E4KyLHyn5X8D8jtDvnJzJ4qAAAAAElFTkSuQmCC"
}Schema
{
"properties": {
"data": {
"type": "string",
"minLength": 1
},
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"extensie": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"soortdocument": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"isContractDocument": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"data",
"naam",
"extensie",
"soortdocument"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/hypotheken/6732/documenten/16Response
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"total": 1,
"message": "Validatie fouten",
"_links": {
"help": {
"href": "http://api.fasterforward.nl/",
"title": "Validatie informatie"
}
},
"_embedded": {
"errors": [
{
"path": "/extensie",
"message": "bestand.extensie.verplicht"
}
]
}
}Hypotheekadvies ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/hypotheekadviezen/{PRODUCT_ID}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheekadviezen/6735
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6735
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 6735,
"type": 15,
"soort": "hypotheekadviezen",
"offertenummer": "12345",
"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",
"adviseur": "Achternaam, Voornaam (I.)",
"acceptant": "AchternaamTwee, Voornaam (V.)",
"acceptantWorkflowgroep": null,
"behandelaar": "Achternaam, Voornaam (I.)",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/hypotheekadviezen/6735"
}
},
"_embedded": {
"onderpandadres": {
"id": 7790,
"straat": "Grimbergen",
"nummer": "2",
"toevoeging": "",
"postcode": "3099KA",
"plaatsnaam": "Rotterdam",
"postcodegebied": "3011",
"longitude": null,
"latitude": null,
"categorie": "default",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/hypotheekadviezen/6735/adressen/7790"
}
},
"_embedded": {
"types": [
{
"id": 7,
"naam": "correspondentieadres"
}
]
}
},
"correspondentieadres": {
"id": 7793,
"straat": "Blauwhof",
"nummer": "45",
"toevoeging": "",
"postcode": "1271CC",
"plaatsnaam": "Huizen",
"postcodegebied": "1275",
"longitude": "5.26394006",
"latitude": "52.28904947",
"categorie": "default",
"_embedded": {
"types": [
{
"id": 1,
"naam": "bezoekadres"
}
]
}
},
"productdelen": [
{
"id": 7894,
"product": "Hypotheekadvies",
"bedrag": "250.00"
}
]
}
}Hypotheekadvies registratie ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/hypotheekadviezen/{PRODUCT_ID}/registraties]&publiek={publiek}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheekadviezen/6735/registraties]&publiek=0
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6735- publiek
int(optioneel) Voorbeeld: 0
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/hypotheekadviezen/6735/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/hypotheekadviezen/6735/registraties/275825"
},
"product": {
"href": "/api/data/klantdossiers/5526/hypotheekadviezen/6735"
},
"bestand": {
"href": "/api/data/klantdossiers/5526/documenten/2"
}
}
}
]
}
}Hypotheekadvies registratie toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/hypotheekadviezen/{PRODUCT_ID}/registraties
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheekadviezen/6735/registraties
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6735
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Klantdossier - Registratie toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/hypotheekadviezen/6735/registraties/275826Hypotheekadvies taak toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/hypotheekadviezen/{PRODUCT_ID}/taken
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheekadviezen/6755/taken
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6755
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",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"prioriteit": {
"enum": [
"Laag",
"Middel",
"Hoog"
]
},
"startdatum": {
"type": "string",
"format": "date"
},
"einddatum": {
"type": "string",
"format": "date"
},
"afgerond": {
"type": "boolean"
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"initiator": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"genodigden": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"verantwoordelijke": {
"enum": [
"Persoon",
"Workflowgroep",
"WorkflowgroepMetPersoon"
]
},
"verantwoordelijkePersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verantwoordelijkeWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"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/hypotheekadviezen/6755/taken/55519Hypotheekadvies workflow toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/hypotheekadviezen/{PRODUCT_ID}/workflows
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheekadviezen/6735/workflows
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6735
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"workflow": {
"id": 21
}
}Schema
{
"properties": {
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"workflow"
]
}Response
204VerbergBekijk
Headers
Content-Type: application/jsonHypotheekadvies factuur toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/hypotheekadviezen/{PRODUCT_ID}/facturen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheekadviezen/6735/facturen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6735
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Factuur - Factuur toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/hypotheekadviezen/6735/facturen/1Hypotheekadvies factuurregel toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/hypotheekadviezen/{PRODUCT_ID}/facturen/{FACTUUR_ID}/regels
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheekadviezen/6735/facturen/1/regels
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6735- FACTUUR_ID
int(verplicht) Voorbeeld: 1
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Factuur - Factuurregel toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/hypotheekadviezen/6735/facturen/1Hypotheekadviesdocument toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/hypotheekadviezen/{PRODUCT_ID}/documenten
Let op: Als het protocol HDN is, zijn alleen PDF bestanden toegestaan.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/2818/hypotheekadviezen/6732/documenten
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 2818- PRODUCT_ID
int(verplicht) Voorbeeld: 6732
Request
VerbergBekijk
Body
{
"naam": "fasterforward.png",
"extensie": "png",
"soortdocument": {
"id": 1
},
"data": "iVBORw0KGgoAAAANSUhEUgAAAP0AAAAbCAYAAAC3KIljAAAKsElEQVR42u2dC3BVxRnH82gCISQk
0ZYEUHTCDBrBBJESmbakVMI7Kj4KDFhGwlBtlUzk2RYIAUGbalHEYnl4DdACSSB1EhsBBwTpRAUa
ERIVWu4QCO88KTQ3Cem/M19mvjmze3bPuWdyL/F+M7/Jze73fbvnsv9z9uzZE4LanbP6oID5xNLT
Rx8A7V6SFRSw2/Hffg1oB26VLzTanz58N0WP/o4CxQIiA6IPWBcVfa/vuuhnApHF3MaivwjSbNIv
KGBdWvQ07nsHRN+1RO8OClhA9CYWuNIHRB+wgOi9E3BA9AHRBywg+v/nDwEPgxdAHtgEXODPYDmY
Du61kC8UjABzwevARawFL4NHQXhniB6+3cFEsAxspH68AWaD/g5+h2HgByC0s0WPnNHgWbAefAj2
g50gBwzvokIKBengFVAI9oKPwFawGAzupH50A0kgFQwC3f1a9MjRAywGF4GOlYNxJvm6gYWa+erA
CtDTkCMXVBBnJbFfMZ8KSV+iwGrQAMysFNxvcky/BmsMjGT1o0EZuEn5TnWW6JErDCwF1ym3jM/A
MJM8mcAFMg3lI8A68Dlwg35UnkP+uZr9nAlcxFAN/yjm/7Sg/jFwBrQrKAEJJu3kUhvprCwEPA62
gePgU0nsRLAHeAxttoAykO53okf8APA1sGMLBPl6gsM2clWCeJbHZTWBoC8PgTO68STYKZLv6YDA
PwuES/rq7gzRI08vcIgNtisk0NlgKpgP9rF6D5guyeUiHxebORQIRHQP1f+efm8DsRp9Pc5yvKHh
/yTzH22oy2Z1jeA98Dx4BsyiK/9XzKcKREraqSCfLPp9ADhqOGa3ISYS7DL41FCub0ErK98AQn0t
en6FrwLe2FBDzg3Arh1wQvQUnwIagFVrAxkWRL8NtPtC9DSQ9rLBtRb0kPimgjNMpOPMRE+D+guW
+xIoBBtBHMvZTkxT9LWfQSCVGsf3HvnWgjBWngzaqG4/iJfEB4OFrM0lKtGT4K+wmNN0tV9lmMof
ZD47QJLgVisT1JDP2/4i+nmSnCUgFcSCaJBsMrjfYvniQIvApwwMB5EgBgwFWyT5HvV2ek+zjX8L
/G+Bj2m6vwwUAY/A7xrorSH6/QDmM9G/xAbeK1SsEl41+V8A0Saif7ujnzTNDZaI6jz5/UXRdib5
NbA+323iHwIukV++oW4DlV8DcRrHvZ/8TypEPw8coc+HQarEfxU7hsWKtu9kJ89PnBJ9G6iwwECW
74gg35cgVLQoJ5kq72E+44HI+kqOZ5/AN8/bhTxaIzBaA0gT+A4GV6QnMy56PWsBzRqiPwtiLBLF
7+PZVaQChGqeKCawAZstEf1B0EpT3DsU+dZSTJ1ZH9hU+E3gps9zTPyHs35mGOrOUfk6zWNeQP7N
CtGX0898ECbxjQfN5Ldbs/0+oIlifPKcPoXluwTqDbxs0v7fhFNytTjHSPI9DooN/Nau6Mk3AtQK
fJ8yOa7pAv8mEKkp+kawkD8FoL45vQ23guV5ipVPsjhDOExxp0WiJ+rBXRq5fsZiRposNDaSzxiw
jj4Xm+RdQT7XQYRhau0m2NqEepZBRMtETxwD4aoTCDHQwne+1Leit2E01T+vEP04ILL/gFwwSLtB
+6KfJPCrBsEm+cNBnSAuQ0P0TUD9WMh50a+nssvgexZFP4cvyklEv9zCusJVismT+Iyk+hugO5tt
NDGByYRYEOSlddyqEDEK0Y9R5PoH+R222Ie7/V709NjtfjAZrGaCNxN9FGhUtH8RFIL54IcgxGHR
vyrwqwJZCv4liMvREP08m5tzakCKRQYKVsKLbYjgPjYAn5GIfoCFfJsoplJSv5rqP6DfI8BNKhul
WPSb4sVTjWFgJWjVFP1lEGL2aJT1O9dGn75xSvS3gNsCSZINJRPAH2lwn7Oz4k65ZlCfdO0q2AyS
HRJ9AXDKtitE3wrifLEjjy1yvWojNoTf1wtEX2cx30SWL9FEVM+zslIq+4PA/5dU1wyiNe6Xp4E8
UAz+CWpBO8OjKfoPLTyB+LmN732XvzynnwJqHHjMxnOOBacs5rkFXgPBXop+H3DKPlKI/oSvtuGy
q9cim/H1FJ8jEH2Vjd1oDRSbJRBlO9Gflf+Kyo4L8pVQXYlJm+Npqn2LfDlN4CjYSu3M1RT9+4rj
HMz3Ddj4zjf6wyO7bGBmHnAC7ARzQJmG6PmW3nSwBlQCXVvipegLgVN2QCH6Ml+Jnl3NVtiMb6H4
BQLRV9jIt51i9xrKn6PyE4bye5iA+rFyPvWfZbbIxzgEfgfSQV/RTkBN0bsUx5jE8oy18R25fCp6
xPUBHsnC1HKQAkINMcVSYajb+z54jG4hzipWwiO8EP16gd9eu+JSiL7Yh6I/RXnybcQmsMH7nEOi
f5pNpaNZeaFskQ9lJ6kuk5VNYhuI7hDEjGV9P6LYW++06Pn3NsPGd1Tqa9G/JMmXahJTqhS9fvs/
pQ00IhvmheizBH7nu6Dod1Ceb2zETmaDd4hDou/JrtBPUlkou41IE8TkUd0uwVOJjyXtFFH9VRCr
2bcsh0QfzI7ndRvfUbWvRf+WINfXiphvFVPg/aDewFSTfCOByNI0RR8ryDlI4vuI4tieAC4DyX4r
eronJlJsnTBoQ40Toqf4Dwx793/E9saHCfzTeD0IZhtvXpS0cZrqN1no12YnRE++e8hXoBX1eoAP
RK+cBrsVV2bVfe92QX2BSc40Sc4HNEU/SJL3C4HvMRAl8U8WbOipBz38WPRx7Mq63ULcQLaa/SYV
OyX6Z9lLPyFgJf1eJPEP4zMBMIQJo48ohp0U3tHsUyyoc1D0s4SbkdRx7/qD6H8jyTdb4PsTcEHi
Xy7Z2cYtB4Qbct4Fjgp8L4EQg+80Sd5PwFQwHszQ2A58CswG94G+tE8gD9wQ+C7z2+k9WcfONmKi
hn8oa98DEh0WfRxbIEwFx9i6gdDYW3yrwRL6XG7iX04+lSBEYzqeT/5OiT4SXGNrCmEaMQ+DVtDm
a9EPATKrAgWgCJwEZlbFd7aZvKZbC0rBNnAIeCR+ixS3Abpv2W0Edq0SRNwGoo9jV74bYJLinruQ
DX7a7uyQ6MnYW3+b+FVbY5GtAnxOn+eb+Ofyt+YU7+JvIb8tfA1DIXqr23r/CrqZ+A4BF8h3sz88
stsBrFitaIed4AWWq8COlYEwyTbZy6pgQcxuYNXOgUQ/X8jj+R7s2AZLFIEJIAHEgAdANqhmPvkg
2GnR84017Kp2TOHfu+NZO/uZqHhrjR/vbjCKyuNpHWEluEz1pSCO5a4GO0GKXdFTzJ9YH06CX4A+
7LXaH5NPS8dJFsz0B9H3An/XfHPsNTBZUh9vyJtIeXXtJuUPN+lrBmi2+Ec0gkE2aARKoz4n+N3q
vTpnInuJxoybYJFB8E6LPsGwYWalRgx/b/+4hv9w9kqvGVtBOMVsM9SleSn6YBKyR9GHho7bG5+I
XiGoXYb99ddooC8D95JfDMgR8KAk70NgFThouFJ7gBuUgLkgXrOfSeBduoVoNpyUzpnExYAXSdQ1
hheBvgTvgEf8/pGdehCOo8HtZsK7Dj4DSwE7oTkuep7nUzboR2j45zD/pRb+HuB82pXXxGYKbppy
pwnWMzJAFngB3OmN6Flsf7AKHAX/ZSfXcrDI0E4KyLHyn5X8D8jtDvnJzJ4qAAAAAElFTkSuQmCC"
}Schema
{
"properties": {
"data": {
"type": "string",
"minLength": 1
},
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"extensie": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"soortdocument": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"isContractDocument": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"data",
"naam",
"extensie",
"soortdocument"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/hypotheekadviezen/6732/documenten/16Response
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"total": 1,
"message": "Validatie fouten",
"_links": {
"help": {
"href": "http://api.fasterforward.nl/",
"title": "Validatie informatie"
}
},
"_embedded": {
"errors": [
{
"path": "/extensie",
"message": "bestand.extensie.verplicht"
}
]
}
}Inkomensverzekering ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/inkomensverzekeringen/{PRODUCT_ID}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/inkomensverzekeringen/6744
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6744
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"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": "Maatschappij",
"communicatievanuitverzekeraar": true,
"particulier": "ja",
"adviseur": "Achternaam00112115, Voornaam (I.)",
"acceptant": null,
"acceptantWorkflowgroep": null,
"behandelaar": "Achternaam00112115, Voornaam (I.)",
"behandelaarWorkflowgroep": null,
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/inkomensverzekeringen/6744"
}
},
"_embedded": {
"correspondentieadres": {
"id": 7793,
"straat": "Groenhof",
"nummer": "1",
"toevoeging": "",
"postcode": "1275BB",
"plaatsnaam": "Huizen",
"land": "NL",
"postcodegebied": "1275",
"longitude": "5.26394006",
"latitude": "52.28904947",
"categorie": "default"
},
"aanvragers": [
{
"id": 120954,
"geslacht": "man",
"initialen": "A.",
"titel": "",
"voornaam": "Aad",
"volledigeVoornamen": "",
"tussenvoegsel": "",
"achternaam": "Jansen",
"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"
}
}
},
{
"id": 120955,
"geslacht": "vrouw",
"initialen": "K.",
"titel": "",
"voornaam": "Kim",
"volledigeVoornamen": "",
"tussenvoegsel": "",
"achternaam": "Jansen - de Jong",
"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"
},
"profielfoto": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120955/profielfoto"
},
"adressen": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120955/adressen"
},
"emailadressen": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120955/emailadressen"
},
"rekeningnummers": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120955/rekeningnummers"
},
"telefoonnummers": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120955/telefoonnummers"
}
}
}
],
"productdelen": [
{
"id": 7905,
"product": "Arbeidsongeschiktheid",
"productgroep": "Arbeidsongeschiktsverzekering",
"polisnummer": "",
"afdbranchecode": null,
"verzekerdBedrag": "0.00",
"verzekerdTermijnbedrag": "0.00",
"koopsom": "0.00",
"eigenRisicoWachttijd": null,
"brutoPremie": "9.86",
"termijnbedragToeslag": "0.00",
"korting": "0.00",
"nettoPremie": "9.86",
"kosten": "0.00",
"assurantiebelasting": "0.00",
"totaal": "0.00",
"premietermijn": "maand",
"hoofdvervaldatum": "2031-09-01T00: 00: 00+02: 00",
"polisLooptijd": 180,
"premievervaldatum": "2031-09-01T00: 00: 00+02: 00",
"premieLooptijd": "180",
"contractvervaldatum": null,
"verlengenOfAflopend": null,
"prolongatiedatum": null,
"royementsdatum": null,
"ingangsdatum": null,
"_embedded": {
"dekkingen": [
{
"dekking": "Arbeidsongeschiktheid",
"dekkingcode": "1100",
"omschrijving": "",
"verzekerdbedrag": "527.00",
"eigenrisicotype": "days",
"eigenrisicobedrag": "365.00"
},
{
"dekking": "Elektronica",
"dekkingcode": "5400",
"omschrijving": "",
"verzekerdbedrag": "30.00",
"eigenrisicotype": "amount",
"eigenrisicobedrag": "0.00"
}
]
}
}
]
}
}Inkomensverzekering toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/inkomensverzekeringen
Wijzigingen met release 1.10.4
-
De velden acceptantWorkflowgroep, acceptant zijn alleen van toepassing bij omgevingen waar dit voor verzekeringsproducten aan staat.
-
Het veld dossierVerantwoordelijkeWorkflowgroep is hernoemd naar behandelaarWorkflowgroep.
-
Het veld dossierVerantwoordelijke is hernoemd naar behandelaar.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/inkomensverzekeringen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Particulier
{
"portefeuille": "Eigen beheer",
"omschrijving": "Inkomensverzekering",
"status": {
"id": 1
},
"bestaandePropositie": {
"id": 3334
},
"adviseur": {
"id": 112115
},
"behandelaarWorkflowgroep": {
"id": 45
},
"bronvermelding": {
"id": 3
},
"aanbrengerPersoon": {
"id": 120956
},
"aanbrengerOrganisatie": {
"id": 14851
},
"polisnummer": "12345",
"offerteaanvraagdatum": "2016-01-01",
"offerteaanvraagdatumDefinitief": true,
"startdatum": "2016-01-01",
"startdatumDefinitief": true,
"polisOpgevraagd": "2016-01-01",
"ontvangstdatumPolis": "2016-01-01",
"uitbetaaldatum": "2016-01-01",
"aanvragerRol": "Particulier",
"aanvragersParticulier": [
{
"id": 120954
},
{
"id": 120955
}
],
"eersteAanvrager": {
"id": 120954
},
"maatschappij": {
"id": 14835
},
"inkoopVia": {
"id": 15100
},
"correspondentieadres": {
"id": 7793
},
"toelichting": "nvt",
"collectiviteitType": "Niet van toepassing",
"toonindigimap": true,
"gearchiveerd": false,
"incassowijze": "Tussenpersoon",
"communicatievanuitverzekeraar": true,
"particulier" : true
}
Zakelijk
{
"portefeuille": "Eigen beheer",
"omschrijving": "Inkomensverzekering",
"status": {
"id": 1
},
"bestaandePropositie": {
"id": 3334
},
"adviseur": {
"id": 112115
},
"behandelaarWorkflowgroep": {
"id": 45
},
"bronvermelding": {
"id": 3
},
"aanbrengerPersoon": {
"id": 120956
},
"aanbrengerOrganisatie": {
"id": 14851
},
"polisnummer": "12345",
"offerteaanvraagdatum": "2016-01-01",
"offerteaanvraagdatumDefinitief": true,
"startdatum": "2016-01-01",
"startdatumDefinitief": true,
"polisOpgevraagd": "2016-01-01",
"ontvangstdatumPolis": "2016-01-01",
"uitbetaaldatum": "2016-01-01",
"aanvragerRol": "Particulier",
"aanvragersParticulier": [
{
"id": 120954
},
{
"id": 120955
}
],
"aanvragerZakelijk": {
"id": 16942
},
"eersteAanvrager": {
"id": 120954
},
"maatschappij": {
"id": 14835
},
"inkoopVia": {
"id": 15100
},
"correspondentieadres": {
"id": 7793
},
"toelichting": "nvt",
"collectiviteitType": "Niet van toepassing",
"toonindigimap": true,
"gearchiveerd": false,
"particulier" : false
}Schema
{
"title": "Inkomensverzekering",
"type": "object",
"properties": {
"portefeuille": {
"enum" : [
"Eigen beheer",
"Extern beheer"
]
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bestaandePropositie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"adviseur": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"acceptant": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"acceptantWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"behandelaar": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"behandelaarWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bronvermelding": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanbrengerPersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanbrengerOrganisatie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"polisnummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"offerteaanvraagdatum": {
"type": "string",
"format": "date"
},
"offerteaanvraagdatumDefinitief": {
"type": "boolean"
},
"startdatum": {
"type": "string",
"format": "date"
},
"startdatumDefinitief": {
"type": "boolean"
},
"polisOpgevraagd": {
"type": "string",
"format": "date"
},
"ontvangstdatumPolis": {
"type": "string",
"format": "date"
},
"uitbetaaldatum": {
"type": "string",
"format": "date"
},
"aanvragerRol": {
"enum": [
"Particulier",
"Zakelijk"
]
},
"aanvragerZakelijk": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanvragersParticulier": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"eersteAanvrager": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"maatschappij": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"inkoopVia": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"correspondentieadres": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"toelichting": {
"type": "string",
"minLength": 1
},
"collectiviteitType": {
"enum": [
"Niet van toepassing",
"Mantel",
"Contract"
]
},
"toonindigimap": {
"type": "boolean"
},
"gearchiveerd": {
"type": "boolean"
},
"incassowijze": {
"enum": [
"Maatschappij",
"Tussenpersoon"
]
},
"handmatigprolongeren": {
"type": "boolean"
},
"particulier": {
"type": "boolean"
},
"communicatievanuitverzekeraar": {
"type": "boolean"
}
},
"required": [
"toonindigimap",
"offerteaanvraagdatum",
"offerteaanvraagdatumDefinitief",
"startdatum",
"startdatumDefinitief",
"gearchiveerd",
"portefeuille",
"status",
"adviseur",
"maatschappij",
"bestaandePropositie",
"bronvermelding",
"inkoopVia",
"aanvragerRol",
"collectiviteitType"
],
"allOf": [
{
"oneOf": [
{
"properties": {
"aanvragerRol": {
"enum": ["Particulier"]
}
},
"required": ["aanvragersParticulier"]
},
{
"properties": {
"aanvragerRol": {
"enum": ["Zakelijk"]
}
},
"required": ["aanvragerZakelijk"]
}
]
},
{
"oneOf": [
{ "required": ["behandelaar"] },
{ "required": ["behandelaarWorkflowgroep"] }
]
}
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/inkomensverzekeringen/6755Inkomensverzekeringdeel toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/inkomensverzekeringen/{PRODUCT_ID}/onderdelen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/inkomensverzekeringen/6755/onderdelen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6755
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"artikel": {
"id": 20696
},
"polisnummer": "12345",
"zeroProduct": true,
"brutoPremie": 125,
"premietermijn": "Maand",
"nettoPremie": 100,
"incasso": 0,
"vergoedingspercentageEenmalig": 0,
"vergoedingspercentageDoorlopend": 0,
"prolongatieProvisiebedrag": 0,
"polisLooptijd": 12,
"hoofdvervaldatum": "2018-01-01",
"premieLooptijd": 12,
"premievervaldatum": "2018-01-01",
"royementsdatum": "2018-01-01",
"contractvervaldatum": "2018-01-01",
"betalingsprofiel": {
"id": 1
},
"verzekerdbedrag": 100000,
"verzekerdtermijnbedrag": 50,
"doelkapitaal": 100,
"koopsom": 100,
"eigenRisicoWachttijd": "0 dagen",
"korting": 2.5,
"kosten": 5.25,
"assurantiebelasting": 10.25,
"verlengenAflopend": "Verlengen",
"prolongatiedatum": "2018-06-01"
}Schema
{
"title": "Inkomenverzekeringdeel",
"type": "object",
"properties": {
"artikel": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"polisnummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"zeroProduct": {
"type": "boolean"
},
"brutoPremie": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"termijnbedragToeslag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"premietermijn": {
"enum": [
"Maand",
"Kwartaal",
"Semester",
"Jaar",
"2 maanden",
"Eenmalig"
]
},
"nettoPremie": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"incasso": {
"type": "number",
"description": "Termijnbedrag totaal in Elements",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"vergoedingspercentageEenmalig": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"vergoedingspercentageDoorlopend": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"prolongatieProvisiebedrag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"polisLooptijd": {
"type": "integer",
"minimum": 0
},
"hoofdvervaldatum": {
"type": "string",
"format": "date"
},
"premieLooptijd": {
"type": "integer",
"minimum": 0
},
"premievervaldatum": {
"type": "string",
"format": "date"
},
"royementsdatum": {
"type": "string",
"format": "date"
},
"contractvervaldatum": {
"type": "string",
"format": "date"
},
"betalingsprofiel": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verzekerdbedrag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"verzekerdtermijnbedrag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"doelkapitaal": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"koopsom": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"eigenRisicoWachttijd": {
"enum": [
"0 dagen",
"14 dagen",
"30 dagen",
"60 dagen",
"90 dagen",
"180 dagen",
"365 dagen",
"730 dagen"
]
},
"bijzonderheden": {
"type": "string",
"minLength": 1
},
"korting": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"kosten": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"assurantiebelasting": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"verlengenAflopend": {
"enum": [
"Verlengen",
"Aflopend"
]
},
"prolongatiedatum": {
"type": "string",
"format": "date"
}
},
"required": [
"artikel",
"premietermijn",
"polisLooptijd",
"premieLooptijd",
"vergoedingspercentageEenmalig",
"vergoedingspercentageDoorlopend"
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/inkomensverzekeringen/6755/onderdelen/7917Inkomensverzekering registratie ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/inkomensverzekeringen/{PRODUCT_ID}/registraties]&publiek={publiek}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/inkomensverzekeringen/6735/registraties]&publiek=0
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6735- publiek
int(optioneel) Voorbeeld: 0
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/inkomensverzekeringen/6735/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/inkomensverzekeringen/6735/registraties/275825"
},
"product": {
"href": "/api/data/klantdossiers/5526/inkomensverzekeringen/6735"
},
"bestand": {
"href": "/api/data/klantdossiers/5526/documenten/2"
}
}
}
]
}
}Inkomensverzekering registratie toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/inkomensverzekeringen/{PRODUCT_ID}/registraties
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/inkomensverzekeringen/6755/registraties
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6755
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Klantdossier - Registratie toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/inkomensverzekeringen/6755/registraties/275826Inkomensverzekering taak toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/inkomensverzekeringen/{PRODUCT_ID}/taken
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/inkomensverzekeringen/6755/taken
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6755
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",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"prioriteit": {
"enum": [
"Laag",
"Middel",
"Hoog"
]
},
"startdatum": {
"type": "string",
"format": "date"
},
"einddatum": {
"type": "string",
"format": "date"
},
"afgerond": {
"type": "boolean"
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"initiator": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"genodigden": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"verantwoordelijke": {
"enum": [
"Persoon",
"Workflowgroep",
"WorkflowgroepMetPersoon"
]
},
"verantwoordelijkePersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verantwoordelijkeWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"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/inkomensverzekeringen/6755/taken/55519Inkomensverzekering workflow toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/inkomensverzekeringen/{PRODUCT_ID}/workflows
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/inkomensverzekeringen/6755/workflows
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6755
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"workflow": {
"id": 21
}
}Schema
{
"properties": {
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"workflow"
]
}Response
204VerbergBekijk
Headers
Content-Type: application/jsonInkomensverzekering / schademelding workflow toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/inkomensverzekeringen/{PRODUCT_ID}/schademelding/{SCHADEMELDING_ID}/workflows
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/inkomensverzekeringen/6753/schademelding/1/workflows
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6753- SCHADEMELDING_ID
int(verplicht) Voorbeeld: 1
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"workflow": {
"id": 21
}
}Schema
{
"properties": {
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"workflow"
]
}Response
204VerbergBekijk
Headers
Content-Type: application/jsonInkomensverzekering factuur toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/inkomensverzekeringen/{PRODUCT_ID}/facturen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/inkomensverzekeringen/6755/facturen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6755
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Factuur - Factuur toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/inkomensverzekeringen/6755/facturen/1Inkomensverzekering factuurregel toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/inkomensverzekeringen/{PRODUCT_ID}/facturen/{FACTUUR_ID}/regels
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/inkomensverzekeringen/6755/facturen/1/regels
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6755- FACTUUR_ID
int(verplicht) Voorbeeld: 1
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Factuur - Factuurregel toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/inkomensverzekeringen/6755/facturen/1Inkomensverzekeringsdocument toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/inkomensverzekeringen/{PRODUCT_ID}/documenten
Let op: Als het protocol HDN is, zijn alleen PDF bestanden toegestaan.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/2818/inkomensverzekeringen/6732/documenten
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 2818- PRODUCT_ID
int(verplicht) Voorbeeld: 6732
Request
VerbergBekijk
Body
{
"naam": "fasterforward.png",
"extensie": "png",
"soortdocument": {
"id": 1
},
"data": "iVBORw0KGgoAAAANSUhEUgAAAP0AAAAbCAYAAAC3KIljAAAKsElEQVR42u2dC3BVxRnH82gCISQk
0ZYEUHTCDBrBBJESmbakVMI7Kj4KDFhGwlBtlUzk2RYIAUGbalHEYnl4DdACSSB1EhsBBwTpRAUa
ERIVWu4QCO88KTQ3Cem/M19mvjmze3bPuWdyL/F+M7/Jze73fbvnsv9z9uzZE4LanbP6oID5xNLT
Rx8A7V6SFRSw2/Hffg1oB26VLzTanz58N0WP/o4CxQIiA6IPWBcVfa/vuuhnApHF3MaivwjSbNIv
KGBdWvQ07nsHRN+1RO8OClhA9CYWuNIHRB+wgOi9E3BA9AHRBywg+v/nDwEPgxdAHtgEXODPYDmY
Du61kC8UjABzwevARawFL4NHQXhniB6+3cFEsAxspH68AWaD/g5+h2HgByC0s0WPnNHgWbAefAj2
g50gBwzvokIKBengFVAI9oKPwFawGAzupH50A0kgFQwC3f1a9MjRAywGF4GOlYNxJvm6gYWa+erA
CtDTkCMXVBBnJbFfMZ8KSV+iwGrQAMysFNxvcky/BmsMjGT1o0EZuEn5TnWW6JErDCwF1ym3jM/A
MJM8mcAFMg3lI8A68Dlwg35UnkP+uZr9nAlcxFAN/yjm/7Sg/jFwBrQrKAEJJu3kUhvprCwEPA62
gePgU0nsRLAHeAxttoAykO53okf8APA1sGMLBPl6gsM2clWCeJbHZTWBoC8PgTO68STYKZLv6YDA
PwuES/rq7gzRI08vcIgNtisk0NlgKpgP9rF6D5guyeUiHxebORQIRHQP1f+efm8DsRp9Pc5yvKHh
/yTzH22oy2Z1jeA98Dx4BsyiK/9XzKcKREraqSCfLPp9ADhqOGa3ISYS7DL41FCub0ErK98AQn0t
en6FrwLe2FBDzg3Arh1wQvQUnwIagFVrAxkWRL8NtPtC9DSQ9rLBtRb0kPimgjNMpOPMRE+D+guW
+xIoBBtBHMvZTkxT9LWfQSCVGsf3HvnWgjBWngzaqG4/iJfEB4OFrM0lKtGT4K+wmNN0tV9lmMof
ZD47QJLgVisT1JDP2/4i+nmSnCUgFcSCaJBsMrjfYvniQIvApwwMB5EgBgwFWyT5HvV2ek+zjX8L
/G+Bj2m6vwwUAY/A7xrorSH6/QDmM9G/xAbeK1SsEl41+V8A0Saif7ujnzTNDZaI6jz5/UXRdib5
NbA+323iHwIukV++oW4DlV8DcRrHvZ/8TypEPw8coc+HQarEfxU7hsWKtu9kJ89PnBJ9G6iwwECW
74gg35cgVLQoJ5kq72E+44HI+kqOZ5/AN8/bhTxaIzBaA0gT+A4GV6QnMy56PWsBzRqiPwtiLBLF
7+PZVaQChGqeKCawAZstEf1B0EpT3DsU+dZSTJ1ZH9hU+E3gps9zTPyHs35mGOrOUfk6zWNeQP7N
CtGX0898ECbxjQfN5Ldbs/0+oIlifPKcPoXluwTqDbxs0v7fhFNytTjHSPI9DooN/Nau6Mk3AtQK
fJ8yOa7pAv8mEKkp+kawkD8FoL45vQ23guV5ipVPsjhDOExxp0WiJ+rBXRq5fsZiRposNDaSzxiw
jj4Xm+RdQT7XQYRhau0m2NqEepZBRMtETxwD4aoTCDHQwne+1Leit2E01T+vEP04ILL/gFwwSLtB
+6KfJPCrBsEm+cNBnSAuQ0P0TUD9WMh50a+nssvgexZFP4cvyklEv9zCusJVismT+Iyk+hugO5tt
NDGByYRYEOSlddyqEDEK0Y9R5PoH+R222Ie7/V709NjtfjAZrGaCNxN9FGhUtH8RFIL54IcgxGHR
vyrwqwJZCv4liMvREP08m5tzakCKRQYKVsKLbYjgPjYAn5GIfoCFfJsoplJSv5rqP6DfI8BNKhul
WPSb4sVTjWFgJWjVFP1lEGL2aJT1O9dGn75xSvS3gNsCSZINJRPAH2lwn7Oz4k65ZlCfdO0q2AyS
HRJ9AXDKtitE3wrifLEjjy1yvWojNoTf1wtEX2cx30SWL9FEVM+zslIq+4PA/5dU1wyiNe6Xp4E8
UAz+CWpBO8OjKfoPLTyB+LmN732XvzynnwJqHHjMxnOOBacs5rkFXgPBXop+H3DKPlKI/oSvtuGy
q9cim/H1FJ8jEH2Vjd1oDRSbJRBlO9Gflf+Kyo4L8pVQXYlJm+Npqn2LfDlN4CjYSu3M1RT9+4rj
HMz3Ddj4zjf6wyO7bGBmHnAC7ARzQJmG6PmW3nSwBlQCXVvipegLgVN2QCH6Ml+Jnl3NVtiMb6H4
BQLRV9jIt51i9xrKn6PyE4bye5iA+rFyPvWfZbbIxzgEfgfSQV/RTkBN0bsUx5jE8oy18R25fCp6
xPUBHsnC1HKQAkINMcVSYajb+z54jG4hzipWwiO8EP16gd9eu+JSiL7Yh6I/RXnybcQmsMH7nEOi
f5pNpaNZeaFskQ9lJ6kuk5VNYhuI7hDEjGV9P6LYW++06Pn3NsPGd1Tqa9G/JMmXahJTqhS9fvs/
pQ00IhvmheizBH7nu6Dod1Ceb2zETmaDd4hDou/JrtBPUlkou41IE8TkUd0uwVOJjyXtFFH9VRCr
2bcsh0QfzI7ndRvfUbWvRf+WINfXiphvFVPg/aDewFSTfCOByNI0RR8ryDlI4vuI4tieAC4DyX4r
eronJlJsnTBoQ40Toqf4Dwx793/E9saHCfzTeD0IZhtvXpS0cZrqN1no12YnRE++e8hXoBX1eoAP
RK+cBrsVV2bVfe92QX2BSc40Sc4HNEU/SJL3C4HvMRAl8U8WbOipBz38WPRx7Mq63ULcQLaa/SYV
OyX6Z9lLPyFgJf1eJPEP4zMBMIQJo48ohp0U3tHsUyyoc1D0s4SbkdRx7/qD6H8jyTdb4PsTcEHi
Xy7Z2cYtB4Qbct4Fjgp8L4EQg+80Sd5PwFQwHszQ2A58CswG94G+tE8gD9wQ+C7z2+k9WcfONmKi
hn8oa98DEh0WfRxbIEwFx9i6gdDYW3yrwRL6XG7iX04+lSBEYzqeT/5OiT4SXGNrCmEaMQ+DVtDm
a9EPATKrAgWgCJwEZlbFd7aZvKZbC0rBNnAIeCR+ixS3Abpv2W0Edq0SRNwGoo9jV74bYJLinruQ
DX7a7uyQ6MnYW3+b+FVbY5GtAnxOn+eb+Ofyt+YU7+JvIb8tfA1DIXqr23r/CrqZ+A4BF8h3sz88
stsBrFitaIed4AWWq8COlYEwyTbZy6pgQcxuYNXOgUQ/X8jj+R7s2AZLFIEJIAHEgAdANqhmPvkg
2GnR84017Kp2TOHfu+NZO/uZqHhrjR/vbjCKyuNpHWEluEz1pSCO5a4GO0GKXdFTzJ9YH06CX4A+
7LXaH5NPS8dJFsz0B9H3An/XfHPsNTBZUh9vyJtIeXXtJuUPN+lrBmi2+Ec0gkE2aARKoz4n+N3q
vTpnInuJxoybYJFB8E6LPsGwYWalRgx/b/+4hv9w9kqvGVtBOMVsM9SleSn6YBKyR9GHho7bG5+I
XiGoXYb99ddooC8D95JfDMgR8KAk70NgFThouFJ7gBuUgLkgXrOfSeBduoVoNpyUzpnExYAXSdQ1
hheBvgTvgEf8/pGdehCOo8HtZsK7Dj4DSwE7oTkuep7nUzboR2j45zD/pRb+HuB82pXXxGYKbppy
pwnWMzJAFngB3OmN6Flsf7AKHAX/ZSfXcrDI0E4KyLHyn5X8D8jtDvnJzJ4qAAAAAElFTkSuQmCC"
}Schema
{
"properties": {
"data": {
"type": "string",
"minLength": 1
},
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"extensie": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"soortdocument": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"isContractDocument": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"data",
"naam",
"extensie",
"soortdocument"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/inkomensverzekeringen/6732/documenten/16Response
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"total": 1,
"message": "Validatie fouten",
"_links": {
"help": {
"href": "http://api.fasterforward.nl/",
"title": "Validatie informatie"
}
},
"_embedded": {
"errors": [
{
"path": "/extensie",
"message": "bestand.extensie.verplicht"
}
]
}
}Levensverzekering ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/levensverzekeringen/{PRODUCT_ID}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/levensverzekeringen/6742
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6742
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"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",
"maatschappij": "ABN AMRO",
"ingangsdatum": "2016-08-01T00:00:00+02:00",
"ingangsdatumDefinitief": "nee",
"garantiekapitaal": "0.00",
"incassowijze": "Tussenpersoon",
"factuurtype": "Overschrijving",
"factuurverzendenbij": "Elke prolongatie",
"factuurverzendwijze": "E-mail",
"handmatigprolongeren": "nee",
"adviseur": "Achternaam, oornaam (I.)",
"particulier": "ja",
"communicatieVanuitVerzekeraar": "ja",
"doelverzekering": "Hypotheek",
"verzekeringsmotief": "Hypotheek",
"acceptant": null,
"acceptantWorkflowgroep": null,
"behandelaar": "Achternaam00112115, Voornaam (I.)",
"behandelaarWorkflowgroep": null,
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/levensverzekeringen/6742"
},
"verpandAan": {
"href": "/api/data/klantdossiers/5526/hypotheken/6732"
}
},
"_embedded": {
"correspondentieadres": {
"id": 7793,
"straat": "Groenhof",
"nummer": "1",
"toevoeging": "",
"postcode": "1275BB",
"plaatsnaam": "Huizen",
"land": "NL",
"postcodegebied": "1275",
"longitude": "5.26394006",
"latitude": "52.28904947",
"categorie": "default"
},
"verzekeringsnemers": [
{
"id": 120954,
"geslacht": "man",
"initialen": "A.",
"titel": "",
"voornaam": "Aad",
"volledigeVoornamen": "",
"tussenvoegsel": "",
"achternaam": "Jansen",
"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"
}
}
},
{
"id": 120955,
"geslacht": "vrouw",
"initialen": "K.",
"titel": "",
"voornaam": "Kim",
"volledigeVoornamen": "",
"tussenvoegsel": "",
"achternaam": "Jansen - de Jong",
"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"
},
"profielfoto": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120955/profielfoto"
},
"adressen": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120955/adressen"
},
"emailadressen": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120955/emailadressen"
},
"rekeningnummers": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120955/rekeningnummers"
},
"telefoonnummers": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120955/telefoonnummers"
}
}
}
],
"contactpersonen": [
{
"id": 120954,
"geslacht": "X",
"initialen": "A.",
"titel": "",
"voornaam": "Aad",
"volledigeVoornamen": "",
"tussenvoegsel": "",
"achternaam": "Jansen",
"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"
}
}
},
{
"id": 120955,
"geslacht": "vrouw",
"initialen": "K.",
"titel": "",
"voornaam": "Kim",
"volledigeVoornamen": "",
"tussenvoegsel": "",
"achternaam": "Jansen - de Jong",
"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"
},
"profielfoto": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120955/profielfoto"
},
"adressen": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120955/adressen"
},
"emailadressen": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120955/emailadressen"
},
"rekeningnummers": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120955/rekeningnummers"
},
"telefoonnummers": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120955/telefoonnummers"
}
}
}
],
"verzekerden": [
{
"id": 120954,
"geslacht": null,
"initialen": "A.",
"titel": "",
"voornaam": "Aad",
"volledigeVoornamen": "",
"tussenvoegsel": "",
"achternaam": "Jansen",
"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"
}
}
}
],
"productdelen": [
{
"id": 7903,
"product": "Levensverzekering",
"looptijd": 360,
"soortVerzekering": "Overlijdensrisicoverzekering",
"polisnummer": "",
"verzekeringsduur": 360,
"hoofdvervaldatum": "2046-08-01T00:00:00+01:00",
"_embedded": {
"premies": [
{
"startdatum": "2016-07-11T00:00:00+02:00",
"einddatum": "2041-08-01T00:00:00+01:00",
"premiebedrag": "0.00",
"premieduur": 300,
"premietermijn": "maand"
}
],
"kapitalen": [
{
"kapitaalBijOverlijden": "45000.00",
"kapitaalBijOverlijdenPercentage": "0.00",
"kapitaalBijLeven": "0.00",
"kapitaalBijLevenType": "prognose",
"kapitaalBijLevenPercentage": "0.00",
"dekkingstypeDalendPercentage": "0.00",
"minimaalBedragEinddatum": "0.00",
"_embedded": {
"persoon": [
{
"id": 120954,
"geslacht": null,
"initialen": "A.",
"titel": "",
"voornaam": "Aad",
"volledigeVoornamen": "",
"tussenvoegsel": "",
"achternaam": "Jansen",
"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"
}
}
}
]
}
}
],
"inleg": [
{
"bedrag": "5000.00",
"datum": "2016-07-11T00:00:00+02:00",
"nummer": 1
}
]
}
}
]
}
}Levensverzekering toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/levensverzekeringen
Wijzigingen met release 1.10.4
-
De velden acceptantWorkflowgroep, acceptant zijn alleen van toepassing bij omgevingen waar dit voor verzekeringsproducten aan staat.
-
Het veld dossierVerantwoordelijkeWorkflowgroep is hernoemd naar behandelaarWorkflowgroep.
-
Het veld dossierVerantwoordelijke is hernoemd naar behandelaar.
Wijzigingen met release 1.9.3
-
Het veld verzekeringnemers is deprecated. Gebruik hiervoor verzekeringnemersParticulier. 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 verzekeringnemerZakelijk gevuld te worden met het id van de zakelijke klant. Verzekerden zijn echter particuliere klanten.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/levensverzekeringen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"portefeuille": "Eigen beheer",
"omschrijving": "Levensverzekering",
"status": {
"id": 1
},
"bestaandePropositie": {
"id": 3334
},
"verpandAan": {
"id": 6752
},
"adviseur": {
"id": 112115
},
"behandelaarWorkflowgroep": {
"id": 45
},
"bronvermelding": {
"id": 3
},
"aanbrengerPersoon": {
"id": 120956
},
"aanbrengerOrganisatie": {
"id": 14851
},
"polisnummer": "12345",
"offerteaanvraagdatum": "2016-01-01",
"offerteaanvraagdatumDefinitief": true,
"ingangsdatum": "2016-01-01",
"ingangsdatumDefinitief": true,
"aanvraagNaarMaatschappij": "2016-01-01",
"startdatumMedischTraject": "2016-01-01",
"keuringsdatum": "2016-01-01",
"medischAkkoord": "2016-01-01",
"technischAkkoord": "2016-01-01",
"geldigheidMedischAkkoord": "2016-01-01",
"aktedatum": "2016-01-01",
"ontvangstdatumPolis": "2016-01-01",
"datumAfgelegd": "2016-01-01",
"polisOpgevraagd": "2016-01-01",
"verzekeringnemersParticulier": [
{
"id": 120954
},
{
"id": 120955
}
],
"verzekeringnemerZakelijk": {
"id": 16942
},
"verzekerden": [
{
"id": 120955
}
],
"contactpersoon": {
"id": 120955
},
"premiebetalerPersoon": {
"id": 120955
},
"kruislingseVerzekering": true,
"begunstigde": "Standaard",
"maatschappij": {
"id": 14831
},
"inkoopVia": {
"id": 15100
},
"doelKapitaal": 100,
"communicatievanuitverzekeraar": true,
"doelverzekering": "Hypotheek",
"verzekeringsmotief": "Hypotheek",
"garantiekapitaal": 100,
"brutovoorbeeldRendement": 100,
"correspondentieadres": {
"id": 7793
},
"toelichting": "nvt",
"toonindigimap": true,
"gearchiveerd": false,
"incassowijze": "Tussenpersoon",
"factuurtype": "Overschrijving",
"factuurverzendenbij": "Elke prolongatie",
"factuurverzendwijze": "E-mail",
"handmatigprolongeren": false
}Schema
{
"title": "Levensverzekering",
"type": "object",
"properties": {
"portefeuille": {
"enum": [
"Eigen beheer",
"Extern beheer"
]
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bestaandePropositie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verpandAan": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verpandAanOmschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"adviseur": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"acceptant": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"acceptantWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"behandelaar": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"behandelaarWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bronvermelding": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanbrengerPersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanbrengerOrganisatie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"polisnummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"offerteaanvraagdatum": {
"type": "string",
"format": "date"
},
"offerteaanvraagdatumDefinitief": {
"type": "boolean"
},
"ingangsdatum": {
"type": "string",
"format": "date"
},
"ingangsdatumDefinitief": {
"type": "boolean"
},
"aanvraagNaarMaatschappij": {
"type": "string",
"format": "date"
},
"startdatumMedischTraject": {
"type": "string",
"format": "date"
},
"keuringsdatum": {
"type": "string",
"format": "date"
},
"medischAkkoord": {
"type": "string",
"format": "date"
},
"technischAkkoord": {
"type": "string",
"format": "date"
},
"geldigheidMedischAkkoord": {
"type": "string",
"format": "date"
},
"aktedatum": {
"type": "string",
"format": "date"
},
"ontvangstdatumPolis": {
"type": "string",
"format": "date"
},
"datumAfgelegd": {
"type": "string",
"format": "date"
},
"polisOpgevraagd": {
"type": "string",
"format": "date"
},
"verzekeringnemers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"verzekeringnemersParticulier": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"verzekeringnemerZakelijk": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verzekerden": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"contactpersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"premiebetalerPersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"kruislingseVerzekering": {
"type": "boolean"
},
"begunstigde": {
"enum": [
"Standaard",
"Afwijkend"
]
},
"maatschappij": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"inkoopVia": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"doelKapitaal": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"garantiekapitaal": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"brutovoorbeeldRendement": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"correspondentieadres": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"toelichting": {
"type": "string",
"minLength": 1
},
"toonindigimap": {
"type": "boolean"
},
"gearchiveerd": {
"type": "boolean"
},
"termijnbedragBrutopremie": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"toeslag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"termijnbedragKorting": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"termijnbedragNettopremie": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"termijnbedragPoliskosten": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"termijnbedragTussenpersoonkosten": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"termijnbedragTotaal": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"beloningPercentageKantoor": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"beloningPercentageAdviseur": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"premietermijnPer": {
"enum": [
"Maand",
"Kwartaal",
"Semester",
"Jaar",
"2 maanden",
"Eenmalig"
]
},
"incassowijze": {
"enum": [
"Maatschappij",
"Tussenpersoon"
]
},
"factuurtype": {
"enum": [
"Overschrijving",
"Incasso"
]
},
"factuurverzendenbij": {
"enum": [
"Elke prolongatie",
"Hoofdvervaldatum",
"Nooit"
]
},
"factuurverzendwijze": {
"enum": [
"E-mail",
"Post"
]
},
"handmatigprolongeren": {
"type": "boolean"
},
"particulier": {
"type": "boolean"
},
"communicatievanuitverzekeraar": {
"type": "boolean"
},
"verzekeringsmotief": {
"enum": [
"Hypotheek",
"Gerichte Lijfrente",
"Nabestaandenvoorziening",
"Financiering/kredietverstrekking",
"Successieafdekking",
"Compagnonverzekering",
"Keymanverzekering"
]
},
"doelverzekering": {
"enum": [
"Hypotheek",
"Verlies van inkomen (nabestaanden)",
"Compagnon",
"Keyman/-woman",
"Afdekking erfbelasting",
"Fiscale claim bij overlijden",
"Financiering/kredietverstrekking",
"Lijfrente/aanvullend pensioen opbouw"
]
}
},
"required": [
"toonindigimap",
"offerteaanvraagdatum",
"offerteaanvraagdatumDefinitief",
"ingangsdatum",
"ingangsdatumDefinitief",
"gearchiveerd",
"portefeuille",
"status",
"adviseur",
"maatschappij",
"bestaandePropositie",
"bronvermelding",
"inkoopVia",
"begunstigde",
"kruislingseVerzekering"
],
"oneOf": [
{
"required": [
"behandelaar"
]
},
{
"required": [
"behandelaarWorkflowgroep"
]
}
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/levensverzekeringen/6753Levensverzekeringdeel toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/levensverzekeringen/{PRODUCT_ID}/verzekeringdelen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/levensverzekeringen/6753/verzekeringdelen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6753
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"artikel": {
"id": 20795
},
"polisnummer": "12345",
"zeroProduct": true,
"box": "Box 1",
"vrijgesteld": true,
"prolongatieProvisiebedrag": 100,
"looptijd": 100,
"hoofdvervaldatum": "2016-01-01",
"premieLooptijd": 360,
"premievervaldatum": "2016-01-01",
"royementsdatum": "2016-01-01",
"contractvervaldatum": "2016-01-01",
"commissieDeRuiterGegevensActueelPer": "2016-01-01",
"commissieDeRuiterAfkoopwaarde": 100,
"commissieDeRuiterVerwachtKapitaal": 100
}Schema
{
"title": "Levensverzekeringdeel",
"type": "object",
"properties": {
"artikel": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"polisnummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"zeroProduct": {
"type": "boolean"
},
"box": {
"enum": [
"Box 1",
"Box 3",
"Box 1 / Box 3"
]
},
"vrijgesteld": {
"type": "boolean"
},
"prolongatieProvisiebedrag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"looptijd": {
"type": "integer",
"minimum": 0
},
"hoofdvervaldatum": {
"type": "string",
"format": "date"
},
"premieLooptijd": {
"type": "integer",
"minimum": 0
},
"premievervaldatum": {
"type": "string",
"format": "date"
},
"royementsdatum": {
"type": "string",
"format": "date"
},
"contractvervaldatum": {
"type": "string",
"format": "date"
},
"commissieDeRuiterGegevensActueelPer": {
"type": "string",
"format": "date"
},
"commissieDeRuiterAfkoopwaarde": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"commissieDeRuiterVerwachtKapitaal": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"termijnbedragBrutopremie": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"termijnbedragToeslag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"termijnbedragKorting": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"termijnbedragNettopremie": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"termijnbedragPoliskosten": {
"description": "Termijnbedrag kosten in Elements",
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"termijnbedragTotaal": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"premietermijn": {
"enum": [
"Maand",
"Kwartaal",
"Semester",
"Jaar",
"2 maanden",
"Eenmalig"
]
},
"vergoedingspercentageEenmalig": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"vergoedingspercentageDoorlopend": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"afwijkendePremiebetalerParticulier": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"afwijkendePremiebetalerZakelijk": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"factuurtype": {
"enum": [
"Overschrijving",
"Incasso"
]
}
},
"required": [
"artikel",
"looptijd",
"premieLooptijd",
"vrijgesteld",
"box"
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/levensverzekeringen/6753/verzekeringdelen/7915Levensverzekeringdeel kapitaal toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/levensverzekeringen/{PRODUCT_ID}/verzekeringdelen/{PRODUCTDEEL_ID}/kapitalen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/levensverzekeringen/6753/verzekeringdelen/7915/kapitalen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6753- PRODUCTDEEL_ID
int(verplicht) Voorbeeld: 7915
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"kapitaalBijOverlijden": 100000,
"kapitaalBijOverlijdenPercentage": 75,
"kapitaalBijLeven": 100000,
"kapitaalBijLevenType": "Prognose",
"kapitaalBijLevenPercentage": 50,
"medischeOpslag": true,
"persoon": {
"id": 120954
}
}Schema
{
"title": "LevensverzekeringdeelKapitaal",
"type": "object",
"properties": {
"kapitaalBijOverlijden": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"kapitaalBijOverlijdenPercentage": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"kapitaalBijLeven": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"kapitaalBijLevenType": {
"enum": [
"Prognose",
"Gegarandeerd"
]
},
"kapitaalBijLevenPercentage": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"medischeOpslag": {
"type": "boolean"
},
"persoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minimaalBedragEinddatum": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
}
},
"required": [
"kapitaalBijOverlijden",
"kapitaalBijOverlijdenPercentage",
"kapitaalBijLeven",
"kapitaalBijLevenType",
"medischeOpslag",
"persoon"
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/levensverzekeringen/6753/verzekeringdelen/7915/kapitalen/5158Levensverzekeringdeel premie toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/levensverzekeringen/{PRODUCT_ID}/verzekeringdelen/{PRODUCTDEEL_ID}/premies
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/levensverzekeringen/6753/verzekeringdelen/7915/premies
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6753- PRODUCTDEEL_ID
int(verplicht) Voorbeeld: 7915
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"startdatum": "2016-01-01",
"einddatum": "2016-01-01",
"premieduur": 1,
"premiebedrag": 100,
"spaarpremie": 100,
"risicopremie": 100,
"premietype": "Laag",
"premietermijn": "Maand"
}Schema
{
"title": "LevensverzekeringdeelPremie",
"type": "object",
"properties": {
"startdatum": {
"type": "string",
"format": "date"
},
"einddatum": {
"type": "string",
"format": "date"
},
"premieduur": {
"type": "integer",
"minimum": 0
},
"premiebedrag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"spaarpremie": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"risicopremie": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"premietype": {
"enum": [
"Laag",
"Normaal",
"Hoog"
]
},
"premietermijn": {
"enum": [
"Maand",
"Kwartaal",
"Semester",
"Jaar",
"2 maanden",
"Eenmalig"
]
}
},
"required": [
"startdatum",
"einddatum",
"premieduur",
"premiebedrag",
"spaarpremie",
"risicopremie",
"premietype",
"premietermijn"
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/levensverzekeringen/6753/verzekeringdelen/7915/premies/1599Levensverzekeringdeel storting toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/levensverzekeringen/{PRODUCT_ID}/verzekeringdelen/{PRODUCTDEEL_ID}/stortingen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/levensverzekeringen/6753/verzekeringdelen/7915/stortingen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6753- PRODUCTDEEL_ID
int(verplicht) Voorbeeld: 7915
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"bedrag": 100
}Schema
{
"title": "LevensverzekeringdeelInleg",
"type": "object",
"properties": {
"bedrag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
}
},
"required": [
"bedrag"
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/levensverzekeringen/6753/verzekeringdelen/7915/stortingen/1078Levensverzekering registratie ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/levensverzekeringen/{PRODUCT_ID}/registraties]&publiek={publiek}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/levensverzekeringen/6753/registraties]&publiek=0
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6753- publiek
int(optioneel) Voorbeeld: 0
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/levensverzekeringen/6753/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/levensverzekeringen/6753/registraties/275825"
},
"product": {
"href": "/api/data/klantdossiers/5526/levensverzekeringen/6753"
},
"bestand": {
"href": "/api/data/klantdossiers/5526/documenten/2"
}
}
}
]
}
}Levensverzekering registratie toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/levensverzekeringen/{PRODUCT_ID}/registraties
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/levensverzekeringen/6753/registraties
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6753
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Klantdossier - Registratie toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/levensverzekeringen/6753/registraties/275826Levensverzekering taak toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/levensverzekeringen/{PRODUCT_ID}/taken
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/levensverzekeringen/6755/taken
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6755
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",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"prioriteit": {
"enum": [
"Laag",
"Middel",
"Hoog"
]
},
"startdatum": {
"type": "string",
"format": "date"
},
"einddatum": {
"type": "string",
"format": "date"
},
"afgerond": {
"type": "boolean"
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"initiator": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"genodigden": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"verantwoordelijke": {
"enum": [
"Persoon",
"Workflowgroep",
"WorkflowgroepMetPersoon"
]
},
"verantwoordelijkePersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verantwoordelijkeWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"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/levensverzekeringen/6755/taken/55519Levensverzekering workflow toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/levensverzekeringen/{PRODUCT_ID}/workflows
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/levensverzekeringen/6753/workflows
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6753
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"workflow": {
"id": 21
}
}Schema
{
"properties": {
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"workflow"
]
}Response
204VerbergBekijk
Headers
Content-Type: application/jsonLevensverzekering factuur toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/levensverzekeringen/{PRODUCT_ID}/facturen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/levensverzekeringen/6753/facturen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6753
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Factuur - Factuur toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/levensverzekeringen/6753/facturen/1Levensverzekering factuurregel toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/levensverzekeringen/{PRODUCT_ID}/facturen/{FACTUUR_ID}/regels
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/levensverzekeringen/6753/facturen/1/regels
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6753- FACTUUR_ID
int(verplicht) Voorbeeld: 1
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Factuur - Factuurregel toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/levensverzekeringen/6753/facturen/1Levensverzekeringsdocument toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/levensverzekeringen/{PRODUCT_ID}/documenten
Let op: Als het protocol HDN is, zijn alleen PDF bestanden toegestaan.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/2818/levensverzekeringen/6732/documenten
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 2818- PRODUCT_ID
int(verplicht) Voorbeeld: 6732
Request
VerbergBekijk
Body
{
"naam": "fasterforward.png",
"extensie": "png",
"soortdocument": {
"id": 1
},
"data": "iVBORw0KGgoAAAANSUhEUgAAAP0AAAAbCAYAAAC3KIljAAAKsElEQVR42u2dC3BVxRnH82gCISQk
0ZYEUHTCDBrBBJESmbakVMI7Kj4KDFhGwlBtlUzk2RYIAUGbalHEYnl4DdACSSB1EhsBBwTpRAUa
ERIVWu4QCO88KTQ3Cem/M19mvjmze3bPuWdyL/F+M7/Jze73fbvnsv9z9uzZE4LanbP6oID5xNLT
Rx8A7V6SFRSw2/Hffg1oB26VLzTanz58N0WP/o4CxQIiA6IPWBcVfa/vuuhnApHF3MaivwjSbNIv
KGBdWvQ07nsHRN+1RO8OClhA9CYWuNIHRB+wgOi9E3BA9AHRBywg+v/nDwEPgxdAHtgEXODPYDmY
Du61kC8UjABzwevARawFL4NHQXhniB6+3cFEsAxspH68AWaD/g5+h2HgByC0s0WPnNHgWbAefAj2
g50gBwzvokIKBengFVAI9oKPwFawGAzupH50A0kgFQwC3f1a9MjRAywGF4GOlYNxJvm6gYWa+erA
CtDTkCMXVBBnJbFfMZ8KSV+iwGrQAMysFNxvcky/BmsMjGT1o0EZuEn5TnWW6JErDCwF1ym3jM/A
MJM8mcAFMg3lI8A68Dlwg35UnkP+uZr9nAlcxFAN/yjm/7Sg/jFwBrQrKAEJJu3kUhvprCwEPA62
gePgU0nsRLAHeAxttoAykO53okf8APA1sGMLBPl6gsM2clWCeJbHZTWBoC8PgTO68STYKZLv6YDA
PwuES/rq7gzRI08vcIgNtisk0NlgKpgP9rF6D5guyeUiHxebORQIRHQP1f+efm8DsRp9Pc5yvKHh
/yTzH22oy2Z1jeA98Dx4BsyiK/9XzKcKREraqSCfLPp9ADhqOGa3ISYS7DL41FCub0ErK98AQn0t
en6FrwLe2FBDzg3Arh1wQvQUnwIagFVrAxkWRL8NtPtC9DSQ9rLBtRb0kPimgjNMpOPMRE+D+guW
+xIoBBtBHMvZTkxT9LWfQSCVGsf3HvnWgjBWngzaqG4/iJfEB4OFrM0lKtGT4K+wmNN0tV9lmMof
ZD47QJLgVisT1JDP2/4i+nmSnCUgFcSCaJBsMrjfYvniQIvApwwMB5EgBgwFWyT5HvV2ek+zjX8L
/G+Bj2m6vwwUAY/A7xrorSH6/QDmM9G/xAbeK1SsEl41+V8A0Saif7ujnzTNDZaI6jz5/UXRdib5
NbA+323iHwIukV++oW4DlV8DcRrHvZ/8TypEPw8coc+HQarEfxU7hsWKtu9kJ89PnBJ9G6iwwECW
74gg35cgVLQoJ5kq72E+44HI+kqOZ5/AN8/bhTxaIzBaA0gT+A4GV6QnMy56PWsBzRqiPwtiLBLF
7+PZVaQChGqeKCawAZstEf1B0EpT3DsU+dZSTJ1ZH9hU+E3gps9zTPyHs35mGOrOUfk6zWNeQP7N
CtGX0898ECbxjQfN5Ldbs/0+oIlifPKcPoXluwTqDbxs0v7fhFNytTjHSPI9DooN/Nau6Mk3AtQK
fJ8yOa7pAv8mEKkp+kawkD8FoL45vQ23guV5ipVPsjhDOExxp0WiJ+rBXRq5fsZiRposNDaSzxiw
jj4Xm+RdQT7XQYRhau0m2NqEepZBRMtETxwD4aoTCDHQwne+1Leit2E01T+vEP04ILL/gFwwSLtB
+6KfJPCrBsEm+cNBnSAuQ0P0TUD9WMh50a+nssvgexZFP4cvyklEv9zCusJVismT+Iyk+hugO5tt
NDGByYRYEOSlddyqEDEK0Y9R5PoH+R222Ie7/V709NjtfjAZrGaCNxN9FGhUtH8RFIL54IcgxGHR
vyrwqwJZCv4liMvREP08m5tzakCKRQYKVsKLbYjgPjYAn5GIfoCFfJsoplJSv5rqP6DfI8BNKhul
WPSb4sVTjWFgJWjVFP1lEGL2aJT1O9dGn75xSvS3gNsCSZINJRPAH2lwn7Oz4k65ZlCfdO0q2AyS
HRJ9AXDKtitE3wrifLEjjy1yvWojNoTf1wtEX2cx30SWL9FEVM+zslIq+4PA/5dU1wyiNe6Xp4E8
UAz+CWpBO8OjKfoPLTyB+LmN732XvzynnwJqHHjMxnOOBacs5rkFXgPBXop+H3DKPlKI/oSvtuGy
q9cim/H1FJ8jEH2Vjd1oDRSbJRBlO9Gflf+Kyo4L8pVQXYlJm+Npqn2LfDlN4CjYSu3M1RT9+4rj
HMz3Ddj4zjf6wyO7bGBmHnAC7ARzQJmG6PmW3nSwBlQCXVvipegLgVN2QCH6Ml+Jnl3NVtiMb6H4
BQLRV9jIt51i9xrKn6PyE4bye5iA+rFyPvWfZbbIxzgEfgfSQV/RTkBN0bsUx5jE8oy18R25fCp6
xPUBHsnC1HKQAkINMcVSYajb+z54jG4hzipWwiO8EP16gd9eu+JSiL7Yh6I/RXnybcQmsMH7nEOi
f5pNpaNZeaFskQ9lJ6kuk5VNYhuI7hDEjGV9P6LYW++06Pn3NsPGd1Tqa9G/JMmXahJTqhS9fvs/
pQ00IhvmheizBH7nu6Dod1Ceb2zETmaDd4hDou/JrtBPUlkou41IE8TkUd0uwVOJjyXtFFH9VRCr
2bcsh0QfzI7ndRvfUbWvRf+WINfXiphvFVPg/aDewFSTfCOByNI0RR8ryDlI4vuI4tieAC4DyX4r
eronJlJsnTBoQ40Toqf4Dwx793/E9saHCfzTeD0IZhtvXpS0cZrqN1no12YnRE++e8hXoBX1eoAP
RK+cBrsVV2bVfe92QX2BSc40Sc4HNEU/SJL3C4HvMRAl8U8WbOipBz38WPRx7Mq63ULcQLaa/SYV
OyX6Z9lLPyFgJf1eJPEP4zMBMIQJo48ohp0U3tHsUyyoc1D0s4SbkdRx7/qD6H8jyTdb4PsTcEHi
Xy7Z2cYtB4Qbct4Fjgp8L4EQg+80Sd5PwFQwHszQ2A58CswG94G+tE8gD9wQ+C7z2+k9WcfONmKi
hn8oa98DEh0WfRxbIEwFx9i6gdDYW3yrwRL6XG7iX04+lSBEYzqeT/5OiT4SXGNrCmEaMQ+DVtDm
a9EPATKrAgWgCJwEZlbFd7aZvKZbC0rBNnAIeCR+ixS3Abpv2W0Edq0SRNwGoo9jV74bYJLinruQ
DX7a7uyQ6MnYW3+b+FVbY5GtAnxOn+eb+Ofyt+YU7+JvIb8tfA1DIXqr23r/CrqZ+A4BF8h3sz88
stsBrFitaIed4AWWq8COlYEwyTbZy6pgQcxuYNXOgUQ/X8jj+R7s2AZLFIEJIAHEgAdANqhmPvkg
2GnR84017Kp2TOHfu+NZO/uZqHhrjR/vbjCKyuNpHWEluEz1pSCO5a4GO0GKXdFTzJ9YH06CX4A+
7LXaH5NPS8dJFsz0B9H3An/XfHPsNTBZUh9vyJtIeXXtJuUPN+lrBmi2+Ec0gkE2aARKoz4n+N3q
vTpnInuJxoybYJFB8E6LPsGwYWalRgx/b/+4hv9w9kqvGVtBOMVsM9SleSn6YBKyR9GHho7bG5+I
XiGoXYb99ddooC8D95JfDMgR8KAk70NgFThouFJ7gBuUgLkgXrOfSeBduoVoNpyUzpnExYAXSdQ1
hheBvgTvgEf8/pGdehCOo8HtZsK7Dj4DSwE7oTkuep7nUzboR2j45zD/pRb+HuB82pXXxGYKbppy
pwnWMzJAFngB3OmN6Flsf7AKHAX/ZSfXcrDI0E4KyLHyn5X8D8jtDvnJzJ4qAAAAAElFTkSuQmCC"
}Schema
{
"properties": {
"data": {
"type": "string",
"minLength": 1
},
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"extensie": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"soortdocument": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"isContractDocument": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"data",
"naam",
"extensie",
"soortdocument"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/levensverzekeringen/6732/documenten/16Response
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"total": 1,
"message": "Validatie fouten",
"_links": {
"help": {
"href": "http://api.fasterforward.nl/",
"title": "Validatie informatie"
}
},
"_embedded": {
"errors": [
{
"path": "/extensie",
"message": "bestand.extensie.verplicht"
}
]
}
}Pensioen ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/pensioenen/{PRODUCT_ID}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/pensioenen/6745
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6745
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"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",
"acceptant": null,
"acceptantWorkflowgroep": "Bemiddelaar Financieel",
"behandelaar": null,
"behandelaarWorkflowgroep": "Bemiddelaar Financieel",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/pensioenen/6745"
}
},
"_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"
}
]
}
},
"pensioenoverzicht voor": [
{
"id": 120954,
"geslacht": "man",
"initialen": "A.",
"titel": "",
"voornaam": "Aad",
"volledigeVoornamen": "",
"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": 7907,
"product": "Pensioen",
"startdatum": null,
"levenslangpensioenVanafPensioendatum": "0.00",
"overbruggingspensioenTotPensioendatum": "0.00",
"nabestaandenpensioenBijOverlijdenVoorPensioendatum": "0.00",
"nabestaandenpensioenBijOverlijdenNaPensioendatum": "0.00",
"wezenpensioenUitTeKerenTotLeeftijd21Jaar": "0.00"
}
]
}
}Pensioen toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/pensioenen
Wijzigingen met release 1.9.3
-
aanvragerParticulier is alleen te gebruiken voor pensioentype Individueel
-
aanvragerZakelijk is toegevoegd. De waarde is te gebruiken voor overige pensioentypes
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/pensioenen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"portefeuille": "Eigen beheer",
"omschrijving": "Pensioen",
"status": {
"id": 1
},
"bestaandePropositie": {
"id": 3334
},
"adviseur": {
"id": 112115
},
"acceptantWorkflowgroep": {
"id": 45
},
"behandelaarWorkflowgroep": {
"id": 45
},
"bronvermelding": {
"id": 3
},
"aanbrengerPersoon": {
"id": 120956
},
"aanbrengerOrganisatie": {
"id": 14851
},
"polisnummer": "12345",
"offerteaanvraagdatum": "2016-01-01",
"offerteaanvraagdatumDefinitief": true,
"startdatum": "2016-01-01",
"startdatumDefinitief": true,
"polisOpgevraagd": "2016-01-01",
"ontvangstdatumPolis": "2016-01-01",
"typePensioen": "Collectief",
"soortPolis": "B",
"mantel": true,
"mantelOmschrijving": "Omschrijving",
"aanvragerParticulier": {
"id": 120954
},
"premiebetalerPersoon": {
"id": 120954
},
"maatschappij": {
"id": 16279
},
"inkoopVia": {
"id": 15100
},
"correspondentieadres": {
"id": 7793
},
"toelichting": "nvt",
"gearchiveerd": false,
"toonindigimap": true
}Schema
{
"title": "Pensioen",
"type": "object",
"properties": {
"portefeuille": {
"enum": [
"Eigen beheer",
"Extern beheer"
]
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bestaandePropositie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"adviseur": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"acceptant": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"acceptantWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"behandelaar": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"behandelaarWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bronvermelding": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verzekering": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanbrengerPersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanbrengerOrganisatie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"polisnummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"offerteaanvraagdatum": {
"type": "string",
"format": "date"
},
"offerteaanvraagdatumDefinitief": {
"type": "boolean"
},
"startdatum": {
"type": "string",
"format": "date"
},
"startdatumDefinitief": {
"type": "boolean"
},
"polisOpgevraagd": {
"type": "string",
"format": "date"
},
"ontvangstdatumPolis": {
"type": "string",
"format": "date"
},
"typePensioen": {
"enum": [
"Collectief",
"Individueel",
"Semi-collectief"
]
},
"soortPolis": {
"enum": [
"B",
"C"
]
},
"mantel": {
"type": "boolean"
},
"mantelContract": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"mantelOmschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"aanvragerParticulier": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanvragerZakelijk": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"premiebetalerPersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"premiebetalerOrganisatie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"maatschappij": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"inkoopVia": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"correspondentieadres": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"toelichting": {
"type": "string",
"minLength": 1
},
"gearchiveerd": {
"type": "boolean"
},
"toonindigimap": {
"type": "boolean"
}
},
"required": [
"portefeuille",
"status",
"bestaandePropositie",
"adviseur",
"bronvermelding",
"offerteaanvraagdatum",
"offerteaanvraagdatumDefinitief",
"startdatum",
"startdatumDefinitief",
"typePensioen",
"maatschappij",
"inkoopVia",
"gearchiveerd",
"toonindigimap"
],
"allOf": [
{
"oneOf": [
{
"required": [
"aanvragerParticulier"
]
},
{
"required": [
"aanvragerZakelijk"
]
}
]
},
{
"oneOf": [
{
"required": [
"premiebetalerPersoon"
]
},
{
"required": [
"premiebetalerOrganisatie"
]
}
]
},
{
"oneOf": [
{
"required": [
"acceptant"
]
},
{
"required": [
"acceptantWorkflowgroep"
]
}
]
},
{
"oneOf": [
{
"required": [
"behandelaar"
]
},
{
"required": [
"behandelaarWorkflowgroep"
]
}
]
}
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/pensioenen/6759Pensioendeel toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/pensioenen/{PRODUCT_ID}/delen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/pensioenen/6759/delen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6759
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"artikel": {
"id": 20745
},
"zeroProduct": true,
"vorigeWerkgever": "JMT",
"werknemer": {
"id": 120954
},
"ingangsdatumPensioen": "2016-01-01",
"looptijd": 360,
"brutopremie": 125,
"nettopremie": 100,
"premietermijn": "Maand",
"verzameling": 100,
"betalingsprofiel": {
"id": 1
},
"pensioengevendSalaris": 100,
"pensioengrondslag": 100,
"opbouwpercentage": 100,
"doelkapitaal": 100,
"brutoRendement": 100,
"overlijdingsrisicokapitaalTbvNabestaandenpensioen": 100,
"pensioenFranchise": 100,
"levenslangPensioenVanafPensioendatum": 100,
"overbruggingspensioenTotPensioendatum": 100,
"nabestaandenpensioenVoorPensioendatum": 100,
"nabestaandenpensioenNaPensioendatum": 100,
"wezenpensioenTot21": 100,
"premiestijging": "Verzekerd",
"bijdrageWerkgever": 100,
"status": "Premiebetalend"
}Schema
{
"title": "Pensioendeel",
"type": "object",
"properties": {
"artikel": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"zeroProduct": {
"type": "boolean"
},
"gekoppeldInkomen": {
"oneOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"vorigeWerkgever": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"werknemer": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"ingangsdatumPensioen": {
"type": "string",
"format": "date"
},
"looptijd": {
"type": "integer",
"minimum": 0
},
"brutopremie": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"nettopremie": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"premietermijn": {
"enum": [
"Maand",
"Kwartaal",
"Semester",
"Jaar",
"2 maanden",
"Eenmalig"
]
},
"verzameling": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"betalingsprofiel": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"pensioengevendSalaris": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"pensioengrondslag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"opbouwpercentage": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"doelkapitaal": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"brutoRendement": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"overlijdingsrisicokapitaalTbvNabestaandenpensioen": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"pensioenFranchise": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"levenslangPensioenVanafPensioendatum": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"overbruggingspensioenTotPensioendatum": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"nabestaandenpensioenVoorPensioendatum": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"nabestaandenpensioenNaPensioendatum": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"wezenpensioenTot21": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"premiestijging": {
"enum": [
"Verzekerd",
"Niet verzekerd"
]
},
"bijdrageWerkgever": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"status": {
"enum": [
"Premiebetalend",
"Premievrij"
]
}
},
"required": [
"artikel",
"looptijd",
"brutopremie",
"nettopremie",
"verzameling",
"pensioengevendSalaris",
"pensioengrondslag",
"opbouwpercentage",
"pensioenFranchise",
"levenslangPensioenVanafPensioendatum",
"overbruggingspensioenTotPensioendatum",
"nabestaandenpensioenVoorPensioendatum",
"nabestaandenpensioenNaPensioendatum",
"wezenpensioenTot21",
"bijdrageWerkgever",
"premietermijn",
"premiestijging",
"status"
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/pensioenen/6759/delen/7921Pensioen registratie ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/pensioenen/{PRODUCT_ID}/registraties]&publiek={publiek}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/pensioenen/6759/registraties]&publiek=0
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6759- publiek
int(optioneel) Voorbeeld: 0
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/pensioenen/6759/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/pensioenen/6759/registraties/275825"
},
"product": {
"href": "/api/data/klantdossiers/5526/pensioenen/6759"
},
"bestand": {
"href": "/api/data/klantdossiers/5526/documenten/2"
}
}
}
]
}
}Pensioen registratie toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/pensioenen/{PRODUCT_ID}/registraties
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/pensioenen/6759/registraties
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6759
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Klantdossier - Registratie toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/pensioenen/6752/registraties/275826Pensioen taak toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/pensioenen/{PRODUCT_ID}/taken
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/pensioenen/6755/taken
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6755
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",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"prioriteit": {
"enum": [
"Laag",
"Middel",
"Hoog"
]
},
"startdatum": {
"type": "string",
"format": "date"
},
"einddatum": {
"type": "string",
"format": "date"
},
"afgerond": {
"type": "boolean"
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"initiator": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"genodigden": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"verantwoordelijke": {
"enum": [
"Persoon",
"Workflowgroep",
"WorkflowgroepMetPersoon"
]
},
"verantwoordelijkePersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verantwoordelijkeWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"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/pensioenen/6755/taken/55519Pensioen workflow toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/pensioenen/{PRODUCT_ID}/workflows
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/pensioenen/6759/workflows
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6759
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"workflow": {
"id": 21
}
}Schema
{
"properties": {
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"workflow"
]
}Response
204VerbergBekijk
Headers
Content-Type: application/jsonPensioen factuur toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/pensioenen/{PRODUCT_ID}/facturen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/pensioenen/6759/facturen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6759
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Factuur - Factuur toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/pensioenen/6759/facturen/1Pensioen factuurregel toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/pensioenen/{PRODUCT_ID}/facturen/{FACTUUR_ID}/regels
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/pensioenen/6759/facturen/1/regels
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6759- FACTUUR_ID
int(verplicht) Voorbeeld: 1
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Factuur - Factuurregel toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/pensioenen/6759/facturen/1Pensioensdocument toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/pensioenen/{PRODUCT_ID}/documenten
Let op: Als het protocol HDN is, zijn alleen PDF bestanden toegestaan.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/2818/pensioenen/6732/documenten
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 2818- PRODUCT_ID
int(verplicht) Voorbeeld: 6732
Request
VerbergBekijk
Body
{
"naam": "fasterforward.png",
"extensie": "png",
"soortdocument": {
"id": 1
},
"data": "iVBORw0KGgoAAAANSUhEUgAAAP0AAAAbCAYAAAC3KIljAAAKsElEQVR42u2dC3BVxRnH82gCISQk
0ZYEUHTCDBrBBJESmbakVMI7Kj4KDFhGwlBtlUzk2RYIAUGbalHEYnl4DdACSSB1EhsBBwTpRAUa
ERIVWu4QCO88KTQ3Cem/M19mvjmze3bPuWdyL/F+M7/Jze73fbvnsv9z9uzZE4LanbP6oID5xNLT
Rx8A7V6SFRSw2/Hffg1oB26VLzTanz58N0WP/o4CxQIiA6IPWBcVfa/vuuhnApHF3MaivwjSbNIv
KGBdWvQ07nsHRN+1RO8OClhA9CYWuNIHRB+wgOi9E3BA9AHRBywg+v/nDwEPgxdAHtgEXODPYDmY
Du61kC8UjABzwevARawFL4NHQXhniB6+3cFEsAxspH68AWaD/g5+h2HgByC0s0WPnNHgWbAefAj2
g50gBwzvokIKBengFVAI9oKPwFawGAzupH50A0kgFQwC3f1a9MjRAywGF4GOlYNxJvm6gYWa+erA
CtDTkCMXVBBnJbFfMZ8KSV+iwGrQAMysFNxvcky/BmsMjGT1o0EZuEn5TnWW6JErDCwF1ym3jM/A
MJM8mcAFMg3lI8A68Dlwg35UnkP+uZr9nAlcxFAN/yjm/7Sg/jFwBrQrKAEJJu3kUhvprCwEPA62
gePgU0nsRLAHeAxttoAykO53okf8APA1sGMLBPl6gsM2clWCeJbHZTWBoC8PgTO68STYKZLv6YDA
PwuES/rq7gzRI08vcIgNtisk0NlgKpgP9rF6D5guyeUiHxebORQIRHQP1f+efm8DsRp9Pc5yvKHh
/yTzH22oy2Z1jeA98Dx4BsyiK/9XzKcKREraqSCfLPp9ADhqOGa3ISYS7DL41FCub0ErK98AQn0t
en6FrwLe2FBDzg3Arh1wQvQUnwIagFVrAxkWRL8NtPtC9DSQ9rLBtRb0kPimgjNMpOPMRE+D+guW
+xIoBBtBHMvZTkxT9LWfQSCVGsf3HvnWgjBWngzaqG4/iJfEB4OFrM0lKtGT4K+wmNN0tV9lmMof
ZD47QJLgVisT1JDP2/4i+nmSnCUgFcSCaJBsMrjfYvniQIvApwwMB5EgBgwFWyT5HvV2ek+zjX8L
/G+Bj2m6vwwUAY/A7xrorSH6/QDmM9G/xAbeK1SsEl41+V8A0Saif7ujnzTNDZaI6jz5/UXRdib5
NbA+323iHwIukV++oW4DlV8DcRrHvZ/8TypEPw8coc+HQarEfxU7hsWKtu9kJ89PnBJ9G6iwwECW
74gg35cgVLQoJ5kq72E+44HI+kqOZ5/AN8/bhTxaIzBaA0gT+A4GV6QnMy56PWsBzRqiPwtiLBLF
7+PZVaQChGqeKCawAZstEf1B0EpT3DsU+dZSTJ1ZH9hU+E3gps9zTPyHs35mGOrOUfk6zWNeQP7N
CtGX0898ECbxjQfN5Ldbs/0+oIlifPKcPoXluwTqDbxs0v7fhFNytTjHSPI9DooN/Nau6Mk3AtQK
fJ8yOa7pAv8mEKkp+kawkD8FoL45vQ23guV5ipVPsjhDOExxp0WiJ+rBXRq5fsZiRposNDaSzxiw
jj4Xm+RdQT7XQYRhau0m2NqEepZBRMtETxwD4aoTCDHQwne+1Leit2E01T+vEP04ILL/gFwwSLtB
+6KfJPCrBsEm+cNBnSAuQ0P0TUD9WMh50a+nssvgexZFP4cvyklEv9zCusJVismT+Iyk+hugO5tt
NDGByYRYEOSlddyqEDEK0Y9R5PoH+R222Ie7/V709NjtfjAZrGaCNxN9FGhUtH8RFIL54IcgxGHR
vyrwqwJZCv4liMvREP08m5tzakCKRQYKVsKLbYjgPjYAn5GIfoCFfJsoplJSv5rqP6DfI8BNKhul
WPSb4sVTjWFgJWjVFP1lEGL2aJT1O9dGn75xSvS3gNsCSZINJRPAH2lwn7Oz4k65ZlCfdO0q2AyS
HRJ9AXDKtitE3wrifLEjjy1yvWojNoTf1wtEX2cx30SWL9FEVM+zslIq+4PA/5dU1wyiNe6Xp4E8
UAz+CWpBO8OjKfoPLTyB+LmN732XvzynnwJqHHjMxnOOBacs5rkFXgPBXop+H3DKPlKI/oSvtuGy
q9cim/H1FJ8jEH2Vjd1oDRSbJRBlO9Gflf+Kyo4L8pVQXYlJm+Npqn2LfDlN4CjYSu3M1RT9+4rj
HMz3Ddj4zjf6wyO7bGBmHnAC7ARzQJmG6PmW3nSwBlQCXVvipegLgVN2QCH6Ml+Jnl3NVtiMb6H4
BQLRV9jIt51i9xrKn6PyE4bye5iA+rFyPvWfZbbIxzgEfgfSQV/RTkBN0bsUx5jE8oy18R25fCp6
xPUBHsnC1HKQAkINMcVSYajb+z54jG4hzipWwiO8EP16gd9eu+JSiL7Yh6I/RXnybcQmsMH7nEOi
f5pNpaNZeaFskQ9lJ6kuk5VNYhuI7hDEjGV9P6LYW++06Pn3NsPGd1Tqa9G/JMmXahJTqhS9fvs/
pQ00IhvmheizBH7nu6Dod1Ceb2zETmaDd4hDou/JrtBPUlkou41IE8TkUd0uwVOJjyXtFFH9VRCr
2bcsh0QfzI7ndRvfUbWvRf+WINfXiphvFVPg/aDewFSTfCOByNI0RR8ryDlI4vuI4tieAC4DyX4r
eronJlJsnTBoQ40Toqf4Dwx793/E9saHCfzTeD0IZhtvXpS0cZrqN1no12YnRE++e8hXoBX1eoAP
RK+cBrsVV2bVfe92QX2BSc40Sc4HNEU/SJL3C4HvMRAl8U8WbOipBz38WPRx7Mq63ULcQLaa/SYV
OyX6Z9lLPyFgJf1eJPEP4zMBMIQJo48ohp0U3tHsUyyoc1D0s4SbkdRx7/qD6H8jyTdb4PsTcEHi
Xy7Z2cYtB4Qbct4Fjgp8L4EQg+80Sd5PwFQwHszQ2A58CswG94G+tE8gD9wQ+C7z2+k9WcfONmKi
hn8oa98DEh0WfRxbIEwFx9i6gdDYW3yrwRL6XG7iX04+lSBEYzqeT/5OiT4SXGNrCmEaMQ+DVtDm
a9EPATKrAgWgCJwEZlbFd7aZvKZbC0rBNnAIeCR+ixS3Abpv2W0Edq0SRNwGoo9jV74bYJLinruQ
DX7a7uyQ6MnYW3+b+FVbY5GtAnxOn+eb+Ofyt+YU7+JvIb8tfA1DIXqr23r/CrqZ+A4BF8h3sz88
stsBrFitaIed4AWWq8COlYEwyTbZy6pgQcxuYNXOgUQ/X8jj+R7s2AZLFIEJIAHEgAdANqhmPvkg
2GnR84017Kp2TOHfu+NZO/uZqHhrjR/vbjCKyuNpHWEluEz1pSCO5a4GO0GKXdFTzJ9YH06CX4A+
7LXaH5NPS8dJFsz0B9H3An/XfHPsNTBZUh9vyJtIeXXtJuUPN+lrBmi2+Ec0gkE2aARKoz4n+N3q
vTpnInuJxoybYJFB8E6LPsGwYWalRgx/b/+4hv9w9kqvGVtBOMVsM9SleSn6YBKyR9GHho7bG5+I
XiGoXYb99ddooC8D95JfDMgR8KAk70NgFThouFJ7gBuUgLkgXrOfSeBduoVoNpyUzpnExYAXSdQ1
hheBvgTvgEf8/pGdehCOo8HtZsK7Dj4DSwE7oTkuep7nUzboR2j45zD/pRb+HuB82pXXxGYKbppy
pwnWMzJAFngB3OmN6Flsf7AKHAX/ZSfXcrDI0E4KyLHyn5X8D8jtDvnJzJ4qAAAAAElFTkSuQmCC"
}Schema
{
"properties": {
"data": {
"type": "string",
"minLength": 1
},
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"extensie": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"soortdocument": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"isContractDocument": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"data",
"naam",
"extensie",
"soortdocument"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/pensioenen/6732/documenten/16Response
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"total": 1,
"message": "Validatie fouten",
"_links": {
"help": {
"href": "http://api.fasterforward.nl/",
"title": "Validatie informatie"
}
},
"_embedded": {
"errors": [
{
"path": "/extensie",
"message": "bestand.extensie.verplicht"
}
]
}
}Schadeverzekering ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/schadeverzekeringen/{PRODUCT_ID}
Wijzigingen met release 1.10.5
-
Het veld isPakket is deprecated, en geeft altijd “nee” terug
-
Het veld productgroep onder productdelen wordt nu ingevuld met de afd branchenaam
-
Het veld naam onder productdelen is deprecated gebruik hiervoor het veld product
-
Het veld naam/product onder productdelen is nu binnen Elements een veld dat product specifiek is en handmatig gewijzigd kan worden
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/schadeverzekeringen/6752
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6752
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 6749,
"type": 4,
"soort": "schadeverzekeringen",
"offertenummer": "9999999",
"omschrijving": "auto AA-000-AA",
"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": "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",
"beloningpercentageDeelnemer": "0.00",
"beloningpercentageAdviseur": "0.00",
"incassowijze": "Tussenpersoon",
"factuurtype": "Overschrijving",
"factuurverzendenbij": "Elke prolongatie",
"factuurverzendwijze": "E-mail",
"handmatigprolongeren": "nee",
"particulier": "ja",
"adviseur": "Achternaam00112115, Voornaam (I.)",
"acceptant": null,
"acceptantWorkflowgroep": null,
"behandelaar": "Achternaam00112115, Voornaam (I.)",
"behandelaarWorkflowgroep": null,
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/schadeverzekeringen/6749"
}
},
"_embedded": {
"correspondentieadres": {
"id": 7793,
"straat": "Groenhof",
"nummer": "1",
"toevoeging": "",
"postcode": "1275BB",
"plaatsnaam": "Huizen",
"land": "NL",
"postcodegebied": "1275",
"longitude": "5.26394006",
"latitude": "52.28904947",
"categorie": "default"
},
"verzekeringsnemers": [
{
"id": 120954,
"geslacht": "man",
"initialen": "A.",
"titel": "",
"voornaam": "Aad",
"volledigeVoornamen": "",
"tussenvoegsel": "",
"achternaam": "Jansen",
"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"
}
}
}
],
"productdelen": [
{
"id": 7911,
"product": "Motorrijtuigen",
"productgroep": "Motorrijtuigen",
"naam": "Motorrijtuigen",
"afdbranchecode": "020",
"polisnummer": "12037190",
"brutoPremie": "348.75",
"termijnbedragToeslag": "0.00",
"korting": "0.00",
"kosten": "0.00",
"assurantiebelasting": "73.24",
"nettoPremie": "348.75",
"termijnbedragTotaal": "421.99",
"pakketkorting": null,
"premietermijn": "jaar",
"looptijdPolis": 12,
"looptijdPremie": 12,
"hoofdvervaldatum": "2013-10-29T00:00:00+01:00",
"premievervaldatum": "2013-10-29T00:00:00+01:00",
"contractvervaldatum": null,
"verlengenOfAflopend": "Verlengen",
"prolongatiedatum": null,
"royementsdatum": null,
"ingangsdatum": null,
"objectId": 9398,
"objectInfo": "11-AA-11 Opel Astra",
"schadevrijeJaren": 0,
"afwijkendePremiebetaler": null,
"mutatiestatus": "Lopend",
"_embedded": {
"dekkingen": [
{
"dekking": "Overig motorrijtuigen",
"dekkingcode": "2999",
"omschrijving": "",
"verzekerdbedrag": "9250.00",
"eigenrisicotype": "amount",
"eigenrisicobedrag": "100.00"
},
{
"dekking": "Aanvullende dekking bril en lenzen",
"dekkingcode": "1238",
"omschrijving": "",
"verzekerdbedrag": "10.00",
"eigenrisicotype": "amount",
"eigenrisicobedrag": "30.00"
}
]
}
},
{
"id": 7915,
"product": "Rechtsbijstand",
"productgroep": "Rechtsbijstand",
"naam": "Rechtsbijstand",
"afdbranchecode": "090",
"polisnummer": "",
"brutoPremie": "0.00",
"korting": "0.00",
"kosten": "0.00",
"assurantiebelasting": "0.00",
"nettoPremie": "0.00",
"termijnbedragTotaal": "0.00",
"pakketkorting": null,
"premietermijn": "maand",
"looptijdPolis": 14,
"looptijdPremie": 70,
"hoofdvervaldatum": "2013-12-29T00:00:00+01:00",
"premievervaldatum": "2018-08-29T00:00:00+02:00",
"contractvervaldatum": null,
"verlengenOfAflopend": "Verlengen",
"prolongatiedatum": null,
"royementsdatum": null,
"ingangsdatum": null,
"objectInfo": "",
"afwijkendePremiebetaler": null,
"mutatiestatus": "Opgeschort",
"_embedded": {
"dekkingen": [
{
"dekking": "Garantie",
"dekkingcode": "2036",
"omschrijving": "",
"verzekerdbedrag": "50.00",
"eigenrisicotype": "percentage",
"eigenrisicobedrag": "10.00"
},
{
"dekking": "Ongevallen",
"dekkingcode": "1015",
"omschrijving": "",
"verzekerdbedrag": "23.00",
"eigenrisicotype": "amount",
"eigenrisicobedrag": "12.00"
}
]
}
}
]
}
}Schadeverzekering toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/schadeverzekeringen
Wijzigingen met release 1.10.4
-
De velden acceptantWorkflowgroep, acceptant zijn alleen van toepassing bij omgevingen waar dit voor verzekeringsproducten aan staat.
-
Het veld dossierVerantwoordelijkeWorkflowgroep is hernoemd naar behandelaarWorkflowgroep.
-
Het veld dossierVerantwoordelijke is hernoemd naar behandelaar.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/schadeverzekeringen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"portefeuille": "Eigen beheer",
"omschrijving": "Schadeverzekering",
"status": {
"id": 1
},
"bestaandePropositie": {
"id": 3334
},
"adviseur": {
"id": 112115
},
"behandelaarWorkflowgroep": {
"id": 45
},
"aanbrengerPersoon": {
"id": 120956
},
"aanbrengerOrganisatie": {
"id": 14851
},
"bronvermelding": {
"id": 2000
},
"polisOfPakketNummer": "12345",
"offerteaanvraagdatum": "2010-01-01",
"offerteaanvraagdatumDefinitief": false,
"startdatum": "2017-03-17",
"startdatumDefinitief": false,
"verzondenNaarMaatschappij": "2016-01-01",
"ontvangstdatumPolis": "2016-01-01",
"datumAfgelegd": "2016-01-01",
"verzekeringnemerRol": "Particulier",
"verzekeringnemerParticulier": {
"id": 120955
},
"maatschappij": {
"id": 14835
},
"inkoopVia": {
"id": 15100
},
"correspondentieadres": {
"id": 7793
},
"toonindigimap": false,
"gearchiveerd": false,
"brutoPremie": 1.25,
"toeslag": 2.25,
"korting": 3.25,
"nettoPremie": 4.25,
"poliskosten": 5.25,
"assurantiebelasting": 7.25,
"totaal": 8.25,
"pakketkorting": 9.25,
"pakketkortingPercentage": 10.25,
"tussenpersoonkosten": 3.33,
"premietermijn": "Maand",
"beloningpercentageDeelnemer": 33.33,
"beloningpercentageAdviseur": 44.44,
"incassowijze": "Tussenpersoon",
"factuurtype": "Overschrijving",
"factuurverzendenbij": "Elke prolongatie",
"factuurverzendwijze": "E-mail",
"handmatigprolongeren": false,
"particulier": true
}Schema
{
"title": "Schadeverzekering",
"type": "object",
"properties": {
"portefeuille": {
"enum": [
"Eigen beheer",
"Extern beheer"
]
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bestaandePropositie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"adviseur": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"acceptant": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"acceptantWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"behandelaar": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"behandelaarWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanbrengerPersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanbrengerOrganisatie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bronvermelding": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"polisOfPakketNummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"offerteaanvraagdatum": {
"type": "string",
"format": "date"
},
"offerteaanvraagdatumDefinitief": {
"type": "boolean"
},
"startdatum": {
"type": "string",
"format": "date"
},
"startdatumDefinitief": {
"type": "boolean"
},
"verzondenNaarMaatschappij": {
"type": "string",
"format": "date"
},
"ontvangstdatumPolis": {
"type": "string",
"format": "date"
},
"datumAfgelegd": {
"type": "string",
"format": "date"
},
"verzekeringnemerRol": {
"enum": [
"Particulier",
"Zakelijk"
]
},
"verzekeringnemerZakelijk": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verzekeringnemerParticulier": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"maatschappij": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"inkoopVia": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"correspondentieadres": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"toelichting": {
"type": "string",
"minLength": 1
},
"toonindigimap": {
"type": "boolean"
},
"gearchiveerd": {
"type": "boolean"
},
"brutoPremie": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"toeslag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"korting": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"nettoPremie": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"poliskosten": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"tussenpersoonkosten": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"assurantiebelasting": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"totaal": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"pakketkorting": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"pakketkortingPercentage": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"premietermijn": {
"enum": [
"Maand",
"Kwartaal",
"Semester",
"Jaar",
"2 maanden",
"Eenmalig"
]
},
"incassowijze": {
"enum": [
"Maatschappij",
"Tussenpersoon"
]
},
"factuurtype": {
"enum": [
"Overschrijving",
"Incasso"
]
},
"factuurverzendenbij": {
"enum": [
"Elke prolongatie",
"Hoofdvervaldatum",
"Nooit"
]
},
"factuurverzendwijze": {
"enum": [
"E-mail",
"Post"
]
},
"handmatigprolongeren": {
"type": "boolean"
},
"particulier": {
"type": "boolean"
}
},
"required": [
"startdatum",
"startdatumDefinitief",
"toonindigimap",
"offerteaanvraagdatum",
"offerteaanvraagdatumDefinitief",
"gearchiveerd",
"portefeuille",
"status",
"adviseur",
"maatschappij",
"bestaandePropositie",
"bronvermelding",
"inkoopVia",
"verzekeringnemerRol"
],
"allOf": [
{
"oneOf": [
{
"properties": {
"verzekeringnemerRol": {
"enum": [
"Particulier"
]
}
},
"required": [
"verzekeringnemerParticulier"
]
},
{
"properties": {
"verzekeringnemerRol": {
"enum": [
"Zakelijk"
]
}
},
"required": [
"verzekeringnemerZakelijk"
]
}
]
},
{
"oneOf": [
{
"required": [
"behandelaar"
]
},
{
"required": [
"behandelaarWorkflowgroep"
]
}
]
}
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/schadeverzekeringen/6753Schadeverzekeringdeel toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/schadeverzekeringen/{PRODUCT_ID}/onderdelen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/schadeverzekeringen/6753/onderdelen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6753
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Autoverzekering
{
"productnaam" : "Autoverzekering",
"afdbranchecode" : "021",
"polisnummer": "12345",
"productOmschrijving": "Test omschrijving",
"zeroProduct": true,
"verzekerdeRol": "Particulier",
"verzekerdenParticulier": [
{
"id": 120954
}
],
"termijnbedragBrutopremie": 125,
"termijnbedragToeslag": 0,
"termijnbedragKorting": 5,
"termijnbedragNettopremie": 120,
"termijnbedragPoliskosten": 4,
"termijnbedragAssurantiebelasting": 26.04,
"termijnbedragTotaal": 150.04,
"premietermijn": "Maand",
"vergoedingspercentageEenmalig": 0,
"vergoedingspercentageDoorlopend": 0,
"prolongatieProvisiebedrag": 0,
"betalingsprofiel": {
"id": 1
},
"ingangsdatum": "2016-01-01",
"hoofdvervaldatum": "2017-01-01",
"polisLooptijd": 12,
"premievervaldatum": "2017-01-01",
"premieLooptijd": 12,
"contractvervaldatum": "2017-01-01",
"verlengenAflopend": "Verlengen",
"prolongatiedatum": "2017-01-01",
"royementsdatum": "2017-01-01",
"aantalSchadevrijeJaren": 5,
"tweedeGezinsauto": true,
"bmTrede": "1",
"bmKorting": 0,
"bonusPercentage": 0,
"regelmatigeBestuurder": {
"id": 120954
},
"object": {
"id": 179
},
"afwijkendePremiebetalerParticulier": {
"id": 120955
},
"mutatiestatus": "Lopend"
}
Inboedel
{
"productnaam" : "Inboedelverzekering",
"afdbranchecode" : "056",
"polisnummer": "12345",
"productOmschrijving": "Een verzekering",
"zeroProduct": true,
"termijnbedragBrutopremie": 100,
"termijnbedragToeslag": 0,
"termijnbedragKorting": 5,
"termijnbedragNettopremie": 95,
"termijnbedragPoliskosten": 0,
"termijnbedragAssurantiebelasting": 19.95,
"termijnbedragTotaal": 114.95,
"premietermijn": "Maand",
"vergoedingspercentageEenmalig": 100,
"vergoedingspercentageDoorlopend": 100,
"prolongatieProvisiebedrag": 100,
"betalingsprofiel": {
"id": 1
},
"ingangsdatum": "2016-01-01",
"hoofdvervaldatum": "2016-01-01",
"polisLooptijd": 12,
"premievervaldatum": "2016-01-01",
"premieLooptijd": 12,
"contractvervaldatum": "2016-01-01",
"verlengenAflopend": "Verlengen",
"prolongatiedatum": "2016-01-01",
"royementsdatum": "2016-01-01",
"soortDak": "Pannen",
"typeHuis": "Vrijstaand",
"verhuurKamer": true,
"inhoudWoning": 400,
"bouwjaar": 1970,
"soortMuur": "Steen",
"woonoppervlakte": 125,
"premiePromillage": 0,
"wozWaarde": 280000,
"pand": {
"id": 7790
},
"mutatiestatus": "Opgeschort"
}
Aansprakelijkheid
{
"productnaam" : "Aansprakelijkheidsverzekering",
"afdbranchecode" : "060",
"polisnummer": "12345",
"productOmschrijving": "",
"zeroProduct": true,
"verzekerdeRol": "Particulier",
"verzekerdenParticulier": [
{
"id": 120954
}
],
"termijnbedragBrutopremie": 25,
"termijnbedragToeslag": 0,
"termijnbedragKorting": 0,
"termijnbedragNettopremie": 25,
"termijnbedragPoliskosten": 0,
"termijnbedragAssurantiebelasting": 5.25,
"termijnbedragTotaal": 30.25,
"premietermijn": "Maand",
"vergoedingspercentageEenmalig": 0,
"vergoedingspercentageDoorlopend": 0,
"prolongatieProvisiebedrag": 0,
"betalingsprofiel": {
"id": 1
},
"ingangsdatum": "2016-01-01",
"hoofdvervaldatum": "2016-01-01",
"polisLooptijd": 100,
"premievervaldatum": "2016-01-01",
"premieLooptijd": 100,
"contractvervaldatum": "2016-01-01",
"verlengenAflopend": "Verlengen",
"prolongatiedatum": "2016-01-01",
"royementsdatum": "2016-01-01",
"jagersrisico": true,
"mutatiestatus": "Beeindigd",
"gezinssamenstelling": "Andere gezinssamenstelling"
}Schema
{
"title": "Schadeverzekeringdeel",
"type": "object",
"properties": {
"polisnummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"afdbranchecode" : {
"type": "string",
"minLength": 3
},
"productnaam" : {
"type": "string",
"minLength": 1
},
"productOmschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"zeroProduct": {
"type": "boolean"
},
"verzekerdeRol": {
"enum": [
"Particulier",
"Zakelijk"
]
},
"verzekerdeZakelijk": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verzekerdenParticulier": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"termijnbedragBrutopremie": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"termijnbedragToeslag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"termijnbedragKorting": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"termijnbedragNettopremie": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"termijnbedragPoliskosten": {
"description" : "Termijnbedrag kosten in Elements",
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"termijnbedragAssurantiebelasting": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"termijnbedragTotaal": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"termijnbedragPakketkorting": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"premietermijn": {
"enum": [
"Maand",
"Kwartaal",
"Semester",
"Jaar",
"2 maanden",
"Eenmalig"
]
},
"incassoDoor": {
"enum": [
"Maatschappij",
"Tussenpersoon"
]
},
"vergoedingspercentageEenmalig": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"vergoedingspercentageDoorlopend": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"prolongatieProvisiebedrag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"betalingsprofiel": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"ingangsdatum": {
"type": "string",
"format": "date"
},
"hoofdvervaldatum": {
"type": "string",
"format": "date"
},
"polisLooptijd": {
"type": "integer",
"minimum": 0
},
"premievervaldatum": {
"type": "string",
"format": "date"
},
"premieLooptijd": {
"type": "integer",
"minimum": 0
},
"contractvervaldatum": {
"type": "string",
"format": "date"
},
"verlengenAflopend": {
"enum": [
"Verlengen",
"Aflopend"
]
},
"prolongatiedatum": {
"type": "string",
"format": "date"
},
"royementsdatum": {
"type": "string",
"format": "date"
},
"soortDak": {
"enum": [
"Pannen",
"Mastiek",
"Riet"
]
},
"typeHuis": {
"enum": [
"Vrijstaand",
"Twee onder een kap",
"Hoekwoning",
"Tussenwoning",
"Appartement"
]
},
"verhuurKamer": {
"type": "boolean"
},
"inhoudWoning": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"bouwjaar": {
"type": "integer",
"minimum": 0
},
"soortMuur": {
"enum": [
"Steen",
"Hout",
"Overige"
]
},
"woonoppervlakte": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"premiePromillage": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"wozWaarde": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"herbouwwaarde": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"invuldatumHerbouwwaardemeter": {
"type": "string",
"format": "date"
},
"inboedelwaarde": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"invuldatumInboedelwaardemeter": {
"type": "string",
"format": "date"
},
"aantalSchadevrijeJaren": {
"type": "integer",
},
"tweedeGezinsauto": {
"type": "boolean"
},
"bmTrede": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"bmKorting": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"bonusPercentage": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"annuleringsverzekering": {
"type": "boolean"
},
"wintersport": {
"type": "boolean"
},
"voertuighulp": {
"type": "boolean"
},
"dekkingsgebied": {
"enum": [
"Afrika",
"Anders",
"Azië excl. Japan/Zuid-Korea/Taiwan",
"Benelux + DE,FR, IT, AT, PT, ES, CH",
"Benelux + grensstreek Duitsland",
"Benelux en Duitsland",
"Benelux",
"Benelux, Duitsland en Frankrijk",
"Buiten EU",
"Buiten Nederland",
"Caribisch gebied",
"Centraal-Europa",
"EER (EU + NO, IS, LI), Zwitserland en VK",
"Eigen terrein",
"Eurolanden",
"Europa + Marokko, Algerije, Tunesie en Turkije",
"Europa en de landen rond de Middellandse Zee",
"Europa excl. GOS-landen en Georgie",
"Europa exclusief Benelux, Scandinavië, DE, GB, IE",
"Europa exclusief woonplaats",
"Europa inclusief woonplaats",
"Europa tot 15 mijl uit de kust",
"Europa tot 20 mijl uit de kust",
"Europa",
"Europa, Noordzee en NL, BE, DE kust",
"Europa, Noordzee en Nederlandse kust",
"Europese Gemeenschap en Zwitserland",
"Europese binnenwateren + Europ. kust incl. 10 mijl",
"Europese binnenwateren + Europese kust",
"Europese binnenwateren",
"Europese kustwateren",
"Europese zeeën en Caraïbisch gebied",
"Europese zeeën",
"Groot vierkant",
"Groot/Benelux",
"Grote steden",
"Klein vierkant",
"Klein/Benelux",
"Landen van de groene kaart excl. Nederland",
"Lidstaten EU + VK",
"Lidstaten EU",
"Lidstaten EU, Zwitserland, Noorwegen en VK",
"Middelgrote steden",
"Middellandse Zee",
"Midden oosten",
"Midden-Amerika",
"NL binnenwateren excl. IJsselmeer, armen Zeeland",
"Nederland (basis)",
"Nederland (uitgebreid) tot 20 zeemijl uit de kust",
"Nederland + Noordzee",
"Nederland + grensstreek",
"Nederland exclusief woonplaats",
"Nederland inclusief woonplaats",
"Nederland",
"Nederland, Belgie en Duitsland",
"Nederlandse binnenwateren + kust",
"Nederlandse binnenwateren",
"Noord-Europa",
"Noordzee langs Nederlandse en Belgische kust",
"Noordzee",
"Oost-Europa",
"Scandinavië",
"Schengenlanden",
"Super Groot Vierkant",
"USA/Canada",
"Vast adres",
"Verenigd Koninkrijk/Ierland",
"Verre oosten",
"Wereld ex. CU, IR, SY, KP, VE, Noord Soedan, Krim",
"Wereld exclusief CU, IR, IQ, KP, MM, SD, SY",
"Wereld exclusief Europa",
"Wereld exclusief USA/Canada",
"Wereld",
"Wereldzeeën",
"West-Europa",
"Westeuropeesche kustwateren",
"Wisselende locatie",
"Zeevaart 1: 60NB, 15OL, 5WL, 50NB",
"Zeevaart 2: 63NB, 25OL, 15WL, 45NB",
"Zeevaart 3: 63NB, 30OL, 15WL, 35NB",
"Zoals vermeld op groene kaart",
"Zuid-Amerika",
"Zuid-Europa",
"Zuid-Oost Europa"
]
},
"jagersrisico": {
"type": "boolean"
},
"familieVerzekerd": {
"type": "boolean"
},
"regelmatigeBestuurder": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"object": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"pand": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bijzonderheden": {
"type": "string",
"minLength": 1
},
"afwijkendePremiebetalerParticulier": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"afwijkendePremiebetalerZakelijk": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"factuurtype": {
"enum" : [
"Overschrijving",
"Incasso"
]
},
"mutatiestatus": {
"enum": [
"Lopend",
"Opgeschort",
"Beeindigd"
]
},
"bedragEigenRisicoStormschade": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"eigenRisico": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"constructiewijzeDak": {
"enum": [
"Plat dak",
"Schuin dak",
"Bijzondere constructie"
]
},
"staatVanOnderhoud": {
"enum": [
"Goed",
"Matig",
"Redelijk",
"Slecht",
"Zeer goed",
"Onbekend"
]
},
"zonnepanelenAanwezig": {
"type": "boolean"
},
"gezinssamenstelling": {
"enum": [
"Alleenstaande zonder kind(eren)",
"Gezin zonder kind(eren)",
"Gezin met kind(eren)",
"Alleenstaande met kind(eren)",
"Andere gezinssamenstelling"
]
},
"beroepswerkzaamhedenMeeverzekeren": {
"type": "boolean"
},
"beroepswerkzaamhedenMeeverzekerenPartner": {
"type": "boolean"
},
"beroepswerkzaamhedenMeeverzekerenKinderen": {
"type": "boolean"
},
"inboedelMeeverzekerd": {
"type": "boolean"
},
"inboedelVerzekerdBedrag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"aanbouwMeeverzekerd": {
"type": "boolean"
},
"aanbouwVerzekerdBedrag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"moverMeeverzekerd": {
"type": "boolean"
},
"moverVerzekerdBedrag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"bedragFranchiseVerzekerd": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"bedragVerzekerdExterneKosten": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"eigenWoningMeeverzekerd": {
"type": "boolean"
},
"maximaleReisduurInDagen": {
"type": "integer",
"minimum": 0
}
},
"required": [
"productnaam",
"afdbranchecode",
"polisLooptijd",
"premieLooptijd",
"termijnbedragBrutopremie",
"termijnbedragNettopremie",
"termijnbedragTotaal",
"vergoedingspercentageEenmalig",
"vergoedingspercentageDoorlopend",
"premietermijn"
],
"additionalProperties": false,
"oneOf": [
{
"properties": {
"verzekerdeRol": {
"enum": ["Particulier"]
}
},
"required": ["verzekerdenParticulier"]
},
{
"properties": {
"verzekerdeRol": {
"enum": ["Zakelijk"]
}
},
"required": ["verzekerdeZakelijk"]
},
{
"properties": {
"verzekerdeRol": {
"enum": [null]
}
}
}
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/schadeverzekeringen/6753/onderdelen/7918Schadeverzekeringdeel dekking toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/schadeverzekeringen/{PRODUCT_ID}/onderdelen/{PRODUCTDEEL_ID}/dekkingen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/schadeverzekeringen/6753/onderdelen/7917/dekkingen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6753- PRODUCTDEEL_ID
int(verplicht) Voorbeeld: 7917
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"dekking": "2001 - Wettelijke Aansprakelijkheid",
"verzekerdbedrag": 25,
"eigenrisicotype": "Vast bedrag",
"eigenrisicobedrag": 0
}
{
"dekking": "5958",
"omschrijving" : "Dit is een omschrijving",
"verzekerdbedrag": 25,
"eigenrisicotype": "Vast bedrag",
"eigenrisicobedrag": 0
}Schema
{
"title": "Productdeeldekking",
"type": "object",
"properties": {
"dekking": {
"type": "string",
"minLength": 1,
"maxLength": 99
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"verzekerdbedrag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -9999999999.99,
"maximum": 9999999999.99
},
"eigenrisicotype": {
"enum": [
"Vast bedrag",
"Percentage v/d schade",
"Dagen"
]
},
"eigenrisicobedrag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -9999999999.99,
"maximum": 9999999999.99
}
},
"additionalProperties": false,
"anyOf": [
{
"required": [
"dekking"
]
},
{
"required": [
"omschrijving"
]
}
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/schadeverzekeringen/6753/onderdelen/7917/dekkingen/1Schadeverzekeringdeel materieel toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/schadeverzekeringen/{PRODUCT_ID}/onderdelen/{PRODUCTDEEL_ID}/materieel
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/schadeverzekeringen/6753/onderdelen/7917/materieel
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6753- PRODUCTDEEL_ID
int(verplicht) Voorbeeld: 7917
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"omschrijving": "Er is een landbouw werktuig toegevoegd",
"soort": "dorsmachine",
"merk": "Massey Ferguson",
"type": "A2DN",
"constructiedatum": "2022-01-12",
"chassisnummer": "01743939845",
"kenteken": "TAD-62-R"
}Schema
{
"title": "ProductdeelMaterieel",
"type": "object",
"properties": {
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"soort": {
"enum": [
"aanhangerhoogwerker",
"aanhangwagen",
"aardappelpoter",
"aardappelrooier",
"aardappelselectiewagen",
"aggregaat",
"aktiewagen (rijdend)",
"asfalteermachine",
"asfaltfreesmachine",
"autohoogwerker",
"autokraan (rijdend)",
"autolaadkraan",
"autolift (rijdend)",
"autoloskraan (rijdend)",
"balenpers",
"beglazingmachine (rijdend)",
"bermmaaimachine",
"betonmolen",
"betonpomp",
"bietenlader (rijdend)",
"bietenrooier",
"bomenrooimachine",
"boorinstallatie",
"bosmaaier",
"botenkraan (rijdend)",
"botenlift (rijdend)",
"bouwkraan",
"bouwlift",
"boxenvuller",
"brommobiel",
"bulldozer",
"cirkelmaaier",
"combine",
"compactor (rijdend)",
"compressor",
"cultivator",
"cyclomaaier",
"diepwoeler",
"dorsmachine",
"dragline",
"drainagemachine",
"dumper",
"electrowagen (rijdend)",
"elektrische palletwagen (rijdend)",
"elektrowagen",
"elementensteller",
"foodtruck",
"foodtruck aanhanger",
"freesmachine",
"gazonmaaier",
"GNNS/GPS antenne (GPS Bol)",
"goederenlift (rijdend)",
"golfkar (rijdend)",
"gotenwals (rijdend)",
"graaf-/laadcombinatie",
"graafmachine midi",
"graafmachine/excavator",
"grader",
"grasmaaimachine",
"graszaaimachine",
"grond- / tuinfrees (rijdend)",
"grondboorinstallatie",
"grondonderzoekmachine (rijdend)",
"grondverzetmachine (rijdend)",
"hakselaar (rijdend)",
"hallenvuller/scheepslader",
"handpallettruck (rijdend)",
"hark",
"harkkeerder",
"haspel",
"heftruck",
"heikraan (rijdend)",
"heimachine",
"heistelling",
"hijskraan mobiel",
"hoogwerker",
"hooi-/stro-pers",
"hooischudder",
"houtklover",
"ijsdwijlmachine",
"inschuur en opslagapparatuur",
"kiepwagen",
"kilverbak/egalisatiebord",
"kipper/kipwagen",
"klepelmaaier",
"knikarmhoogwerker",
"kniklader",
"knikmops",
"kolkenzuiger",
"kooiaap (rijdend)",
"kraan",
"kunstmeststrooier",
"laad-/loskraan",
"laadschop",
"ladderlift (rijdend)",
"landbouwkraan",
"landbouwspuit",
"loader (rijdend)",
"loofklapper",
"maaidorser",
"maaimachine",
"maishakselaar (rijdend)",
"masthoogwerker",
"meeloopstapelaar (rijdend)",
"meeneemheftruck",
"meet- en regelapparatuur",
"mengmestinstallatie (rijdend)",
"mestafvoerinstallatie (rijdend)",
"mestcontainer",
"mestinjecteur",
"mestpomp (rijdend)",
"mestscheidingsinstallatie (rijdend)",
"midirups (rijdend)",
"mini dumper (rijdend)",
"mini dumper",
"mini-graver",
"minikraan",
"mmbs vrachtauto (motorrijt. met beperkte snelheid)",
"mmbs-voertuig",
"mobiele gekentekende kraan",
"mobiele kraan",
"mobiele kraan (rijdend)",
"mortelspuitmachine",
"motorjapanner (rijdend)",
"motorkruiwagen",
"motormaaier",
"niet wam-plichtig materieel",
"oldtimer tractor",
"onkruidbestrijdingsmachine",
"oogstmachine",
"oppermachine",
"opraapwagen",
"opschepmachine",
"orderverzamelaar",
"overig",
"paardenrijtuig",
"paardentrailer",
"pallet truck",
"pers",
"plantmachine",
"platte (boeren)wagen",
"ploeg",
"plukmachine",
"pompwagen (rijdend)",
"puinbreker",
"quad",
"quad (rijdend)",
"reachtruck",
"regeninstallatie",
"rietsnijmachine zelfrijdend",
"rioolreiniger",
"rolmops (rijdend)",
"rooimachine",
"rotorkopeg",
"rupskraan",
"rupskraan (rijdend)",
"rupslader",
"ruwterreinkraan",
"schaarhoogwerker",
"schaarlift (rijdend)",
"schoffelmachine",
"schranklader",
"schrobmachine zelfrijdend",
"schrootschaar",
"schuif (rijdend)",
"scraper (rijdend)",
"shovel",
"shredder (rijdend)",
"sjees",
"skidster (rijdend)",
"sleuvengraver zelfrijdend",
"sloopmachine (rijdend)",
"sloopmaterieel (rijdend)",
"sloopwerktuig (rijdend)",
"slotenmaaier",
"sondeermachine",
"sorteerinstallatie (rijdend)",
"sorteermachine (rijdend)",
"spinhoogwerker (rijdend)",
"spitmachine",
"spoorkraan (rijdend)",
"sproeimachine",
"spruitenplukmachine",
"spuitapparatuur",
"stapelaar (rijdend)",
"steenbreker (rijdend)",
"stobbenfrees",
"stortbak",
"strooiwagen zelfrijdend",
"takkenkneuzer",
"taludmaaier",
"tankwagen",
"telescoophoogwerker",
"telescoopkraan",
"terminaltrekker",
"torenkraan zelfrijdend",
"tractor",
"tractor/trekker (grondverzet - rijdend)",
"tractor/trekker (transportobject - rijdend)",
"transportsysteem",
"trike landbouw",
"trilmachine zelfrijdend",
"trilplaat",
"trilwals zelfrijdend",
"tuinbouwtractor",
"tuktuk",
"unimog",
"unimog met werkmaterieel (rijdend)",
"unimog met open laadbak (rijdend)",
"veegmachine",
"veegmachine (rijdend)",
"veldspuit",
"verhuislift (rijdend)",
"verkoopwagen zelfrijdend",
"verreiker",
"versnipperaar",
"voerdoseerwagen",
"voermengwagen",
"voorlader (rijdend)",
"vouwkraan (rijdend)",
"vrachtautohoogwerker",
"vuilverdichter",
"wals",
"wegdekreiniger",
"wegenbouwmachine",
"wegmarkeringmachine (rijdend)",
"wegwals (rijdend)",
"werktuigendrager",
"wiel/-rupslader",
"wiellaadschop",
"wiellader",
"wieltrekker",
"witloftrekker (rijdend)",
"zaaibedcombinatie",
"zeefmachine (rijdend)",
"zijlader",
"zitmaaier",
"zodebemester",
"zuiggraafmachine",
"zwenklader"
]
},
"merk": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"type": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"constructiedatum": {
"type": "string",
"format": "date"
},
"chassisnummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"kenteken": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"required": [
"omschrijving"
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/schadeverzekeringen/6753/onderdelen/7911/materieel/123Schadeverzekering registratie ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/schadeverzekeringen/{PRODUCT_ID}/registraties]&publiek={publiek}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/schadeverzekeringen/6753/registraties]&publiek=0
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6753- publiek
int(optioneel) Voorbeeld: 0
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/schadeverzekeringen/6753/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/schadeverzekeringen/6753/registraties/275825"
},
"product": {
"href": "/api/data/klantdossiers/5526/schadeverzekeringen/6753"
},
"bestand": {
"href": "/api/data/klantdossiers/5526/documenten/2"
}
}
}
]
}
}Schadeverzekering registratie toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/schadeverzekeringen/{PRODUCT_ID}/registraties
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/schadeverzekeringen/6753/registraties
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6753
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Klantdossier - Registratie toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/schadeverzekeringen/6753/registraties/275827Schadeverzekering taak toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/schadeverzekeringen/{PRODUCT_ID}/taken
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/schadeverzekeringen/6755/taken
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6755
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",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"prioriteit": {
"enum": [
"Laag",
"Middel",
"Hoog"
]
},
"startdatum": {
"type": "string",
"format": "date"
},
"einddatum": {
"type": "string",
"format": "date"
},
"afgerond": {
"type": "boolean"
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"initiator": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"genodigden": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"verantwoordelijke": {
"enum": [
"Persoon",
"Workflowgroep",
"WorkflowgroepMetPersoon"
]
},
"verantwoordelijkePersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verantwoordelijkeWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"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/schadeverzekeringen/6755/taken/55519Schadeverzekering workflow toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/schadeverzekeringen/{PRODUCT_ID}/workflows
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/schadeverzekeringen/6753/workflows
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6753
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"workflow": {
"id": 21
}
}Schema
{
"properties": {
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"workflow"
]
}Response
204VerbergBekijk
Headers
Content-Type: application/jsonSchadeverzekering /schademelding workflow toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/schadeverzekeringen/{PRODUCT_ID}/schademelding/{SCHADEMELDING_ID}/workflows
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/schadeverzekeringen/6753/schademelding/1/workflows
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6753- SCHADEMELDING_ID
int(verplicht) Voorbeeld: 1
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"workflow": {
"id": 21
}
}Schema
{
"properties": {
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"workflow"
]
}Response
204VerbergBekijk
Headers
Content-Type: application/jsonSchadeverzekering factuur toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/schadeverzekeringen/{PRODUCT_ID}/facturen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/schadeverzekeringen/6753/facturen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6753
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Factuur - Factuur toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/schadeverzekeringen/6753/facturen/1Schadeverzekering factuurregel toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/schadeverzekeringen/{PRODUCT_ID}/facturen/{FACTUUR_ID}/regels
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/schadeverzekeringen/6753/facturen/1/regels
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6753- FACTUUR_ID
int(verplicht) Voorbeeld: 1
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Factuur - Factuurregel toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/schadeverzekeringen/6753/facturen/1Schadeverzekeringsdocument toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/schadeverzekeringen/{PRODUCT_ID}/documenten
Let op: Als het protocol HDN is, zijn alleen PDF bestanden toegestaan.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/2818/schadeverzekeringen/6732/documenten
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 2818- PRODUCT_ID
int(verplicht) Voorbeeld: 6732
Request
VerbergBekijk
Body
{
"naam": "fasterforward.png",
"extensie": "png",
"soortdocument": {
"id": 1
},
"data": "iVBORw0KGgoAAAANSUhEUgAAAP0AAAAbCAYAAAC3KIljAAAKsElEQVR42u2dC3BVxRnH82gCISQk
0ZYEUHTCDBrBBJESmbakVMI7Kj4KDFhGwlBtlUzk2RYIAUGbalHEYnl4DdACSSB1EhsBBwTpRAUa
ERIVWu4QCO88KTQ3Cem/M19mvjmze3bPuWdyL/F+M7/Jze73fbvnsv9z9uzZE4LanbP6oID5xNLT
Rx8A7V6SFRSw2/Hffg1oB26VLzTanz58N0WP/o4CxQIiA6IPWBcVfa/vuuhnApHF3MaivwjSbNIv
KGBdWvQ07nsHRN+1RO8OClhA9CYWuNIHRB+wgOi9E3BA9AHRBywg+v/nDwEPgxdAHtgEXODPYDmY
Du61kC8UjABzwevARawFL4NHQXhniB6+3cFEsAxspH68AWaD/g5+h2HgByC0s0WPnNHgWbAefAj2
g50gBwzvokIKBengFVAI9oKPwFawGAzupH50A0kgFQwC3f1a9MjRAywGF4GOlYNxJvm6gYWa+erA
CtDTkCMXVBBnJbFfMZ8KSV+iwGrQAMysFNxvcky/BmsMjGT1o0EZuEn5TnWW6JErDCwF1ym3jM/A
MJM8mcAFMg3lI8A68Dlwg35UnkP+uZr9nAlcxFAN/yjm/7Sg/jFwBrQrKAEJJu3kUhvprCwEPA62
gePgU0nsRLAHeAxttoAykO53okf8APA1sGMLBPl6gsM2clWCeJbHZTWBoC8PgTO68STYKZLv6YDA
PwuES/rq7gzRI08vcIgNtisk0NlgKpgP9rF6D5guyeUiHxebORQIRHQP1f+efm8DsRp9Pc5yvKHh
/yTzH22oy2Z1jeA98Dx4BsyiK/9XzKcKREraqSCfLPp9ADhqOGa3ISYS7DL41FCub0ErK98AQn0t
en6FrwLe2FBDzg3Arh1wQvQUnwIagFVrAxkWRL8NtPtC9DSQ9rLBtRb0kPimgjNMpOPMRE+D+guW
+xIoBBtBHMvZTkxT9LWfQSCVGsf3HvnWgjBWngzaqG4/iJfEB4OFrM0lKtGT4K+wmNN0tV9lmMof
ZD47QJLgVisT1JDP2/4i+nmSnCUgFcSCaJBsMrjfYvniQIvApwwMB5EgBgwFWyT5HvV2ek+zjX8L
/G+Bj2m6vwwUAY/A7xrorSH6/QDmM9G/xAbeK1SsEl41+V8A0Saif7ujnzTNDZaI6jz5/UXRdib5
NbA+323iHwIukV++oW4DlV8DcRrHvZ/8TypEPw8coc+HQarEfxU7hsWKtu9kJ89PnBJ9G6iwwECW
74gg35cgVLQoJ5kq72E+44HI+kqOZ5/AN8/bhTxaIzBaA0gT+A4GV6QnMy56PWsBzRqiPwtiLBLF
7+PZVaQChGqeKCawAZstEf1B0EpT3DsU+dZSTJ1ZH9hU+E3gps9zTPyHs35mGOrOUfk6zWNeQP7N
CtGX0898ECbxjQfN5Ldbs/0+oIlifPKcPoXluwTqDbxs0v7fhFNytTjHSPI9DooN/Nau6Mk3AtQK
fJ8yOa7pAv8mEKkp+kawkD8FoL45vQ23guV5ipVPsjhDOExxp0WiJ+rBXRq5fsZiRposNDaSzxiw
jj4Xm+RdQT7XQYRhau0m2NqEepZBRMtETxwD4aoTCDHQwne+1Leit2E01T+vEP04ILL/gFwwSLtB
+6KfJPCrBsEm+cNBnSAuQ0P0TUD9WMh50a+nssvgexZFP4cvyklEv9zCusJVismT+Iyk+hugO5tt
NDGByYRYEOSlddyqEDEK0Y9R5PoH+R222Ie7/V709NjtfjAZrGaCNxN9FGhUtH8RFIL54IcgxGHR
vyrwqwJZCv4liMvREP08m5tzakCKRQYKVsKLbYjgPjYAn5GIfoCFfJsoplJSv5rqP6DfI8BNKhul
WPSb4sVTjWFgJWjVFP1lEGL2aJT1O9dGn75xSvS3gNsCSZINJRPAH2lwn7Oz4k65ZlCfdO0q2AyS
HRJ9AXDKtitE3wrifLEjjy1yvWojNoTf1wtEX2cx30SWL9FEVM+zslIq+4PA/5dU1wyiNe6Xp4E8
UAz+CWpBO8OjKfoPLTyB+LmN732XvzynnwJqHHjMxnOOBacs5rkFXgPBXop+H3DKPlKI/oSvtuGy
q9cim/H1FJ8jEH2Vjd1oDRSbJRBlO9Gflf+Kyo4L8pVQXYlJm+Npqn2LfDlN4CjYSu3M1RT9+4rj
HMz3Ddj4zjf6wyO7bGBmHnAC7ARzQJmG6PmW3nSwBlQCXVvipegLgVN2QCH6Ml+Jnl3NVtiMb6H4
BQLRV9jIt51i9xrKn6PyE4bye5iA+rFyPvWfZbbIxzgEfgfSQV/RTkBN0bsUx5jE8oy18R25fCp6
xPUBHsnC1HKQAkINMcVSYajb+z54jG4hzipWwiO8EP16gd9eu+JSiL7Yh6I/RXnybcQmsMH7nEOi
f5pNpaNZeaFskQ9lJ6kuk5VNYhuI7hDEjGV9P6LYW++06Pn3NsPGd1Tqa9G/JMmXahJTqhS9fvs/
pQ00IhvmheizBH7nu6Dod1Ceb2zETmaDd4hDou/JrtBPUlkou41IE8TkUd0uwVOJjyXtFFH9VRCr
2bcsh0QfzI7ndRvfUbWvRf+WINfXiphvFVPg/aDewFSTfCOByNI0RR8ryDlI4vuI4tieAC4DyX4r
eronJlJsnTBoQ40Toqf4Dwx793/E9saHCfzTeD0IZhtvXpS0cZrqN1no12YnRE++e8hXoBX1eoAP
RK+cBrsVV2bVfe92QX2BSc40Sc4HNEU/SJL3C4HvMRAl8U8WbOipBz38WPRx7Mq63ULcQLaa/SYV
OyX6Z9lLPyFgJf1eJPEP4zMBMIQJo48ohp0U3tHsUyyoc1D0s4SbkdRx7/qD6H8jyTdb4PsTcEHi
Xy7Z2cYtB4Qbct4Fjgp8L4EQg+80Sd5PwFQwHszQ2A58CswG94G+tE8gD9wQ+C7z2+k9WcfONmKi
hn8oa98DEh0WfRxbIEwFx9i6gdDYW3yrwRL6XG7iX04+lSBEYzqeT/5OiT4SXGNrCmEaMQ+DVtDm
a9EPATKrAgWgCJwEZlbFd7aZvKZbC0rBNnAIeCR+ixS3Abpv2W0Edq0SRNwGoo9jV74bYJLinruQ
DX7a7uyQ6MnYW3+b+FVbY5GtAnxOn+eb+Ofyt+YU7+JvIb8tfA1DIXqr23r/CrqZ+A4BF8h3sz88
stsBrFitaIed4AWWq8COlYEwyTbZy6pgQcxuYNXOgUQ/X8jj+R7s2AZLFIEJIAHEgAdANqhmPvkg
2GnR84017Kp2TOHfu+NZO/uZqHhrjR/vbjCKyuNpHWEluEz1pSCO5a4GO0GKXdFTzJ9YH06CX4A+
7LXaH5NPS8dJFsz0B9H3An/XfHPsNTBZUh9vyJtIeXXtJuUPN+lrBmi2+Ec0gkE2aARKoz4n+N3q
vTpnInuJxoybYJFB8E6LPsGwYWalRgx/b/+4hv9w9kqvGVtBOMVsM9SleSn6YBKyR9GHho7bG5+I
XiGoXYb99ddooC8D95JfDMgR8KAk70NgFThouFJ7gBuUgLkgXrOfSeBduoVoNpyUzpnExYAXSdQ1
hheBvgTvgEf8/pGdehCOo8HtZsK7Dj4DSwE7oTkuep7nUzboR2j45zD/pRb+HuB82pXXxGYKbppy
pwnWMzJAFngB3OmN6Flsf7AKHAX/ZSfXcrDI0E4KyLHyn5X8D8jtDvnJzJ4qAAAAAElFTkSuQmCC"
}Schema
{
"properties": {
"data": {
"type": "string",
"minLength": 1
},
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"extensie": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"soortdocument": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"isPrimairSchadedocument": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"data",
"naam",
"extensie",
"soortdocument"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/schadeverzekeringen/6732/documenten/16Response
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"total": 1,
"message": "Validatie fouten",
"_links": {
"help": {
"href": "http://api.fasterforward.nl/",
"title": "Validatie informatie"
}
},
"_embedded": {
"errors": [
{
"path": "/extensie",
"message": "bestand.extensie.verplicht"
}
]
}
}Uitvaartverzekering ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/uitvaartverzekeringen/{PRODUCT_ID}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/uitvaartverzekeringen/6748
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6748
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"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",
"particulier": "ja",
"adviseur": "Achternaam00112115, Voornaam (I.)",
"acceptant": null,
"acceptantWorkflowgroep": null,
"behandelaar": "Achternaam00112115, Voornaam (I.)",
"behandelaarWorkflowgroep": null,
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/uitvaartverzekeringen/6748"
}
},
"_embedded": {
"correspondentieadres": {
"id": 7793,
"straat": "Groenhof",
"nummer": "1",
"toevoeging": "",
"postcode": "1275BB",
"plaatsnaam": "Huizen",
"land": "NL",
"postcodegebied": "1275",
"longitude": "5.26394006",
"latitude": "52.28904947",
"categorie": "default"
},
"verzekeringsnemers": [
{
"id": 120954,
"geslacht": "man",
"initialen": "A.",
"titel": "",
"voornaam": "Aad",
"volledigeVoornamen": "",
"tussenvoegsel": "",
"achternaam": "Jansen",
"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"
}
}
},
{
"id": 120955,
"geslacht": "X",
"initialen": "K.",
"titel": "",
"voornaam": "Kim",
"volledigeVoornamen": "",
"tussenvoegsel": "",
"achternaam": "Jansen - de Jong",
"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"
},
"profielfoto": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120955/profielfoto"
},
"adressen": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120955/adressen"
},
"emailadressen": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120955/emailadressen"
},
"rekeningnummers": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120955/rekeningnummers"
},
"telefoonnummers": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120955/telefoonnummers"
}
}
}
],
"contactpersonen": [
{
"id": 120954,
"geslacht": "man",
"initialen": "A.",
"titel": "",
"voornaam": "Aad",
"volledigeVoornamen": "",
"tussenvoegsel": "",
"achternaam": "Jansen",
"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"
}
}
}
],
"verzekerden": [
{
"id": 120954,
"geslacht": null,
"initialen": "A.",
"titel": "",
"voornaam": "Aad",
"volledigeVoornamen": "",
"tussenvoegsel": "",
"achternaam": "Jansen",
"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"
}
}
}
],
"productdelen": [
{
"id": 7909,
"product": "Uitvaart",
"soortVerzekering": "Uitvaart",
"polisnummer": "98734-B",
"brutoTermijnpremie": "0.00",
"premietermijn": "maand",
"premieduur": 0,
"_embedded": {
"kapitalen": [
{
"geindexeerd": false,
"verzekerdbedrag": "12.45",
"soortDekking": "basisdekking",
"_embedded": {
"persoon": [
{
"id": 120954,
"geslacht": "man",
"initialen": "A.",
"titel": "",
"voornaam": "Aad",
"volledigeVoornamen": "",
"tussenvoegsel": "",
"achternaam": "Jansen",
"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"
}
}
}
]
}
}
]
}
}
]
}
}Uitvaartverzekering toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/uitvaartverzekeringen
Wijzigingen met release 1.10.4
-
De velden acceptantWorkflowgroep, acceptant zijn alleen van toepassing bij omgevingen waar dit voor verzekeringsproducten aan staat.
-
Het veld dossierVerantwoordelijkeWorkflowgroep is hernoemd naar behandelaarWorkflowgroep.
-
Het veld dossierVerantwoordelijke is hernoemd naar behandelaar.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/uitvaartverzekeringen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"portefeuille": "Eigen beheer",
"omschrijving": "Uitvaartverzekering",
"status": {
"id": 1
},
"bestaandePropositie": {
"id": 3334
},
"adviseur": {
"id": 112115
},
"behandelaarWorkflowgroep": {
"id": 45
},
"bronvermelding": {
"id": 3
},
"aanbrengerPersoon": {
"id": 120956
},
"aanbrengerOrganisatie": {
"id": 14851
},
"polisnummer": "12345",
"offerteaanvraagdatum": "2016-01-01",
"offerteaanvraagdatumDefinitief": true,
"startdatum": "2016-01-01",
"startdatumDefinitief": true,
"medischeKeuringVereist": true,
"medischAkkoord": "2016-01-01",
"voorlopigeDekking": "2016-01-01",
"aanvraagKeuring": "2016-01-01",
"einddatum": "2016-01-01",
"ontvangstdatumPolis": "2016-01-01",
"polisNaarKlant": "2016-01-01",
"verzekeringnemers": [
{
"id": 120954
},
{
"id": 120955
}
],
"verzekerden": [
{
"id": 120954
},
{
"id": 120955
}
],
"contactpersoon": {
"id": 120955
},
"premiebetaler": {
"id": 120955
},
"begunstigde": "Standaard",
"maatschappij": {
"id": 14878
},
"inkoopVia": {
"id": 15100
},
"kinderenmeeverzekeren": true,
"leeftijdTot": 100,
"correspondentieadres": {
"id": 7793
},
"toelichting": "nvt",
"toonindigimap": true,
"gearchiveerd": false
}Schema
{
"title": "Uitvaartverzekering",
"type": "object",
"properties": {
"portefeuille": {
"enum": [
"Eigen beheer",
"Extern beheer"
]
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bestaandePropositie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"adviseur": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"acceptant": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"acceptantWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"behandelaar": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"behandelaarWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bronvermelding": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanbrengerPersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanbrengerOrganisatie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"polisnummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"offerteaanvraagdatum": {
"type": "string",
"format": "date"
},
"offerteaanvraagdatumDefinitief": {
"type": "boolean"
},
"startdatum": {
"type": "string",
"format": "date"
},
"startdatumDefinitief": {
"type": "boolean"
},
"medischeKeuringVereist": {
"type": "boolean"
},
"medischAkkoord": {
"type": "string",
"format": "date"
},
"voorlopigeDekking": {
"type": "string",
"format": "date"
},
"aanvraagKeuring": {
"type": "string",
"format": "date"
},
"einddatum": {
"type": "string",
"format": "date"
},
"ontvangstdatumPolis": {
"type": "string",
"format": "date"
},
"polisNaarKlant": {
"type": "string",
"format": "date"
},
"verzekeringnemers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"verzekerden": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"contactpersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"premiebetaler": {
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"begunstigde": {
"enum": [
"Standaard",
"Afwijkend"
]
},
"maatschappij": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"inkoopVia": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"kinderenmeeverzekeren": {
"type": "boolean"
},
"leeftijdTot": {
"type": "integer",
"minimum": 0
},
"correspondentieadres": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"toelichting": {
"type": "string",
"minLength": 1
},
"toonindigimap": {
"type": "boolean"
},
"gearchiveerd": {
"type": "boolean"
},
"particulier": {
"type": "boolean"
}
},
"required": [
"toonindigimap",
"gearchiveerd",
"portefeuille",
"status",
"bestaandePropositie",
"adviseur",
"bronvermelding",
"offerteaanvraagdatum",
"offerteaanvraagdatumDefinitief",
"startdatum",
"startdatumDefinitief",
"verzekeringnemers",
"verzekerden",
"contactpersoon",
"premiebetaler",
"maatschappij",
"inkoopVia"
],
"oneOf": [
{
"required": [
"behandelaar"
]
},
{
"required": [
"behandelaarWorkflowgroep"
]
}
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/uitvaartverzekeringen/6760Uitvaartverzekeringdeel toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/uitvaartverzekeringen/{PRODUCT_ID}/onderdelen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/uitvaartverzekeringen/6760/onderdelen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6760
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"artikel": {
"id": 20764
},
"zeroProduct": true,
"polisnummer": "12345",
"brutoKoopsom": 125,
"brutotermijnpremie": 150,
"premietermijnPer": "Maand",
"premieduur": 12,
"prolongatieProvisiebedrag": 0,
"royementsdatum": "2017-01-01",
"betalingsprofiel": {
"id": 1
}
}Schema
{
"title": "Uitvaartverzekeringdeel",
"type": "object",
"properties": {
"artikel": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"zeroProduct": {
"type": "boolean"
},
"polisnummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"brutoKoopsom": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"brutotermijnpremie": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"premietermijnPer": {
"enum": [
"Maand",
"Kwartaal",
"Semester",
"Jaar",
"2 maanden",
"Eenmalig"
]
},
"premieduur": {
"type": "integer",
"minimum": 0
},
"prolongatieProvisiebedrag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"royementsdatum": {
"type": "string",
"format": "date"
},
"betalingsprofiel": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"eenmaligeKoopsom": {
"type": "boolean"
}
},
"required": [
"artikel"
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/uitvaartverzekeringen/6760/onderdelen/7922Uitvaartverzekeringdeel kapitaal toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/uitvaartverzekeringen/{PRODUCT_ID}/onderdelen/{PRODUCTDEEL_ID}/kapitalen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/uitvaartverzekeringen/6760/onderdelen/7922/kapitalen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6760- PRODUCTDEEL_ID
int(verplicht) Voorbeeld: 7922
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"soortNaturadekking": "Basisdekking",
"verzekerdBedrag": 100000,
"geindexeerd": true,
"indexpercentage": 100,
"repatriering": true,
"persoon": {
"id": 120954
},
"premie": 75
}Schema
{
"title": "UitvaartverzekeringdeelKapitaal",
"type": "object",
"properties": {
"soortNaturadekking": {
"enum": [
"Basisdekking",
"Basis + aanvullende dekking",
"Basis + extra uitgebreid"
]
},
"verzekerdBedrag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"geindexeerd": {
"type": "boolean"
},
"indexpercentage": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"repatriering": {
"type": "boolean"
},
"koopsom": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"persoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"premie": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
}
},
"required": [
"geindexeerd",
"persoon"
],
"oneOf": [
{
"required": [
"premie"
]
},
{
"required": [
"koopsom"
]
}
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/uitvaartverzekeringen/6760/onderdelen/7922/kapitalen/2Uitvaartverzekering registratie ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/uitvaartverzekeringen/{PRODUCT_ID}/registraties]&publiek={publiek}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/uitvaartverzekeringen/6760/registraties]&publiek=0
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6760- publiek
int(optioneel) Voorbeeld: 0
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/uitvaartverzekeringen/6760/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/uitvaartverzekeringen/6760/registraties/275825"
},
"product": {
"href": "/api/data/klantdossiers/5526/uitvaartverzekeringen/6760"
},
"bestand": {
"href": "/api/data/klantdossiers/5526/documenten/2"
}
}
}
]
}
}Uitvaartverzekering registratie toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/uitvaartverzekeringen/{PRODUCT_ID}/registraties
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/uitvaartverzekeringen/6760/registraties
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6760
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Klantdossier - Registratie toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/uitvaartverzekeringen/6760/registraties/275826Uitvaartverzekering taak toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/uitvaartverzekeringen/{PRODUCT_ID}/taken
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/uitvaartverzekeringen/6755/taken
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6755
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",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"prioriteit": {
"enum": [
"Laag",
"Middel",
"Hoog"
]
},
"startdatum": {
"type": "string",
"format": "date"
},
"einddatum": {
"type": "string",
"format": "date"
},
"afgerond": {
"type": "boolean"
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"initiator": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"genodigden": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"verantwoordelijke": {
"enum": [
"Persoon",
"Workflowgroep",
"WorkflowgroepMetPersoon"
]
},
"verantwoordelijkePersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verantwoordelijkeWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"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/uitvaartverzekeringen/6755/taken/55519Uitvaartverzekering workflow toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/uitvaartverzekeringen/{PRODUCT_ID}/workflows
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/uitvaartverzekeringen/6760/workflows
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6760
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"workflow": {
"id": 21
}
}Schema
{
"properties": {
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"workflow"
]
}Response
204VerbergBekijk
Headers
Content-Type: application/jsonUitvaartverzekering factuur toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/uitvaartverzekeringen/{PRODUCT_ID}/facturen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/uitvaartverzekeringen/6760/facturen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6760
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Factuur - Factuur toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/uitvaartverzekeringen/6760/facturen/1Uitvaartverzekering factuurregel toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/uitvaartverzekeringen/{PRODUCT_ID}/facturen/{FACTUUR_ID}/regels
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/uitvaartverzekeringen/6760/facturen/1/regels
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6760- FACTUUR_ID
int(verplicht) Voorbeeld: 1
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Factuur - Factuurregel toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/uitvaartverzekeringen/6760/facturen/1Uitvaartverzekeringsdocument toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/uitvaartverzekeringen/{PRODUCT_ID}/documenten
Let op: Als het protocol HDN is, zijn alleen PDF bestanden toegestaan.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/2818/uitvaartverzekeringen/6732/documenten
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 2818- PRODUCT_ID
int(verplicht) Voorbeeld: 6732
Request
VerbergBekijk
Body
{
"naam": "fasterforward.png",
"extensie": "png",
"soortdocument": {
"id": 1
},
"data": "iVBORw0KGgoAAAANSUhEUgAAAP0AAAAbCAYAAAC3KIljAAAKsElEQVR42u2dC3BVxRnH82gCISQk
0ZYEUHTCDBrBBJESmbakVMI7Kj4KDFhGwlBtlUzk2RYIAUGbalHEYnl4DdACSSB1EhsBBwTpRAUa
ERIVWu4QCO88KTQ3Cem/M19mvjmze3bPuWdyL/F+M7/Jze73fbvnsv9z9uzZE4LanbP6oID5xNLT
Rx8A7V6SFRSw2/Hffg1oB26VLzTanz58N0WP/o4CxQIiA6IPWBcVfa/vuuhnApHF3MaivwjSbNIv
KGBdWvQ07nsHRN+1RO8OClhA9CYWuNIHRB+wgOi9E3BA9AHRBywg+v/nDwEPgxdAHtgEXODPYDmY
Du61kC8UjABzwevARawFL4NHQXhniB6+3cFEsAxspH68AWaD/g5+h2HgByC0s0WPnNHgWbAefAj2
g50gBwzvokIKBengFVAI9oKPwFawGAzupH50A0kgFQwC3f1a9MjRAywGF4GOlYNxJvm6gYWa+erA
CtDTkCMXVBBnJbFfMZ8KSV+iwGrQAMysFNxvcky/BmsMjGT1o0EZuEn5TnWW6JErDCwF1ym3jM/A
MJM8mcAFMg3lI8A68Dlwg35UnkP+uZr9nAlcxFAN/yjm/7Sg/jFwBrQrKAEJJu3kUhvprCwEPA62
gePgU0nsRLAHeAxttoAykO53okf8APA1sGMLBPl6gsM2clWCeJbHZTWBoC8PgTO68STYKZLv6YDA
PwuES/rq7gzRI08vcIgNtisk0NlgKpgP9rF6D5guyeUiHxebORQIRHQP1f+efm8DsRp9Pc5yvKHh
/yTzH22oy2Z1jeA98Dx4BsyiK/9XzKcKREraqSCfLPp9ADhqOGa3ISYS7DL41FCub0ErK98AQn0t
en6FrwLe2FBDzg3Arh1wQvQUnwIagFVrAxkWRL8NtPtC9DSQ9rLBtRb0kPimgjNMpOPMRE+D+guW
+xIoBBtBHMvZTkxT9LWfQSCVGsf3HvnWgjBWngzaqG4/iJfEB4OFrM0lKtGT4K+wmNN0tV9lmMof
ZD47QJLgVisT1JDP2/4i+nmSnCUgFcSCaJBsMrjfYvniQIvApwwMB5EgBgwFWyT5HvV2ek+zjX8L
/G+Bj2m6vwwUAY/A7xrorSH6/QDmM9G/xAbeK1SsEl41+V8A0Saif7ujnzTNDZaI6jz5/UXRdib5
NbA+323iHwIukV++oW4DlV8DcRrHvZ/8TypEPw8coc+HQarEfxU7hsWKtu9kJ89PnBJ9G6iwwECW
74gg35cgVLQoJ5kq72E+44HI+kqOZ5/AN8/bhTxaIzBaA0gT+A4GV6QnMy56PWsBzRqiPwtiLBLF
7+PZVaQChGqeKCawAZstEf1B0EpT3DsU+dZSTJ1ZH9hU+E3gps9zTPyHs35mGOrOUfk6zWNeQP7N
CtGX0898ECbxjQfN5Ldbs/0+oIlifPKcPoXluwTqDbxs0v7fhFNytTjHSPI9DooN/Nau6Mk3AtQK
fJ8yOa7pAv8mEKkp+kawkD8FoL45vQ23guV5ipVPsjhDOExxp0WiJ+rBXRq5fsZiRposNDaSzxiw
jj4Xm+RdQT7XQYRhau0m2NqEepZBRMtETxwD4aoTCDHQwne+1Leit2E01T+vEP04ILL/gFwwSLtB
+6KfJPCrBsEm+cNBnSAuQ0P0TUD9WMh50a+nssvgexZFP4cvyklEv9zCusJVismT+Iyk+hugO5tt
NDGByYRYEOSlddyqEDEK0Y9R5PoH+R222Ie7/V709NjtfjAZrGaCNxN9FGhUtH8RFIL54IcgxGHR
vyrwqwJZCv4liMvREP08m5tzakCKRQYKVsKLbYjgPjYAn5GIfoCFfJsoplJSv5rqP6DfI8BNKhul
WPSb4sVTjWFgJWjVFP1lEGL2aJT1O9dGn75xSvS3gNsCSZINJRPAH2lwn7Oz4k65ZlCfdO0q2AyS
HRJ9AXDKtitE3wrifLEjjy1yvWojNoTf1wtEX2cx30SWL9FEVM+zslIq+4PA/5dU1wyiNe6Xp4E8
UAz+CWpBO8OjKfoPLTyB+LmN732XvzynnwJqHHjMxnOOBacs5rkFXgPBXop+H3DKPlKI/oSvtuGy
q9cim/H1FJ8jEH2Vjd1oDRSbJRBlO9Gflf+Kyo4L8pVQXYlJm+Npqn2LfDlN4CjYSu3M1RT9+4rj
HMz3Ddj4zjf6wyO7bGBmHnAC7ARzQJmG6PmW3nSwBlQCXVvipegLgVN2QCH6Ml+Jnl3NVtiMb6H4
BQLRV9jIt51i9xrKn6PyE4bye5iA+rFyPvWfZbbIxzgEfgfSQV/RTkBN0bsUx5jE8oy18R25fCp6
xPUBHsnC1HKQAkINMcVSYajb+z54jG4hzipWwiO8EP16gd9eu+JSiL7Yh6I/RXnybcQmsMH7nEOi
f5pNpaNZeaFskQ9lJ6kuk5VNYhuI7hDEjGV9P6LYW++06Pn3NsPGd1Tqa9G/JMmXahJTqhS9fvs/
pQ00IhvmheizBH7nu6Dod1Ceb2zETmaDd4hDou/JrtBPUlkou41IE8TkUd0uwVOJjyXtFFH9VRCr
2bcsh0QfzI7ndRvfUbWvRf+WINfXiphvFVPg/aDewFSTfCOByNI0RR8ryDlI4vuI4tieAC4DyX4r
eronJlJsnTBoQ40Toqf4Dwx793/E9saHCfzTeD0IZhtvXpS0cZrqN1no12YnRE++e8hXoBX1eoAP
RK+cBrsVV2bVfe92QX2BSc40Sc4HNEU/SJL3C4HvMRAl8U8WbOipBz38WPRx7Mq63ULcQLaa/SYV
OyX6Z9lLPyFgJf1eJPEP4zMBMIQJo48ohp0U3tHsUyyoc1D0s4SbkdRx7/qD6H8jyTdb4PsTcEHi
Xy7Z2cYtB4Qbct4Fjgp8L4EQg+80Sd5PwFQwHszQ2A58CswG94G+tE8gD9wQ+C7z2+k9WcfONmKi
hn8oa98DEh0WfRxbIEwFx9i6gdDYW3yrwRL6XG7iX04+lSBEYzqeT/5OiT4SXGNrCmEaMQ+DVtDm
a9EPATKrAgWgCJwEZlbFd7aZvKZbC0rBNnAIeCR+ixS3Abpv2W0Edq0SRNwGoo9jV74bYJLinruQ
DX7a7uyQ6MnYW3+b+FVbY5GtAnxOn+eb+Ofyt+YU7+JvIb8tfA1DIXqr23r/CrqZ+A4BF8h3sz88
stsBrFitaIed4AWWq8COlYEwyTbZy6pgQcxuYNXOgUQ/X8jj+R7s2AZLFIEJIAHEgAdANqhmPvkg
2GnR84017Kp2TOHfu+NZO/uZqHhrjR/vbjCKyuNpHWEluEz1pSCO5a4GO0GKXdFTzJ9YH06CX4A+
7LXaH5NPS8dJFsz0B9H3An/XfHPsNTBZUh9vyJtIeXXtJuUPN+lrBmi2+Ec0gkE2aARKoz4n+N3q
vTpnInuJxoybYJFB8E6LPsGwYWalRgx/b/+4hv9w9kqvGVtBOMVsM9SleSn6YBKyR9GHho7bG5+I
XiGoXYb99ddooC8D95JfDMgR8KAk70NgFThouFJ7gBuUgLkgXrOfSeBduoVoNpyUzpnExYAXSdQ1
hheBvgTvgEf8/pGdehCOo8HtZsK7Dj4DSwE7oTkuep7nUzboR2j45zD/pRb+HuB82pXXxGYKbppy
pwnWMzJAFngB3OmN6Flsf7AKHAX/ZSfXcrDI0E4KyLHyn5X8D8jtDvnJzJ4qAAAAAElFTkSuQmCC"
}Schema
{
"properties": {
"data": {
"type": "string",
"minLength": 1
},
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"extensie": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"soortdocument": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"isContractDocument": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"data",
"naam",
"extensie",
"soortdocument"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/uitvaartverzekeringen/6732/documenten/16Response
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"total": 1,
"message": "Validatie fouten",
"_links": {
"help": {
"href": "http://api.fasterforward.nl/",
"title": "Validatie informatie"
}
},
"_embedded": {
"errors": [
{
"path": "/extensie",
"message": "bestand.extensie.verplicht"
}
]
}
}Vermogen en bancair ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/vermogenenbancair/{PRODUCT_ID}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/vermogenenbancair/6747
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6747
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"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,
"adviseur": "Achternaam, Voornaam (I.)",
"acceptant": "AchternaamTwee, Voornaam (V.)",
"acceptantWorkflowgroep": null,
"behandelaar": "Achternaam, Voornaam (I.)",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/vermogenenbancair/6747"
}
},
"_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",
"volledigeVoornamen": "",
"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": 7908,
"product": "Fondsenmixhypotheek",
"soortBancairProduct": "Beleggingsrekening",
"overeenkomstnummer": "155",
"rekeningnummer": "NL92INGB0001231234",
"looptijd": 24,
"einddatum": "2016-02-01T00:00:00+01:00",
"mutatiebedrag": "100.00",
"termijn": "maand",
"looptijdbedrag": 12,
"eindkapitaal": "30000.00"
}
]
}
}Vermogen en bancair toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/vermogenenbancair
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/vermogenenbancair
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"portefeuille": "Eigen beheer",
"omschrijving": "Vermogen en bancair",
"status": {
"id": 1
},
"bestaandePropositie": {
"id": 3334
},
"adviseur": {
"id": 112115
},
"acceptantWorkflowgroep": {
"id": 45
},
"behandelaarWorkflowgroep": {
"id": 45
},
"bronvermelding": {
"id": 3
},
"aanbrengerPersoon": {
"id": 120956
},
"aanbrengerOrganisatie": {
"id": 14851
},
"registratienummer": "12345",
"offerteaanvraagdatum": "2016-01-01",
"offerteaanvraagdatumDefinitief": true,
"startdatum": "2016-01-01",
"startdatumDefinitief": true,
"aanvragersParticulier": [
{
"id": 120954
},
{
"id": 120955
}
],
"contactpersoon": {
"id": 120954
},
"premiebetalerPersoon": {
"id": 120954
},
"leverancier": {
"id": 14831
},
"inkoopVia": {
"id": 15100
},
"beheerdVermogen": 125,
"verzekerdBedrag": 175,
"risicoprofiel": "Zeer defensief",
"correspondentieadres": {
"id": 7793
},
"toelichting": "nvt",
"gearchiveerd": false,
"toonindigimap": true
}Schema
{
"title": "Vermogenenbancair",
"type": "object",
"properties": {
"portefeuille": {
"enum": [
"Eigen beheer",
"Extern beheer"
]
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bestaandePropositie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verpandAan": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"adviseur": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"acceptant": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"acceptantWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"behandelaar": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"behandelaarWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bronvermelding": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanbrengerPersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanbrengerOrganisatie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"registratienummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"offerteaanvraagdatum": {
"type": "string",
"format": "date"
},
"offerteaanvraagdatumDefinitief": {
"type": "boolean"
},
"startdatum": {
"type": "string",
"format": "date"
},
"startdatumDefinitief": {
"type": "boolean"
},
"aanvragerZakelijk": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanvragersParticulier": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"contactpersoonZakelijk": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"contactpersoonParticulier": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"premiebetalerPersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"premiebetalerOrganisatie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"leverancier": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"inkoopVia": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"beheerdVermogen": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"verzekerdBedrag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"risicoprofiel": {
"enum": [
"Zeer defensief",
"Defensief",
"Neutraal",
"Offensief",
"Zeer offensief"
]
},
"correspondentieadres": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"toelichting": {
"type": "string",
"minLength": 1
},
"gearchiveerd": {
"type": "boolean"
},
"toonindigimap": {
"type": "boolean"
}
},
"required": [
"bestaandePropositie",
"adviseur",
"bronvermelding",
"offerteaanvraagdatum",
"offerteaanvraagdatumDefinitief",
"startdatum",
"startdatumDefinitief",
"leverancier",
"inkoopVia",
"beheerdVermogen",
"verzekerdBedrag",
"gearchiveerd",
"toonindigimap",
"status"
],
"allOf": [
{
"oneOf": [
{
"required": [
"acceptant"
]
},
{
"required": [
"acceptantWorkflowgroep"
]
}
]
},
{
"oneOf": [
{
"required": [
"behandelaar"
]
},
{
"required": [
"behandelaarWorkflowgroep"
]
}
]
}
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/vermogenenbancair/6756Vermogen en bancair deel toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/vermogenenbancair/{PRODUCT_ID}/onderdelen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/vermogenenbancair/6756/onderdelen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6756
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"artikel": {
"id": 20643
},
"overeenkomstnummer": "12345",
"rekeningnummer": "NL25RABO0136907539",
"tegenrekening": "NL25RABO0136907539",
"zeroProduct": true,
"herbeleggen": true,
"winstdeling": "Herbeleggen",
"looptijd": 12,
"einddatum": "2018-01-01",
"bedrag": 100,
"termijn": "Maand",
"bedragLooptijd": 12,
"percentage": 15,
"percentagetype": "Prognose",
"betalingsprofiel": {
"id": 1
},
"afsluitkosten": 22,
"doorloopkosten": 10,
"aankoopkoers": 100,
"aantalUnits": 1,
"productdoel": "Aankoop / Verbouwing eigen woning (box1)",
"eindkapitaal": 250
}Schema
{
"title": "Vermogenenbancairdeel",
"type": "object",
"properties": {
"artikel": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"overeenkomstnummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"rekeningnummer": {
"type": "string",
"minLength": 1,
"maxLength": 20
},
"tegenrekening": {
"type": "string",
"minLength": 1,
"maxLength": 20
},
"zeroProduct": {
"type": "boolean"
},
"herbeleggen": {
"type": "boolean"
},
"winstdeling": {
"enum": [
"Herbeleggen",
"Uitkeren"
]
},
"looptijd": {
"type": "integer",
"minimum": 0
},
"einddatum": {
"type": "string",
"format": "date"
},
"bedrag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"termijn": {
"enum": [
"Maand",
"Kwartaal",
"Semester",
"Jaar",
"2 maanden",
"Eenmalig"
]
},
"bedragLooptijd": {
"type": "integer",
"minimum": 0
},
"percentage": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"percentagetype": {
"enum": [
"Prognose",
"Gegarandeerd"
]
},
"betalingsprofiel": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"afsluitkosten": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"doorloopkosten": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"aankoopkoers": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"aantalUnits": {
"type": "integer",
"minimum": 0
},
"productdoel": {
"enum": [
"Aankoop / Verbouwing eigen woning (box1)",
"Aankoop tweede woning (box3)",
"Belegging (box3)",
"Consumptief (box3)",
"Pensioen (box 3)"
]
},
"eindkapitaal": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
}
},
"required": [
"artikel",
"productdoel"
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/vermogenenbancair/6756/onderdelen/7918Vermogen en bancair deel inleg toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/vermogenenbancair/{PRODUCT_ID}/onderdelen/{PRODUCTDEEL_ID}/inleggen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/vermogenenbancair/6756/onderdelen/7918/inleggen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6756- PRODUCTDEEL_ID
int(verplicht) Voorbeeld: 7918
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"inleg": 100,
"huidigeWaarde": 100,
"koers": 100,
"datum": "2016-01-01"
}Schema
{
"title": "ProductdeelHuidigeWaarde",
"type": "object",
"properties": {
"inleg": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"huidigeWaarde": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"koers": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"datum": {
"type": "string",
"format": "date"
}
},
"required": [
"inleg",
"koers",
"datum"
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/vermogenenbancair/6756/onderdelen/7918/inleggen/495Vermogen en bancair registratie ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/vermogenenbancair/{PRODUCT_ID}/registraties]&publiek={publiek}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/vermogenenbancair/6756/registraties]&publiek=0
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6756- publiek
int(optioneel) Voorbeeld: 0
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/vermogenenbancair/6756/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/vermogenenbancair/6756/registraties/275825"
},
"product": {
"href": "/api/data/klantdossiers/5526/vermogenenbancair/6756"
},
"bestand": {
"href": "/api/data/klantdossiers/5526/documenten/2"
}
}
}
]
}
}Vermogen en bancair registratie toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/vermogenenbancair/{PRODUCT_ID}/registraties
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/vermogenenbancair/6756/registraties
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6756
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Klantdossier - Registratie toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/vermogenenbancair/6756/registraties/275826Vermogen en bancair taak toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/vermogenenbancair/{PRODUCT_ID}/taken
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/vermogenenbancair/6755/taken
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6755
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",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"prioriteit": {
"enum": [
"Laag",
"Middel",
"Hoog"
]
},
"startdatum": {
"type": "string",
"format": "date"
},
"einddatum": {
"type": "string",
"format": "date"
},
"afgerond": {
"type": "boolean"
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"initiator": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"genodigden": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"verantwoordelijke": {
"enum": [
"Persoon",
"Workflowgroep",
"WorkflowgroepMetPersoon"
]
},
"verantwoordelijkePersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verantwoordelijkeWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"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/vermogenenbancair/6755/taken/55519Vermogen en bancair workflow toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/vermogenenbancair/{PRODUCT_ID}/workflows
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/vermogenenbancair/6756/workflows
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6756
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"workflow": {
"id": 21
}
}Schema
{
"properties": {
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"workflow"
]
}Response
204VerbergBekijk
Headers
Content-Type: application/jsonVermogen en bancair factuur toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/vermogenenbancair/{PRODUCT_ID}/facturen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/vermogenenbancair/6747/facturen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6747
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Factuur - Factuur toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/vermogenenbancair/6747/facturen/1Vermogen en bancair factuurregel toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/vermogenenbancair/{PRODUCT_ID}/facturen/{FACTUUR_ID}/regels
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/vermogenenbancair/6747/facturen/1/regels
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6747- FACTUUR_ID
int(verplicht) Voorbeeld: 1
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
Zie Factuur - Factuurregel toevoegenResponse
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/vermogenenbancair/6747/facturen/1Vermogen en bancairdocument toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/vermogenenbancair/{PRODUCT_ID}/documenten
Let op: Als het protocol HDN is, zijn alleen PDF bestanden toegestaan.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/2818/vermogenenbancair/6732/documenten
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 2818- PRODUCT_ID
int(verplicht) Voorbeeld: 6732
Request
VerbergBekijk
Body
{
"naam": "fasterforward.png",
"extensie": "png",
"soortdocument": {
"id": 1
},
"data": "iVBORw0KGgoAAAANSUhEUgAAAP0AAAAbCAYAAAC3KIljAAAKsElEQVR42u2dC3BVxRnH82gCISQk
0ZYEUHTCDBrBBJESmbakVMI7Kj4KDFhGwlBtlUzk2RYIAUGbalHEYnl4DdACSSB1EhsBBwTpRAUa
ERIVWu4QCO88KTQ3Cem/M19mvjmze3bPuWdyL/F+M7/Jze73fbvnsv9z9uzZE4LanbP6oID5xNLT
Rx8A7V6SFRSw2/Hffg1oB26VLzTanz58N0WP/o4CxQIiA6IPWBcVfa/vuuhnApHF3MaivwjSbNIv
KGBdWvQ07nsHRN+1RO8OClhA9CYWuNIHRB+wgOi9E3BA9AHRBywg+v/nDwEPgxdAHtgEXODPYDmY
Du61kC8UjABzwevARawFL4NHQXhniB6+3cFEsAxspH68AWaD/g5+h2HgByC0s0WPnNHgWbAefAj2
g50gBwzvokIKBengFVAI9oKPwFawGAzupH50A0kgFQwC3f1a9MjRAywGF4GOlYNxJvm6gYWa+erA
CtDTkCMXVBBnJbFfMZ8KSV+iwGrQAMysFNxvcky/BmsMjGT1o0EZuEn5TnWW6JErDCwF1ym3jM/A
MJM8mcAFMg3lI8A68Dlwg35UnkP+uZr9nAlcxFAN/yjm/7Sg/jFwBrQrKAEJJu3kUhvprCwEPA62
gePgU0nsRLAHeAxttoAykO53okf8APA1sGMLBPl6gsM2clWCeJbHZTWBoC8PgTO68STYKZLv6YDA
PwuES/rq7gzRI08vcIgNtisk0NlgKpgP9rF6D5guyeUiHxebORQIRHQP1f+efm8DsRp9Pc5yvKHh
/yTzH22oy2Z1jeA98Dx4BsyiK/9XzKcKREraqSCfLPp9ADhqOGa3ISYS7DL41FCub0ErK98AQn0t
en6FrwLe2FBDzg3Arh1wQvQUnwIagFVrAxkWRL8NtPtC9DSQ9rLBtRb0kPimgjNMpOPMRE+D+guW
+xIoBBtBHMvZTkxT9LWfQSCVGsf3HvnWgjBWngzaqG4/iJfEB4OFrM0lKtGT4K+wmNN0tV9lmMof
ZD47QJLgVisT1JDP2/4i+nmSnCUgFcSCaJBsMrjfYvniQIvApwwMB5EgBgwFWyT5HvV2ek+zjX8L
/G+Bj2m6vwwUAY/A7xrorSH6/QDmM9G/xAbeK1SsEl41+V8A0Saif7ujnzTNDZaI6jz5/UXRdib5
NbA+323iHwIukV++oW4DlV8DcRrHvZ/8TypEPw8coc+HQarEfxU7hsWKtu9kJ89PnBJ9G6iwwECW
74gg35cgVLQoJ5kq72E+44HI+kqOZ5/AN8/bhTxaIzBaA0gT+A4GV6QnMy56PWsBzRqiPwtiLBLF
7+PZVaQChGqeKCawAZstEf1B0EpT3DsU+dZSTJ1ZH9hU+E3gps9zTPyHs35mGOrOUfk6zWNeQP7N
CtGX0898ECbxjQfN5Ldbs/0+oIlifPKcPoXluwTqDbxs0v7fhFNytTjHSPI9DooN/Nau6Mk3AtQK
fJ8yOa7pAv8mEKkp+kawkD8FoL45vQ23guV5ipVPsjhDOExxp0WiJ+rBXRq5fsZiRposNDaSzxiw
jj4Xm+RdQT7XQYRhau0m2NqEepZBRMtETxwD4aoTCDHQwne+1Leit2E01T+vEP04ILL/gFwwSLtB
+6KfJPCrBsEm+cNBnSAuQ0P0TUD9WMh50a+nssvgexZFP4cvyklEv9zCusJVismT+Iyk+hugO5tt
NDGByYRYEOSlddyqEDEK0Y9R5PoH+R222Ie7/V709NjtfjAZrGaCNxN9FGhUtH8RFIL54IcgxGHR
vyrwqwJZCv4liMvREP08m5tzakCKRQYKVsKLbYjgPjYAn5GIfoCFfJsoplJSv5rqP6DfI8BNKhul
WPSb4sVTjWFgJWjVFP1lEGL2aJT1O9dGn75xSvS3gNsCSZINJRPAH2lwn7Oz4k65ZlCfdO0q2AyS
HRJ9AXDKtitE3wrifLEjjy1yvWojNoTf1wtEX2cx30SWL9FEVM+zslIq+4PA/5dU1wyiNe6Xp4E8
UAz+CWpBO8OjKfoPLTyB+LmN732XvzynnwJqHHjMxnOOBacs5rkFXgPBXop+H3DKPlKI/oSvtuGy
q9cim/H1FJ8jEH2Vjd1oDRSbJRBlO9Gflf+Kyo4L8pVQXYlJm+Npqn2LfDlN4CjYSu3M1RT9+4rj
HMz3Ddj4zjf6wyO7bGBmHnAC7ARzQJmG6PmW3nSwBlQCXVvipegLgVN2QCH6Ml+Jnl3NVtiMb6H4
BQLRV9jIt51i9xrKn6PyE4bye5iA+rFyPvWfZbbIxzgEfgfSQV/RTkBN0bsUx5jE8oy18R25fCp6
xPUBHsnC1HKQAkINMcVSYajb+z54jG4hzipWwiO8EP16gd9eu+JSiL7Yh6I/RXnybcQmsMH7nEOi
f5pNpaNZeaFskQ9lJ6kuk5VNYhuI7hDEjGV9P6LYW++06Pn3NsPGd1Tqa9G/JMmXahJTqhS9fvs/
pQ00IhvmheizBH7nu6Dod1Ceb2zETmaDd4hDou/JrtBPUlkou41IE8TkUd0uwVOJjyXtFFH9VRCr
2bcsh0QfzI7ndRvfUbWvRf+WINfXiphvFVPg/aDewFSTfCOByNI0RR8ryDlI4vuI4tieAC4DyX4r
eronJlJsnTBoQ40Toqf4Dwx793/E9saHCfzTeD0IZhtvXpS0cZrqN1no12YnRE++e8hXoBX1eoAP
RK+cBrsVV2bVfe92QX2BSc40Sc4HNEU/SJL3C4HvMRAl8U8WbOipBz38WPRx7Mq63ULcQLaa/SYV
OyX6Z9lLPyFgJf1eJPEP4zMBMIQJo48ohp0U3tHsUyyoc1D0s4SbkdRx7/qD6H8jyTdb4PsTcEHi
Xy7Z2cYtB4Qbct4Fjgp8L4EQg+80Sd5PwFQwHszQ2A58CswG94G+tE8gD9wQ+C7z2+k9WcfONmKi
hn8oa98DEh0WfRxbIEwFx9i6gdDYW3yrwRL6XG7iX04+lSBEYzqeT/5OiT4SXGNrCmEaMQ+DVtDm
a9EPATKrAgWgCJwEZlbFd7aZvKZbC0rBNnAIeCR+ixS3Abpv2W0Edq0SRNwGoo9jV74bYJLinruQ
DX7a7uyQ6MnYW3+b+FVbY5GtAnxOn+eb+Ofyt+YU7+JvIb8tfA1DIXqr23r/CrqZ+A4BF8h3sz88
stsBrFitaIed4AWWq8COlYEwyTbZy6pgQcxuYNXOgUQ/X8jj+R7s2AZLFIEJIAHEgAdANqhmPvkg
2GnR84017Kp2TOHfu+NZO/uZqHhrjR/vbjCKyuNpHWEluEz1pSCO5a4GO0GKXdFTzJ9YH06CX4A+
7LXaH5NPS8dJFsz0B9H3An/XfHPsNTBZUh9vyJtIeXXtJuUPN+lrBmi2+Ec0gkE2aARKoz4n+N3q
vTpnInuJxoybYJFB8E6LPsGwYWalRgx/b/+4hv9w9kqvGVtBOMVsM9SleSn6YBKyR9GHho7bG5+I
XiGoXYb99ddooC8D95JfDMgR8KAk70NgFThouFJ7gBuUgLkgXrOfSeBduoVoNpyUzpnExYAXSdQ1
hheBvgTvgEf8/pGdehCOo8HtZsK7Dj4DSwE7oTkuep7nUzboR2j45zD/pRb+HuB82pXXxGYKbppy
pwnWMzJAFngB3OmN6Flsf7AKHAX/ZSfXcrDI0E4KyLHyn5X8D8jtDvnJzJ4qAAAAAElFTkSuQmCC"
}Schema
{
"properties": {
"data": {
"type": "string",
"minLength": 1
},
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"extensie": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"soortdocument": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"isContractDocument": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"data",
"naam",
"extensie",
"soortdocument"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/vermogenenbancair/6732/documenten/16Response
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"total": 1,
"message": "Validatie fouten",
"_links": {
"help": {
"href": "http://api.fasterforward.nl/",
"title": "Validatie informatie"
}
},
"_embedded": {
"errors": [
{
"path": "/extensie",
"message": "bestand.extensie.verplicht"
}
]
}
}Servetdocument toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/profileprints/{PRODUCT_ID}/documenten
Let op: Als het protocol HDN is, zijn alleen PDF bestanden toegestaan.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/2818/profileprints/6732/documenten
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 2818- PRODUCT_ID
int(verplicht) Voorbeeld: 6732
Request
VerbergBekijk
Body
{
"naam": "fasterforward.png",
"extensie": "png",
"soortdocument": {
"id": 1
},
"data": "iVBORw0KGgoAAAANSUhEUgAAAP0AAAAbCAYAAAC3KIljAAAKsElEQVR42u2dC3BVxRnH82gCISQk
0ZYEUHTCDBrBBJESmbakVMI7Kj4KDFhGwlBtlUzk2RYIAUGbalHEYnl4DdACSSB1EhsBBwTpRAUa
ERIVWu4QCO88KTQ3Cem/M19mvjmze3bPuWdyL/F+M7/Jze73fbvnsv9z9uzZE4LanbP6oID5xNLT
Rx8A7V6SFRSw2/Hffg1oB26VLzTanz58N0WP/o4CxQIiA6IPWBcVfa/vuuhnApHF3MaivwjSbNIv
KGBdWvQ07nsHRN+1RO8OClhA9CYWuNIHRB+wgOi9E3BA9AHRBywg+v/nDwEPgxdAHtgEXODPYDmY
Du61kC8UjABzwevARawFL4NHQXhniB6+3cFEsAxspH68AWaD/g5+h2HgByC0s0WPnNHgWbAefAj2
g50gBwzvokIKBengFVAI9oKPwFawGAzupH50A0kgFQwC3f1a9MjRAywGF4GOlYNxJvm6gYWa+erA
CtDTkCMXVBBnJbFfMZ8KSV+iwGrQAMysFNxvcky/BmsMjGT1o0EZuEn5TnWW6JErDCwF1ym3jM/A
MJM8mcAFMg3lI8A68Dlwg35UnkP+uZr9nAlcxFAN/yjm/7Sg/jFwBrQrKAEJJu3kUhvprCwEPA62
gePgU0nsRLAHeAxttoAykO53okf8APA1sGMLBPl6gsM2clWCeJbHZTWBoC8PgTO68STYKZLv6YDA
PwuES/rq7gzRI08vcIgNtisk0NlgKpgP9rF6D5guyeUiHxebORQIRHQP1f+efm8DsRp9Pc5yvKHh
/yTzH22oy2Z1jeA98Dx4BsyiK/9XzKcKREraqSCfLPp9ADhqOGa3ISYS7DL41FCub0ErK98AQn0t
en6FrwLe2FBDzg3Arh1wQvQUnwIagFVrAxkWRL8NtPtC9DSQ9rLBtRb0kPimgjNMpOPMRE+D+guW
+xIoBBtBHMvZTkxT9LWfQSCVGsf3HvnWgjBWngzaqG4/iJfEB4OFrM0lKtGT4K+wmNN0tV9lmMof
ZD47QJLgVisT1JDP2/4i+nmSnCUgFcSCaJBsMrjfYvniQIvApwwMB5EgBgwFWyT5HvV2ek+zjX8L
/G+Bj2m6vwwUAY/A7xrorSH6/QDmM9G/xAbeK1SsEl41+V8A0Saif7ujnzTNDZaI6jz5/UXRdib5
NbA+323iHwIukV++oW4DlV8DcRrHvZ/8TypEPw8coc+HQarEfxU7hsWKtu9kJ89PnBJ9G6iwwECW
74gg35cgVLQoJ5kq72E+44HI+kqOZ5/AN8/bhTxaIzBaA0gT+A4GV6QnMy56PWsBzRqiPwtiLBLF
7+PZVaQChGqeKCawAZstEf1B0EpT3DsU+dZSTJ1ZH9hU+E3gps9zTPyHs35mGOrOUfk6zWNeQP7N
CtGX0898ECbxjQfN5Ldbs/0+oIlifPKcPoXluwTqDbxs0v7fhFNytTjHSPI9DooN/Nau6Mk3AtQK
fJ8yOa7pAv8mEKkp+kawkD8FoL45vQ23guV5ipVPsjhDOExxp0WiJ+rBXRq5fsZiRposNDaSzxiw
jj4Xm+RdQT7XQYRhau0m2NqEepZBRMtETxwD4aoTCDHQwne+1Leit2E01T+vEP04ILL/gFwwSLtB
+6KfJPCrBsEm+cNBnSAuQ0P0TUD9WMh50a+nssvgexZFP4cvyklEv9zCusJVismT+Iyk+hugO5tt
NDGByYRYEOSlddyqEDEK0Y9R5PoH+R222Ie7/V709NjtfjAZrGaCNxN9FGhUtH8RFIL54IcgxGHR
vyrwqwJZCv4liMvREP08m5tzakCKRQYKVsKLbYjgPjYAn5GIfoCFfJsoplJSv5rqP6DfI8BNKhul
WPSb4sVTjWFgJWjVFP1lEGL2aJT1O9dGn75xSvS3gNsCSZINJRPAH2lwn7Oz4k65ZlCfdO0q2AyS
HRJ9AXDKtitE3wrifLEjjy1yvWojNoTf1wtEX2cx30SWL9FEVM+zslIq+4PA/5dU1wyiNe6Xp4E8
UAz+CWpBO8OjKfoPLTyB+LmN732XvzynnwJqHHjMxnOOBacs5rkFXgPBXop+H3DKPlKI/oSvtuGy
q9cim/H1FJ8jEH2Vjd1oDRSbJRBlO9Gflf+Kyo4L8pVQXYlJm+Npqn2LfDlN4CjYSu3M1RT9+4rj
HMz3Ddj4zjf6wyO7bGBmHnAC7ARzQJmG6PmW3nSwBlQCXVvipegLgVN2QCH6Ml+Jnl3NVtiMb6H4
BQLRV9jIt51i9xrKn6PyE4bye5iA+rFyPvWfZbbIxzgEfgfSQV/RTkBN0bsUx5jE8oy18R25fCp6
xPUBHsnC1HKQAkINMcVSYajb+z54jG4hzipWwiO8EP16gd9eu+JSiL7Yh6I/RXnybcQmsMH7nEOi
f5pNpaNZeaFskQ9lJ6kuk5VNYhuI7hDEjGV9P6LYW++06Pn3NsPGd1Tqa9G/JMmXahJTqhS9fvs/
pQ00IhvmheizBH7nu6Dod1Ceb2zETmaDd4hDou/JrtBPUlkou41IE8TkUd0uwVOJjyXtFFH9VRCr
2bcsh0QfzI7ndRvfUbWvRf+WINfXiphvFVPg/aDewFSTfCOByNI0RR8ryDlI4vuI4tieAC4DyX4r
eronJlJsnTBoQ40Toqf4Dwx793/E9saHCfzTeD0IZhtvXpS0cZrqN1no12YnRE++e8hXoBX1eoAP
RK+cBrsVV2bVfe92QX2BSc40Sc4HNEU/SJL3C4HvMRAl8U8WbOipBz38WPRx7Mq63ULcQLaa/SYV
OyX6Z9lLPyFgJf1eJPEP4zMBMIQJo48ohp0U3tHsUyyoc1D0s4SbkdRx7/qD6H8jyTdb4PsTcEHi
Xy7Z2cYtB4Qbct4Fjgp8L4EQg+80Sd5PwFQwHszQ2A58CswG94G+tE8gD9wQ+C7z2+k9WcfONmKi
hn8oa98DEh0WfRxbIEwFx9i6gdDYW3yrwRL6XG7iX04+lSBEYzqeT/5OiT4SXGNrCmEaMQ+DVtDm
a9EPATKrAgWgCJwEZlbFd7aZvKZbC0rBNnAIeCR+ixS3Abpv2W0Edq0SRNwGoo9jV74bYJLinruQ
DX7a7uyQ6MnYW3+b+FVbY5GtAnxOn+eb+Ofyt+YU7+JvIb8tfA1DIXqr23r/CrqZ+A4BF8h3sz88
stsBrFitaIed4AWWq8COlYEwyTbZy6pgQcxuYNXOgUQ/X8jj+R7s2AZLFIEJIAHEgAdANqhmPvkg
2GnR84017Kp2TOHfu+NZO/uZqHhrjR/vbjCKyuNpHWEluEz1pSCO5a4GO0GKXdFTzJ9YH06CX4A+
7LXaH5NPS8dJFsz0B9H3An/XfHPsNTBZUh9vyJtIeXXtJuUPN+lrBmi2+Ec0gkE2aARKoz4n+N3q
vTpnInuJxoybYJFB8E6LPsGwYWalRgx/b/+4hv9w9kqvGVtBOMVsM9SleSn6YBKyR9GHho7bG5+I
XiGoXYb99ddooC8D95JfDMgR8KAk70NgFThouFJ7gBuUgLkgXrOfSeBduoVoNpyUzpnExYAXSdQ1
hheBvgTvgEf8/pGdehCOo8HtZsK7Dj4DSwE7oTkuep7nUzboR2j45zD/pRb+HuB82pXXxGYKbppy
pwnWMzJAFngB3OmN6Flsf7AKHAX/ZSfXcrDI0E4KyLHyn5X8D8jtDvnJzJ4qAAAAAElFTkSuQmCC"
}Schema
{
"properties": {
"data": {
"type": "string",
"minLength": 1
},
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"extensie": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"soortdocument": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"isContractDocument": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"data",
"naam",
"extensie",
"soortdocument"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/profileprints/6732/documenten/16Response
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"total": 1,
"message": "Validatie fouten",
"_links": {
"help": {
"href": "http://api.fasterforward.nl/",
"title": "Validatie informatie"
}
},
"_embedded": {
"errors": [
{
"path": "/extensie",
"message": "bestand.extensie.verplicht"
}
]
}
}Volmacht verzekering toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/volmachtverzekeringen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/volmachtverzekeringen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"contractId": 123,
"omschrijving": "Mijn Volmacht product via API",
"maatschappij": {
"porcode": "C309"
},
"polisOfPakketNummer": "P091823",
"startdatum": "2024-05-01",
"verzekeringnemerRol": "Particulier",
"verzekeringnemerParticulier": {
"id": 140488
}
}Schema
{
"title": "VolmachtVerzekering",
"type": "object",
"properties": {
"contractId": {
"type": "integer",
"minimum": 1
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"polisOfPakketNummer": {
"type": "string",
"minLength": 1,
"maxLength": 4
},
"startdatum": {
"type": "string",
"format": "date"
},
"verzekeringnemerRol": {
"enum": [
"Particulier",
"Zakelijk"
]
},
"verzekeringnemerZakelijk": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verzekeringnemerParticulier": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"maatschappij": {
"type": "object",
"properties": {
"porcode": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"required": [
"porcode"
],
"additionalProperties": false
},
"gearchiveerd": {
"type": "boolean"
}
},
"required": [
"contractId",
"startdatum",
"maatschappij",
"verzekeringnemerRol"
],
"oneOf": [
{
"properties": {
"verzekeringnemerRol": {
"enum": [
"Particulier"
]
}
},
"required": [
"verzekeringnemerParticulier"
]
},
{
"properties": {
"verzekeringnemerRol": {
"enum": [
"Zakelijk"
]
}
},
"required": [
"verzekeringnemerZakelijk"
]
}
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/{DOSSIER_ID}/volmachtverzekeringen/{PRODUCT_ID}Volmacht verzekering wijzigenPATCH/api/data/klantdossiers/{DOSSIER_ID}/volmachtverzekeringen/{PRODUCT_ID}
Voorbeeld URI
PATCH https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/volmachtverzekeringen/123
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 123
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"omschrijving": "Mijn Volmacht product via API",
"maatschappij": {
"porcode": "C309"
},
"polisOfPakketNummer": "P091823",
"startdatum": "2024-05-01",
"verzekeringnemerRol": "Particulier",
"verzekeringnemerParticulier": {
"id": 140488
}
}Schema
{
"title": "VolmachtVerzekering",
"type": "object",
"properties": {
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"polisOfPakketNummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"startdatum": {
"type": "string",
"format": "date"
},
"verzekeringnemerRol": {
"enum": [
"Particulier",
"Zakelijk"
]
},
"verzekeringnemerZakelijk": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verzekeringnemerParticulier": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"maatschappij": {
"type": "object",
"properties": {
"porcode": {
"type": "string",
"minLength": 1,
"maxLength": 4
}
},
"required": [
"porcode"
],
"additionalProperties": false
},
"gearchiveerd": {
"type": "boolean"
}
},
"oneOf": [
{
"properties": {
"verzekeringnemerRol": {
"enum": [
"Particulier"
]
}
},
"required": [
"verzekeringnemerParticulier"
]
},
{
"properties": {
"verzekeringnemerRol": {
"enum": [
"Zakelijk"
]
}
},
"required": [
"verzekeringnemerZakelijk"
]
}
],
"additionalProperties": false
}Response
204VerbergBekijk
Headers
Content-Type: text/htmlVolmacht verzekering document toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/volmachtverzekeringen/{PRODUCT_ID}/documenten
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/2818/volmachtverzekeringen/6732/documenten
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 2818- PRODUCT_ID
int(verplicht) Voorbeeld: 6732
Request
VerbergBekijk
Body
{
"naam": "fasterforward.png",
"extensie": "png",
"soortdocument": {
"id": 1
},
"data": "iVBORw0KGgoAAAANSUhEUgAAAP0AAAAbCAYAAAC3KIljAAAKsElEQVR42u2dC3BVxRnH82gCISQk
0ZYEUHTCDBrBBJESmbakVMI7Kj4KDFhGwlBtlUzk2RYIAUGbalHEYnl4DdACSSB1EhsBBwTpRAUa
ERIVWu4QCO88KTQ3Cem/M19mvjmze3bPuWdyL/F+M7/Jze73fbvnsv9z9uzZE4LanbP6oID5xNLT
Rx8A7V6SFRSw2/Hffg1oB26VLzTanz58N0WP/o4CxQIiA6IPWBcVfa/vuuhnApHF3MaivwjSbNIv
KGBdWvQ07nsHRN+1RO8OClhA9CYWuNIHRB+wgOi9E3BA9AHRBywg+v/nDwEPgxdAHtgEXODPYDmY
Du61kC8UjABzwevARawFL4NHQXhniB6+3cFEsAxspH68AWaD/g5+h2HgByC0s0WPnNHgWbAefAj2
g50gBwzvokIKBengFVAI9oKPwFawGAzupH50A0kgFQwC3f1a9MjRAywGF4GOlYNxJvm6gYWa+erA
CtDTkCMXVBBnJbFfMZ8KSV+iwGrQAMysFNxvcky/BmsMjGT1o0EZuEn5TnWW6JErDCwF1ym3jM/A
MJM8mcAFMg3lI8A68Dlwg35UnkP+uZr9nAlcxFAN/yjm/7Sg/jFwBrQrKAEJJu3kUhvprCwEPA62
gePgU0nsRLAHeAxttoAykO53okf8APA1sGMLBPl6gsM2clWCeJbHZTWBoC8PgTO68STYKZLv6YDA
PwuES/rq7gzRI08vcIgNtisk0NlgKpgP9rF6D5guyeUiHxebORQIRHQP1f+efm8DsRp9Pc5yvKHh
/yTzH22oy2Z1jeA98Dx4BsyiK/9XzKcKREraqSCfLPp9ADhqOGa3ISYS7DL41FCub0ErK98AQn0t
en6FrwLe2FBDzg3Arh1wQvQUnwIagFVrAxkWRL8NtPtC9DSQ9rLBtRb0kPimgjNMpOPMRE+D+guW
+xIoBBtBHMvZTkxT9LWfQSCVGsf3HvnWgjBWngzaqG4/iJfEB4OFrM0lKtGT4K+wmNN0tV9lmMof
ZD47QJLgVisT1JDP2/4i+nmSnCUgFcSCaJBsMrjfYvniQIvApwwMB5EgBgwFWyT5HvV2ek+zjX8L
/G+Bj2m6vwwUAY/A7xrorSH6/QDmM9G/xAbeK1SsEl41+V8A0Saif7ujnzTNDZaI6jz5/UXRdib5
NbA+323iHwIukV++oW4DlV8DcRrHvZ/8TypEPw8coc+HQarEfxU7hsWKtu9kJ89PnBJ9G6iwwECW
74gg35cgVLQoJ5kq72E+44HI+kqOZ5/AN8/bhTxaIzBaA0gT+A4GV6QnMy56PWsBzRqiPwtiLBLF
7+PZVaQChGqeKCawAZstEf1B0EpT3DsU+dZSTJ1ZH9hU+E3gps9zTPyHs35mGOrOUfk6zWNeQP7N
CtGX0898ECbxjQfN5Ldbs/0+oIlifPKcPoXluwTqDbxs0v7fhFNytTjHSPI9DooN/Nau6Mk3AtQK
fJ8yOa7pAv8mEKkp+kawkD8FoL45vQ23guV5ipVPsjhDOExxp0WiJ+rBXRq5fsZiRposNDaSzxiw
jj4Xm+RdQT7XQYRhau0m2NqEepZBRMtETxwD4aoTCDHQwne+1Leit2E01T+vEP04ILL/gFwwSLtB
+6KfJPCrBsEm+cNBnSAuQ0P0TUD9WMh50a+nssvgexZFP4cvyklEv9zCusJVismT+Iyk+hugO5tt
NDGByYRYEOSlddyqEDEK0Y9R5PoH+R222Ie7/V709NjtfjAZrGaCNxN9FGhUtH8RFIL54IcgxGHR
vyrwqwJZCv4liMvREP08m5tzakCKRQYKVsKLbYjgPjYAn5GIfoCFfJsoplJSv5rqP6DfI8BNKhul
WPSb4sVTjWFgJWjVFP1lEGL2aJT1O9dGn75xSvS3gNsCSZINJRPAH2lwn7Oz4k65ZlCfdO0q2AyS
HRJ9AXDKtitE3wrifLEjjy1yvWojNoTf1wtEX2cx30SWL9FEVM+zslIq+4PA/5dU1wyiNe6Xp4E8
UAz+CWpBO8OjKfoPLTyB+LmN732XvzynnwJqHHjMxnOOBacs5rkFXgPBXop+H3DKPlKI/oSvtuGy
q9cim/H1FJ8jEH2Vjd1oDRSbJRBlO9Gflf+Kyo4L8pVQXYlJm+Npqn2LfDlN4CjYSu3M1RT9+4rj
HMz3Ddj4zjf6wyO7bGBmHnAC7ARzQJmG6PmW3nSwBlQCXVvipegLgVN2QCH6Ml+Jnl3NVtiMb6H4
BQLRV9jIt51i9xrKn6PyE4bye5iA+rFyPvWfZbbIxzgEfgfSQV/RTkBN0bsUx5jE8oy18R25fCp6
xPUBHsnC1HKQAkINMcVSYajb+z54jG4hzipWwiO8EP16gd9eu+JSiL7Yh6I/RXnybcQmsMH7nEOi
f5pNpaNZeaFskQ9lJ6kuk5VNYhuI7hDEjGV9P6LYW++06Pn3NsPGd1Tqa9G/JMmXahJTqhS9fvs/
pQ00IhvmheizBH7nu6Dod1Ceb2zETmaDd4hDou/JrtBPUlkou41IE8TkUd0uwVOJjyXtFFH9VRCr
2bcsh0QfzI7ndRvfUbWvRf+WINfXiphvFVPg/aDewFSTfCOByNI0RR8ryDlI4vuI4tieAC4DyX4r
eronJlJsnTBoQ40Toqf4Dwx793/E9saHCfzTeD0IZhtvXpS0cZrqN1no12YnRE++e8hXoBX1eoAP
RK+cBrsVV2bVfe92QX2BSc40Sc4HNEU/SJL3C4HvMRAl8U8WbOipBz38WPRx7Mq63ULcQLaa/SYV
OyX6Z9lLPyFgJf1eJPEP4zMBMIQJo48ohp0U3tHsUyyoc1D0s4SbkdRx7/qD6H8jyTdb4PsTcEHi
Xy7Z2cYtB4Qbct4Fjgp8L4EQg+80Sd5PwFQwHszQ2A58CswG94G+tE8gD9wQ+C7z2+k9WcfONmKi
hn8oa98DEh0WfRxbIEwFx9i6gdDYW3yrwRL6XG7iX04+lSBEYzqeT/5OiT4SXGNrCmEaMQ+DVtDm
a9EPATKrAgWgCJwEZlbFd7aZvKZbC0rBNnAIeCR+ixS3Abpv2W0Edq0SRNwGoo9jV74bYJLinruQ
DX7a7uyQ6MnYW3+b+FVbY5GtAnxOn+eb+Ofyt+YU7+JvIb8tfA1DIXqr23r/CrqZ+A4BF8h3sz88
stsBrFitaIed4AWWq8COlYEwyTbZy6pgQcxuYNXOgUQ/X8jj+R7s2AZLFIEJIAHEgAdANqhmPvkg
2GnR84017Kp2TOHfu+NZO/uZqHhrjR/vbjCKyuNpHWEluEz1pSCO5a4GO0GKXdFTzJ9YH06CX4A+
7LXaH5NPS8dJFsz0B9H3An/XfHPsNTBZUh9vyJtIeXXtJuUPN+lrBmi2+Ec0gkE2aARKoz4n+N3q
vTpnInuJxoybYJFB8E6LPsGwYWalRgx/b/+4hv9w9kqvGVtBOMVsM9SleSn6YBKyR9GHho7bG5+I
XiGoXYb99ddooC8D95JfDMgR8KAk70NgFThouFJ7gBuUgLkgXrOfSeBduoVoNpyUzpnExYAXSdQ1
hheBvgTvgEf8/pGdehCOo8HtZsK7Dj4DSwE7oTkuep7nUzboR2j45zD/pRb+HuB82pXXxGYKbppy
pwnWMzJAFngB3OmN6Flsf7AKHAX/ZSfXcrDI0E4KyLHyn5X8D8jtDvnJzJ4qAAAAAElFTkSuQmCC"
}Schema
{
"properties": {
"data": {
"type": "string",
"minLength": 1
},
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"extensie": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"soortdocument": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"isContractDocument": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"data",
"naam",
"extensie",
"soortdocument"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/2818/volmachtverzekeringen/6732/documenten/16Response
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"total": 1,
"message": "Validatie fouten",
"_links": {
"help": {
"href": "http://api.fasterforward.nl/",
"title": "Validatie informatie"
}
},
"_embedded": {
"errors": [
{
"path": "/extensie",
"message": "bestand.extensie.verplicht"
}
]
}
}Volmacht verzekering scenario toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/volmachtverzekeringscenarios
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/volmachtverzekeringscenarios
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"scenarrioId": 123,
"omschrijving": "Mijn Volmacht verzekering scenario product via API",
"startdatum": "2024-05-01",
"verzekeringnemerRol": "Particulier",
"verzekeringnemerParticulier": {
"id": 140488
}
}Schema
{
"title": "VolmachtVerzekeringScenario",
"type": "object",
"properties": {
"scenarioId": {
"type": "integer",
"minimum": 1
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"startdatum": {
"type": "string",
"format": "date"
},
"verzekeringnemerRol": {
"enum": [
"Particulier",
"Zakelijk"
]
},
"verzekeringnemerZakelijk": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verzekeringnemerParticulier": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"gearchiveerd": {
"type": "boolean"
}
},
"required": [
"scenarioId",
"startdatum",
"verzekeringnemerRol"
],
"oneOf": [
{
"properties": {
"verzekeringnemerRol": {
"enum": [
"Particulier"
]
}
},
"required": [
"verzekeringnemerParticulier"
]
},
{
"properties": {
"verzekeringnemerRol": {
"enum": [
"Zakelijk"
]
}
},
"required": [
"verzekeringnemerZakelijk"
]
}
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/{DOSSIER_ID}/volmachtverzekeringscenarios/{PRODUCT_ID}Volmacht verzekering scenario wijzigenPATCH/api/data/klantdossiers/{DOSSIER_ID}/volmachtverzekeringscenarios/{PRODUCT_ID}
Voorbeeld URI
PATCH https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/volmachtverzekeringscenarios/123
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 123
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"omschrijving": "Mijn Volmacht verzekering scenario product via API",
"startdatum": "2024-05-01",
"verzekeringnemerRol": "Particulier",
"verzekeringnemerParticulier": {
"id": 140488
}
}Schema
{
"title": "VolmachtVerzekeringScenario",
"type": "object",
"properties": {
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"startdatum": {
"type": "string",
"format": "date"
},
"verzekeringnemerRol": {
"enum": [
"Particulier",
"Zakelijk"
]
},
"verzekeringnemerZakelijk": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verzekeringnemerParticulier": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"gearchiveerd": {
"type": "boolean"
}
},
"additionalProperties": false
}Response
204VerbergBekijk
Headers
Content-Type: text/htmlVolmacht verzekering scenario document toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/volmachtverzekeringscenarios/{PRODUCT_ID}/documenten
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/2818/volmachtverzekeringscenarios/6732/documenten
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 2818- PRODUCT_ID
int(verplicht) Voorbeeld: 6732
Request
VerbergBekijk
Body
{
"naam": "fasterforward.png",
"extensie": "png",
"soortdocument": {
"id": 1
},
"data": "iVBORw0KGgoAAAANSUhEUgAAAP0AAAAbCAYAAAC3KIljAAAKsElEQVR42u2dC3BVxRnH82gCISQk
0ZYEUHTCDBrBBJESmbakVMI7Kj4KDFhGwlBtlUzk2RYIAUGbalHEYnl4DdACSSB1EhsBBwTpRAUa
ERIVWu4QCO88KTQ3Cem/M19mvjmze3bPuWdyL/F+M7/Jze73fbvnsv9z9uzZE4LanbP6oID5xNLT
Rx8A7V6SFRSw2/Hffg1oB26VLzTanz58N0WP/o4CxQIiA6IPWBcVfa/vuuhnApHF3MaivwjSbNIv
KGBdWvQ07nsHRN+1RO8OClhA9CYWuNIHRB+wgOi9E3BA9AHRBywg+v/nDwEPgxdAHtgEXODPYDmY
Du61kC8UjABzwevARawFL4NHQXhniB6+3cFEsAxspH68AWaD/g5+h2HgByC0s0WPnNHgWbAefAj2
g50gBwzvokIKBengFVAI9oKPwFawGAzupH50A0kgFQwC3f1a9MjRAywGF4GOlYNxJvm6gYWa+erA
CtDTkCMXVBBnJbFfMZ8KSV+iwGrQAMysFNxvcky/BmsMjGT1o0EZuEn5TnWW6JErDCwF1ym3jM/A
MJM8mcAFMg3lI8A68Dlwg35UnkP+uZr9nAlcxFAN/yjm/7Sg/jFwBrQrKAEJJu3kUhvprCwEPA62
gePgU0nsRLAHeAxttoAykO53okf8APA1sGMLBPl6gsM2clWCeJbHZTWBoC8PgTO68STYKZLv6YDA
PwuES/rq7gzRI08vcIgNtisk0NlgKpgP9rF6D5guyeUiHxebORQIRHQP1f+efm8DsRp9Pc5yvKHh
/yTzH22oy2Z1jeA98Dx4BsyiK/9XzKcKREraqSCfLPp9ADhqOGa3ISYS7DL41FCub0ErK98AQn0t
en6FrwLe2FBDzg3Arh1wQvQUnwIagFVrAxkWRL8NtPtC9DSQ9rLBtRb0kPimgjNMpOPMRE+D+guW
+xIoBBtBHMvZTkxT9LWfQSCVGsf3HvnWgjBWngzaqG4/iJfEB4OFrM0lKtGT4K+wmNN0tV9lmMof
ZD47QJLgVisT1JDP2/4i+nmSnCUgFcSCaJBsMrjfYvniQIvApwwMB5EgBgwFWyT5HvV2ek+zjX8L
/G+Bj2m6vwwUAY/A7xrorSH6/QDmM9G/xAbeK1SsEl41+V8A0Saif7ujnzTNDZaI6jz5/UXRdib5
NbA+323iHwIukV++oW4DlV8DcRrHvZ/8TypEPw8coc+HQarEfxU7hsWKtu9kJ89PnBJ9G6iwwECW
74gg35cgVLQoJ5kq72E+44HI+kqOZ5/AN8/bhTxaIzBaA0gT+A4GV6QnMy56PWsBzRqiPwtiLBLF
7+PZVaQChGqeKCawAZstEf1B0EpT3DsU+dZSTJ1ZH9hU+E3gps9zTPyHs35mGOrOUfk6zWNeQP7N
CtGX0898ECbxjQfN5Ldbs/0+oIlifPKcPoXluwTqDbxs0v7fhFNytTjHSPI9DooN/Nau6Mk3AtQK
fJ8yOa7pAv8mEKkp+kawkD8FoL45vQ23guV5ipVPsjhDOExxp0WiJ+rBXRq5fsZiRposNDaSzxiw
jj4Xm+RdQT7XQYRhau0m2NqEepZBRMtETxwD4aoTCDHQwne+1Leit2E01T+vEP04ILL/gFwwSLtB
+6KfJPCrBsEm+cNBnSAuQ0P0TUD9WMh50a+nssvgexZFP4cvyklEv9zCusJVismT+Iyk+hugO5tt
NDGByYRYEOSlddyqEDEK0Y9R5PoH+R222Ie7/V709NjtfjAZrGaCNxN9FGhUtH8RFIL54IcgxGHR
vyrwqwJZCv4liMvREP08m5tzakCKRQYKVsKLbYjgPjYAn5GIfoCFfJsoplJSv5rqP6DfI8BNKhul
WPSb4sVTjWFgJWjVFP1lEGL2aJT1O9dGn75xSvS3gNsCSZINJRPAH2lwn7Oz4k65ZlCfdO0q2AyS
HRJ9AXDKtitE3wrifLEjjy1yvWojNoTf1wtEX2cx30SWL9FEVM+zslIq+4PA/5dU1wyiNe6Xp4E8
UAz+CWpBO8OjKfoPLTyB+LmN732XvzynnwJqHHjMxnOOBacs5rkFXgPBXop+H3DKPlKI/oSvtuGy
q9cim/H1FJ8jEH2Vjd1oDRSbJRBlO9Gflf+Kyo4L8pVQXYlJm+Npqn2LfDlN4CjYSu3M1RT9+4rj
HMz3Ddj4zjf6wyO7bGBmHnAC7ARzQJmG6PmW3nSwBlQCXVvipegLgVN2QCH6Ml+Jnl3NVtiMb6H4
BQLRV9jIt51i9xrKn6PyE4bye5iA+rFyPvWfZbbIxzgEfgfSQV/RTkBN0bsUx5jE8oy18R25fCp6
xPUBHsnC1HKQAkINMcVSYajb+z54jG4hzipWwiO8EP16gd9eu+JSiL7Yh6I/RXnybcQmsMH7nEOi
f5pNpaNZeaFskQ9lJ6kuk5VNYhuI7hDEjGV9P6LYW++06Pn3NsPGd1Tqa9G/JMmXahJTqhS9fvs/
pQ00IhvmheizBH7nu6Dod1Ceb2zETmaDd4hDou/JrtBPUlkou41IE8TkUd0uwVOJjyXtFFH9VRCr
2bcsh0QfzI7ndRvfUbWvRf+WINfXiphvFVPg/aDewFSTfCOByNI0RR8ryDlI4vuI4tieAC4DyX4r
eronJlJsnTBoQ40Toqf4Dwx793/E9saHCfzTeD0IZhtvXpS0cZrqN1no12YnRE++e8hXoBX1eoAP
RK+cBrsVV2bVfe92QX2BSc40Sc4HNEU/SJL3C4HvMRAl8U8WbOipBz38WPRx7Mq63ULcQLaa/SYV
OyX6Z9lLPyFgJf1eJPEP4zMBMIQJo48ohp0U3tHsUyyoc1D0s4SbkdRx7/qD6H8jyTdb4PsTcEHi
Xy7Z2cYtB4Qbct4Fjgp8L4EQg+80Sd5PwFQwHszQ2A58CswG94G+tE8gD9wQ+C7z2+k9WcfONmKi
hn8oa98DEh0WfRxbIEwFx9i6gdDYW3yrwRL6XG7iX04+lSBEYzqeT/5OiT4SXGNrCmEaMQ+DVtDm
a9EPATKrAgWgCJwEZlbFd7aZvKZbC0rBNnAIeCR+ixS3Abpv2W0Edq0SRNwGoo9jV74bYJLinruQ
DX7a7uyQ6MnYW3+b+FVbY5GtAnxOn+eb+Ofyt+YU7+JvIb8tfA1DIXqr23r/CrqZ+A4BF8h3sz88
stsBrFitaIed4AWWq8COlYEwyTbZy6pgQcxuYNXOgUQ/X8jj+R7s2AZLFIEJIAHEgAdANqhmPvkg
2GnR84017Kp2TOHfu+NZO/uZqHhrjR/vbjCKyuNpHWEluEz1pSCO5a4GO0GKXdFTzJ9YH06CX4A+
7LXaH5NPS8dJFsz0B9H3An/XfHPsNTBZUh9vyJtIeXXtJuUPN+lrBmi2+Ec0gkE2aARKoz4n+N3q
vTpnInuJxoybYJFB8E6LPsGwYWalRgx/b/+4hv9w9kqvGVtBOMVsM9SleSn6YBKyR9GHho7bG5+I
XiGoXYb99ddooC8D95JfDMgR8KAk70NgFThouFJ7gBuUgLkgXrOfSeBduoVoNpyUzpnExYAXSdQ1
hheBvgTvgEf8/pGdehCOo8HtZsK7Dj4DSwE7oTkuep7nUzboR2j45zD/pRb+HuB82pXXxGYKbppy
pwnWMzJAFngB3OmN6Flsf7AKHAX/ZSfXcrDI0E4KyLHyn5X8D8jtDvnJzJ4qAAAAAElFTkSuQmCC"
}Schema
{
"properties": {
"data": {
"type": "string",
"minLength": 1
},
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"extensie": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"soortdocument": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"isContractDocument": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"data",
"naam",
"extensie",
"soortdocument"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/2818/volmachtverzekeringscenarios/6732/documenten/16Response
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"total": 1,
"message": "Validatie fouten",
"_links": {
"help": {
"href": "http://api.fasterforward.nl/",
"title": "Validatie informatie"
}
},
"_embedded": {
"errors": [
{
"path": "/extensie",
"message": "bestand.extensie.verplicht"
}
]
}
}Factuur ¶
Factuur collectieGET/api/data/klantdossiers/{DOSSIER_ID}/facturen
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/facturen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/facturen"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/facturen?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/facturen?pagina=31&per_pagina=20"
}
},
"_embedded": {
"facturen": [
{
"id": 10,
"omschrijving": "",
"factuurnummer": null,
"bedrag": "1500.00",
"bedragBtw": "0.00",
"totaalbedrag": "1500.00",
"factuurstatus": "Nieuw",
"factuurdatum": "2016-07-13T00:00:00+02:00",
"vervaldatum": "2016-08-12T00:00:00+02:00",
"betaallink": "https://www.mollie.com/paymentscreen/banktransfer/pay-online/1.1htmnm",
"betaallink verloopdatum": "2022-03-24T00:00:00+02:00",
"betaallink status": "open",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/facturen/10"
}
}
}
]
}
}Factuur ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/facturen/{FACTUUR_ID}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/facturen/10
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- FACTUUR_ID
int(verplicht) Voorbeeld: 10
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 10,
"omschrijving": "",
"factuurnummer": null,
"bedrag": "1500.00",
"bedragBtw": "0.00",
"totaalbedrag": "1500.00",
"factuurstatus": "Nieuw",
"factuurdatum": "2016-07-13T00:00:00+02:00",
"vervaldatum": "2016-08-12T00:00:00+02:00",
"betaallink": "https://www.mollie.com/paymentscreen/banktransfer/pay-online/1.1htmnm",
"betaallink verloopdatum": "2022-03-24T00:00:00+02:00",
"betaallink status": "open",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/facturen/10"
}
},
"_embedded": {
"factuurregels": [
{
"id": 19,
"naam": "Advies - Starter",
"aantal": "1.00",
"kostprijs": "750.00",
"verkoopprijs": "1500.00",
"marge": "0.00",
"omschrijving": null,
"kortingspercentage": "0.00",
"korting": "0.00",
"bedrag": "1500.00",
"bedragBtw": "0.00",
"totaalbedrag": "1500.00",
"totaalkorting": "0.00"
}
]
}
}Factuur toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/facturen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/facturen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"administratie": {
"id": 99
},
"factuurdatum": "2018-01-01",
"documenttemplate": {
"id": 71
},
"eerstePersoon": {
"id": 120954
},
"tweedePersoon": {
"id": 120955
},
"betaaltermijn": 10,
"betaalwijze": {
"id": 1
},
"omschrijving": "Factuur januari"
}Schema
{
"properties": {
"title": "Factuur",
"administratie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"factuurdatum": {
"type": "string",
"format": "date"
},
"documenttemplate": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"organisatie": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"eerstePersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"tweedePersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"betaaltermijn": {
"type": "integer",
"minimum": 1
}
},
"additionalProperties": false,
"required": [
"administratie",
"factuurdatum",
"documenttemplate"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/facturen/1Factuurregel toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/facturen/{FACTUUR_ID}/regels
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/facturen/1/regels
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- FACTUUR_ID
int(verplicht) Voorbeeld: 1
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"artikel": {
"id": 995
},
"aantal": 1,
"btw": {
"id": 100
},
"kostprijs": 1900,
"marge": 0,
"verkoopprijs": 2000,
"kortingtype": "geen",
"omschrijving": "Dienst januari"
}Schema
{
"properties": {
"title": "Factuurregel",
"artikel": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aantal": {
"type": "integer",
"minimum": 1
},
"btw": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"kostprijs": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"marge": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"verkoopprijs": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"kortingtype": {
"enum": [
"geen",
"bedrag",
"percentage"
]
},
"korting": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
}
},
"additionalProperties": false,
"required": [
"artikel",
"aantal",
"btw",
"verkoopprijs",
"kortingtype"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/facturen/1Factuur event sturenPOST/api/data/klantdossiers/{DOSSIER_ID}/facturen/{FACTUUR_ID}/event
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/facturen/1/event
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- FACTUUR_ID
int(verplicht) Voorbeeld: 1
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"event": "Factuur geboekt",
"bericht": "Voor de 2x"
}Schema
{
"properties": {
"event": {
"enum": [
"Factuur geboekt",
"Factuur gesaldeerd",
"Stornering",
"Bericht"
]
},
"bericht": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false,
"required": [
"event"
]
}Response
204VerbergBekijk
Headers
Content-Type: application/jsonDocument ¶
Document collectieGET/api/data/klantdossiers/{DOSSIER_ID}/documenten&publiek={PUBLIEK}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/documenten&publiek=1
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PUBLIEK
boolean(optioneel) Voorbeeld: 1
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/documenten"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/documenten?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/documenten?pagina=31&per_pagina=20"
}
},
"_embedded": {
"documenten": [
{
"id": 1,
"naam": "Identiteitsbewijs.pdf",
"extensie": "pdf",
"bestandsgrootte": 7945,
"mimetype": "application/pdf",
"omschrijving": "Identiteitsbewijs 1e aanvrager (voor- en de achterkant van de pagina waar de foto op staat, NB geen rijbewijs)",
"aanmaakdatum": "2017-11-30T16:06:02+01:00",
"publiek": "ja",
"pad": "Dossier/Identiteitsbewijs",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/documenten/1"
},
"product": [
{
"href": "/api/data/klantdossiers/5526/hypotheken/6732"
},
{
"href": "/api/data/klantdossiers/5526/schadeverzekeringen/6752"
}
],
"download": {
"href": "/api/data/klantdossiers/5526/documenten/1/download"
}
}
}
]
}
}Document ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/documenten/{DOCUMENT_ID}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/documenten/1
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- DOCUMENT_ID
int(verplicht) Voorbeeld: 1
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 1,
"naam": "Identiteitsbewijs.pdf",
"extensie": "pdf",
"bestandsgrootte": 7945,
"mimetype": "application/pdf",
"omschrijving": "Identiteitsbewijs 1e aanvrager (voor- en de achterkant van de pagina waar de foto op staat, NB geen rijbewijs)",
"aanmaakdatum": "2017-11-30T16:06:02+01:00",
"publiek": "ja",
"pad": "Dossier/Identiteitsbewijs",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/documenten/1"
},
"product": [
{
"href": "/api/data/klantdossiers/5526/hypotheken/6732"
},
{
"href": "/api/data/klantdossiers/5526/schadeverzekeringen/6752"
}
],
"download": {
"href": "/api/data/klantdossiers/5526/documenten/1/download"
}
}
}Document downloadenGET/api/data/klantdossiers/{DOSSIER_ID}/documenten/{DOCUMENT_ID}/download
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/documenten/1/download
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- DOCUMENT_ID
int(verplicht) Voorbeeld: 1
Response
200VerbergBekijk
Headers
Content-Type: image/png
Content-Disposition: inline; filename="fasterforward.png"Document toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/documenten
Let op: Als het protocol HDN is, zijn alleen PDF bestanden toegestaan.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/2818/documenten
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 2818
Request
VerbergBekijk
Body
{
"naam": "fasterforward.png",
"extensie": "png",
"soortdocument": {
"id": 1
},
"data": "iVBORw0KGgoAAAANSUhEUgAAAP0AAAAbCAYAAAC3KIljAAAKsElEQVR42u2dC3BVxRnH82gCISQk
0ZYEUHTCDBrBBJESmbakVMI7Kj4KDFhGwlBtlUzk2RYIAUGbalHEYnl4DdACSSB1EhsBBwTpRAUa
ERIVWu4QCO88KTQ3Cem/M19mvjmze3bPuWdyL/F+M7/Jze73fbvnsv9z9uzZE4LanbP6oID5xNLT
Rx8A7V6SFRSw2/Hffg1oB26VLzTanz58N0WP/o4CxQIiA6IPWBcVfa/vuuhnApHF3MaivwjSbNIv
KGBdWvQ07nsHRN+1RO8OClhA9CYWuNIHRB+wgOi9E3BA9AHRBywg+v/nDwEPgxdAHtgEXODPYDmY
Du61kC8UjABzwevARawFL4NHQXhniB6+3cFEsAxspH68AWaD/g5+h2HgByC0s0WPnNHgWbAefAj2
g50gBwzvokIKBengFVAI9oKPwFawGAzupH50A0kgFQwC3f1a9MjRAywGF4GOlYNxJvm6gYWa+erA
CtDTkCMXVBBnJbFfMZ8KSV+iwGrQAMysFNxvcky/BmsMjGT1o0EZuEn5TnWW6JErDCwF1ym3jM/A
MJM8mcAFMg3lI8A68Dlwg35UnkP+uZr9nAlcxFAN/yjm/7Sg/jFwBrQrKAEJJu3kUhvprCwEPA62
gePgU0nsRLAHeAxttoAykO53okf8APA1sGMLBPl6gsM2clWCeJbHZTWBoC8PgTO68STYKZLv6YDA
PwuES/rq7gzRI08vcIgNtisk0NlgKpgP9rF6D5guyeUiHxebORQIRHQP1f+efm8DsRp9Pc5yvKHh
/yTzH22oy2Z1jeA98Dx4BsyiK/9XzKcKREraqSCfLPp9ADhqOGa3ISYS7DL41FCub0ErK98AQn0t
en6FrwLe2FBDzg3Arh1wQvQUnwIagFVrAxkWRL8NtPtC9DSQ9rLBtRb0kPimgjNMpOPMRE+D+guW
+xIoBBtBHMvZTkxT9LWfQSCVGsf3HvnWgjBWngzaqG4/iJfEB4OFrM0lKtGT4K+wmNN0tV9lmMof
ZD47QJLgVisT1JDP2/4i+nmSnCUgFcSCaJBsMrjfYvniQIvApwwMB5EgBgwFWyT5HvV2ek+zjX8L
/G+Bj2m6vwwUAY/A7xrorSH6/QDmM9G/xAbeK1SsEl41+V8A0Saif7ujnzTNDZaI6jz5/UXRdib5
NbA+323iHwIukV++oW4DlV8DcRrHvZ/8TypEPw8coc+HQarEfxU7hsWKtu9kJ89PnBJ9G6iwwECW
74gg35cgVLQoJ5kq72E+44HI+kqOZ5/AN8/bhTxaIzBaA0gT+A4GV6QnMy56PWsBzRqiPwtiLBLF
7+PZVaQChGqeKCawAZstEf1B0EpT3DsU+dZSTJ1ZH9hU+E3gps9zTPyHs35mGOrOUfk6zWNeQP7N
CtGX0898ECbxjQfN5Ldbs/0+oIlifPKcPoXluwTqDbxs0v7fhFNytTjHSPI9DooN/Nau6Mk3AtQK
fJ8yOa7pAv8mEKkp+kawkD8FoL45vQ23guV5ipVPsjhDOExxp0WiJ+rBXRq5fsZiRposNDaSzxiw
jj4Xm+RdQT7XQYRhau0m2NqEepZBRMtETxwD4aoTCDHQwne+1Leit2E01T+vEP04ILL/gFwwSLtB
+6KfJPCrBsEm+cNBnSAuQ0P0TUD9WMh50a+nssvgexZFP4cvyklEv9zCusJVismT+Iyk+hugO5tt
NDGByYRYEOSlddyqEDEK0Y9R5PoH+R222Ie7/V709NjtfjAZrGaCNxN9FGhUtH8RFIL54IcgxGHR
vyrwqwJZCv4liMvREP08m5tzakCKRQYKVsKLbYjgPjYAn5GIfoCFfJsoplJSv5rqP6DfI8BNKhul
WPSb4sVTjWFgJWjVFP1lEGL2aJT1O9dGn75xSvS3gNsCSZINJRPAH2lwn7Oz4k65ZlCfdO0q2AyS
HRJ9AXDKtitE3wrifLEjjy1yvWojNoTf1wtEX2cx30SWL9FEVM+zslIq+4PA/5dU1wyiNe6Xp4E8
UAz+CWpBO8OjKfoPLTyB+LmN732XvzynnwJqHHjMxnOOBacs5rkFXgPBXop+H3DKPlKI/oSvtuGy
q9cim/H1FJ8jEH2Vjd1oDRSbJRBlO9Gflf+Kyo4L8pVQXYlJm+Npqn2LfDlN4CjYSu3M1RT9+4rj
HMz3Ddj4zjf6wyO7bGBmHnAC7ARzQJmG6PmW3nSwBlQCXVvipegLgVN2QCH6Ml+Jnl3NVtiMb6H4
BQLRV9jIt51i9xrKn6PyE4bye5iA+rFyPvWfZbbIxzgEfgfSQV/RTkBN0bsUx5jE8oy18R25fCp6
xPUBHsnC1HKQAkINMcVSYajb+z54jG4hzipWwiO8EP16gd9eu+JSiL7Yh6I/RXnybcQmsMH7nEOi
f5pNpaNZeaFskQ9lJ6kuk5VNYhuI7hDEjGV9P6LYW++06Pn3NsPGd1Tqa9G/JMmXahJTqhS9fvs/
pQ00IhvmheizBH7nu6Dod1Ceb2zETmaDd4hDou/JrtBPUlkou41IE8TkUd0uwVOJjyXtFFH9VRCr
2bcsh0QfzI7ndRvfUbWvRf+WINfXiphvFVPg/aDewFSTfCOByNI0RR8ryDlI4vuI4tieAC4DyX4r
eronJlJsnTBoQ40Toqf4Dwx793/E9saHCfzTeD0IZhtvXpS0cZrqN1no12YnRE++e8hXoBX1eoAP
RK+cBrsVV2bVfe92QX2BSc40Sc4HNEU/SJL3C4HvMRAl8U8WbOipBz38WPRx7Mq63ULcQLaa/SYV
OyX6Z9lLPyFgJf1eJPEP4zMBMIQJo48ohp0U3tHsUyyoc1D0s4SbkdRx7/qD6H8jyTdb4PsTcEHi
Xy7Z2cYtB4Qbct4Fjgp8L4EQg+80Sd5PwFQwHszQ2A58CswG94G+tE8gD9wQ+C7z2+k9WcfONmKi
hn8oa98DEh0WfRxbIEwFx9i6gdDYW3yrwRL6XG7iX04+lSBEYzqeT/5OiT4SXGNrCmEaMQ+DVtDm
a9EPATKrAgWgCJwEZlbFd7aZvKZbC0rBNnAIeCR+ixS3Abpv2W0Edq0SRNwGoo9jV74bYJLinruQ
DX7a7uyQ6MnYW3+b+FVbY5GtAnxOn+eb+Ofyt+YU7+JvIb8tfA1DIXqr23r/CrqZ+A4BF8h3sz88
stsBrFitaIed4AWWq8COlYEwyTbZy6pgQcxuYNXOgUQ/X8jj+R7s2AZLFIEJIAHEgAdANqhmPvkg
2GnR84017Kp2TOHfu+NZO/uZqHhrjR/vbjCKyuNpHWEluEz1pSCO5a4GO0GKXdFTzJ9YH06CX4A+
7LXaH5NPS8dJFsz0B9H3An/XfHPsNTBZUh9vyJtIeXXtJuUPN+lrBmi2+Ec0gkE2aARKoz4n+N3q
vTpnInuJxoybYJFB8E6LPsGwYWalRgx/b/+4hv9w9kqvGVtBOMVsM9SleSn6YBKyR9GHho7bG5+I
XiGoXYb99ddooC8D95JfDMgR8KAk70NgFThouFJ7gBuUgLkgXrOfSeBduoVoNpyUzpnExYAXSdQ1
hheBvgTvgEf8/pGdehCOo8HtZsK7Dj4DSwE7oTkuep7nUzboR2j45zD/pRb+HuB82pXXxGYKbppy
pwnWMzJAFngB3OmN6Flsf7AKHAX/ZSfXcrDI0E4KyLHyn5X8D8jtDvnJzJ4qAAAAAElFTkSuQmCC"
}Schema
{
"properties": {
"data": {
"type": "string",
"minLength": 1
},
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"extensie": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"soortdocument": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"data",
"naam",
"extensie",
"soortdocument"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/documenten/16Response
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"total": 1,
"message": "Validatie fouten",
"_links": {
"help": {
"href": "http://api.fasterforward.nl/",
"title": "Validatie informatie"
}
},
"_embedded": {
"errors": [
{
"path": "/extensie",
"message": "bestand.extensie.verplicht"
}
]
}
}Stuk ¶
Stuk collectieGET/api/data/klantdossiers/{DOSSIER_ID}/stukken
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/stukken
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/stukken"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/stukken?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/stukken?pagina=31&per_pagina=20"
}
},
"_embedded": {
"stukken": [
{
"id": 91,
"omschrijving": "Koopcontract door beide partijen getekend",
"ontvangstdatum": "2017-04-18T00:00:00+02:00",
"datumBeoordelingIntern": null,
"statusBeoordelingIntern": "nog te beoordelen",
"toelichtingBeoordelingIntern": null,
"verzenddatum": null,
"datumBeoordelingMaatschappij": null,
"statusBeoordelingMaatschappij": null,
"toelichtingBeoordelingMaatschappij": null,
"origineelAanleveren": null, // Wordt vanaf HDN 21 niet meer gevuld.
"opgevraagdViaBron": null,
"verzendwijze": null,
"bron": "elements",
"aanTeLeverenDoor": "klant",
"toelichtingAanTeLeverenDocument": null,
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/stukken/91"
}
}
}
]
}
}Stuk ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/stukken/{STUK_ID}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/stukken/91
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- STUK_ID
int(verplicht) Voorbeeld: 91
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 91,
"omschrijving": "Koopcontract door beide partijen getekend",
"ontvangstdatum": "2017-04-18T00:00:00+02:00",
"datumBeoordelingIntern": null,
"statusBeoordelingIntern": "nog te beoordelen",
"toelichtingBeoordelingIntern": null,
"verzenddatum": null,
"datumBeoordelingMaatschappij": null,
"statusBeoordelingMaatschappij": null,
"toelichtingBeoordelingMaatschappij": null,
"origineelAanleveren": null, // Wordt vanaf HDN 21 niet meer gevuld.
"opgevraagdViaBron": null,
"verzendwijze": null,
"bron": "elements",
"aanTeLeverenDoor": "klant",
"toelichtingAanTeLeverenDocument": null,
"protocol": "algemeen",
"soortDocumentId": 1,
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/stukken/91"
},
"bestand": {
"href": "/api/data/klantdossiers/5526/documenten/25"
},
"product": {
"href": "/api/data/klantdossiers/5526/hypotheken/6732"
},
"klantDieMoetAanleveren": {
"href": "/api/data/klantdossiers/5526/klanten/particulier/120954"
}
}
}Document onder stuk toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/stukken/{STUK_ID}/documenttoevoegen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/stukken/91/documenttoevoegen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- STUK_ID
int(verplicht) Voorbeeld: 91
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"naam": "voorbeeld.pdf",
"extensie": "pdf",
"data": "JVBERi0xLjQNCiXi48/TDQozIDAgb2JqDQo8PA0KL0xpbmVhcml6ZWQgMQ0KL0wgNDQzNw0KL0ggWyA3ODIgMTM5IF0NCi9PIDUNCi9FIDM4OTkNCi9OIDENCi9UIDQyNTENCj4+DQplbmRvYmoNCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICANCnhyZWYNCjMgMTMNCjAwMDAwMDAwMTcgMDAwMDAgbg0KMDAwMDAwMDcyNyAwMDAwMCBuDQowMDAwMDAwOTIxIDAwMDAwIG4NCjAwMDAwMDExNzIgMDAwMDAgbg0KMDAwMDAwMTI4MiAwMDAwMCBuDQowMDAwMDAxMzg5IDAwMDAwIG4NCjAwMDAwMDE0OTkgMDAwMDAgbg0KMDAwMDAwMTU2OSAwMDAwMCBuDQowMDAwMDAxODU5IDAwMDAwIG4NCjAwMDAwMDE5NjUgMDAwMDAgbg0KMDAwMDAwMjA3OCAwMDAwMCBuDQowMDAwMDAyMTU4IDAwMDAwIG4NCjAwMDAwMDA3ODIgMDAwMDAgbg0KdHJhaWxlcg0KPDwNCi9TaXplIDE2DQovUHJldiA0MjQxDQovSW5mbyAyIDAgUg0KL1Jvb3QgNCAwIFINCi9JRCBbPDY4MWU5NTBlOTU4MTE1NzhiYmEzODhmNjAxY2U5ZDY5Pjw2ODFlOTUwZTk1ODExNTc4YmJhMzg4ZjYwMWNlOWQ2OT5dDQo+Pg0Kc3RhcnR4cmVmDQowDQolJUVPRg0KICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICANCjQgMCBvYmoNCjw8DQovVHlwZSAvQ2F0YWxvZw0KL1BhZ2VzIDEgMCBSDQo+Pg0KZW5kb2JqDQoxNSAwIG9iag0KPDwNCi9TIDM2DQovRmlsdGVyIC9GbGF0ZURlY29kZQ0KL0xlbmd0aCA1MQ0KPj4NCnN0cmVhbQ0KeJxjYGDgYmBg5mMAAu5FDNgABxKbC4oZGNwYuMUWLBBqamAwZ1TQZoySYWAAAGFJBJoKDQplbmRzdHJlYW0NCmVuZG9iag0KNSAwIG9iag0KPDwNCi9UeXBlIC9QYWdlDQovQ3JvcEJveCBbIDAgMCA1OTUgODQyIF0NCi9NZWRpYUJveCBbIDAgMCA1OTUgODQyIF0NCi9Sb3RhdGUgMA0KL1Jlc291cmNlcyA8PCAvRm9udCA8PCAvVFQyIDYgMCBSIC9UVDQgNyAwIFIgL0YyIDggMCBSIC9UVDYgMTEgMCBSIC9UVDgNCjEyIDAgUiA+PiAvRXh0R1N0YXRlIDw8IC9HUzEgMTMgMCBSID4+ID4+DQovQ29udGVudHMgMTQgMCBSDQovUGFyZW50IDEgMCBSDQo+Pg0KZW5kb2JqDQo2IDAgb2JqDQo8PA0KL1R5cGUgL0ZvbnQNCi9TdWJ0eXBlIC9UeXBlMQ0KL0Jhc2VGb250IC9IZWx2ZXRpY2EtQm9sZA0KL0VuY29kaW5nIC9XaW5BbnNpRW5jb2RpbmcNCj4+DQplbmRvYmoNCjcgMCBvYmoNCjw8DQovVHlwZSAvRm9udA0KL1N1YnR5cGUgL1R5cGUxDQovQmFzZUZvbnQgL1RpbWVzLVJvbWFuDQovRW5jb2RpbmcgL1dpbkFuc2lFbmNvZGluZw0KPj4NCmVuZG9iag0KOCAwIG9iag0KPDwNCi9CYXNlRm9udCAvU3ltYm9sDQovRW5jb2RpbmcgOSAwIFINCi9TdWJ0eXBlIC9UeXBlMQ0KL1RvVW5pY29kZSAxMCAwIFINCi9UeXBlIC9Gb250DQo+Pg0KZW5kb2JqDQo5IDAgb2JqDQo8PA0KL0RpZmZlcmVuY2VzIFsgMSAvYnVsbGV0IF0NCi9UeXBlIC9FbmNvZGluZw0KPj4NCmVuZG9iag0KMTAgMCBvYmoNCjw8DQovRmlsdGVyIC9GbGF0ZURlY29kZQ0KL0xlbmd0aCAyMDgNCj4+DQpzdHJlYW0NCkiJVJC9DsIwDIT3PoVHEEPazlUXWDrwIwrsaeJWkYgTuenQtycpBcQQS/bl050t9s2hIRNAXNipFgP0hjTj6CZWCB0OhqAoQRsV1m6pykoPIsLtPAa0DfUOqioT1yiOgWfYtLPt3HOXb0GcWSMbGmBzK+6POGgn759okQLkUNegsc/E/ij9SVqM8oou82I1dBpHLxWypAGhyov6XZD0v/Yhuv7d/r5WZV6WdRaJj5bgtMnXW03MMday7pIoZTCE34t455NletlLgAEAQ8hpPwoNCmVuZHN0cmVhbQ0KZW5kb2JqDQoxMSAwIG9iag0KPDwNCi9UeXBlIC9Gb250DQovU3VidHlwZSAvVHlwZTENCi9CYXNlRm9udCAvSGVsdmV0aWNhDQovRW5jb2RpbmcgL1dpbkFuc2lFbmNvZGluZw0KPj4NCmVuZG9iag0KMTIgMCBvYmoNCjw8DQovVHlwZSAvRm9udA0KL1N1YnR5cGUgL1R5cGUxDQovQmFzZUZvbnQgL1RpbWVzLUJvbGRJdGFsaWMNCi9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nDQo+Pg0KZW5kb2JqDQoxMyAwIG9iag0KPDwNCi9TQSBmYWxzZQ0KL1NNIDAuMDINCi9UUiAvSWRlbnRpdHkNCi9UeXBlIC9FeHRHU3RhdGUNCj4+DQplbmRvYmoNCjE0IDAgb2JqDQo8PA0KL0ZpbHRlciAvRmxhdGVEZWNvZGUNCi9MZW5ndGggMTY1OA0KPj4NCnN0cmVhbQ0KeJydV1tv2zYUfvev4FspIFZF6g4MA7J1GTDsoegM7CHdgywxiQZZNCQ6Wf79zoW6OLWLtgjgkJTO4bl+59Mvu00k8G943Lz//S8lHsfN+91OCyV2D5ttFEaRzsSu3uAqK8TuZaOSMEpIhldaxWGeKZGnOW53h829vA1UFGrZBNs8VNLujQi2CpfwoAhzWQdbLYdgm4UZPK2c+PjhTty1eFDIzozBP2L3BxqSrAyJSm+IxhUYotkKLYoyLHWUiVyXYay9CQ1c+1mnmfhoB1ftOyM+WLAiCktZnw6md+IuSMNYwiGeDQd4GIOJYM1nCfbQw8+BaEc0PpKVOPXtsxnGquODh7ZDvzSs7HAAMTp1T9PqOKD7pTSjGZ79zSbQ8Dtp7Dp2lLwrvHdlqcm7UKVi9+clL1Uapt5L+xDEEDIR0M0mSCCgtOFz27vxZr0PIvgdaI3+homsSMa5tg+2JeTsEVNXyBt6k0RreoNFO3ti6ZEesXDfiEc+5f3xqWWZMYiksKzXG+olSNkrX8XBGEEzS3kvGsvbExqKlpqVqLsRfKMJtik881ZXuIu9gw1bzGLjKCBWFG0upmSqalxdLKZIhbkPM4RWVMdj19aVa20vKnD52FUOEy9OIxmopWmEs6IeDBd2BVYk0hnRunDOs4pivE6H8eXkZnkSqnUJU5y5HEvOR+tj3/OuoetSui6VHWebC/KBCx4CIkznX6vpNTfYvq0xxhReDUfYEU07uqHdn9jJESwXFkq+tgczCqyvVQDzOYD51+s1y6K5K4+DhU48jAJUHmzf0d0lVgJ0rhSmJ4MBIOypd4YaKMe4vrTuCX2oyXAvVQtqwfGpQteghaG5Ytn2jwEq8zF/f+fBLCJ7ffCLK6bGkPMMTf0pUj+L3b+IQdksvxYpoeySMxHIjpcovAQGJ/Vhysr0vM5UBOCg1VrBbf9qe3MD5fX68mSgjry+NQoqry9X5+p0BNUerdXdS1FDkdijgVwCwgbbAvoBC0lLilwobjvEsjiiBEh74lbsDcad6pn2EwJiFzDyQWKg9fwOyxQ7QE77evAHFSQEenUBOeW7TkVF5osmOQ/rHBWYEwiJ6MYnQzZX9NsEjAW4HqC1ExlSyX8yNZ21COeFPLb8Sk+vO24ZQAAU4DWW86LEgyQuITI+RrS1pIHfOrBytsTxZhQjtAeftH4B9b0yucfIZ/JdACiRTWKQFz5e2ynOLRjF3qwVneil0ZuHDmxhBiOQfgXYvujLOcRREmof4sb276BrIFniqeJhhUFGABML+HlcQ3QYAfau4R0KLMiSIbKMP9KNaZ56BP7mblxElm5Mlm7k+ttOy0vtuGi4J9jNcRa9TcvMT1adrtJF99tWTwF53+iuupfqlTgGTEkAOXEcWkDg2nMSBYg8DIZ2fOa618u0SM8J128gIYtDHZ1fK2h6IWsBRwh2C391y9iLDIAOG/PMGedCyH8IUNMEWN/3AeoicjGFEwtUeamuZHBWMGVQYQZjmBAtsYEcMljRf5w/ENoXGCAKY/waaGRpmBGQgWkIQ/780cXUe5B/E/245OivzCG2ksv/qvpqNif3yrckV+dAaopzfTijCXOpCdHRigimMw0SJKaf/ACzOj0ems6TXc9HkRwBWyC2ONoHhwFBoYGGUXMJXrIZXq4geBoDHHh4gRk0VFOFJWSL56nAnbSaShFomgNywICOg2rNYJFzsSA5BswVeebEQwmBkABkkilTb53o7Aic5mQQpia6tjhIEuAgc/HJS+pfvbTyFTI+e4lmey+foV1pUGiqIAAMaLa2h/alhtbycAQchymxb7vW4YCSP4SLSak8R/zmplpEvmiq7eIxdpXSl7tq0XAvdwDwD1xxAA7itubVQJ9yn0zVTIR4wK8n/15FycF8U7aRi2BeGvvSd7ZqiFNzLQNp2c9MY7oFKlbjfJlEZ6oKU2i/HoBxsTTj1eJMclDqP1YRDlXM3yMZWA2kGXfTqYGPmItZ+kqCEjCx+L4EzSKXB1fM+UmKIr+Sn1nBvfzVUqVBA9f06/gTd/6UyGG4zIQn9nNNzd90uB4YqfiBGA982vk3B5KDQc/HSF5oi4xmEmr9dzW/ip93tKq9yrdXe02NLwjWxIdQG6v8zh15LbUxzGj/tYHt9oh9JqjxIKO8EszU2ArKeEHfxclE+4hxydGtZgBOACxqnKDEHaX4G3/3vjh+223+B3iyCB4NCmVuZHN0cmVhbQ0KZW5kb2JqDQoxIDAgb2JqDQo8PA0KL1R5cGUgL1BhZ2VzDQovS2lkcyBbIDUgMCBSIF0NCi9Db3VudCAxDQo+Pg0KZW5kb2JqDQoyIDAgb2JqDQo8PA0KL0F1dGhvciAoY2RhaWx5KQ0KL0NyZWF0aW9uRGF0ZSAoRDoyMDAwMDYyOTEwMjEwOCsxMScwMCcpDQovQ3JlYXRvciAoTWljcm9zb2Z0IFdvcmQgOC4wKQ0KL1RpdGxlIChUaGlzIGlzIGEgdGVzdCBQREYgZmlsZSkNCi9Nb2REYXRlIChEOjIwMTYxMjA2MDMwMzUyLTA1JzAwJykNCi9Qcm9kdWNlcg0KKDMtSGVpZ2h0c1woVE1cKSBQREYgT3B0aW1pemF0aW9uIFNoZWxsIDQuNS4yNC42IFwoaHR0cDovL3d3dy5wZGYtdG9vbHMuY29tXCkpDQo+Pg0KZW5kb2JqDQp4cmVmDQowIDMNCjAwMDAwMDAwMDAgNjU1MzUgZg0KMDAwMDAwMzg5OSAwMDAwMCBuDQowMDAwMDAzOTY1IDAwMDAwIG4NCnRyYWlsZXINCjw8DQovU2l6ZSAzDQovSUQgWzw2ODFlOTUwZTk1ODExNTc4YmJhMzg4ZjYwMWNlOWQ2OT48NjgxZTk1MGU5NTgxMTU3OGJiYTM4OGY2MDFjZTlkNjk+XQ0KPj4NCnN0YXJ0eHJlZg0KMTc4DQolJUVPRg0K"
}Schema
{
"properties": {
"data": {
"type": "string",
"minLength": 1
},
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"extensie": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"aanmaakdatum": {
"type": "string",
"format": "date"
}
},
"additionalProperties": false,
"required": [
"data",
"naam",
"extensie"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/documenten/16E-mail ¶
E-mail collectieGET/api/data/klantdossiers/{DOSSIER_ID}/emails&gearchiveerd={GEARCHIVEERD}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/emails&gearchiveerd=0
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- GEARCHIVEERD
boolean(optioneel) Voorbeeld: 0
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/emails"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/emails?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/emails?pagina=31&per_pagina=20"
}
},
"_embedded": {
"emails": [
{
"id": 7,
"onderwerp": "Communicatie email",
"afzender": "Afzender",
"afzenderEmailadres": "afzender@fasterforward.nl",
"ontvanger": "ontvanger@fasterforward.nl",
"richting": "out",
"verzenddatum": "2016-07-12T09:38:42+02:00",
"ontvangstdatum": "2016-07-12T09:38:42+02:00",
"grootte": 1117,
"gelezen": true,
"bevatverwijderdebijlage": false,
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/emails/7"
}
}
}
]
}
}E-mail ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/emails/{EMAIL_ID}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/emails/7
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- EMAIL_ID
int(verplicht) Voorbeeld: 7
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 7,
"onderwerp": "Communicatie email",
"afzender": "Afzender",
"afzenderEmailadres": "afzender@fasterforward.nl",
"ontvanger": "ontvanger@fasterforward.nl",
"richting": "out",
"verzenddatum": "2016-07-12T09:38:42+02:00",
"ontvangstdatum": "2016-07-12T09:38:42+02:00",
"grootte": 1117,
"gelezen": true,
"bevatverwijderdebijlage": false,
"inhoud": "RGF0ZTogVHVlLCAxMiBKdWwgMjAxNiAwOTozODo0MiArMDIwMApSZXR1cm4tUGF0aDogZ
mZ3ZGRlYnVnQGdtYWlsLmNvbQpGcm9tOiBGRldEIERlYnVnIEdtYWlsIDxmZndkZGVidW
dAZ21haWwuY29tPgpSZXBseS10bzogRkZXRCBEZWJ1ZyBHbWFpbCA8ZmZ3ZGRlYnVnQGd
tYWlsLmNvbT4KTWVzc2FnZS1JRDogPCNENTUyNi5iNjQzNzlhYWQ2MWQwZDY2NGVkZTc1
OWE2MGFhZmNiMEBhcm5vbGQuZmFzdGVyZm9yd2FyZGVsZW1lbnRzLmxvY2FsPgpYLUVsZ
W1lbnRzOiA8I0Q1NTI2LmI2NDM3OWFhZDYxZDBkNjY0ZWRlNzU5YTYwYWFmY2IwQGFybm
9sZC5mYXN0ZXJmb3J3YXJkZWxlbWVudHMubG9jYWw+Ck1JTUUtVmVyc2lvbjogMS4wCkN
vbnRlbnQtVHlwZTogbXVsdGlwYXJ0L2FsdGVybmF0aXZlOwoJYm91bmRhcnk9ImIxXzQy
NDJjMzE0NjA2NDk1NGQxNjg3ZWZkOTQ3ZTg0MjUyIgpUbzogZmZ3ZGRlYnVnQGdtYWlsL
mNvbQpTdWJqZWN0OiA9P1VURi04P0I/UTI5dGJYVnVhV05oZEdsbElHVnRZV2xzPz0KCg
otLWIxXzQyNDJjMzE0NjA2NDk1NGQxNjg3ZWZkOTQ3ZTg0MjUyCkNvbnRlbnQtVHlwZTo
gdGV4dC9wbGFpbjsgY2hhcnNldD0iVVRGLTgiCkNvbnRlbnQtVHJhbnNmZXItRW5jb2Rp
bmc6IDhiaXQKCgoJCgkJCgkJCURpdCBpcyBlZW4gdGVzdCBiZXJpY2h0LgoKCgkJCgoJC
goKCgoKCi0tYjFfNDI0MmMzMTQ2MDY0OTU0ZDE2ODdlZmQ5NDdlODQyNTIKQ29udGVudC
1UeXBlOiB0ZXh0L2h0bWw7IGNoYXJzZXQ9IlVURi04IgpDb250ZW50LVRyYW5zZmVyLUV
uY29kaW5nOiA4Yml0Cgo8c3BhbiBzdHlsZT0iZm9udC1mYW1pbHk6IFZlcmRhbmE7IGZv
bnQtc2l6ZTogMTBwdDsiPjx0YWJsZSBib3JkZXI9IjAiIGNlbGxwYWRkaW5nPSIwIiBjZ
Wxsc3BhY2luZz0iMCIgc3R5bGU9IndpZHRoOiAxMDAlOyBmb250LWZhbWlseTogYXJpYW
w7Ij4KCTx0Ym9keT4KCQk8dHI+CgkJCTx0ZD48c3BhbiBzdHlsZT0iZm9udC1zaXplOjE
wcHQ7Ij48cD5EaXQgaXMgZWVuIHRlc3QgYmVyaWNodC48L3A+Cgo8L3NwYW4+PC90ZD4K
CQk8L3RyPgoKCTwvdGJvZHk+Cgo8L3RhYmxlPgoKCjwvc3Bhbj4KCgoKLS1iMV80MjQyY
zMxNDYwNjQ5NTRkMTY4N2VmZDk0N2U4NDI1Mi0tCg==",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/emails/7"
}
}
}E-mail toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/emails
De e-mail wordt gekoppeld aan de in Elements standaard aangegeven e-mailbox.
Om een e-mail aan een product te koppelen kan in de body het product gevuld worden.
Standaard wordt het onderwerp, de verzenddatum en ontvangstdatum uit de raw e-mail gehaald. Deze zijn echter ook mee te geven in het request.
De richting van de e-mail, (inkomen of uitgaand) is ook op te geven in de body. Valide waardes zijn in en out voor respectievelijk inkomende en uitgaande e-mail.
Als laatste is het mogelijk de e-mail te markeren als verwijderd uit inbox. Daarvoor dient er een datumtijd meegegeven te worden in verwijderdUitInbox.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/1/emails
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 1
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"product": {
"id": 6743
},
"richting": "in",
"raw": "UmV0dXJuLXBhdGg6IDx2ZXJ6ZW5kZXJAZm9vLmNvbT4KUmVjZWl2ZWQ6IGZyb20gc210cDA1LnNlbmRlcmlzcC5ubCAodW52ZXJpZmllZCBbMTIzLjQ1Ni4yNS4xMDVdKSBieSBNQUlMOS5uc2hvc3RzLmNvbQogKFZpcmNvbSBTTVRQUlMgNS4zMjMyKSB3aXRoIEVTTVRQIGlkIDxCMDA4NzgwMzYxM0BNQUlMOS5uc2hvc3RzLmNvbT4gZm9yIDxvbnR2YW5nZXJAZm9vLmNvbT47CiBTYXQsIDI4IE1heSAyMDA1IDE2OjI1OjAwIC0wNjAwClJlY2VpdmVkOiBmcm9tIFBDMS5tYWlsc2VydmVyMS5jb20gKGM1MTlkYmNjYS5jYWJsZS5zZW5kZXJpc3AubmwgWzg5LjE0Ny4xMDMuMjMyXSkKICAgICAgICBieSBzbXRwNS5zZW5kZXJpc3AubmwgKFBvc3RmaXgpIHdpdGggRVNNVFAgaWQgRDI0ODAyNTQzOAogICAgICAgIGZvciA8b250dmFuZ2VyQGZvby5jb20+OyBTdW4sIDI5IE1heSAyMDA1IDAwOjI1OjAwICswMjAwIChDRVNUKQpNZXNzYWdlLUlkOiA8NS4wLjIuMS4xLjIwMDUwNTI0MTAyODM1LjAxZGYzMjQxQHBvcC5tYWlsc2VydmVyMS5jb20+ClgtU2VuZGVyOiB0ZXN0QHBvcC5tYWlsc2VydmVyMS5jb20KWC1NYWlsZXI6IFFVQUxDT01NIFdpbmRvd3MgRXVkb3JhIFZlcnNpb24gNS4wLjIKRGF0ZTogU3VuLCAyOSBNYXkgMjAwNSAwMDoyNTowNyArMDIwMApUbzogb250dmFuZ2VyQGZvby5jb20KRnJvbTogVmVyemVuZGVyIE5hYW0gPHZlcnplbmRlckBmb28uY29tPgpTdWJqZWN0OiBlZW4gYWZiZWVsZGluZwpNaW1lLVZlcnNpb246IDEuMApDb250ZW50LVR5cGU6IG11bHRpcGFydC9taXhlZDsKICAgICAgICBib3VuZGFyeT0iPT09PT09PT09PT09PT09PT09PT09XzYwMjcwNzgyPT1fIgoKLS09PT09PT09PT09PT09PT09PT09PT1fNjAyNzA3ODI9PV8KQ29udGVudC1UeXBlOiB0ZXh0L3BsYWluOyBjaGFyc2V0PSJ1cy1hc2NpaSI7IGZvcm1hdD1mbG93ZWQKCmRpdCBpcyBoZXQgcG9ydGFhbGxvZ28KLS09PT09PT09PT09PT09PT09PT09PT1fNjAyNzA3ODI9PV8KQ29udGVudC1UeXBlOiBpbWFnZS9naWY7IG5hbWU9IlBvcnRhbC5naWYiOwogeC1tYWMtdHlwZT0iNDc0OTQ2NjYiOyB4LW1hYy1jcmVhdG9yPSI0QTU2NTc1MiIKQ29udGVudC1UcmFuc2Zlci1FbmNvZGluZzogYmFzZTY0CkNvbnRlbnQtRGlzcG9zaXRpb246IGF0dGFjaG1lbnQ7IGZpbGVuYW1lPSJQb3J0YWwuZ2lmIgoKUjBsR09EbGhJZ0FnQU1RZkFObmwyY2paeDZPeG9ybkV1T1BzNDVpbWw0bVlpZlAyOCtueDZVdFZTOWZkMTJ0M2EzeUpmTGpRdUt2Rgpxc1hOeE1IV3dWVmdWYjdUdlNrdktjemZ5emxBT2QzcDNzL2l6ZERZejJCdFlNdmR6TkhnMGJQTXNrRktRYks3c3YvLy95SDVCQUVBCkFCOEFMQUFBQUFBaUFDQUFBQVgvNENlT1pHbWVhS3F1NlNFSVhpd01CL2w0QUdzV2lxWDhpb0doOW5sZ0ZDK2k3ak04T0owSWh1ZHoKTUNDdVFvRmx5U0JjdjRQSUZJa2dtQW1QUWtHWk1sZ09YOElnOC9nZ0NtV0wzZ0tRc2dvUGNRUUFCZ0pCRHdSOEFBQWFCUWwxS3pGWApaeFlFTVJobUFJb1FEQWtFTEFwNFo2TjVpaHNiQXdzSktwQWZESGtBQVFNZUF4aUxBS2NiRng0UkRDZ0hnQVlZYVdVQUE1MFZDUVllCkFibTZIc29ud0ZBZWdRZ1dxUlBLblFzREdoY1lHaFFDMFNhMFgzRWJCaFVMSXdjTERCQVVGQUVhNUZNbTd3SUZ6SG9BRHdzNnNDSEEKZ0lLR0FBZ2RaQmp3SzBLSERnd2VMSnJqcXdTRGVnZ0RTSERBUU0yYUVzQUtNR2l3aUZORkVnWTAvMmlBd0JKQ0FKZXlUcGFJWWVIVQpIRFlXQk1SaTJhQ25CSllLVzQxUTRNRlVBQVluUFJoNHNFSGpSZ01NREJRd2tLRURCaE1DTVBDWk55NERQa0JOSllnVjRMQkRnZzRUCkl1UXpRT0FVaFFzU0RDVEk4ZUdGeHA0TkNsVEFrYUZDQmpZaUhqeW9lZUhnc1FRSVJIZ29BQUZ2M2c3NEZFaHpnNHRlQUFlcWlGZ3cKMExnbmh3S1FWUXdZZkRBaldiVWlEc1R6L0RrQlBoVFZtaUtFSUVGQTZCRWpHM0RZTFNDRGdSUUlkRFpsS1JiMGF5WU9kRHRZemdEMQpDUU1JMVFod3NOdkFiUkdGT0N4ZmJpRENsaE1MSWt3WW55QUQwcjdIOTJuZjNsMnl0QmlMcTFZWVg4RzlZcWtHcEFyb0xsVEZBUXd4CjJDZUNCWDFOa0V3R1ZSV3d4QklLRnNUUUNWb1QvTGJnRXRoNEFOZ0hJUUFBT3c9PQotLT09PT09PT09PT09PT09PT09PT09PV82MDI3MDc4Mj09Xy0t"
}Schema
{
"properties": {
"raw": {
"type": "string",
"minLength": 1
},
"product": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"schademelding": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"onderwerp": {
"type": "string",
"minLength": 1,
"maxLength": 700
},
"verzenddatum": {
"type": "string",
"format": "date-time"
},
"ontvangstdatum": {
"type": "string",
"format": "date-time"
},
"verwijderdUitInbox": {
"type": "string",
"format": "date-time"
},
"richting": {
"enum": [
"in",
"out"
]
}
},
"additionalProperties": false,
"required": [
"raw"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/emails/13Taak ¶
Taak collectieGET/api/data/klantdossiers/{DOSSIER_ID}/taken&afgerond={AFGEROND}&eigenaar={EIGENAAR}
Stamgegevens in de context van taken zijn hier te vinden: taak stamgegevens.
Het is mogelijk om te filteren op startdatum middels startdatum[van]=jjjj-mm-dd en startdatum[tot]=jjjj-mm-dd.
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/taken&afgerond=0&eigenaar=13552
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- AFGEROND
boolean(optioneel) Voorbeeld: 0- EIGENAAR
int(optioneel) Voorbeeld: 13552
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/taken"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/taken?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/taken?pagina=31&per_pagina=20"
}
},
"_embedded": {
"taken": [
{
"id": 55516,
"naam": "Contact opnemen met de klant nav aanvraag",
"omschrijving": "",
"aanmaakdatum": "2016-07-27T09:36:17+02:00",
"startdatum": "2016-07-27T09:30:00+02:00",
"einddatum": "2016-07-27T10:30:00+02:00",
"afgerond": "nee",
"typeId": 3,
"statusId": 2,
"prioriteitId": 2,
"workflowgroep": "Naam workflowgroep",
"bron": "systeem",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/taken/55516"
},
"stamgegevens": {
"href": "/api/data/stamgegevens/taak"
}
},
"_embedded": {
"initiator": [
{
"id": 112794,
"geslacht": "man",
"initialen": "I.",
"titel": "",
"voornaam": "Voornaam",
"volledigeVoornamen": "",
"tussenvoegsel": "",
"achternaam": "Medior",
"bsn": "",
"nationaliteitId": 1,
"burgerlijkestaatId": null,
"weergavenaam": "Medior, Voornaam (I.)",
"geboortedatum": null,
"pensioendatum": null,
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/taken/55516"
},
"adressen": {
"href": "/api/data/klantdossiers/5526/taken/55516/adressen"
},
"emailadressen": {
"href": "/api/data/klantdossiers/5526/taken/55516/emailadressen"
},
"rekeningnummers": {
"href": "/api/data/klantdossiers/5526/taken/55516/rekeningnummers"
},
"telefoonnummers": {
"href": "/api/data/klantdossiers/5526/taken/55516/telefoonnummers"
}
}
}
],
"eigenaar": [
{
"id": 112794,
"geslacht": "X",
"initialen": "I.",
"titel": "",
"voornaam": "Voornaam",
"volledigeVoornamen": "",
"tussenvoegsel": "",
"achternaam": "Medior",
"bsn": "",
"nationaliteitId": 1,
"burgerlijkestaatId": null,
"weergavenaam": "Medior, Voornaam (I.)",
"geboortedatum": null,
"pensioendatum": null,
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/taken/55516"
},
"adressen": {
"href": "/api/data/klantdossiers/5526/taken/55516/adressen"
},
"emailadressen": {
"href": "/api/data/klantdossiers/5526/taken/55516/emailadressen"
},
"rekeningnummers": {
"href": "/api/data/klantdossiers/5526/taken/55516/rekeningnummers"
},
"telefoonnummers": {
"href": "/api/data/klantdossiers/5526/taken/55516/telefoonnummers"
}
}
}
],
"product": [
{
"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"
}
}
}
]
}
}
]
}
}Taak ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/taken/{TAAK_ID}
Stamgegevens in de context van taken zijn hier te vinden: taak stamgegevens.
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/taken/55516
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- TAAK_ID
int(verplicht) Voorbeeld: 55516
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 55516,
"naam": "Contact opnemen met de klant nav aanvraag",
"omschrijving": "",
"aanmaakdatum": "2016-07-27T09:36:17+02:00",
"startdatum": "2016-07-27T09:30:00+02:00",
"einddatum": "2016-07-27T10:30:00+02:00",
"afgerond": "nee",
"typeId": 3,
"statusId": 2,
"prioriteitId": 2,
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/taken/55516"
},
"stamgegevens": {
"href": "/api/data/stamgegevens/taak"
}
},
"_embedded": {
"initiator": [
{
"id": 112794,
"geslacht": null,
"initialen": "I.",
"titel": "",
"voornaam": "Voornaam",
"volledigeVoornamen": "",
"tussenvoegsel": "",
"achternaam": "Medior",
"bsn": "",
"nationaliteitId": 1,
"burgerlijkestaatId": null,
"weergavenaam": "Medior, Voornaam (I.)",
"geboortedatum": null,
"pensioendatum": null,
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/taken/55516"
},
"adressen": {
"href": "/api/data/klantdossiers/5526/taken/55516/adressen"
},
"emailadressen": {
"href": "/api/data/klantdossiers/5526/taken/55516/emailadressen"
},
"rekeningnummers": {
"href": "/api/data/klantdossiers/5526/taken/55516/rekeningnummers"
},
"telefoonnummers": {
"href": "/api/data/klantdossiers/5526/taken/55516/telefoonnummers"
}
}
}
],
"eigenaar": [
{
"id": 112794,
"geslacht": "man",
"initialen": "I.",
"titel": "",
"voornaam": "Voornaam",
"volledigeVoornamen": "",
"tussenvoegsel": "",
"achternaam": "Medior",
"bsn": "",
"nationaliteitId": 1,
"burgerlijkestaatId": null,
"weergavenaam": "Medior, Voornaam (I.)",
"geboortedatum": null,
"pensioendatum": null,
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/taken/55516"
},
"adressen": {
"href": "/api/data/klantdossiers/5526/taken/55516/adressen"
},
"emailadressen": {
"href": "/api/data/klantdossiers/5526/taken/55516/emailadressen"
},
"rekeningnummers": {
"href": "/api/data/klantdossiers/5526/taken/55516/rekeningnummers"
},
"telefoonnummers": {
"href": "/api/data/klantdossiers/5526/taken/55516/telefoonnummers"
}
}
}
]
}
}Taak toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/taken
Stamgegevens in de context van taken zijn hier te vinden: taak stamgegevens.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/taken
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
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",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"prioriteit": {
"enum": [
"Laag",
"Middel",
"Hoog"
]
},
"startdatum": {
"type": "string",
"format": "date"
},
"einddatum": {
"type": "string",
"format": "date"
},
"afgerond": {
"type": "boolean"
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"initiator": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"genodigden": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"verantwoordelijke": {
"enum": [
"Persoon",
"Workflowgroep",
"WorkflowgroepMetPersoon"
]
},
"verantwoordelijkePersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verantwoordelijkeWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"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/htmlResponse
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": "Failed matching exactly one of the provided schemas."
}
]
}
}Taak workflow toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/taken/{TAAK_ID}/workflows
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/taken/55516/workflows
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- TAAK_ID
int(verplicht) Voorbeeld: 55516
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"workflow": {
"id": 21
}
}Schema
{
"properties": {
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"workflow"
]
}Response
204VerbergBekijk
Headers
Content-Type: application/jsonPand ¶
Pand collectieGET/api/data/klantdossiers/{DOSSIER_ID}/panden&gearchiveerd={GEARCHIVEERD}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/panden&gearchiveerd=0
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- GEARCHIVEERD
boolean(optioneel) Voorbeeld: 0
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/panden"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/panden?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/panden?pagina=31&per_pagina=20"
}
},
"_embedded": {
"panden": [
{
"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/panden/7790"
}
}
}
]
}
}Ockto ¶
ODM ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/externegegevens/ockto/odm/laatste
Het access token dient aangevraagd te worden voor de webservice “data”, waarvoor toegang voor de scope “klantdossier.read” verleend wordt.
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/externegegevens/ockto/odm/laatste
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"applicationId": "7c9c6bd9-68c4-46bb-bdb3-000deaa9ba5f",
"provider": null,
"clientcontext": {
"Input": {
"Application": {
"Inventory": {
"Persons": [
{
"ID": "c9aac718-0942-43f0-b699-e85c8575944a",
"Type": 0,
"Initials": "P",
"FirstName": null,
"Prefix": null,
...QR-code ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/externegegevens/ockto/qrcode
Het access token dient aangevraagd te worden voor de webservice “data”, waarvoor toegang voor de scope “ockto” verleend wordt.
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/externegegevens/ockto/qrcode
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Response
200VerbergBekijk
Headers
Content-Type: text/plainBody
iVBORw0KGgoAAAANSUhEUgAAAJQAAACUCAYAAAB1PADUAAAAAXNSR0IA
rs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQA
ABCDSURBVHhe7Y+BzmI5usTu+7/03BMWNCYqQ30EemelseT/SBUndP/f
xV/flqTzpZHaXWI7YTPVmDbUaBrS9NZw/5b3d/PhiSSdL43U7hLbCZup
xrShRtOQpreG+7e8v5sPTyTpfGmkdpfYTthMNaYNNZqGNL013L/l/d3n
4VPsHdsJG7Mh3VtOSW/sGtZwp0Zqd0k63yW2T9nfub6/efiB7YSN2ZDu
LaekN3YNa7hTI7W7JJ3vEtun7O9c3988/MB2wsZsSPeWU9Ibu4Y13KmR
2l2SzneJ7VP2d65vfpi7SaZ7g91tdmpYw72R2H7C9E32lDS7Sfb9+r4P
TTLdG+xus1PDGu6NxPYTpm+yp6TZTbLv1/d9aJLp3mB3m50a1nBvJLaf
MH2TPSXNbpJ9v77vQ5PYTqyxnbBpJOn8lSSdv5JMd2KN7eSk4W6Sfb++
70OT2E6ssZ2waSTp/JUknb+STHdije3kpOFukn2/vu9Dk9hOrL...Schademelding ¶
Schademeldingen ophalenGET/api/data/klantdossiers/{DOSSIER_ID}/schademeldingen
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/schademeldingen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/schademeldingen"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/schademeldingen?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/schademeldingen?pagina=31&per_pagina=20"
}
},
"_embedded": {
"schademeldingen": [
{
"id": 1,
"schadenummer": "SCHA01",
"status": "Nieuw",
"externSchadenummer": "EXT01",
"schadedatum": "2016-07-25T16:15:00+02:00",
"datumAfgehandeld": null,
"artikelnaam": "Motorrijtuig",
"afdbranchecode": "020",
"maatschappij": "Klaverblad",
"adres": "Voorbeeldstraat 1, 1234BB, Bergen op Zoom, NL",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/schadeverzekeringen/6746/schademeldingen/1"
},
"product": {
"href": "/api/data/klantdossiers/5526/schadeverzekeringen/6746"
}
}
},
{
"id": 2,
"schadenummer": "SCHA02",
"status": "Nieuw",
"externSchadenummer": "EXT02",
"schadedatum": "2018-01-16T00:00:00+01:00",
"datumAfgehandeld": null,
"artikelnaam": "Arbeidsongeschiktheid",
"afdbranchecode": null,
"maatschappij": "Callas Group",
"adres": "Voorbeeldstraat 1, 1234BB, Bergen op Zoom, NL",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/inkomensverzekeringen/6744/schademeldingen/2"
},
"product": {
"href": "/api/data/klantdossiers/5526/inkomensverzekeringen/6744"
}
}
}
]
}
}Schademeldingen onder schadeverzekering collectieGET/api/data/klantdossiers/{DOSSIER_ID}/schadeverzekeringen/{PRODUCT_ID}/schademeldingen
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/schadeverzekeringen/6746/schademeldingen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6746
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/schadeverzekeringen/6746/schademeldingen"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/schadeverzekeringen/6746/schademeldingen?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/schadeverzekeringen/6746/schademeldingen?pagina=31&per_pagina=20"
}
},
"_embedded": {
"schademeldingen": [
{
"id": 1,
"schadenummer": "SCHA01",
"status": "Nieuw",
"externSchadenummer": "EXT01",
"schadedatum": "2016-07-25T16:15:00+02:00",
"datumAfgehandeld": null,
"artikelnaam": "Motorrijtuig",
"afdbranchecode": "020",
"maatschappij": "Klaverblad",
"adres": "Voorbeeldstraat 1, 1234BB, Bergen op Zoom, NL",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/schadeverzekeringen/6746/schademeldingen/1"
},
"product": {
"href": "/api/data/klantdossiers/5526/schadeverzekeringen/6746"
}
}
}
]
}
}Schademeldingen onder inkomensverzekering collectieGET/api/data/klantdossiers/{DOSSIER_ID}/inkomensverzekeringen/{PRODUCT_ID}/schademeldingen
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/inkomensverzekeringen/6744/schademeldingen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6744
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/inkomensverzekeringen/6744/schademeldingen"
},
"volgende": {
"href": "/api/data/klantdossiers/5526/inkomensverzekeringen/6744/schademeldingen?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/klantdossiers/5526/inkomensverzekeringen/6744/schademeldingen?pagina=31&per_pagina=20"
}
},
"_embedded": {
"schademeldingen": [
{
"id": 2,
"schadenummer": "SCHA02",
"status": "Nieuw",
"externSchadenummer": "EXT02",
"schadedatum": "2018-01-16T00:00:00+01:00",
"datumAfgehandeld": null,
"artikelnaam": "Arbeidsongeschiktheid",
"afdbranchecode": null,
"maatschappij": "Callas Group",
"adres": "Voorbeeldstraat 1, 1234BB, Bergen op Zoom, NL",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/inkomensverzekeringen/6744/schademeldingen/2"
},
"product": {
"href": "/api/data/klantdossiers/5526/inkomensverzekeringen/6744"
}
}
}
]
}
}Schademelding ophalen onder schadeverzekeringGET/api/data/klantdossiers/{DOSSIER_ID}/schadeverzekeringen/{PRODUCT_ID}/schademeldingen/{SCHADEMELDING_ID}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/schadeverzekeringen/6746/schademeldingen/1
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6746- SCHADEMELDING_ID
int(verplicht) Voorbeeld: 1
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 2,
"schadenummer": "SCHA02",
"status": "Nieuw",
"externSchadenummer": "EXT02",
"schadedatum": "2018-01-16T00:00:00+01:00",
"datumAfgehandeld": null,
"artikelnaam": "Arbeidsongeschiktheid",
"afdbranchecode": null,
"maatschappij": "Callas Group",
"adres": "Voorbeeldstraat 1, 1234BB, Bergen op Zoom, NL",
"oorzaak": "Aansprakelijkheid",
"tegenpartij": "nee",
"aangifteBijPolitie": "nee",
"expertisebureauIngeschakeld": "nee",
"letselschade": "nee",
"geschatSchadebedrag": "0.00",
"uitgekeerdSchadebedrag": "0.00",
"uitkeringsdatum": "2018-01-31T00:00:00+01:00",
"omschrijving": "Omschrijving",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/schadeverzekeringen/6746/schademeldingen/2"
},
"product": {
"href": "/api/data/klantdossiers/5526/schadeverzekeringen/6746"
}
}
}Schademelding ophalen onder inkomensverzekeringGET/api/data/klantdossiers/{DOSSIER_ID}/inkomensverzekeringen/{PRODUCT_ID}/schademeldingen/{SCHADEMELDING_ID}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/inkomensverzekeringen/6744/schademeldingen/1
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PRODUCT_ID
int(verplicht) Voorbeeld: 6744- SCHADEMELDING_ID
int(verplicht) Voorbeeld: 1
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 2,
"schadenummer": "",
"status": "Nieuw",
"externSchadenummer": "",
"schadedatum": "2018-01-16T00:00:00+01:00",
"datumAfgehandeld": null,
"artikelnaam": "Arbeidsongeschiktheid",
"afdbranchecode": null,
"maatschappij": "Callas Group",
"adres": "Voorbeeldstraat 1, 1234BB, Bergen op Zoom, NL",
"oorzaak": "Aansprakelijkheid",
"tegenpartij": "nee",
"aangifteBijPolitie": "nee",
"expertisebureauIngeschakeld": "nee",
"letselschade": "nee",
"geschatSchadebedrag": "0.00",
"uitgekeerdSchadebedrag": "0.00",
"uitkeringsdatum": "2018-01-31T00:00:00+01:00",
"omschrijving": "",
"_links": {
"self": {
"href": "/api/data/klantdossiers/5526/inkomensverzekeringen/6744/schademeldingen/2"
},
"product": {
"href": "/api/data/klantdossiers/5526/inkomensverzekeringen/6744"
}
}
}Schademelding toevoegen onder schadeverzekeringPOST/api/data/klantdossiers/{DOSSIER_ID}/schadeverzekeringen/{SCHADEVERZEKERING_ID}/onderdelen/{ONDERDEEL_ID}/schademeldingen
Wanneer in Elements mutatievoorstellen ingeschakeld zijn, wordt er voor het toevoegen van een object gebruik gemaakt van het veld object en wordt het veld bezitting niet geaccepteerd.
Bij geen gebruik van mutatievoorstellen wordt er gekeken naar het veld bezitting en wordt het veld object niet geaccepteerd. object wordt dan gevuld a.d.v. bezitting.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/schadeverzekeringen/6746/onderdelen/7906/schademeldingen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- SCHADEVERZEKERING_ID
int(verplicht) Voorbeeld: 6746- ONDERDEEL_ID
int(verplicht) Voorbeeld: 7906
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"meldingSchade": "2018-01-17 15:17:00",
"schadedatum": "2018-01-17 11:39:00",
"datumAfgehandeld": "2018-01-17 18:00:00",
"schademelderType": "Verzekeringnemer",
"status": {
"id": 1
},
"oorzaak": {
"id": 18
},
"schadenummer": "SCHA03",
"externSchadenummer": "EXT03",
"schuldSchade": true,
"behandelaarWorkflowgroep": {
"id": 55
},
"behandelaarPersoon": {
"id": 120953
},
"tegenpartij": false,
"expertisebureauIngeschakeld": true,
"verhaalbaar": true,
"letselschade": true,
"regresschade": true,
"aangifteBijPolitie": true,
"verhaalService": true,
"coulanceschade": true,
"geschatSchadebedrag": 250,
"uitgekeerdSchadebedrag": 200,
"uitkeringsDatum": "2018-01-17",
"omschrijving": "<p>Waterschade Ipad</p>",
"bezitting": {
"id": 8398
}
}Schema
{
"title": "Schademelding",
"type": "object",
"properties": {
"meldingSchade": {
"type": "string",
"format": "date"
},
"schadedatum": {
"type": "string",
"format": "date"
},
"datumAfgehandeld": {
"type": "string",
"format": "date"
},
"schademelderType": {
"enum": [
"Tegenpartij",
"Tegenpartij Bestuurders",
"Tegenpartij Expertisebureau",
"Tegenpartij Inzittende",
"Verzekeringnemer",
"Verzekeringnemer Bestuurders",
"Verzekeringnemer Expertisebureau",
"Verzekeringnemer Inzittende"
]
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"oorzaak": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"schadenummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"externSchadenummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"schuldSchade": {
"type": "boolean"
},
"behandelaarWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"behandelaarPersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"tegenpartij": {
"type": "boolean"
},
"expertisebureauIngeschakeld": {
"type": "boolean"
},
"verhaalbaar": {
"type": "boolean"
},
"letselschade": {
"type": "boolean"
},
"regresschade": {
"type": "boolean"
},
"aangifteBijPolitie": {
"type": "boolean"
},
"verhaalService": {
"type": "boolean"
},
"coulanceschade": {
"type": "boolean"
},
"geschatSchadebedrag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"uitgekeerdSchadebedrag": {
"type": "number",
"multipleOf": 0.01,
"minimum": -99999999.99,
"maximum": 99999999.99
},
"uitkeringsDatum": {
"type": "string",
"format": "date"
},
"omschrijving": {
"type": "string",
"minLength": 1
},
"bezitting": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"required": [
"meldingSchade",
"schadedatum",
"status",
"schademelderType",
"oorzaak",
"schuldSchade",
"tegenpartij",
"expertisebureauIngeschakeld",
"verhaalbaar",
"letselschade",
"aangifteBijPolitie",
"verhaalService",
"coulanceschade",
"geschatSchadebedrag",
"uitgekeerdSchadebedrag"
],
"additionalProperties": false
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/schadeverzekeringen/6746/schademeldingen/3Document toevoegen aan schademelding onder schadeverzekeringPOST/api/data/klantdossiers/{DOSSIER_ID}/schadeverzekeringen/{SCHADEVERZEKERING_ID}/schademeldingen/{SCHADEMELDING_ID}/documenten
Voeg een schadedocument toe aan een schademelding onder een schadeverzekering.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/1234/schadeverzekeringen/1234/schademeldingen/1234/documenten
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 1234- SCHADEVERZEKERING_ID
int(verplicht) Voorbeeld: 1234- SCHADEMELDING_ID
int(verplicht) Voorbeeld: 1234
Request
VerbergBekijk
Body
{
"naam": "fasterforward.png",
"extensie": "png",
"soortdocument": {
"id": 1
},
"data": "iVBORw0KGgoAAAANSUhEUgAAAP0AAAAbCAYAAAC3KIljAAAKsElEQVR42u2dC3BVxRnH82gCISQk
0ZYEUHTCDBrBBJESmbakVMI7Kj4KDFhGwlBtlUzk2RYIAUGbalHEYnl4DdACSSB1EhsBBwTpRAUa
ERIVWu4QCO88KTQ3Cem/M19mvjmze3bPuWdyL/F+M7/Jze73fbvnsv9z9uzZE4LanbP6oID5xNLT
Rx8A7V6SFRSw2/Hffg1oB26VLzTanz58N0WP/o4CxQIiA6IPWBcVfa/vuuhnApHF3MaivwjSbNIv
KGBdWvQ07nsHRN+1RO8OClhA9CYWuNIHRB+wgOi9E3BA9AHRBywg+v/nDwEPgxdAHtgEXODPYDmY
Du61kC8UjABzwevARawFL4NHQXhniB6+3cFEsAxspH68AWaD/g5+h2HgByC0s0WPnNHgWbAefAj2
g50gBwzvokIKBengFVAI9oKPwFawGAzupH50A0kgFQwC3f1a9MjRAywGF4GOlYNxJvm6gYWa+erA
CtDTkCMXVBBnJbFfMZ8KSV+iwGrQAMysFNxvcky/BmsMjGT1o0EZuEn5TnWW6JErDCwF1ym3jM/A
MJM8mcAFMg3lI8A68Dlwg35UnkP+uZr9nAlcxFAN/yjm/7Sg/jFwBrQrKAEJJu3kUhvprCwEPA62
gePgU0nsRLAHeAxttoAykO53okf8APA1sGMLBPl6gsM2clWCeJbHZTWBoC8PgTO68STYKZLv6YDA
PwuES/rq7gzRI08vcIgNtisk0NlgKpgP9rF6D5guyeUiHxebORQIRHQP1f+efm8DsRp9Pc5yvKHh
/yTzH22oy2Z1jeA98Dx4BsyiK/9XzKcKREraqSCfLPp9ADhqOGa3ISYS7DL41FCub0ErK98AQn0t
en6FrwLe2FBDzg3Arh1wQvQUnwIagFVrAxkWRL8NtPtC9DSQ9rLBtRb0kPimgjNMpOPMRE+D+guW
+xIoBBtBHMvZTkxT9LWfQSCVGsf3HvnWgjBWngzaqG4/iJfEB4OFrM0lKtGT4K+wmNN0tV9lmMof
ZD47QJLgVisT1JDP2/4i+nmSnCUgFcSCaJBsMrjfYvniQIvApwwMB5EgBgwFWyT5HvV2ek+zjX8L
/G+Bj2m6vwwUAY/A7xrorSH6/QDmM9G/xAbeK1SsEl41+V8A0Saif7ujnzTNDZaI6jz5/UXRdib5
NbA+323iHwIukV++oW4DlV8DcRrHvZ/8TypEPw8coc+HQarEfxU7hsWKtu9kJ89PnBJ9G6iwwECW
74gg35cgVLQoJ5kq72E+44HI+kqOZ5/AN8/bhTxaIzBaA0gT+A4GV6QnMy56PWsBzRqiPwtiLBLF
7+PZVaQChGqeKCawAZstEf1B0EpT3DsU+dZSTJ1ZH9hU+E3gps9zTPyHs35mGOrOUfk6zWNeQP7N
CtGX0898ECbxjQfN5Ldbs/0+oIlifPKcPoXluwTqDbxs0v7fhFNytTjHSPI9DooN/Nau6Mk3AtQK
fJ8yOa7pAv8mEKkp+kawkD8FoL45vQ23guV5ipVPsjhDOExxp0WiJ+rBXRq5fsZiRposNDaSzxiw
jj4Xm+RdQT7XQYRhau0m2NqEepZBRMtETxwD4aoTCDHQwne+1Leit2E01T+vEP04ILL/gFwwSLtB
+6KfJPCrBsEm+cNBnSAuQ0P0TUD9WMh50a+nssvgexZFP4cvyklEv9zCusJVismT+Iyk+hugO5tt
NDGByYRYEOSlddyqEDEK0Y9R5PoH+R222Ie7/V709NjtfjAZrGaCNxN9FGhUtH8RFIL54IcgxGHR
vyrwqwJZCv4liMvREP08m5tzakCKRQYKVsKLbYjgPjYAn5GIfoCFfJsoplJSv5rqP6DfI8BNKhul
WPSb4sVTjWFgJWjVFP1lEGL2aJT1O9dGn75xSvS3gNsCSZINJRPAH2lwn7Oz4k65ZlCfdO0q2AyS
HRJ9AXDKtitE3wrifLEjjy1yvWojNoTf1wtEX2cx30SWL9FEVM+zslIq+4PA/5dU1wyiNe6Xp4E8
UAz+CWpBO8OjKfoPLTyB+LmN732XvzynnwJqHHjMxnOOBacs5rkFXgPBXop+H3DKPlKI/oSvtuGy
q9cim/H1FJ8jEH2Vjd1oDRSbJRBlO9Gflf+Kyo4L8pVQXYlJm+Npqn2LfDlN4CjYSu3M1RT9+4rj
HMz3Ddj4zjf6wyO7bGBmHnAC7ARzQJmG6PmW3nSwBlQCXVvipegLgVN2QCH6Ml+Jnl3NVtiMb6H4
BQLRV9jIt51i9xrKn6PyE4bye5iA+rFyPvWfZbbIxzgEfgfSQV/RTkBN0bsUx5jE8oy18R25fCp6
xPUBHsnC1HKQAkINMcVSYajb+z54jG4hzipWwiO8EP16gd9eu+JSiL7Yh6I/RXnybcQmsMH7nEOi
f5pNpaNZeaFskQ9lJ6kuk5VNYhuI7hDEjGV9P6LYW++06Pn3NsPGd1Tqa9G/JMmXahJTqhS9fvs/
pQ00IhvmheizBH7nu6Dod1Ceb2zETmaDd4hDou/JrtBPUlkou41IE8TkUd0uwVOJjyXtFFH9VRCr
2bcsh0QfzI7ndRvfUbWvRf+WINfXiphvFVPg/aDewFSTfCOByNI0RR8ryDlI4vuI4tieAC4DyX4r
eronJlJsnTBoQ40Toqf4Dwx793/E9saHCfzTeD0IZhtvXpS0cZrqN1no12YnRE++e8hXoBX1eoAP
RK+cBrsVV2bVfe92QX2BSc40Sc4HNEU/SJL3C4HvMRAl8U8WbOipBz38WPRx7Mq63ULcQLaa/SYV
OyX6Z9lLPyFgJf1eJPEP4zMBMIQJo48ohp0U3tHsUyyoc1D0s4SbkdRx7/qD6H8jyTdb4PsTcEHi
Xy7Z2cYtB4Qbct4Fjgp8L4EQg+80Sd5PwFQwHszQ2A58CswG94G+tE8gD9wQ+C7z2+k9WcfONmKi
hn8oa98DEh0WfRxbIEwFx9i6gdDYW3yrwRL6XG7iX04+lSBEYzqeT/5OiT4SXGNrCmEaMQ+DVtDm
a9EPATKrAgWgCJwEZlbFd7aZvKZbC0rBNnAIeCR+ixS3Abpv2W0Edq0SRNwGoo9jV74bYJLinruQ
DX7a7uyQ6MnYW3+b+FVbY5GtAnxOn+eb+Ofyt+YU7+JvIb8tfA1DIXqr23r/CrqZ+A4BF8h3sz88
stsBrFitaIed4AWWq8COlYEwyTbZy6pgQcxuYNXOgUQ/X8jj+R7s2AZLFIEJIAHEgAdANqhmPvkg
2GnR84017Kp2TOHfu+NZO/uZqHhrjR/vbjCKyuNpHWEluEz1pSCO5a4GO0GKXdFTzJ9YH06CX4A+
7LXaH5NPS8dJFsz0B9H3An/XfHPsNTBZUh9vyJtIeXXtJuUPN+lrBmi2+Ec0gkE2aARKoz4n+N3q
vTpnInuJxoybYJFB8E6LPsGwYWalRgx/b/+4hv9w9kqvGVtBOMVsM9SleSn6YBKyR9GHho7bG5+I
XiGoXYb99ddooC8D95JfDMgR8KAk70NgFThouFJ7gBuUgLkgXrOfSeBduoVoNpyUzpnExYAXSdQ1
hheBvgTvgEf8/pGdehCOo8HtZsK7Dj4DSwE7oTkuep7nUzboR2j45zD/pRb+HuB82pXXxGYKbppy
pwnWMzJAFngB3OmN6Flsf7AKHAX/ZSfXcrDI0E4KyLHyn5X8D8jtDvnJzJ4qAAAAAElFTkSuQmCC"
}Schema
{
"properties": {
"data": {
"type": "string",
"minLength": 1
},
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"extensie": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"soortdocument": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"isPrimairSchadedocument": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"data",
"naam",
"extensie",
"soortdocument"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/schadeverzekeringen/1634/schademeldingen/12345/documentenResponse
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"total": 1,
"message": "Validatie fouten",
"_links": {
"help": {
"href": "http://api.fasterforward.nl/",
"title": "Validatie informatie"
}
},
"_embedded": {
"errors": [
{
"path": "/extensie",
"message": "bestand.extensie.verplicht"
}
]
}
}Document toevoegen aan schademelding onder inkomenverzekeringPOST/api/data/klantdossiers/{DOSSIER_ID}/inkomensverzekeringen/{SCHADEVERZEKERING_ID}/schademeldingen/{SCHADEMELDING_ID}/documenten
Voeg een schadedocument toe aan een schademelding onder een inkomenverzekering.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/1234/inkomensverzekeringen/1234/schademeldingen/1234/documenten
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 1234- SCHADEVERZEKERING_ID
int(verplicht) Voorbeeld: 1234- SCHADEMELDING_ID
int(verplicht) Voorbeeld: 1234
Request
VerbergBekijk
Body
{
"naam": "fasterforward.png",
"extensie": "png",
"soortdocument": {
"id": 1
},
"data": "iVBORw0KGgoAAAANSUhEUgAAAP0AAAAbCAYAAAC3KIljAAAKsElEQVR42u2dC3BVxRnH82gCISQk
0ZYEUHTCDBrBBJESmbakVMI7Kj4KDFhGwlBtlUzk2RYIAUGbalHEYnl4DdACSSB1EhsBBwTpRAUa
ERIVWu4QCO88KTQ3Cem/M19mvjmze3bPuWdyL/F+M7/Jze73fbvnsv9z9uzZE4LanbP6oID5xNLT
Rx8A7V6SFRSw2/Hffg1oB26VLzTanz58N0WP/o4CxQIiA6IPWBcVfa/vuuhnApHF3MaivwjSbNIv
KGBdWvQ07nsHRN+1RO8OClhA9CYWuNIHRB+wgOi9E3BA9AHRBywg+v/nDwEPgxdAHtgEXODPYDmY
Du61kC8UjABzwevARawFL4NHQXhniB6+3cFEsAxspH68AWaD/g5+h2HgByC0s0WPnNHgWbAefAj2
g50gBwzvokIKBengFVAI9oKPwFawGAzupH50A0kgFQwC3f1a9MjRAywGF4GOlYNxJvm6gYWa+erA
CtDTkCMXVBBnJbFfMZ8KSV+iwGrQAMysFNxvcky/BmsMjGT1o0EZuEn5TnWW6JErDCwF1ym3jM/A
MJM8mcAFMg3lI8A68Dlwg35UnkP+uZr9nAlcxFAN/yjm/7Sg/jFwBrQrKAEJJu3kUhvprCwEPA62
gePgU0nsRLAHeAxttoAykO53okf8APA1sGMLBPl6gsM2clWCeJbHZTWBoC8PgTO68STYKZLv6YDA
PwuES/rq7gzRI08vcIgNtisk0NlgKpgP9rF6D5guyeUiHxebORQIRHQP1f+efm8DsRp9Pc5yvKHh
/yTzH22oy2Z1jeA98Dx4BsyiK/9XzKcKREraqSCfLPp9ADhqOGa3ISYS7DL41FCub0ErK98AQn0t
en6FrwLe2FBDzg3Arh1wQvQUnwIagFVrAxkWRL8NtPtC9DSQ9rLBtRb0kPimgjNMpOPMRE+D+guW
+xIoBBtBHMvZTkxT9LWfQSCVGsf3HvnWgjBWngzaqG4/iJfEB4OFrM0lKtGT4K+wmNN0tV9lmMof
ZD47QJLgVisT1JDP2/4i+nmSnCUgFcSCaJBsMrjfYvniQIvApwwMB5EgBgwFWyT5HvV2ek+zjX8L
/G+Bj2m6vwwUAY/A7xrorSH6/QDmM9G/xAbeK1SsEl41+V8A0Saif7ujnzTNDZaI6jz5/UXRdib5
NbA+323iHwIukV++oW4DlV8DcRrHvZ/8TypEPw8coc+HQarEfxU7hsWKtu9kJ89PnBJ9G6iwwECW
74gg35cgVLQoJ5kq72E+44HI+kqOZ5/AN8/bhTxaIzBaA0gT+A4GV6QnMy56PWsBzRqiPwtiLBLF
7+PZVaQChGqeKCawAZstEf1B0EpT3DsU+dZSTJ1ZH9hU+E3gps9zTPyHs35mGOrOUfk6zWNeQP7N
CtGX0898ECbxjQfN5Ldbs/0+oIlifPKcPoXluwTqDbxs0v7fhFNytTjHSPI9DooN/Nau6Mk3AtQK
fJ8yOa7pAv8mEKkp+kawkD8FoL45vQ23guV5ipVPsjhDOExxp0WiJ+rBXRq5fsZiRposNDaSzxiw
jj4Xm+RdQT7XQYRhau0m2NqEepZBRMtETxwD4aoTCDHQwne+1Leit2E01T+vEP04ILL/gFwwSLtB
+6KfJPCrBsEm+cNBnSAuQ0P0TUD9WMh50a+nssvgexZFP4cvyklEv9zCusJVismT+Iyk+hugO5tt
NDGByYRYEOSlddyqEDEK0Y9R5PoH+R222Ie7/V709NjtfjAZrGaCNxN9FGhUtH8RFIL54IcgxGHR
vyrwqwJZCv4liMvREP08m5tzakCKRQYKVsKLbYjgPjYAn5GIfoCFfJsoplJSv5rqP6DfI8BNKhul
WPSb4sVTjWFgJWjVFP1lEGL2aJT1O9dGn75xSvS3gNsCSZINJRPAH2lwn7Oz4k65ZlCfdO0q2AyS
HRJ9AXDKtitE3wrifLEjjy1yvWojNoTf1wtEX2cx30SWL9FEVM+zslIq+4PA/5dU1wyiNe6Xp4E8
UAz+CWpBO8OjKfoPLTyB+LmN732XvzynnwJqHHjMxnOOBacs5rkFXgPBXop+H3DKPlKI/oSvtuGy
q9cim/H1FJ8jEH2Vjd1oDRSbJRBlO9Gflf+Kyo4L8pVQXYlJm+Npqn2LfDlN4CjYSu3M1RT9+4rj
HMz3Ddj4zjf6wyO7bGBmHnAC7ARzQJmG6PmW3nSwBlQCXVvipegLgVN2QCH6Ml+Jnl3NVtiMb6H4
BQLRV9jIt51i9xrKn6PyE4bye5iA+rFyPvWfZbbIxzgEfgfSQV/RTkBN0bsUx5jE8oy18R25fCp6
xPUBHsnC1HKQAkINMcVSYajb+z54jG4hzipWwiO8EP16gd9eu+JSiL7Yh6I/RXnybcQmsMH7nEOi
f5pNpaNZeaFskQ9lJ6kuk5VNYhuI7hDEjGV9P6LYW++06Pn3NsPGd1Tqa9G/JMmXahJTqhS9fvs/
pQ00IhvmheizBH7nu6Dod1Ceb2zETmaDd4hDou/JrtBPUlkou41IE8TkUd0uwVOJjyXtFFH9VRCr
2bcsh0QfzI7ndRvfUbWvRf+WINfXiphvFVPg/aDewFSTfCOByNI0RR8ryDlI4vuI4tieAC4DyX4r
eronJlJsnTBoQ40Toqf4Dwx793/E9saHCfzTeD0IZhtvXpS0cZrqN1no12YnRE++e8hXoBX1eoAP
RK+cBrsVV2bVfe92QX2BSc40Sc4HNEU/SJL3C4HvMRAl8U8WbOipBz38WPRx7Mq63ULcQLaa/SYV
OyX6Z9lLPyFgJf1eJPEP4zMBMIQJo48ohp0U3tHsUyyoc1D0s4SbkdRx7/qD6H8jyTdb4PsTcEHi
Xy7Z2cYtB4Qbct4Fjgp8L4EQg+80Sd5PwFQwHszQ2A58CswG94G+tE8gD9wQ+C7z2+k9WcfONmKi
hn8oa98DEh0WfRxbIEwFx9i6gdDYW3yrwRL6XG7iX04+lSBEYzqeT/5OiT4SXGNrCmEaMQ+DVtDm
a9EPATKrAgWgCJwEZlbFd7aZvKZbC0rBNnAIeCR+ixS3Abpv2W0Edq0SRNwGoo9jV74bYJLinruQ
DX7a7uyQ6MnYW3+b+FVbY5GtAnxOn+eb+Ofyt+YU7+JvIb8tfA1DIXqr23r/CrqZ+A4BF8h3sz88
stsBrFitaIed4AWWq8COlYEwyTbZy6pgQcxuYNXOgUQ/X8jj+R7s2AZLFIEJIAHEgAdANqhmPvkg
2GnR84017Kp2TOHfu+NZO/uZqHhrjR/vbjCKyuNpHWEluEz1pSCO5a4GO0GKXdFTzJ9YH06CX4A+
7LXaH5NPS8dJFsz0B9H3An/XfHPsNTBZUh9vyJtIeXXtJuUPN+lrBmi2+Ec0gkE2aARKoz4n+N3q
vTpnInuJxoybYJFB8E6LPsGwYWalRgx/b/+4hv9w9kqvGVtBOMVsM9SleSn6YBKyR9GHho7bG5+I
XiGoXYb99ddooC8D95JfDMgR8KAk70NgFThouFJ7gBuUgLkgXrOfSeBduoVoNpyUzpnExYAXSdQ1
hheBvgTvgEf8/pGdehCOo8HtZsK7Dj4DSwE7oTkuep7nUzboR2j45zD/pRb+HuB82pXXxGYKbppy
pwnWMzJAFngB3OmN6Flsf7AKHAX/ZSfXcrDI0E4KyLHyn5X8D8jtDvnJzJ4qAAAAAElFTkSuQmCC"
}Schema
{
"properties": {
"data": {
"type": "string",
"minLength": 1
},
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"extensie": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"soortdocument": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"data",
"naam",
"extensie",
"soortdocument"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/inkomensverzekeringen/1634/schademeldingen/1234/documentenResponse
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"total": 1,
"message": "Validatie fouten",
"_links": {
"help": {
"href": "http://api.fasterforward.nl/",
"title": "Validatie informatie"
}
},
"_embedded": {
"errors": [
{
"path": "/extensie",
"message": "bestand.extensie.verplicht"
}
]
}
}Leveranciersdossier ¶
Leveranciersdossier toevoegen ¶
Leveranciersdossier toevoegenPOST/api/data/leveranciersdossiers
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/leveranciersdossiers
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
{
"allOf": [
{
"$ref": "definitions/Elements.Entity.Dossier.json#/definitions/dossier"
}
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/leveranciersdossiers/5526Klant - zakelijk toevoegen ¶
Klant - zakelijk toevoegenPOST/api/data/leveranciersdossier/{DOSSIER_ID}/klanten/zakelijk
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/leveranciersdossier/5526/klanten/zakelijk
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
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/leveranciersdossier/5526/klanten/zakelijk/16941Kantoor ¶
Collectie ¶
CollectieGET/api/data/kantoren
Bij het opvragen van het access token worden de kantoren bepaald waarvoor de gebruiker rechten heeft. Deze kantoren worden hier opgehaald.
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/kantoren
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/kantoren"
},
"volgende": {
"href": "/api/data/kantoren?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/kantoren?pagina=31&per_pagina=20"
}
},
"_embedded": {
"kantoren": [
{
"id": 14830,
"type": null,
"naam": "CO00014830",
"kvknummer": "",
"btwnummer": "",
"statutairenaam": "CO00014830",
"handelsnaam": "CO00014830",
"kleur1": "#93c47d",
"kleur2": "#ff0000",
"kleur3": "#c27ba0",
"kleur4": "#0fffff",
"_links": {
"self": {
"href": "/api/data/kantoren/14830"
},
"adressen": {
"href": "/api/data/kantoren/14830/adressen"
},
"emailadressen": {
"href": "/api/data/kantoren/14830/emailadressen"
},
"telefoonnummers": {
"href": "/api/data/kantoren/14830/telefoonnummers"
},
"rekeningnummers": {
"href": "/api/data/kantoren/14830/rekeningnummers"
},
"profielfoto": {
"href": "/api/data/kantoren/14830/profielfoto"
},
"codes": {
"href": "/api/data/kantoren/14830/codes"
},
"logo": {
"href": "/api/data/kantoren/14830/logo"
},
"medewerkers": {
"href": "/api/data/kantoren/14830/medewerkers"
}
}
},
{
"id": 16319,
"type": null,
"naam": "Deelnemer00016319",
"kvknummer": "",
"btwnummer": "",
"statutairenaam": "Deelnemer00016319",
"handelsnaam": "Deelnemer00016319",
"kleur1": "#93c47d",
"kleur2": "#ff0000",
"kleur3": "#c27ba0",
"kleur4": "#0fffff",
"_links": {
"self": {
"href": "/api/data/kantoren/16319"
},
"adressen": {
"href": "/api/data/kantoren/16319/adressen"
},
"emailadressen": {
"href": "/api/data/kantoren/16319/emailadressen"
},
"telefoonnummers": {
"href": "/api/data/kantoren/16319/telefoonnummers"
},
"rekeningnummers": {
"href": "/api/data/kantoren/16319/rekeningnummers"
},
"profielfoto": {
"href": "/api/data/kantoren/16319/profielfoto"
},
"codes": {
"href": "/api/data/kantoren/16319/codes"
},
"logo": {
"href": "/api/data/kantoren/16319/logo"
},
"medewerkers": {
"href": "/api/data/kantoren/16319/medewerkers"
}
}
}
]
}
}Kantoor ¶
KantoorGET/api/data/kantoren/{ORGANISATIE_ID}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/kantoren/14830
URI Parameters
VerbergBekijk
- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14830
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 14830,
"type": null,
"naam": "CO00014830",
"kvknummer": "",
"btwnummer": "",
"statutairenaam": "CO00014830",
"handelsnaam": "CO00014830",
"kleur1": "#93c47d",
"kleur2": "#ff0000",
"kleur3": "#c27ba0",
"kleur4": "#0fffff",
"_links": {
"self": {
"href": "/api/data/kantoren/14830"
},
"adressen": {
"href": "/api/data/kantoren/14830/adressen"
},
"emailadressen": {
"href": "/api/data/kantoren/14830/emailadressen"
},
"telefoonnummers": {
"href": "/api/data/kantoren/14830/telefoonnummers"
},
"medewerkers": {
"href": "/api/data/kantoren/14830/medewerkers"
},
"profielfoto": {
"href": "/api/data/kantoren/14830/profielfoto"
},
"codes": {
"href": "/api/data/kantoren/14830/codes"
},
"logo": {
"href": "/api/data/kantoren/14830/logo"
}
},
"_embedded": {
"openingstijden": [
{
"dag": "Dinsdag",
"van": "10:00",
"tot": "13:00",
"omschrijving": ""
}
]
}
}Adressen collectie ¶
Adressen collectieGET/api/data/kantoren/{ORGANISATIE_ID}/adressen
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/kantoren/14830/adressen
URI Parameters
VerbergBekijk
- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14830
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/kantoren/14830/adressen"
},
"volgende": {
"href": "/api/data/kantoren/14830/adressen?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/kantoren/14830/adressen?pagina=31&per_pagina=20"
}
},
"_embedded": {
"adressen": [
{
"id": 7368,
"straat": "Postbus",
"nummer": "1",
"toevoeging": "",
"postcode": "1234AB",
"plaatsnaam": "Plaatsnaam",
"land": "NL",
"postcodegebied": "1234",
"longitude": null,
"latitude": null,
"categorie": "box",
"_links": {
"self": {
"href": "/api/data/kantoren/14830/adressen/7368"
}
},
"_embedded": {
"types": [
{
"id": 7,
"naam": "correspondentieadres"
}
]
}
},
{
"id": 7542,
"straat": "Straatnaam",
"nummer": "1",
"toevoeging": "A",
"postcode": "1234AB",
"plaatsnaam": "Plaatsnaam",
"postcodegebied": "1234",
"longitude": "4.84971000",
"latitude": "52.35883000",
"categorie": "default",
"_links": {
"self": {
"href": "/api/data/kantoren/14830/adressen/7542"
}
},
"_embedded": {
"types": [
{
"id": 1,
"naam": "bezoekadres"
},
{
"id": 3,
"naam": "factuuradres"
},
{
"id": 4,
"naam": "afleveradres"
},
{
"id": 5,
"naam": "algemeen"
},
{
"id": 6,
"naam": "priveadres"
}
]
}
}
]
}
}Adres ¶
AdresGET/api/data/kantoren/{ORGANISATIE_ID}/adressen/{ADRES_ID}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/kantoren/14830/adressen/7368
URI Parameters
VerbergBekijk
- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14830- ADRES_ID
int(verplicht) Voorbeeld: 7368
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 7368,
"straat": "Postbus",
"nummer": "1",
"toevoeging": "",
"postcode": "1234AB",
"plaatsnaam": "Plaatsnaam",
"land": "NL",
"postcodegebied": "1234",
"longitude": null,
"latitude": null,
"categorie": "box",
"_links": {
"self": {
"href": "/api/data/kantoren/14830/adressen/7368"
}
},
"_embedded": {
"types": [
{
"id": 7,
"naam": "correspondentieadres"
}
]
}
}Telefoonnummers collectie ¶
Telefoonnummers collectieGET/api/data/kantoren/{ORGANISATIE_ID}/telefoonnummers
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/kantoren/14830/telefoonnummers
URI Parameters
VerbergBekijk
- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14830
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/kantoren/14830/telefoonnummers"
},
"volgende": {
"href": "/api/data/kantoren/14830/telefoonnummers?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/kantoren/14830/telefoonnummers?pagina=31&per_pagina=20"
}
},
"_embedded": {
"telefoonnummers": [
{
"id": 69584,
"naam": "999393-8008833",
"omschrijving": "",
"weergavenaam": "9993938008833",
"_links": {
"self": {
"href": "/api/data/kantoren/14830/telefoonnummers/69584"
}
},
"_embedded": {
"types": [
{
"id": 1,
"naam": "algemeen"
}
]
}
},
{
"id": 69585,
"naam": "999393-8008830",
"omschrijving": "",
"weergavenaam": "9993938008830",
"_links": {
"self": {
"href": "/api/data/kantoren/14830/telefoonnummers/69585"
}
},
"_embedded": {
"types": [
{
"id": 4,
"naam": "fax"
}
]
}
}
]
}
}Telefoonnummer ¶
TelefoonnummerGET/api/data/kantoren/{ORGANISATIE_ID}/telefoonnummers/{TELEFOONNUMMER_ID}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/kantoren/14830/telefoonnummers/69584
URI Parameters
VerbergBekijk
- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14830- TELEFOONNUMMER_ID
int(verplicht) Voorbeeld: 69584
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 69584,
"naam": "999393-8008833",
"omschrijving": "",
"weergavenaam": "9993938008833",
"_links": {
"self": {
"href": "/api/data/kantoren/14830/telefoonnummers/69584"
}
},
"_embedded": {
"types": [
{
"id": 1,
"naam": "algemeen"
}
]
}
}Emailadressen collectie ¶
Emailadressen collectieGET/api/data/kantoren/{ORGANISATIE_ID}/emailadressen
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/kantoren/14830/emailadressen
URI Parameters
VerbergBekijk
- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14830
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/kantoren/14830/emailadressen"
},
"volgende": {
"href": "/api/data/kantoren/14830/emailadressen?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/kantoren/14830/emailadressen?pagina=31&per_pagina=20"
}
},
"_embedded": {
"emailadressen": [
{
"id": 34024,
"naam": "email00034024@dummy.nl",
"omschrijving": null,
"_links": {
"self": {
"href": "/api/data/kantoren/14830/emailadressen/34024"
}
},
"_embedded": {
"types": [
{
"id": 1,
"naam": "Zakelijk"
}
]
}
}
]
}
}Emailadres ¶
EmailadresGET/api/data/kantoren/{ORGANISATIE_ID}/emailadressen/{EMAILADRES_ID}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/kantoren/14830/emailadressen/34024
URI Parameters
VerbergBekijk
- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14830- EMAILADRES_ID
int(verplicht) Voorbeeld: 34024
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 34024,
"naam": "email00034024@dummy.nl",
"omschrijving": null,
"_links": {
"self": {
"href": "/api/data/kantoren/14830/emailadressen/34024"
}
},
"_embedded": {
"types": [
{
"id": 1,
"naam": "Zakelijk"
}
]
}
}Profielfoto meta data ophalen ¶
Profielfoto meta data ophalenGET/api/data/kantoren/{ORGANISATIE_ID}/profielfoto
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/kantoren/14830/profielfoto
URI Parameters
VerbergBekijk
- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14830
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/kantoren/14830/profielfoto"
},
"download": {
"href": "/api/data/kantoren/14830/profielfoto/download"
}
}
}Response
404VerbergBekijk
Headers
Content-Type: application/jsonProfielfoto binary downloaden ¶
Profielfoto binary downloadenGET/api/data/kantoren/{ORGANISATIE_ID}/profielfoto/download
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/kantoren/14830/profielfoto/download
URI Parameters
VerbergBekijk
- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14830
Response
200VerbergBekijk
Headers
Content-Type: image/pngBody
<binary data>Response
404VerbergBekijk
Headers
Content-Type: application/jsonMedewerkers collectie ¶
Medewerkers collectieGET/api/data/kantoren/{ORGANISATIE_ID}/medewerkers
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/kantoren/14830/medewerkers
URI Parameters
VerbergBekijk
- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14830
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/kantoren/14830/medewerkers"
},
"volgende": {
"href": "/api/data/kantoren/14830/medewerkers?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/kantoren/14830/medewerkers?pagina=31&per_pagina=20"
}
},
"_embedded": {
"medewerkers": [
{
"id": 112115,
"geslacht": "man",
"initialen": "I.",
"titel": "",
"voornaam": "Voornaam",
"volledigeVoornamen": "",
"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/kantoren/14830/medewerkers/112115"
}
}
},
{
"id": 112116,
"geslacht": null,
"initialen": "I.",
"titel": "",
"voornaam": "Voornaam",
"volledigeVoornamen": "",
"tussenvoegsel": "",
"achternaam": "Achternaam00112116",
"bsn": "",
"nationaliteitId": 1,
"nationaliteit": "Nederlandse",
"burgerlijkestaatId": 2,
"burgerlijkestaat": "Gehuwd (gemeenschap van goederen)",
"weergavenaam": "Achternaam00112116, Voornaam (I.)",
"geboortedatum": null,
"pensioendatum": null,
"overleden": "nee",
"datumOverlijden": null,
"_links": {
"self": {
"href": "/api/data/kantoren/14830/medewerkers/112116"
}
},
"_embedded": {
"functies": [
{
"id": "4",
"naam": "Acceptant",
"omschrijving": null
},
{
"id": "3",
"naam": "Adviseur",
"omschrijving": null
},
{
"id": "2",
"naam": "Behandelaar",
"omschrijving": null
}
}
}
]
}
}
Medewerker ¶
MedewerkerGET/api/data/kantoren/{ORGANISATIE_ID}/medewerkers/{PERSOON_ID}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/kantoren/14830/medewerkers/112115
URI Parameters
VerbergBekijk
- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14830- PERSOON_ID
int(verplicht) Voorbeeld: 112115
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 112115,
"geslacht": "man",
"initialen": "I.",
"titel": "",
"voornaam": "Voornaam",
"volledigeVoornamen": "",
"tussenvoegsel": "",
"achternaam": "Achternaam00112115",
"bsn": "",
"nationaliteitId": 1,
"nationaliteit": "Nederlandse",
"burgerlijkestaatId": 1,
"burgerlijkestaat": "Alleenstaand",
"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/kantoren/14830/medewerkers/112115"
},
"profielfoto": {
"href": "/api/data/kantoren/14830/medewerkers/112115/profielfoto"
},
"adressen": {
"href": "/api/data/kantoren/14830/medewerkers/112115/adressen"
},
"emailadressen": {
"href": "/api/data/kantoren/14830/medewerkers/112115/emailadressen"
},
"rekeningnummers": {
"href": "/api/data/kantoren/14830/medewerkers/112115/rekeningnummers"
},
"telefoonnummers": {
"href": "/api/data/kantoren/14830/medewerkers/112115/telefoonnummers"
}
},
"_embedded": {
"functies": [
{
"id": "4",
"naam": "Acceptant",
"omschrijving": null
},
{
"id": "3",
"naam": "Adviseur",
"omschrijving": null
},
{
"id": "2",
"naam": "Behandelaar",
"omschrijving": null
}
}
}
Profielfoto meta data ophalen ¶
Profielfoto meta data ophalenGET/api/data/kantoren/{ORGANISATIE_ID}/medewerkers/{PERSOON_ID}/profielfoto
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/kantoren/14830/medewerkers/112115/profielfoto
URI Parameters
VerbergBekijk
- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14830- PERSOON_ID
int(verplicht) Voorbeeld: 112115
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/kantoren/14830/medewerkers/112115/profielfoto"
},
"download": {
"href": "/api/data/kantoren/14830/medewerkers/112115/profielfoto/download"
}
}
}Response
404VerbergBekijk
Headers
Content-Type: application/jsonProfielfoto binary downloaden ¶
Profielfoto binary downloadenGET/api/data/kantoren/{ORGANISATIE_ID}/medewerkers/{PERSOON_ID}/profielfoto/download
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/kantoren/14830/medewerkers/112115/profielfoto/download
URI Parameters
VerbergBekijk
- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14830- PERSOON_ID
int(verplicht) Voorbeeld: 112115
Response
200VerbergBekijk
Headers
Content-Type: image/pngBody
<binary data>Response
404VerbergBekijk
Headers
Content-Type: application/jsonCode collectie ¶
Code collectieGET/api/data/kantoren/{KANTOOR_ID}/codes
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/kantoren/16319/codes
URI Parameters
VerbergBekijk
- KANTOOR_ID
int(verplicht) Voorbeeld: 16319
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/kantoren/16319/codes"
},
"volgende": {
"href": "/api/data/kantoren/16319/codes?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/kantoren/16319/codes?pagina=31&per_pagina=20"
}
},
"_embedded": {
"codes": [
{
"id": 465,
"code": "123",
"omschrijving": "",
"afgiftedatum": "2018-06-26T00:00:00+02:00",
"type": "Vestigingsnummer"
}
]
}
}Logo kantoor ¶
Logo kantoorGET/api/data/kantoren/{KANTOOR_ID}/logo
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/kantoren/16319/logo
URI Parameters
VerbergBekijk
- KANTOOR_ID
int(verplicht) Voorbeeld: 16319
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"id": 26,
"naam": "png.png",
"extensie": "png",
"bestandsgrootte": 43580,
"mimetype": "image/jpeg",
"omschrijving": "",
"aanmaakdatum": "2020-02-17T15:08:21+01:00",
"publiek": "nee",
"_links": {
"self": {
"href": "/api/data/kantoren/16319/logo"
},
"download": {
"href": "/api/data/kantoren/16319/logo/download"
}
}
}Beschikbaarheid agenda ¶
Beschikbaarheid agendaGET/api/data/kantoren/{KANTOOR_ID}/beschikbaarheid{?vanaf,aantal_dagen,medewerkers}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/kantoren/16319/beschikbaarheid?vanaf=2020-08-18&aantal_dagen=7&medewerkers=23423
URI Parameters
VerbergBekijk
- KANTOOR_ID
int(verplicht) Voorbeeld: 16319- vanaf
string(optioneel) Voorbeeld: 2020-08-18- aantal_dagen
int(optioneel) Voorbeeld: 7- medewerkers
int(optioneel) Voorbeeld: 23423
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/kantoren/426/beschikbaarheid"
}
},
"_embedded": {
"beschikbaarheid": [
{
"tijdsblokken": [
{
"datum": "2020-08-18",
"tijden": [
{
"van": "00:00",
"tot": "24:00"
}
]
}
],
"_links": {
"medewerker": {
"href": "/api/data/kantoren/426/medewerkers/1037801"
}
}
}
]
}
}Response
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"error": "Vanaf bevat een ongeldige datum"
}Response
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"error": "Medewerkers bevat een ongeldige waarde"
}Response
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"error": "Aantaldagen bevat een ongeldige waarde"
}Response
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"error": "Aantaldagen mag niet groter zijn dan 31"
}Stamgegevens ¶
Taak ¶
TaakGET/api/data/stamgegevens/taak
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/stamgegevens/taak
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/stamgegevens/taak"
}
},
"_embedded": {
"type": [
{
"id": 1,
"naam": "afspraak"
},
{
"id": 2,
"naam": "bellen"
},
{
"id": 3,
"naam": "actie"
},
{
"id": 5,
"naam": "klacht"
},
{
"id": 7,
"naam": "schade"
},
{
"id": 8,
"naam": "doel"
},
{
"id": 9,
"naam": "bezichtiging"
}
],
"status": [
{
"id": 1,
"naam": "niet gestart"
},
{
"id": 2,
"naam": "bezig"
},
{
"id": 3,
"naam": "compleet"
},
{
"id": 4,
"naam": "wachtend"
},
{
"id": 5,
"naam": "uitgesteld"
},
{
"id": 6,
"naam": "gestopt"
}
],
"prioriteit": [
{
"id": 1,
"naam": "laag"
},
{
"id": 2,
"naam": "middel"
},
{
"id": 3,
"naam": "hoog"
}
]
}
}Soort documenten ¶
Soort documentenGET/api/data/stamgegevens/soortdocumenten
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/stamgegevens/soortdocumenten
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/stamgegevens/soortdocumenten"
},
"volgende": {
"href": "/api/data/stamgegevens/soortdocumenten?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/stamgegevens/soortdocumenten?pagina=31&per_pagina=20"
}
},
"_embedded": {
"soortdocumenten": [
{
"id": 1,
"naam": "Koopcontract door beide partijen getekend",
"protocol": "algemeen"
},
{
"id": 2,
"naam": "Koop- en aanneemovereenkomst",
"protocol": "algemeen"
},
{
"id": 3,
"naam": "Taxatierapport huidige woning",
"protocol": "algemeen"
},
{
"id": 5,
"naam": "Verklaring makelaar over opbrengst",
"protocol": "algemeen"
},
{
"id": 6,
"naam": "Eigendomsbewijs huidige woning",
"protocol": "algemeen"
},
{
"id": 7,
"naam": "Verkoopcontract huidige woning(en)",
"protocol": "algemeen"
},
{
"id": 8,
"naam": "Recente jaaropgave huidige hypotheek",
"protocol": "algemeen"
},
{
"id": 9,
"naam": "Werkgeversverklaring 1e aanvrager",
"protocol": "hdn"
},
{
"id": 10,
"naam": "Aanstellingsbrief (ven)",
"protocol": "algemeen"
},
{
"id": 12,
"naam": "Jaaroverzicht(en) salaris 1e aanvrager",
"protocol": "hdn"
},
{
"id": 13,
"naam": "IB verklaringen",
"protocol": "algemeen"
},
{
"id": 14,
"naam": "Aanslagbiljetten IB afgelopen 3 jaren 1e aanvrager",
"protocol": "hdn"
},
{
"id": 15,
"naam": "Jaarstukken laatste 3 jaar 1e aanvrager",
"protocol": "hdn"
},
{
"id": 16,
"naam": "Bewijsstukken uitkering 1e aanvrager",
"protocol": "hdn"
},
{
"id": 17,
"naam": "Aflossing- en opheffingsbewijs krediet 1e aanvrager",
"protocol": "hdn"
},
{
"id": 18,
"naam": "Saldobiljet van doorlopend krediet",
"protocol": "hdn"
},
{
"id": 19,
"naam": "Vonnis (echtscheiding) van rechtbank 1e aanvrager",
"protocol": "hdn"
},
{
"id": 20,
"naam": "Echtscheidingsconvenant 1e aanvrager",
"protocol": "hdn"
},
{
"id": 21,
"naam": "Register huwelijk en echtscheiding 1e aanvrager",
"protocol": "hdn"
},
{
"id": 22,
"naam": "Laatste toekenning rijksbijdrage",
"protocol": "algemeen"
}
]
}
}Activiteiten ¶
ActiviteitenGET/api/data/stamgegevens/activiteiten
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/stamgegevens/activiteiten
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/stamgegevens/activiteiten"
},
"volgende": {
"href": "/api/data/stamgegevens/activiteiten?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/stamgegevens/activiteiten?pagina=31&per_pagina=20"
}
},
"_embedded": {
"activiteiten": [
{
"naam": "Algemeen",
"id": 1
}
]
}
}Registratie types ¶
Registratie typesGET/api/data/stamgegevens/registratietypes
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/stamgegevens/registratietypes
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/stamgegevens/registratietypes"
},
"volgende": {
"href": "/api/data/stamgegevens/registratietypes?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/stamgegevens/registratietypes?pagina=31&per_pagina=20"
}
},
"_embedded": {
"registratietypes": [
{
"naam": "Voorbereiden",
"id": 1
},
{
"naam": "Telefoongesprek",
"id": 2
},
{
"naam": "Vergadering",
"id": 3
},
{
"naam": "E-mail/Brief",
"id": 4
},
{
"naam": "Reizen",
"id": 5
},
{
"naam": "Productie",
"id": 6
},
{
"naam": "Documenteren",
"id": 7
},
{
"naam": "Urgente registratie",
"id": 11
},
{
"naam": "Advies",
"id": 13
},
{
"naam": "Bemiddeling",
"id": 14
},
{
"naam": "Bezichtiging",
"id": 15
},
{
"naam": "Intake",
"id": 16
},
{
"naam": "Uitwerken",
"id": 17
},
{
"naam": "Offerte",
"id": 18
}
]
}
}Dossierrollen ¶
DossierrollenGET/api/data/stamgegevens/dossierrollen
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/stamgegevens/dossierrollen
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/stamgegevens/dossierrollen"
}
},
"_embedded": {
"dossierrollen": [
{
"id": 2,
"naam": "Notaris",
"systeem": true,
"weergevenOpDossierstartpagina": false,
"selecteerbaarInProduct": false
},
{
"id": 4,
"naam": "Makelaar",
"systeem": true,
"weergevenOpDossierstartpagina": false,
"selecteerbaarInProduct": false
},
{
"id": 15,
"naam": "Aanbrenger",
"systeem": true,
"weergevenOpDossierstartpagina": false,
"selecteerbaarInProduct": false
},
{
"id": 16,
"naam": "Belastingadviseur",
"systeem": true,
"weergevenOpDossierstartpagina": false,
"selecteerbaarInProduct": false
},
{
"id": 17,
"naam": "Adviseur",
"systeem": true,
"weergevenOpDossierstartpagina": false,
"selecteerbaarInProduct": false
},
{
"id": 18,
"naam": "Standaard dossierverantwoordelijke",
"systeem": true,
"weergevenOpDossierstartpagina": false,
"selecteerbaarInProduct": false
},
{
"id": 20,
"naam": "Koper",
"systeem": true,
"weergevenOpDossierstartpagina": false,
"selecteerbaarInProduct": false
},
{
"id": 21,
"naam": "Overige organisatie",
"systeem": true,
"weergevenOpDossierstartpagina": false,
"selecteerbaarInProduct": false
},
{
"id": 22,
"naam": "Overige persoon",
"systeem": true,
"weergevenOpDossierstartpagina": false,
"selecteerbaarInProduct": false
},
{
"id": 24,
"naam": "Ex-partner",
"systeem": false,
"weergevenOpDossierstartpagina": false,
"selecteerbaarInProduct": true
},
{
"id": 25,
"naam": "Bewindvoerder",
"systeem": false,
"weergevenOpDossierstartpagina": true,
"selecteerbaarInProduct": false
}
]
}
}Oorzaken ¶
OorzakenGET/api/data/stamgegevens/schademeldingoorzaken
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/stamgegevens/schademeldingoorzaken
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/stamgegevens/schademeldingoorzaken"
},
"volgende": {
"href": "/api/data/stamgegevens/schademeldingoorzaken?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/stamgegevens/schademeldingoorzaken?pagina=8&per_pagina=20"
}
},
"_embedded": {
"schademeldingoorzaken": [
{
"naam": "Natuurlijke oorzaken",
"id": 68
},
{
"naam": "Blikseminslag",
"id": 69
},
{
"naam": "Neerslag",
"id": 70
},
{
"naam": "Hagel",
"id": 71
},
{
"naam": "Vorst",
"id": 72
},
{
"naam": "Storm",
"id": 73
},
{
"naam": "Aardbeving",
"id": 74
},
{
"naam": "Vulkanische uitbarsting",
"id": 75
},
{
"naam": "Overstroming",
"id": 76
},
{
"naam": "Warmte",
"id": 77
},
{
"naam": "Sneeuw",
"id": 78
},
{
"naam": "Aardverschuiving",
"id": 79
},
{
"naam": "Lawine",
"id": 80
},
{
"naam": "Vallend berggesteente",
"id": 81
},
{
"naam": "Luchtdruk",
"id": 82
},
{
"naam": "Overlijden",
"id": 83
},
{
"naam": "Meteorieten",
"id": 84
},
{
"naam": "Vloedgolf",
"id": 85
},
{
"naam": "Broeien",
"id": 86
},
{
"naam": "Insecten/Ongedierte",
"id": 87
}
]
}
}Statussen ¶
StatussenGET/api/data/stamgegevens/schademeldingstatussen
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/stamgegevens/schademeldingstatussen
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/stamgegevens/schademeldingstatussen"
},
"volgende": {
"href": "/api/data/stamgegevens/schademeldingstatussen?pagina=2&per_pagina=20"
},
"laatste": {
"href": "/api/data/stamgegevens/schademeldingstatussen?pagina=2&per_pagina=20"
}
},
"_embedded": {
"schademeldingstatussen": [
{
"naam": "Nieuw",
"id": 1
},
{
"naam": "In behandeling",
"id": 2
},
{
"naam": "Dossier gesloten",
"id": 3
},
{
"naam": "Gesloten - Verhaalbaar",
"id": 5
},
{
"naam": "Lopend en dossier compleet",
"id": 6
},
{
"naam": "Documenten opgevraagd bij klant",
"id": 7
},
{
"naam": "Verhaalbaar",
"id": 8
},
{
"naam": "Rappel 1 verstuurd naar klant",
"id": 9
},
{
"naam": "Expert ingeschakeld",
"id": 10
},
{
"naam": "Rappel 2 verstuurd naar klant",
"id": 11
},
{
"naam": "Dossier compleet",
"id": 12
},
{
"naam": "Gesloten - Afgelegd vanwege geen reactie",
"id": 13
},
{
"naam": "Gesloten - Coulance maatschappij",
"id": 14
},
{
"naam": "Gesloten - Afgewezen",
"id": 15
},
{
"naam": "Gesloten - Coulance",
"id": 16
},
{
"naam": "Gesloten - Niet verhaalbaar",
"id": 17
}
]
}
}Functies ¶
FunctiesGET/api/data/stamgegevens/functies
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/stamgegevens/functies
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/data/stamgegevens/functies"
}
},
"_embedded": {
"functies": [
{
"id": "1",
"naam": "Contactpersoon",
"omschrijving": null
},
{
"id": "2",
"naam": "Behandelaar",
"omschrijving": null
},
{
"id": "3",
"naam": "Adviseur",
"omschrijving": null
},
{
"id": "4",
"naam": "Acceptant",
"omschrijving": null
},
{
"id": "5",
"naam": "Bestuurder",
"omschrijving": null
},
{
"id": "7",
"naam": "Werknemer",
"omschrijving": ""
},
{
"id": "8",
"naam": "Eigenaar",
"omschrijving": ""
},
{
"id": "9",
"naam": "DGA",
"omschrijving": ""
},
{
"id": "10",
"naam": "NVM makelaar",
"omschrijving": "NVM makelaar"
},
{
"id": "11",
"naam": "Vennoot / Mede eigenaar",
"omschrijving": ""
},
{
"id": "12",
"naam": "Accountmanager",
"omschrijving": ""
}
]
}
}Vaste waarden ¶
Vaste waarden ¶
Vaste waardenGET/api/data/vastewaarden
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/data/vastewaarden
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"aanhef": [
"Geachte heer",
"Geachte mevrouw",
"Geachte heer en mevrouw",
"Geachte mevrouw en mijnheer",
"Geachte heren",
"Geachte dames",
"Geachte dames en heren",
"Geachte relatie"
],
"adrestype": [
"Bezoekadres",
"Factuuradres",
"Afleveradres",
"Algemeen",
"Priveadres",
"Correspondentieadres",
"Pand"
],
.......
}Mutaties ¶
Persoon ¶
Persoon toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/mutaties/personen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/mutaties/personen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"persoon": {
"geslacht": "Man",
"initialen": "J.",
"titel": "dhr",
"voornaam": "Jan",
"volledigeVoornamen": "",
"achternaam": "Nijs",
"tussenvoegsel": "de",
"bsn": "695803888",
"geboortedatum": "1980-01-25",
"burgerlijkestaat": "Alleenstaand"
},
"telefoonnummers": [
{
"naam": "0610485677",
"type": "Algemeen"
},
{
"naam": "0610485677",
"type": "Zakelijk"
}
],
"rekeningnummers": [
{
"iban": "NL25RABO0136907539",
"bic": "RABONL2U",
"land": "NL",
"type": "Incasso"
}
],
"emailadressen": [
{
"naam": "particulier@home.nl",
"type": "Algemeen"
}
],
"adressen": [
{
"postcode": "4651ME",
"nummer": "3",
"toevoeging": "B",
"straat": "Grimbergen",
"plaatsnaam": "Steenbergen",
"gemeente": "Steenbergen",
"provincie": "Noord-Brabant",
"land": "NL",
"categorie": "Standaard",
"type": "Correspondentieadres"
}
]
}Schema
{
"properties": {
"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": "date"
},
"geboorteplaats": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"geslacht": {
"enum": [
"Man",
"Vrouw",
"X"
]
},
"voorkeurstaal": {
"enum": [
"nld",
"eng"
]
},
"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": "date"
}
},
"additionalProperties": false,
"required": [
"achternaam"
]
},
"telefoonnummers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"naam": {
"type": "string",
"pattern": "^[0-9 ()+-]{1,255}$"
},
"type": {
"enum": [
"Algemeen",
"Storingsnummer",
"Fax",
"Mobiel",
"Zakelijk"
]
}
},
"additionalProperties": false,
"required": [
"naam",
"type"
]
},
"minItems": 1,
"uniqueItems": true
},
"rekeningnummers": {
"type": "array",
"items": {
"type": "object",
"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"
]
},
"minItems": 1,
"uniqueItems": true
},
"emailadressen": {
"type": "array",
"items": {
"type": "object",
"properties": {
"naam": {
"type": "email"
},
"type": {
"enum": [
"Zakelijk",
"Prive",
"Algemeen"
]
}
},
"additionalProperties": false,
"required": [
"naam",
"type"
]
},
"minItems": 1,
"uniqueItems": true
},
"adressen": {
"type": "array",
"items": {
"type": "object",
"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": [
"type"
]
}
}
},
"additionalProperties": false,
"required": [
"persoon"
]
}Response
201VerbergBekijk
Headers
Content-Type: application/jsonPersoon wijzigenPATCH/api/data/klantdossiers/{DOSSIER_ID}/mutaties/personen/{PERSOON_ID}
Voorbeeld URI
PATCH https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/mutaties/personen/120961
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120961
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"burgerlijkestaat": "Samenwonend met samenlevingscontract"
}Schema
{
"type": "object",
"properties": {
"achternaam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"tussenvoegsel": {
"type": "string",
"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": "date"
},
"geboorteplaats": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"geslacht": {
"enum": [
"Man",
"Vrouw",
"X"
]
},
"voorkeurstaal": {
"enum": [
"nld",
"eng"
]
},
"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": "date"
}
},
"additionalProperties": false
}Response
204VerbergBekijk
Headers
Content-Type: application/jsonTelefoonnummer toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/mutaties/personen/{PERSOON_ID}/telefoonnummers
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/mutaties/personen/120961/telefoonnummers
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120961
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"naam": "0610485677",
"type": "Algemeen"
}Schema
{
"type": "object",
"properties": {
"naam": {
"type": "string",
"pattern": "^[0-9 ()+-]{1,255}$"
},
"type": {
"enum": [
"Algemeen",
"Storingsnummer",
"Fax",
"Mobiel",
"Zakelijk"
]
}
},
"additionalProperties": false,
"required": [
"naam",
"type"
]
}Response
201VerbergBekijk
Headers
Content-Type: application/jsonTelefoonnummer wijzigenPATCH/api/data/klantdossiers/{DOSSIER_ID}/mutaties/personen/{PERSOON_ID}/telefoonnummers/{TELEFOONNUMMER_ID}
Voorbeeld URI
PATCH https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/mutaties/personen/120961/telefoonnummers/76411
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120961- TELEFOONNUMMER_ID
int(verplicht) Voorbeeld: 76411
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"naam": "0610485677"
}Schema
{
"type": "object",
"properties": {
"naam": {
"type": "string",
"pattern": "^[0-9 ()+-]{1,255}$"
}
},
"additionalProperties": false,
"required": [
"naam"
]
}Response
204VerbergBekijk
Headers
Content-Type: application/jsonTelefoonnummer verwijderenDELETE/api/data/klantdossiers/{DOSSIER_ID}/mutaties/personen/{PERSOON_ID}/telefoonnummers/{TELEFOONNUMMER_ID}
Voorbeeld URI
DELETE https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/mutaties/personen/120961/telefoonnummers/76411
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120961- TELEFOONNUMMER_ID
int(verplicht) Voorbeeld: 76411
Response
204VerbergBekijk
Headers
Content-Type: application/jsonAdres toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/mutaties/personen/{PERSOON_ID}/adressen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/mutaties/personen/120961/adressen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120961
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
{
"type": "object",
"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": [
"postcode",
"nummer",
"type"
]
}Response
201VerbergBekijk
Headers
Content-Type: application/jsonAdres wijzigenPATCH/api/data/klantdossiers/{DOSSIER_ID}/mutaties/personen/{PERSOON_ID}/adressen/{ADRES_ID}
Voorbeeld URI
PATCH https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/mutaties/personen/120961/adressen/7797
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120961- ADRES_ID
int(verplicht) Voorbeeld: 7797
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"categorie": "Postbus"
}Schema
{
"type": "object",
"properties": {
"postcode": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"nummer": {
"type": "string",
"minLength": 1,
"maxLength": 25
},
"toevoeging": {
"type": "string",
"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"
]
}
},
"additionalProperties": false
}Response
204VerbergBekijk
Headers
Content-Type: application/jsonAdres verwijderenDELETE/api/data/klantdossiers/{DOSSIER_ID}/mutaties/personen/{PERSOON_ID}/adressen/{ADRES_ID}
Voorbeeld URI
DELETE https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/mutaties/personen/120961/adressen/7797
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120961- ADRES_ID
int(verplicht) Voorbeeld: 7797
Response
204VerbergBekijk
Headers
Content-Type: application/jsonEmailadres toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/mutaties/personen/{PERSOON_ID}/emailadressen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/mutaties/personen/120961/emailadressen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120961
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"naam": "particulier@home.nl",
"type": "Algemeen"
}Schema
{
"type": "object",
"properties": {
"naam": {
"type": "email"
},
"type": {
"enum": [
"Zakelijk",
"Prive",
"Algemeen"
]
}
},
"additionalProperties": false,
"required": [
"naam",
"type"
]
}Response
201VerbergBekijk
Headers
Content-Type: application/jsonEmailadres wijzigenPATCH/api/data/klantdossiers/{DOSSIER_ID}/mutaties/personen/{PERSOON_ID}/emailadressen/{EMAILADRES_ID}
Voorbeeld URI
PATCH https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/mutaties/personen/120961/emailadressen/7797
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120961- EMAILADRES_ID
int(verplicht) Voorbeeld: 7797
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"naam": "particulier@gmail.nl"
}Schema
{
"type": "object",
"properties": {
"naam": {
"type": "string",
"format": "email",
"maxLength": 255
}
},
"additionalProperties": false,
"required": [
"naam"
]
}Response
204VerbergBekijk
Headers
Content-Type: application/jsonEmailadres verwijderenDELETE/api/data/klantdossiers/{DOSSIER_ID}/mutaties/personen/{PERSOON_ID}/emailadressen/{EMAILADRES_ID}
Voorbeeld URI
DELETE https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/mutaties/personen/120961/emailadressen/7797
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120961- EMAILADRES_ID
int(verplicht) Voorbeeld: 7797
Response
204VerbergBekijk
Headers
Content-Type: application/jsonRekeningnummer toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/mutaties/personen/{PERSOON_ID}/rekeningnummers
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/mutaties/personen/120961/rekeningnummers
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120961
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"iban": "NL25RABO0136907539",
"bic": "RABONL2U",
"land": "NL",
"type": "Incasso"
}Schema
{
"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"
]
}Response
201VerbergBekijk
Headers
Content-Type: application/jsonRekeningnummer wijzigenPATCH/api/data/klantdossiers/{DOSSIER_ID}/mutaties/personen/{PERSOON_ID}/rekeningnummers/{REKENINGNUMMER_ID}
Voorbeeld URI
PATCH https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/mutaties/personen/120961/rekeningnummers/1964
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120961- REKENINGNUMMER_ID
int(verplicht) Voorbeeld: 1964
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"iban": "NL25RABO0136907539"
}Schema
{
"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"
]
}
},
"additionalProperties": false
}Response
204VerbergBekijk
Headers
Content-Type: application/jsonRekeningnummer verwijderenDELETE/api/data/klantdossiers/{DOSSIER_ID}/mutaties/personen/{PERSOON_ID}/rekeningnummers/{REKENINGNUMMER_ID}
Voorbeeld URI
DELETE https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/mutaties/personen/120961/rekeningnummers/1964
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- PERSOON_ID
int(verplicht) Voorbeeld: 120961- REKENINGNUMMER_ID
int(verplicht) Voorbeeld: 1964
Response
204VerbergBekijk
Headers
Content-Type: application/jsonOrganisatie ¶
Organisatie toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/mutaties/organisaties
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/mutaties/organisaties
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"organisatie": {
"naam": "Organisatie00014829",
"statutairenaam": "Organisatie00014829",
"handelsnaam": "Organisatie00014829",
"kvknummer": "39081762",
"btwnummer": "NL811716764B01",
"type": "NV"
},
"telefoonnummers": [
{
"naam": "0610485677",
"type": "Algemeen"
},
{
"naam": "0610485677",
"type": "Zakelijk"
}
],
"rekeningnummers": [
{
"iban": "NL25RABO0136907539",
"bic": "RABONL2U",
"land": "NL",
"type": "Incasso"
}
],
"emailadressen": [
{
"naam": "zakelijk@home.nl",
"type": "Zakelijk"
}
],
"adressen": [
{
"postcode": "4651ME",
"nummer": "3",
"toevoeging": "B",
"straat": "Grimbergen",
"plaatsnaam": "Steenbergen",
"gemeente": "Steenbergen",
"provincie": "Noord-Brabant",
"land": "NL",
"categorie": "Standaard",
"type": "Correspondentieadres"
}
]
}Schema
{
"type": "object",
"properties": {
"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"
]
},
"telefoonnummers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"naam": {
"type": "string",
"pattern": "^[0-9 ()+-]{1,255}$"
},
"type": {
"enum": [
"Algemeen",
"Storingsnummer",
"Fax",
"Mobiel",
"Zakelijk"
]
}
},
"additionalProperties": false,
"required": [
"naam",
"type"
]
},
"minItems": 1,
"uniqueItems": true
},
"rekeningnummers": {
"type": "array",
"items": {
"type": "object",
"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"
]
},
"minItems": 1,
"uniqueItems": true
},
"emailadressen": {
"type": "array",
"items": {
"type": "object",
"properties": {
"naam": {
"type": "email"
},
"type": {
"enum": [
"Zakelijk",
"Prive",
"Algemeen"
]
}
},
"additionalProperties": false,
"required": [
"naam",
"type"
]
},
"minItems": 1,
"uniqueItems": true
},
"adressen": {
"type": "array",
"items": {
"type": "object",
"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": [
"type"
]
}
}
},
"additionalProperties": false,
"required": [
"organisatie"
]
}Response
201VerbergBekijk
Headers
Content-Type: application/jsonOrganisatie wijzigenPATCH/api/data/klantdossiers/{DOSSIER_ID}/mutaties/organisaties/{ORGANISATIE_ID}
Voorbeeld URI
PATCH https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/mutaties/organisaties/14835
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"naam": "Organisatie00014830"
}Schema
{
"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
}Response
204VerbergBekijk
Headers
Content-Type: application/jsonTelefoonnummer toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/mutaties/organisaties/{ORGANISATIE_ID}/telefoonnummers
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/mutaties/organisaties/14835/telefoonnummers
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"naam": "0610485677",
"type": "Algemeen"
}Schema
{
"type": "object",
"properties": {
"naam": {
"type": "string",
"pattern": "^[0-9 ()+-]{1,255}$"
},
"type": {
"enum": [
"Algemeen",
"Storingsnummer",
"Fax",
"Mobiel",
"Zakelijk"
]
}
},
"additionalProperties": false,
"required": [
"naam",
"type"
]
}Response
201VerbergBekijk
Headers
Content-Type: application/jsonTelefoonnummer wijzigenPATCH/api/data/klantdossiers/{DOSSIER_ID}/mutaties/organisaties/{ORGANISATIE_ID}/telefoonnummers/{TELEFOONNUMMER_ID}
Voorbeeld URI
PATCH https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/mutaties/organisaties/14835/telefoonnummers/76411
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835- TELEFOONNUMMER_ID
int(verplicht) Voorbeeld: 76411
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"naam": "0610485677"
}Schema
{
"type": "object",
"properties": {
"naam": {
"type": "string",
"pattern": "^[0-9 ()+-]{1,255}$"
}
},
"additionalProperties": false,
"required": [
"naam"
]
}Response
204VerbergBekijk
Headers
Content-Type: application/jsonTelefoonnummer verwijderenDELETE/api/data/klantdossiers/{DOSSIER_ID}/mutaties/organisaties/{ORGANISATIE_ID}/telefoonnummers/{TELEFOONNUMMER_ID}
Voorbeeld URI
DELETE https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/mutaties/organisaties/14835/telefoonnummers/76411
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835- TELEFOONNUMMER_ID
int(verplicht) Voorbeeld: 76411
Response
204VerbergBekijk
Headers
Content-Type: application/jsonAdres toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/mutaties/organisaties/{ORGANISATIE_ID}/adressen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/mutaties/organisaties/14835/adressen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835
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
{
"type": "object",
"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": [
"postcode",
"nummer",
"type"
]
}Response
201VerbergBekijk
Headers
Content-Type: application/jsonAdres wijzigenPATCH/api/data/klantdossiers/{DOSSIER_ID}/mutaties/organisaties/{ORGANISATIE_ID}/adressen/{ADRES_ID}
Voorbeeld URI
PATCH https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/mutaties/organisaties/14835/adressen/7797
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835- ADRES_ID
int(verplicht) Voorbeeld: 7797
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"nummer": "4",
"toevoeging": "A"
}Schema
{
"type": "object",
"properties": {
"postcode": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"nummer": {
"type": "string",
"minLength": 1,
"maxLength": 25
},
"toevoeging": {
"type": "string",
"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"
]
}
},
"additionalProperties": false
}Response
204VerbergBekijk
Headers
Content-Type: application/jsonAdres verwijderenDELETE/api/data/klantdossiers/{DOSSIER_ID}/mutaties/organisaties/{ORGANISATIE_ID}/adressen/{ADRES_ID}
Voorbeeld URI
DELETE https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/mutaties/organisaties/14835/adressen/7797
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835- ADRES_ID
int(verplicht) Voorbeeld: 7797
Response
204VerbergBekijk
Headers
Content-Type: application/jsonEmailadres toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/mutaties/organisaties/{ORGANISATIE_ID}/emailadressen
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/mutaties/organisaties/14835/emailadressen
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"naam": "particulier@home.nl",
"type": "Algemeen"
}Schema
{
"type": "object",
"properties": {
"naam": {
"type": "email"
},
"type": {
"enum": [
"Zakelijk",
"Prive",
"Algemeen"
]
}
},
"additionalProperties": false,
"required": [
"naam",
"type"
]
}Response
201VerbergBekijk
Headers
Content-Type: application/jsonEmailadres wijzigenPATCH/api/data/klantdossiers/{DOSSIER_ID}/mutaties/organisaties/{ORGANISATIE_ID}/emailadressen/{EMAILADRES_ID}
Voorbeeld URI
PATCH https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/mutaties/organisaties/14835/emailadressen/7797
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835- EMAILADRES_ID
int(verplicht) Voorbeeld: 7797
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"naam": "particulier@gmail.nl"
}Schema
{
"type": "object",
"properties": {
"naam": {
"type": "string",
"format": "email",
"maxLength": 255
}
},
"additionalProperties": false,
"required": [
"naam"
]
}Response
204VerbergBekijk
Headers
Content-Type: application/jsonEmailadres verwijderenDELETE/api/data/klantdossiers/{DOSSIER_ID}/mutaties/organisaties/{ORGANISATIE_ID}/emailadressen/{EMAILADRES_ID}
Voorbeeld URI
DELETE https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/mutaties/organisaties/14835/emailadressen/7797
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835- EMAILADRES_ID
int(verplicht) Voorbeeld: 7797
Response
204VerbergBekijk
Headers
Content-Type: application/jsonRekeningnummer toevoegenPOST/api/data/klantdossiers/{DOSSIER_ID}/mutaties/organisaties/{ORGANISATIE_ID}/rekeningnummers
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/mutaties/organisaties/14835/rekeningnummers
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"iban": "NL25RABO0136907539",
"bic": "RABONL2U",
"land": "NL",
"type": "Incasso"
}Schema
{
"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"
]
}Response
201VerbergBekijk
Headers
Content-Type: application/jsonRekeningnummer wijzigenPATCH/api/data/klantdossiers/{DOSSIER_ID}/mutaties/organisaties/{ORGANISATIE_ID}/rekeningnummers/{REKENINGNUMMER_ID}
Voorbeeld URI
PATCH https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/mutaties/organisaties/14835/rekeningnummers/1964
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835- REKENINGNUMMER_ID
int(verplicht) Voorbeeld: 1964
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"iban": "NL25RABO0136907539"
}Schema
{
"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"
]
}
},
"additionalProperties": false
}Response
204VerbergBekijk
Headers
Content-Type: application/jsonRekeningnummer verwijderenDELETE/api/data/klantdossiers/{DOSSIER_ID}/mutaties/organisaties/{ORGANISATIE_ID}/rekeningnummers/{REKENINGNUMMER_ID}
Voorbeeld URI
DELETE https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/mutaties/organisaties/14835/rekeningnummers/1964
URI Parameters
VerbergBekijk
- DOSSIER_ID
int(verplicht) Voorbeeld: 5526- ORGANISATIE_ID
int(verplicht) Voorbeeld: 14835- REKENINGNUMMER_ID
int(verplicht) Voorbeeld: 1964
Response
204VerbergBekijk
Headers
Content-Type: application/jsonService ¶
Het access token dient aangevraagd te worden voor de webservice “service”, waarvoor toegang voor de scope “telefonie” verleend wordt.
Telefonie ¶
TelefonieGET/api/service/telefonie&telefoonnummer={TELEFOONNUMMER}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/service/telefonie&telefoonnummer=0612345678
URI Parameters
VerbergBekijk
- TELEFOONNUMMER
string(verplicht) Voorbeeld: 0612345678
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/service/telefonie"
}
},
"_embedded": {
"telefonie": [
{
"dossierId": "5526",
"omschrijving": "Klantdossier",
"dossierstatus": "Nieuw",
"correspondentieadres": "Groenhof 1, 1275BB, Huizen",
"kantoor": "Deelnemer00016319",
"adviseur": "Achternaam00112115, Voornaam (I.)",
"eerstePersoon": "Jansen, Aad (A.)",
"eerstePersoonTelefoonAlgemeen": "0612345678",
"eerstePersoonTelefoonMobiel": "0612345678",
"eerstePersoonEmail": "aad-jansen@mailprovider.nl",
"tweedePersoon": "Jansen - de Jong, Kim (K.)",
"tweedePersoonTelefoonAlgemeen": "0698765432",
"tweedePersoonTelefoonMobiel": "0698765432",
"tweedePersoonEmail": "kimberly_dejong65@mailprovider.nl",
"organisatie": null,
"organisatieTelefoonAlgemeen": null,
"organisatieTelefoonMobiel": null,
"organisatieEmail": null,
"_links": {
"self": {
"href": "/api/service/telefonie"
},
"dossierInElements": {
"href": "/?data=KEIbAmQJt8itXig981jjABFFiQgL9RV4vwOObFbg0o3A9ymPm8SPkVTIOl7qMzrcD%2F9u1%2BUhLD2%2FOxUhdb9v0A%3D%3D"
},
"registratieAanmakenInDossier": {
"href": "/?data=6Wx8Ocz3mD5YlbQn5BqQU53Vt3lSnTkNsb%2Fhx0yWMLsCQF8oGnuAsqKft4ljNVSgFZkBY84iKLMd%2BF8WUQFtl29oSw%2FFheeA6Ix8Eu%2BQ6RZHe1qqLOdWWfNY91hw4%2FOB"
}
}
}
]
}
}HDN ¶
Het access token dient aangevraagd te worden voor de webservice “hdn”, waarvoor toegang voor de scope “hdn” verleend wordt.
Algemeen ¶
AlgemeenPOST/api/hdn/v2
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/hdn/v2
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"header": {
"receiver": "002031",
"sender": "001031",
"requestSchema": {
"messageType": "AX OfferteAanvraag",
"receiverCode": "EX Example Bank",
"schemaVersion": "24.0"
}
},
"miscellaneous": {
"senderName": "Verzendernaam",
"receiverName": "Ontvangernaam",
"sendingApplication": {
"applicationName": "Applicatie",
"applicationVersion": "1231",
"sendingDateTime": "2024-03-15T14:51:21.900Z"
}
},
"message": {
"data": "XML data base64 encoded"
},
"eblinqx": {
"dossiernummer": 1231,
"aanvraagvolgnummer": "string"
}
}Schema
{
"properties": {
"header": {
"type": "object",
"properties": {
"sender": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "[0-9]{6}"
},
"receiver": {
"type": "string",
"minLength": 6,
"maxLength": 6,
"pattern": "[0-9]{6}"
},
"requestSchema": {
"type": "object",
"properties": {
"messageType": {
"enum": [
"AX OfferteAanvraag",
"LX LevenAanvraag",
"KX KredietAanvraag"
]
},
"receiverCode": {
"type": "string"
},
"schemaVersion": {
"type": "string"
}
},
"required": [
"messageType",
"receiverCode",
"schemaVersion"
]
}
},
"required": [
"requestSchema"
],
"additionalProperties": false
},
"message": {
"type": "object",
"properties": {
"data": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false,
"required": [
"data"
]
},
"miscellaneous": {
"type": "object",
"properties": {
"senderName": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"receiverName": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"sendingApplication": {
"type": "object",
"properties": {
"applicationName": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"applicationVersion": {
"type": "string",
"minLength": 1
},
"sendingDateTime": {
"type": "string",
"format": "date-time"
}
},
"required": [
"applicationName",
"applicationVersion"
],
"additionalProperties": false
},
"additionalProperties": false,
"required": [
"sendingApplication"
]
}
},
"eblinqx": {
"type": "object",
"properties": {
"eblinqxId": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"dossiernummer": {
"type": "integer",
"minimum": 1
},
"aanvraagvolgnummer": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
}
},
"required": [
"header",
"message",
"miscellaneous"
],
"additionalProperties": false
}Response
200Response
404VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"error": "Dossier kan niet gevonden worden"
}Response
400VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"error": "Invalide XML"
}DEPRECATED ¶
Deze endpoints worden ondersteunt tot 1 juni 2025
Het access token dient aangevraagd te worden voor de webservice “hdn”, waarvoor toegang voor de scope “findesk”, of “finix”, “hdn”, “myview” verleend wordt.
AlgemeenPOST/api/hdn
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/hdn
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
<?xml version="1.0"?>
<axbestand>
DQo8T2ZmZXJ0ZUFhbnZyYWFnPg0KCTxIZWFkZXI+DQoJCTxWZXJ6ZW5kZXJOckhETj4zMjEz
MTE8L1ZlcnplbmRlck5ySEROPg0KCQk8VmVyemVuZGVyTmFhbT5EZSBIeXBvdGhlZWthZHZp
c2V1ciBDdWlqY2s8L1ZlcnplbmRlck5hYW0+DQoJCTxPbnR2YW5nZXJOckhETj4zMTk2Njg8
L09udHZhbmdlck5ySEROPg0KCQk8T250dmFuZ2VyTmFhbT5NVU5UIEh5cG90aGVrZW48L09u
dHZhbmdlck5hYW0+DQoJCTxCZXJpY2h0U29vcnQ+QVggT2ZmZXJ0ZUFhbnZyYWFnPC9CZXJp
Y2h0U29vcnQ+DQoJCTxCZXJpY2h0VmVyc2llPjE1LjA8L0JlcmljaHRWZXJzaWU+DQoJCTxP
bnR2YW5nZXJDb2RlPk1UIE11bnQgSHlwb3RoZWtlbjwvT250dmFuZ2VyQ29kZT4NCgkJPFZl
cnplbmREdD4NCgkJCTxEYWc+MTI8L0RhZz4NCgkJCTxNYWFuZD43PC9NYWFuZD4NCgkJCTxK
YWFyPjIwMTY8L0phYXI+DQoJCTwvVmVyemVuZER0Pg0KCQk8VmVyemVuZFRpamQ+DQoJCQk8
VXVyPjEyPC9VdXI+DQoJCQk8TWludXRlbj40MTwvTWludXRlbj4NCgkJCTxTZWNvbmRlbj40
NTwvU2Vjb25kZW4+DQoJCTwvVmVyemVuZFRpamQ+DQoJCTxBYW52cmFhZ1ZvbGdOcj5JU1ct
o=
</axbestand>Response
201VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"succes" => true,
"description" => null
}FindeskPOST/api/hdn/findesk
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/hdn/findesk
Request
VerbergBekijk
Headers
Content-Type: application/xmlBody
<?xml version="1.0"?>
<findesk>
<XML application="Findesk"/>
<axbestand>
DQo8T2ZmZXJ0ZUFhbnZyYWFnPg0KCTxIZWFkZXI+DQoJCTxWZXJ6ZW5kZXJOckhETj4zMjEz
MTE8L1ZlcnplbmRlck5ySEROPg0KCQk8VmVyemVuZGVyTmFhbT5EZSBIeXBvdGhlZWthZHZp
c2V1ciBDdWlqY2s8L1ZlcnplbmRlck5hYW0+DQoJCTxPbnR2YW5nZXJOckhETj4zMTk2Njg8
L09udHZhbmdlck5ySEROPg0KCQk8T250dmFuZ2VyTmFhbT5NVU5UIEh5cG90aGVrZW48L09u
dHZhbmdlck5hYW0+DQoJCTxCZXJpY2h0U29vcnQ+QVggT2ZmZXJ0ZUFhbnZyYWFnPC9CZXJp
Y2h0U29vcnQ+DQoJCTxCZXJpY2h0VmVyc2llPjE1LjA8L0JlcmljaHRWZXJzaWU+DQoJCTxP
bnR2YW5nZXJDb2RlPk1UIE11bnQgSHlwb3RoZWtlbjwvT250dmFuZ2VyQ29kZT4NCgkJPFZl
cnplbmREdD4NCgkJCTxEYWc+MTI8L0RhZz4NCgkJCTxNYWFuZD43PC9NYWFuZD4NCgkJCTxK
YWFyPjIwMTY8L0phYXI+DQoJCTwvVmVyemVuZER0Pg0KCQk8VmVyemVuZFRpamQ+DQoJCQk8
VXVyPjEyPC9VdXI+DQoJCQk8TWludXRlbj40MTwvTWludXRlbj4NCgkJCTxTZWNvbmRlbj40
NTwvU2Vjb25kZW4+DQoJCTwvVmVyemVuZFRpamQ+DQoJCTxBYW52cmFhZ1ZvbGdOcj5JU1ct
o=
</axbestand>
</findesk>Response
201VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"succes" => true,
"description" => null
}FinixPOST/api/hdn/finix
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/hdn/finix
Request
VerbergBekijk
Headers
Content-Type: application/xmlBody
<?xml version="1.0"?>
<finix>
<XML application="Finix"/>
<axbestand>
DQo8T2ZmZXJ0ZUFhbnZyYWFnPg0KCTxIZWFkZXI+DQoJCTxWZXJ6ZW5kZXJOckhETj4zMjEz
MTE8L1ZlcnplbmRlck5ySEROPg0KCQk8VmVyemVuZGVyTmFhbT5EZSBIeXBvdGhlZWthZHZp
c2V1ciBDdWlqY2s8L1ZlcnplbmRlck5hYW0+DQoJCTxPbnR2YW5nZXJOckhETj4zMTk2Njg8
L09udHZhbmdlck5ySEROPg0KCQk8T250dmFuZ2VyTmFhbT5NVU5UIEh5cG90aGVrZW48L09u
dHZhbmdlck5hYW0+DQoJCTxCZXJpY2h0U29vcnQ+QVggT2ZmZXJ0ZUFhbnZyYWFnPC9CZXJp
Y2h0U29vcnQ+DQoJCTxCZXJpY2h0VmVyc2llPjE1LjA8L0JlcmljaHRWZXJzaWU+DQoJCTxP
bnR2YW5nZXJDb2RlPk1UIE11bnQgSHlwb3RoZWtlbjwvT250dmFuZ2VyQ29kZT4NCgkJPFZl
cnplbmREdD4NCgkJCTxEYWc+MTI8L0RhZz4NCgkJCTxNYWFuZD43PC9NYWFuZD4NCgkJCTxK
YWFyPjIwMTY8L0phYXI+DQoJCTwvVmVyemVuZER0Pg0KCQk8VmVyemVuZFRpamQ+DQoJCQk8
VXVyPjEyPC9VdXI+DQoJCQk8TWludXRlbj40MTwvTWludXRlbj4NCgkJCTxTZWNvbmRlbj40
NTwvU2Vjb25kZW4+DQoJCTwvVmVyemVuZFRpamQ+DQoJCTxBYW52cmFhZ1ZvbGdOcj5JU1ct
o=
</axbestand>
</finix>Response
201VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"succes" => true,
"description" => null
}MyViewPOST/api/hdn/myview
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/hdn/myview
Request
VerbergBekijk
Headers
Content-Type: application/xmlBody
<?xml version="1.0"?>
<myview>
<XML application="MyView"/>
<axbestand>
DQo8T2ZmZXJ0ZUFhbnZyYWFnPg0KCTxIZWFkZXI+DQoJCTxWZXJ6ZW5kZXJOckhETj4zMjEz
MTE8L1ZlcnplbmRlck5ySEROPg0KCQk8VmVyemVuZGVyTmFhbT5EZSBIeXBvdGhlZWthZHZp
c2V1ciBDdWlqY2s8L1ZlcnplbmRlck5hYW0+DQoJCTxPbnR2YW5nZXJOckhETj4zMTk2Njg8
L09udHZhbmdlck5ySEROPg0KCQk8T250dmFuZ2VyTmFhbT5NVU5UIEh5cG90aGVrZW48L09u
dHZhbmdlck5hYW0+DQoJCTxCZXJpY2h0U29vcnQ+QVggT2ZmZXJ0ZUFhbnZyYWFnPC9CZXJp
Y2h0U29vcnQ+DQoJCTxCZXJpY2h0VmVyc2llPjE1LjA8L0JlcmljaHRWZXJzaWU+DQoJCTxP
bnR2YW5nZXJDb2RlPk1UIE11bnQgSHlwb3RoZWtlbjwvT250dmFuZ2VyQ29kZT4NCgkJPFZl
cnplbmREdD4NCgkJCTxEYWc+MTI8L0RhZz4NCgkJCTxNYWFuZD43PC9NYWFuZD4NCgkJCTxK
YWFyPjIwMTY8L0phYXI+DQoJCTwvVmVyemVuZER0Pg0KCQk8VmVyemVuZFRpamQ+DQoJCQk8
VXVyPjEyPC9VdXI+DQoJCQk8TWludXRlbj40MTwvTWludXRlbj4NCgkJCTxTZWNvbmRlbj40
NTwvU2Vjb25kZW4+DQoJCTwvVmVyemVuZFRpamQ+DQoJCTxBYW52cmFhZ1ZvbGdOcj5JU1ct
o=
</axbestand>
</myview>Response
201VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"succes" => true,
"description" => null
}AdviesboxPOST/api/hdn/adviesbox
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/hdn/adviesbox
Request
VerbergBekijk
Headers
Content-Type: application/xmlBody
<?xml version="1.0"?>
<adviesbox>
<XML application="Adviesbox"/>
<axbestand>
DQo8T2ZmZXJ0ZUFhbnZyYWFnPg0KCTxIZWFkZXI+DQoJCTxWZXJ6ZW5kZXJOckhETj4zMjEz
MTE8L1ZlcnplbmRlck5ySEROPg0KCQk8VmVyemVuZGVyTmFhbT5EZSBIeXBvdGhlZWthZHZp
c2V1ciBDdWlqY2s8L1ZlcnplbmRlck5hYW0+DQoJCTxPbnR2YW5nZXJOckhETj4zMTk2Njg8
L09udHZhbmdlck5ySEROPg0KCQk8T250dmFuZ2VyTmFhbT5NVU5UIEh5cG90aGVrZW48L09u
dHZhbmdlck5hYW0+DQoJCTxCZXJpY2h0U29vcnQ+QVggT2ZmZXJ0ZUFhbnZyYWFnPC9CZXJp
Y2h0U29vcnQ+DQoJCTxCZXJpY2h0VmVyc2llPjE1LjA8L0JlcmljaHRWZXJzaWU+DQoJCTxP
bnR2YW5nZXJDb2RlPk1UIE11bnQgSHlwb3RoZWtlbjwvT250dmFuZ2VyQ29kZT4NCgkJPFZl
cnplbmREdD4NCgkJCTxEYWc+MTI8L0RhZz4NCgkJCTxNYWFuZD43PC9NYWFuZD4NCgkJCTxK
YWFyPjIwMTY8L0phYXI+DQoJCTwvVmVyemVuZER0Pg0KCQk8VmVyemVuZFRpamQ+DQoJCQk8
VXVyPjEyPC9VdXI+DQoJCQk8TWludXRlbj40MTwvTWludXRlbj4NCgkJCTxTZWNvbmRlbj40
NTwvU2Vjb25kZW4+DQoJCTwvVmVyemVuZFRpamQ+DQoJCTxBYW52cmFhZ1ZvbGdOcj5JU1ct
o=
</axbestand>
</adviesbox>Response
201VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"succes" => true,
"description" => null
}Leadinbox ¶
Het access token dient aangevraagd te worden voor de webservice “leadinbox”, waarvoor toegang voor de scope “leadinbox_insert” verleend wordt.
Lead toevoegen ¶
Lead toevoegenPOST/api/leadinbox
Middels onderstaande elementen uit het ‘verwerking’ element kunt u de wijze waarop Faster Forward Elements het dossier matched beinvloeden:
-
matchDossierOngeachtAantalPersonen
- hiermee kan worden aangegeven of het aantal personen uit de XML overeen dient te komen met het aantal personen uit het dossier
-
matchDossierOngeachtKantoor
- hiermee kan worden aangeven of het kantoor uit de XML overeen dient te komen met het kantoor van het dossier
Middels onderstaande elementen uit het ‘verwerking’ element kunt u de wijze waarop Faster Forward Elements de lead verwerkt beinvloeden:
-
verwerkDirectNaarDossierBijGeenMatch
- hiermee kan worden aangeven of de lead direct tot een nieuw dossier dient te worden verwerkt of de lead dient uit te vallen
-
verwerkDirectNaarDossierBijMatch
- hiermee kan worden aangeven of de lead direct dient te worden verwerkt of de lead dient uit te vallen
Onderstaand voorbeeld representeert een POST request om een lead aan te maken. U kunt de volledige opbouw en mogelijkheden van de leadinbox xml opzoeken in onderstaande XML schemes
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/leadinbox
Request
VerbergBekijk
Headers
Content-Type: application/xmlBody
<?xml version="1.0"?>
<leadinbox>
<dossier>
<kantoor>{ORGANISATIE_ID}</kantoor>
<status>1</status>
</dossier>
<personen>
<persoon>
<rol>eerste aanvrager</rol>
<achternaam>FFWD test</achternaam>
<geboorteplaats>Bergen op Zoom</geboorteplaats>
</persoon>
</personen>
<verwerking>
<matchDossierOngeachtAantalPersonen>0</matchDossierOngeachtAantalPersonen>
<verwerkDirectNaarDossierBijGeenMatch>1</verwerkDirectNaarDossierBijGeenMatch>
<verwerkDirectNaarDossierBijMatch>0</verwerkDirectNaarDossierBijMatch>
<matchDossierOngeachtKantoor>0</matchDossierOngeachtKantoor>
</verwerking>
</leadinbox>Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"succes": true,
"description": "3"
}AFD ¶
Het opvoeren van een AFD bericht via de API gaat middels een JSON body, waarin het “kantoorId” en een “data” element zijn opgenomen.
Het “data” element bevat de base64-geëncodeerde versie van het AFD bericht. Om deze koppeling te kunnen bewerkstelligen is het noodzakelijk om in het AFD bericht een “AL_CPRELNR” element op te nemen met daarin eveneens het kantoorId. Dit kantoorId dient hetzelfde te zijn als het kantoorId uit de JSON body.
Dit ziet er als volgt uit:
<Pakket>
<Mantel>
<AL>
<AL_CPRELNR>14830</AL_CPRELNR>
<AL_ENTITEI>AL</AL_ENTITEI>
<AL_VRWRKCD>0</AL_VRWRKCD>
<AL_FUNCTIE>01</AL_FUNCTIE>
...Het access token dient aangevraagd te worden voor de webservice “afd”, waarvoor toegang voor de scope “afd_insert” verleend wordt.
Correspondentiebericht ¶
CorrespondentieberichtPOST/api/afd/correspondentie
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/afd/correspondentie
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"kantoorId": 14830,
"data": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPFBha2tldAo
gICAgPE1hbnRlbD4KICAgICAgICA8QUw+CiAgICAgICAgICAgIDxBTF9DUFJFTE
5SPjE0ODMwPC9BTF9DUFJFTE5SPgogICAgICAgICAgICA8QUxfRU5USVRFST5BT
..."
}Schema
{
"properties": {
"kantoorId": {
"type": "integer",
"minimum": 1
},
"data": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false,
"required": [
"kantoorId",
"data"
]
}Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"succes" => true,
"description" => 1
}Pakket of polis ¶
Pakket of polisPOST/api/afd/pakketofpolis
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/afd/pakketofpolis
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"kantoorId": 14830,
"data": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPFBha2tldAo
gICAgPE1hbnRlbD4KICAgICAgICA8QUw+CiAgICAgICAgICAgIDxBTF9DUFJFTE
5SPjE0ODMwPC9BTF9DUFJFTE5SPgogICAgICAgICAgICA8QUxfRU5USVRFST5BT
..."
}Schema
{
"properties": {
"kantoorId": {
"type": "integer",
"minimum": 1
},
"data": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false,
"required": [
"kantoorId",
"data"
]
}Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"succes" => true,
"description" => 1
}Conversie ¶
Voor het toevoegen van e-mails en documenten is het makkelijker om niet in te schieten via het klantdossier endpoint. Het klantdossier endpoint vereist dat je een aparte url gebruikt voor dossier en producttype.
Voor het toevoegen van een e-mail of document binnen de conversie endpoint wordt altijd dezelfde url gebruikt, in de body van het request kun je het dossier en product opgeven.
Het access token dient aangevraagd te worden voor de webservice “conversie”, waarvoor toegang voor de scope “email” of “documenten” verleend wordt.
E-mailboxen ophalen ¶
E-mailboxen ophalenGET/api/conversie/e-mailboxen
E-mail wordt toegevoegd aan een e-mailbox. Om een overzicht van de e-mailboxen te krijgen is deze endpoint gemaakt.
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/conversie/e-mailboxen
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/conversie/e-mailboxen"
}
},
"_embedded": {
"e-mailboxen": [
{
"naam": "adviseur@tussenpersoon.nl",
"omschrijving": "",
"afzendernaam": "Adviseurs",
"afzenderadres": "adviseur@tussenpersoon.nl",
"servertype": "pop3",
"id": 1,
"_links": {
"self": {
"href": "/api/conversie/e-mailboxen/1"
}
}
}
]
}
}E-mail toevoegen ¶
E-mail toevoegenPOST/api/conversie/e-mailboxen/{EMAILBOX_ID}/e-mails
Om een e-mail aan een dossier of product te koppelen kunnen in de body dossier en product gevuld worden.
Het raw element bevat de base64-geëncodeerde versie van het e-mailbericht. Ondersteunde bestandstypen zijn: .eml (RFC 822) en .msg (Microsoft Outlook).
Standaard wordt het onderwerp, de verzenddatum en ontvangstdatum uit de raw e-mail gehaald. Deze zijn echter ook mee te geven in het request.
De richting van de e-mail, (inkomen of uitgaand) is ook op te geven in de body. Valide waardes zijn in en out voor respectievelijk inkomende en uitgaande e-mail.
Als laatste is het mogelijk de e-mail te markeren als verwijderd uit inbox. Daarvoor dient er een datumtijd meegegeven te worden in verwijderdUitInbox.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/conversie/e-mailboxen/1/e-mails
URI Parameters
VerbergBekijk
- EMAILBOX_ID
int(verplicht) Voorbeeld: 1
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"dossier": {
"id": 5526
},
"product": {
"id": 6743
},
"richting": "in",
"raw": "UmV0dXJuLXBhdGg6IDx2ZXJ6ZW5kZXJAZm9vLmNvbT4KUmVjZWl2ZWQ6IGZyb20gc210cDA1LnNlbmRlcmlzcC5ubCAodW52ZXJpZmllZCBbMTIzLjQ1Ni4yNS4xMDVdKSBieSBNQUlMOS5uc2hvc3RzLmNvbQogKFZpcmNvbSBTTVRQUlMgNS4zMjMyKSB3aXRoIEVTTVRQIGlkIDxCMDA4NzgwMzYxM0BNQUlMOS5uc2hvc3RzLmNvbT4gZm9yIDxvbnR2YW5nZXJAZm9vLmNvbT47CiBTYXQsIDI4IE1heSAyMDA1IDE2OjI1OjAwIC0wNjAwClJlY2VpdmVkOiBmcm9tIFBDMS5tYWlsc2VydmVyMS5jb20gKGM1MTlkYmNjYS5jYWJsZS5zZW5kZXJpc3AubmwgWzg5LjE0Ny4xMDMuMjMyXSkKICAgICAgICBieSBzbXRwNS5zZW5kZXJpc3AubmwgKFBvc3RmaXgpIHdpdGggRVNNVFAgaWQgRDI0ODAyNTQzOAogICAgICAgIGZvciA8b250dmFuZ2VyQGZvby5jb20+OyBTdW4sIDI5IE1heSAyMDA1IDAwOjI1OjAwICswMjAwIChDRVNUKQpNZXNzYWdlLUlkOiA8NS4wLjIuMS4xLjIwMDUwNTI0MTAyODM1LjAxZGYzMjQxQHBvcC5tYWlsc2VydmVyMS5jb20+ClgtU2VuZGVyOiB0ZXN0QHBvcC5tYWlsc2VydmVyMS5jb20KWC1NYWlsZXI6IFFVQUxDT01NIFdpbmRvd3MgRXVkb3JhIFZlcnNpb24gNS4wLjIKRGF0ZTogU3VuLCAyOSBNYXkgMjAwNSAwMDoyNTowNyArMDIwMApUbzogb250dmFuZ2VyQGZvby5jb20KRnJvbTogVmVyemVuZGVyIE5hYW0gPHZlcnplbmRlckBmb28uY29tPgpTdWJqZWN0OiBlZW4gYWZiZWVsZGluZwpNaW1lLVZlcnNpb246IDEuMApDb250ZW50LVR5cGU6IG11bHRpcGFydC9taXhlZDsKICAgICAgICBib3VuZGFyeT0iPT09PT09PT09PT09PT09PT09PT09XzYwMjcwNzgyPT1fIgoKLS09PT09PT09PT09PT09PT09PT09PT1fNjAyNzA3ODI9PV8KQ29udGVudC1UeXBlOiB0ZXh0L3BsYWluOyBjaGFyc2V0PSJ1cy1hc2NpaSI7IGZvcm1hdD1mbG93ZWQKCmRpdCBpcyBoZXQgcG9ydGFhbGxvZ28KLS09PT09PT09PT09PT09PT09PT09PT1fNjAyNzA3ODI9PV8KQ29udGVudC1UeXBlOiBpbWFnZS9naWY7IG5hbWU9IlBvcnRhbC5naWYiOwogeC1tYWMtdHlwZT0iNDc0OTQ2NjYiOyB4LW1hYy1jcmVhdG9yPSI0QTU2NTc1MiIKQ29udGVudC1UcmFuc2Zlci1FbmNvZGluZzogYmFzZTY0CkNvbnRlbnQtRGlzcG9zaXRpb246IGF0dGFjaG1lbnQ7IGZpbGVuYW1lPSJQb3J0YWwuZ2lmIgoKUjBsR09EbGhJZ0FnQU1RZkFObmwyY2paeDZPeG9ybkV1T1BzNDVpbWw0bVlpZlAyOCtueDZVdFZTOWZkMTJ0M2EzeUpmTGpRdUt2Rgpxc1hOeE1IV3dWVmdWYjdUdlNrdktjemZ5emxBT2QzcDNzL2l6ZERZejJCdFlNdmR6TkhnMGJQTXNrRktRYks3c3YvLy95SDVCQUVBCkFCOEFMQUFBQUFBaUFDQUFBQVgvNENlT1pHbWVhS3F1NlNFSVhpd01CL2w0QUdzV2lxWDhpb0doOW5sZ0ZDK2k3ak04T0owSWh1ZHoKTUNDdVFvRmx5U0JjdjRQSUZJa2dtQW1QUWtHWk1sZ09YOElnOC9nZ0NtV0wzZ0tRc2dvUGNRUUFCZ0pCRHdSOEFBQWFCUWwxS3pGWApaeFlFTVJobUFJb1FEQWtFTEFwNFo2TjVpaHNiQXdzSktwQWZESGtBQVFNZUF4aUxBS2NiRng0UkRDZ0hnQVlZYVdVQUE1MFZDUVllCkFibTZIc29ud0ZBZWdRZ1dxUlBLblFzREdoY1lHaFFDMFNhMFgzRWJCaFVMSXdjTERCQVVGQUVhNUZNbTd3SUZ6SG9BRHdzNnNDSEEKZ0lLR0FBZ2RaQmp3SzBLSERnd2VMSnJqcXdTRGVnZ0RTSERBUU0yYUVzQUtNR2l3aUZORkVnWTAvMmlBd0JKQ0FKZXlUcGFJWWVIVQpIRFlXQk1SaTJhQ25CSllLVzQxUTRNRlVBQVluUFJoNHNFSGpSZ01NREJRd2tLRURCaE1DTVBDWk55NERQa0JOSllnVjRMQkRnZzRUCkl1UXpRT0FVaFFzU0RDVEk4ZUdGeHA0TkNsVEFrYUZDQmpZaUhqeW9lZUhnc1FRSVJIZ29BQUZ2M2c3NEZFaHpnNHRlQUFlcWlGZ3cKMExnbmh3S1FWUXdZZkRBaldiVWlEc1R6L0RrQlBoVFZtaUtFSUVGQTZCRWpHM0RZTFNDRGdSUUlkRFpsS1JiMGF5WU9kRHRZemdEMQpDUU1JMVFod3NOdkFiUkdGT0N4ZmJpRENsaE1MSWt3WW55QUQwcjdIOTJuZjNsMnl0QmlMcTFZWVg4RzlZcWtHcEFyb0xsVEZBUXd4CjJDZUNCWDFOa0V3R1ZSV3d4QklLRnNUUUNWb1QvTGJnRXRoNEFOZ0hJUUFBT3c9PQotLT09PT09PT09PT09PT09PT09PT09PV82MDI3MDc4Mj09Xy0t"
}Schema
{
"properties": {
"raw": {
"type": "string",
"minLength": 1
},
"dossier": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"product": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"schademelding": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"onderwerp": {
"type": "string",
"minLength": 1,
"maxLength": 700
},
"verzenddatum": {
"type": "string",
"format": "date-time"
},
"ontvangstdatum": {
"type": "string",
"format": "date-time"
},
"verwijderdUitInbox": {
"type": "string",
"format": "date-time"
},
"richting": {
"enum": [
"in",
"out"
]
}
},
"additionalProperties": false,
"required": [
"raw"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/conversie/1/e-mails/13Document toevoegen ¶
Document toevoegenPOST/api/conversie/documenten
Voeg een document toe aan een dossier
Let op: Als het protocol HDN is, zijn alleen PDF bestanden toegestaan.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/conversie/documenten
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"dossier": {
"id": 5526
},
"product": {
"id": 6743
},
"schademelding": {
"id": 1345
},
"map": {
"id": 12
},
"naam": "pdf-sample.pdf",
"extensie": "pdf",
"soortdocument": {
"id": 1
},
"data": "JVBERi0xLjMNJeLjz9MNCjcgMCBvYmoNPDwvTGluZWFyaXplZCAxL0wgNzk0NS9PIDkvRSAzNTI0L04gMS9UIDc2NTYvSCBbIDQ1MSAxMzddPj4NZW5kb2JqDSAgICAgICAgICAgICAgICAgICAgICAgDQoxMyAwIG9iag08PC9EZWNvZGVQYXJtczw8L0NvbHVtbnMgNC9QcmVkaWN0b3IgMTI+Pi9GaWx0ZXIvRmxhdGVEZWNvZGUvSURbPDREQzkxQTE4NzVBNkQ3MDdBRUMyMDNCQjAyMUM5M0EwPjxGNkM5MkIzNjhBOEExMzQwODQ1N0ExRDM5NUEzN0VCOT5dL0luZGV4WzcgMjFdL0luZm8gNiAwIFIvTGVuZ3RoIDUyL1ByZXYgNzY1Ny9Sb290IDggMCBSL1NpemUgMjgvVHlwZS9YUmVmL1dbMSAyIDFdPj5zdHJlYW0NCmjeYmJkEGBgYmCyARIMIIKxAUgwpwIJNkcg8eUYAxMjwzSQLAMjucR/xp1fAAIMAEykBvANCmVuZHN0cmVhbQ1lbmRvYmoNc3RhcnR4cmVmDQowDQolJUVPRg0KICAgICAgICANCjI3IDAgb2JqDTw8L0ZpbHRlci9GbGF0ZURlY29kZS9JIDY5L0xlbmd0aCA1OC9TIDM4Pj5zdHJlYW0NCmjeYmBgYGFgYPzPAATcNgyogJEBJMvRgCzGAsUMDA0M3Azc0x50JoA4zAwMWgIQLYwsAAEGAL/iBRkNCmVuZHN0cmVhbQ1lbmRvYmoNOCAwIG9iag08PC9NZXRhZGF0YSAxIDAgUi9QYWdlcyA1IDAgUi9UeXBlL0NhdGFsb2c+Pg1lbmRvYmoNOSAwIG9iag08PC9Db250ZW50cyAxMSAwIFIvQ3JvcEJveFswIDAgNTk1IDg0Ml0vTWVkaWFCb3hbMCAwIDU5NSA4NDJdL1BhcmVudCA1IDAgUi9SZXNvdXJjZXMgMTQgMCBSL1JvdGF0ZSAwL1R5cGUvUGFnZT4+DWVuZG9iag0xMCAwIG9iag08PC9GaWx0ZXIvRmxhdGVEZWNvZGUvRmlyc3QgOTQvTGVuZ3RoIDc3My9OIDEzL1R5cGUvT2JqU3RtPj5zdHJlYW0NCmjevFRtb9owEP4r/gPgl9hxIlVI0I6u0lqhJls/RPmQgguRQoISV6P/fncJLoG1K6XSiMz55e58vue545IwwhXhnibcJyKAlSaeCAgPiOeDCImUighGVMiI4CQUoCYIZ1oS4YGt5kRIsGIhEeAokLAGFcYkubigl1VR1dEmmxtcNAovY+R+NKLftvY6spnFg+uI4/XdwbQqLexNBcYAWzSOBQbQTSXe3k19vLibBnhnZz6rq3lkbEJnV1Mam61NR6OEXmbF/fUEr8rW6ywRQwE/iPRQpvQ2s3W+TdhQcnQ+FBwdDxkPPRCe0rjSXEFe2JDzUKAImEIdjZENQ8VUSh9WuTWzKi9t0m0ReOGQBSFEk0IY0Zg8ZUVjaHSLpoLG9/RmYUqb2xcav2zMPj+jEehf5U9Ppjbl3DQJp4/PRWFsulMs59UiL5et3iRrDCaQRi/rx6p4PURYMVXR86NFI7TkNK5+ljkoGMJ3ScUztG+djZs5RERCpiB/m+8mX64sYfTKdPsDwTmdFtmyAca0VpNJtU0GPtBn4GkkgQfMYDJI29O7bG3ouM6zYjCpisVtTG9sVuTzcbksDPiNrFn/Aip6+zDwqjrf2Ko+fN2BF/dG+pCX47LJX9fTvG7s5SqrXXx7d0hsfPCPbKfBub9PTv1sYpel1hBcL+yqSYRGSn7ta2nyKn3O39Dxff2hH6X81rovuxMXpZPuDi8IWy3P89I+wEHI3wPYdwDLHsDKR4CZBoCxUzCmewDH+do0d+b3fbXOyln0DsrsY4z/dnQW0IIfAa3lKUCrw2RDjWPa2tGmVu3/T4UcQe1me6iOAXXQO8hCKd/QlLCr2KHEyHCOo08ADcPt49i9A6ggeie7uBgj/+vTPku/1GV8BSQUypHQ08dd5nzqOfPzCOcdEg40Tmosny3JMOiXpNRdSXLBfMyGeL8k277ZZeYoRQOuPtOF/+n3vNypo2IV/Ixi3X+nFuipPfeDjsxccbr/rqgP+zHu9IoRCtEVo4tiV9JAiD8CDAA+0IrxDQplbmRzdHJlYW0NZW5kb2JqDTExIDAgb2JqDTw8L0ZpbHRlci9GbGF0ZURlY29kZS9MZW5ndGggMTUzMD4+c3RyZWFtDQpIibRXS2/jNhBGr/4Vc1uqiBW9H8d0tynQ02IroIduD7LEJCpk0RDppPlT/Y2dB2l7nS0KLFoEUPgacuabmW/GP3Sb267LIIXuYZMWcVJAgn8yytI8rqukgrqscZ7k0O03t+9tCYPlYwnYYXP70y8pPNrNNomTJKugGzY0qhroXja/qbsoTeJMjdG2jlNldhqibUpD3GjiWg3RNlNrtK3iCnd7Bx8/3MP9RAuNmrWNfu9+Jh0Lr2MmCmbQtHGbkXJZG+eZKMc6JK3XIaMR6zDiu3/BR7O6fjdr+GBQhyRu1XDc68XBfVTGucJFWlv3uJmjgqjLZ4Xa8ObnCCZLqieqh+MyPevV9rMsPEwzWZXhyKx7FONV9xRGh5WMb5W2en32L+sow2+4cZ7ZzAS2aZyW0H1gCJPGG9K2mRhiHqIcYYGI79dRgaDxRNbN4uzN5TxK8LvymKyKC9WzjHPTEm1b9MsjuadRN3ySRQc+IaKzOYq05S0RXkZ4lFWZH54mkbFRosDIvV5RL8GXvcpTYrLFm0XKWzEamR5JUdJUX4i6G5AXdbQtcc9r3dMs9waOorGIWQuIFWHafe+jogiRSSMCEwGE/nCYp6F3k1mgR8MOc+/IiXC0rEam9AjOwLBqCdEe3yqU0zC5OPgsi3PvspTC8BRxjJkEUCvYTh7HRWYjX1rypaWaxXMSQg8Somgc6NkfG/iYW80yDYQXQ5XhEsXwOFm3TrujmGJRPzAYpIPZawsUK1cBJqDUJ1BqUfywGsyQvQUU3Jtl5hda8h1mmQK9sFqYtua4OM2BXRNGL5N7Ik0HVs9LDcCpYZ96MgBTC4M+V9PyGNFlgt/tvWcfAbJhJFkrUkh9F3V/UPpX/lBcVJj+eAYBlZ3GE4NwV0id0htWtSXfc7e8mkXfoJNfX540elOEPaugEV6YYUm9cJ0KKDCgx8xBI7BIT9G2wUAjr2aKDYzhbiYqyBPGSZmjxPiiCR4OIZ4HAqHAE+JA/DCm/YxihoJOhfmw+oUeccMkYLy2rCu5sQjGpj6006SpROFPmrXr+TtGkk40XjE7ChVzpH3SA69NxHuNOkxyZOHjTiIVk4gEZExRdL7E8wwNEQOPBk8N3yCn9nK5aOJkYsFiVMrK5AcYcBcqL4Rxpd5FmIJVEEMPyPKlnvClBhZ2+vKiIx+yXj0yYIu1jbjoq+nwhiNGs7zDYEXw4akX7iYoiQPgzB+eGij1LDLHP1EGCZzTtqK0tVdJgPqU35gHxdfyQEJjG4ZkEhFSTYx7jVyotD6hsAUoLy4qzxeVclE/v/SvXByR+JEF4LBOSESDL6ZoiVpXzTNZc/PrVTXHRGov8i7JTvj7ggfMy1RbUUUmoca/MwkTUQXjxVE/iyPEP/U1vZDfi+K/xDb0GWndppfQpgRtjnQ3cTGqEdqe/xOZIgwvyIYp4fEaZdQKEHoogwSO1efLrWufUOvwluXkcS6NtfqzH97inF3hHDRvQ4dEFYNJh6OWbOi5QXF6pNIr7YtsEN5hex1n3yz5fobKLtYu7kOseXBkKwmtTL2jMBgKNPmZwr5MvSqkHvLt2gc3F/ysb3awNGdpiAes9Q7rlVAakfJlG0QlXQTZBmx/qFkJzQxnJ9WkSkmtXoyD2VgspkdNKRy6gbMtLIG2SNvmDbpq29LsnCo+jJ8xDZgQM/Y2Zh3G9bRgWnCiZGp/QL5CNtxN8+SIiNX/yQzbs5oUvkHLDvnpQfyPSQR3g4xWbss/6X4MLdFKvbA/1zN+5BJ2CJVGgm40L8ts+pG7KoksrKG7U+ELr2D8ZESPQfTUxiCJ7i5Z+hwqeXMR9UQOFE90QYW6YdtEs7CqsSX9dyC/mV1zgbBoGt8+vTfsSYz4gb9OflOcOsEaSfFUOHNPvumpvabxKnksG2D3sjr7kyvLYSmRZSqCPKXKGIQm/0NGjlKnzaPBX3n9tL9p9D6Tm2QR3fdVF4SI4ah9pHAFjl9EXUYghV0eY680/EukCF0CF2hl3QXtEelReBHnc6uh4Ff67sSBP3abvwcArRiH3QoNCmVuZHN0cmVhbQ1lbmRvYmoNMTIgMCBvYmoNPDwvRmlsdGVyL0ZsYXRlRGVjb2RlL0xlbmd0aCAyMDg+PnN0cmVhbQ0KSIlUkL0OwjAMhPc+hUcQQ9rOVRdYOvAjCuxp4laRiBO56dC3JykFxBBL9uXTnS32zaEhE0Bc2KkWA/SGNOPoJlYIHQ6GoChBGxXWbqnKSg8iwu08BrQN9Q6qKhPXKI6BZ9i0s+3cc5dvQZxZIxsaYHMr7o84aCfvn2iRAuRQ16Cxz8T+KP1JWozyii7zYjV0GkcvFbKkAaHKi/pdkPS/9iG6/t3+vlZlXpZ1FomPluC0yddbTcwx1rLukihlMITfi3jnk2V62UuAAQBDyGk/Cg0KZW5kc3RyZWFtDWVuZG9iag0xIDAgb2JqDTw8L0xlbmd0aCAzNjU2L1N1YnR5cGUvWE1ML1R5cGUvTWV0YWRhdGE+PnN0cmVhbQ0KPD94cGFja2V0IGJlZ2luPSLvu78iIGlkPSJXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQiPz4KPHg6eG1wbWV0YSB4bWxuczp4PSJhZG9iZTpuczptZXRhLyIgeDp4bXB0az0iQWRvYmUgWE1QIENvcmUgNC4yLjEtYzA0MyA1Mi4zNzI3MjgsIDIwMDkvMDEvMTgtMTU6MDg6MDQgICAgICAgICI+CiAgIDxyZGY6UkRGIHhtbG5zOnJkZj0iaHR0cDovL3d3dy53My5vcmcvMTk5OS8wMi8yMi1yZGYtc3ludGF4LW5zIyI+CiAgICAgIDxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSIiCiAgICAgICAgICAgIHhtbG5zOmRjPSJodHRwOi8vcHVybC5vcmcvZGMvZWxlbWVudHMvMS4xLyI+CiAgICAgICAgIDxkYzpmb3JtYXQ+YXBwbGljYXRpb24vcGRmPC9kYzpmb3JtYXQ+CiAgICAgICAgIDxkYzpjcmVhdG9yPgogICAgICAgICAgICA8cmRmOlNlcT4KICAgICAgICAgICAgICAgPHJkZjpsaT5jZGFpbHk8L3JkZjpsaT4KICAgICAgICAgICAgPC9yZGY6U2VxPgogICAgICAgICA8L2RjOmNyZWF0b3I+CiAgICAgICAgIDxkYzp0aXRsZT4KICAgICAgICAgICAgPHJkZjpBbHQ+CiAgICAgICAgICAgICAgIDxyZGY6bGkgeG1sOmxhbmc9IngtZGVmYXVsdCI+VGhpcyBpcyBhIHRlc3QgUERGIGZpbGU8L3JkZjpsaT4KICAgICAgICAgICAgPC9yZGY6QWx0PgogICAgICAgICA8L2RjOnRpdGxlPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIj4KICAgICAgICAgPHhtcDpDcmVhdGVEYXRlPjIwMDAtMDYtMjlUMTA6MjE6MDgrMTE6MDA8L3htcDpDcmVhdGVEYXRlPgogICAgICAgICA8eG1wOkNyZWF0b3JUb29sPk1pY3Jvc29mdCBXb3JkIDguMDwveG1wOkNyZWF0b3JUb29sPgogICAgICAgICA8eG1wOk1vZGlmeURhdGU+MjAxMy0xMC0yOFQxNToyNDoxMy0wNDowMDwveG1wOk1vZGlmeURhdGU+CiAgICAgICAgIDx4bXA6TWV0YWRhdGFEYXRlPjIwMTMtMTAtMjhUMTU6MjQ6MTMtMDQ6MDA8L3htcDpNZXRhZGF0YURhdGU+CiAgICAgIDwvcmRmOkRlc2NyaXB0aW9uPgogICAgICA8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIgogICAgICAgICAgICB4bWxuczpwZGY9Imh0dHA6Ly9ucy5hZG9iZS5jb20vcGRmLzEuMy8iPgogICAgICAgICA8cGRmOlByb2R1Y2VyPkFjcm9iYXQgRGlzdGlsbGVyIDQuMCBmb3IgV2luZG93czwvcGRmOlByb2R1Y2VyPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6eG1wTU09Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9tbS8iPgogICAgICAgICA8eG1wTU06RG9jdW1lbnRJRD51dWlkOjA4MDVlMjIxLTgwYTgtNDU5ZS1hNTIyLTYzNWVkNWMxZTJlNjwveG1wTU06RG9jdW1lbnRJRD4KICAgICAgICAgPHhtcE1NOkluc3RhbmNlSUQ+dXVpZDo2MmQ2YWU2ZC00M2M0LTQ3MmQtOWIyOC03YzRhZGQ4ZjllNDY8L3htcE1NOkluc3RhbmNlSUQ+CiAgICAgIDwvcmRmOkRlc2NyaXB0aW9uPgogICA8L3JkZjpSREY+CjwveDp4bXBtZXRhPgogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgCjw/eHBhY2tldCBlbmQ9InciPz4NCmVuZHN0cmVhbQ1lbmRvYmoNMiAwIG9iag08PC9GaWx0ZXIvRmxhdGVEZWNvZGUvRmlyc3QgNC9MZW5ndGggNDgvTiAxL1R5cGUvT2JqU3RtPj5zdHJlYW0NCmjeMlUwULCx0XfOL80rUTDU985MKY62BIoFxeqHVBak6gckpqcW29kBBBgA1ncLgA0KZW5kc3RyZWFtDWVuZG9iag0zIDAgb2JqDTw8L0ZpbHRlci9GbGF0ZURlY29kZS9GaXJzdCA0L0xlbmd0aCAxNjcvTiAxL1R5cGUvT2JqU3RtPj5zdHJlYW0NCmjePMvBCsIwEEXRX5mdDaKdxCpVSqFY3AkuBNexSelA6EAyRfx7A4qPu3znAAhNU3aLTByLwVkKb1Weo7dCPPdWfNGfDOYdzFGj0VivtV4hrn6vrK40RE48Cjw4Oqi3qMoruz/WuwxrvTeV3m2w+uJbZLcMPhZdxk8r0FMSCsFHqLYII0d40Oz4lVR5Jwm+uE+UIGdBfBK49RcYKXjVth8BBgBnZztkDQplbmRzdHJlYW0NZW5kb2JqDTQgMCBvYmoNPDwvRGVjb2RlUGFybXM8PC9Db2x1bW5zIDMvUHJlZGljdG9yIDEyPj4vRmlsdGVyL0ZsYXRlRGVjb2RlL0lEWzw0REM5MUExODc1QTZENzA3QUVDMjAzQkIwMjFDOTNBMD48RjZDOTJCMzY4QThBMTM0MDg0NTdBMUQzOTVBMzdFQjk+XS9JbmZvIDYgMCBSL0xlbmd0aCAzNy9Sb290IDggMCBSL1NpemUgNy9UeXBlL1hSZWYvV1sxIDIgMF0+PnN0cmVhbQ0KaN5iYmBgYGLkPcLEwD+ViYGhh4mBkYWJ8bEkkM0IEGAAKlkDFA0KZW5kc3RyZWFtDWVuZG9iag1zdGFydHhyZWYNCjExNg0KJSVFT0YNCg=="
}Schema
{
"properties": {
"data": {
"type": "string",
"minLength": 1
},
"dossier": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"product": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"schademelding": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"soortdocument": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"omschrijving": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"extensie": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"aanmaakdatum": {
"type": "string",
"format": "date-time"
},
"map": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"dossier",
"data",
"naam",
"extensie",
"soortdocument"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/conversie/documenten/12Mappen toevoegen ¶
Mappen toevoegenPOST/api/conversie/mappen
Voeg een map toe aan een dossier
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/conversie/mappen
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"naam": "Map in dossier",
"dossier": {
"id": 5526
},
"bovenliggendeMap": {
"id": 12
}
}Schema
{
"properties": {
"naam": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"dossier": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"bovenliggendeMap": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"naam",
"dossier"
]
}Response
201VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/conversie/mappen/13Datasets ¶
Limieten ¶
-
Bevragingen zijn mogelijk voor sommige datasets van 18:00 - 06:00
-
Eén bevraging per client per 10 minuten
Datasets ¶
De volgende datasets zijn beschikbaar:
| Naam | Beschrijving | Mag opgehaald worden |
|---|---|---|
| Besparing ORV | Berekening voor het uitrekenen van mogelijke besparing op ORV | 18:00 - 06:00 |
| Mailing natuurlijke personen | Mailing natuurlijke personen | 18:00 - 06:00 |
| Mailing rechtspersonen | Mailing rechtspersonen | 18:00 - 06:00 |
| Schadeproducten | Schadeproducten met categorie en AFD branchecode | 18:00 - 06:00 |
| Taken | Taken | 18:00 - 06:00 |
| Afspraken per adviseur | Aantal afspraken per adviseur van afgelopen maand | Altijd |
| HDN Aanvragen | HDN Aanvragen uit de omgeving per week | Altijd |
| Eerste afspraken per adviseur | Aantal eerste afspraken per adviseur van afgelopen maand | Altijd |
| Nieuwe producten per maand | Aantal nieuwe producten per maand gegroepeerd van huidig en afgelopen jaar | Altijd |
| Afspraken per kantoor | Aantal afspraken per kantoor van de afgelopen maand | Altijd |
| VerzekeringsPortefeuille | VerzekeringsPortefeuille | Altijd |
| Pijplijn informatie | Pijplijn informatie | Altijd |
Bovenstaande datasets zijn op te halen vanuit Elements. Wil je één van deze datasets ophalen, maar is deze nog niet beschikbaar voor jouw organisatie? Neem dan contact op met onze supportafdeling.
Dataset Collectie ¶
Dataset CollectieGET/api/datasets
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/datasets
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/datasets"
}
},
"_embedded": {
"datasets": [
{
"naam": "Besparing ORV",
"omschrijving": "Berekening voor het uitrekenen van mogelijke besparing op ORV",
"id": 1,
"_links": {
"self": {
"href": "/api/datasets/1"
}
}
}
]
}
}Dataset Ophalen ¶
Dataset OphalenGET/api/datasets/{DATASET_ID}
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/datasets/1
URI Parameters
VerbergBekijk
- DATASET_ID
int(verplicht) Voorbeeld: 1
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
[
{
"EersteAanvragerGeslacht": "Vrouw",
"EersteAanvragerGeboortedatum": "1983-04-17",
"EersteAanvragerRoker": "Nee",
"TweedeAanvragerGeslacht": null,
"TweedeAanvragerGeboortedatum": null,
"TweedeAanvragerRoker": null,
"HuidigePremiePerMaand": "0.00",
"Product": "Overlijdensrisicoverzekering",
"Vorm": "Onbekend",
"EersteAanvragerVerzekerdBedragBijLeven": "0.00",
"EersteAanvragerVerzekerdBedragBijOverlijden": "200000.00",
"EersteAanvragerDalingpercentage": null,
"TweedeAanvragerVerzekerdBedragBijLeven": null,
"TweedeAanvragerVerzekerdBedragBijOverlijden": null,
"TweedeAanvragerDalingpercentage": null,
"Ingangsdatum": "2011-06-08",
"Einddatum": "2041-06-08",
"Dossiernummer": 9
},
{
"EersteAanvragerGeslacht": "X",
"EersteAanvragerGeboortedatum": "1979-02-19",
"EersteAanvragerRoker": "Nee",
"TweedeAanvragerGeslacht": null,
"TweedeAanvragerGeboortedatum": null,
"TweedeAanvragerRoker": null,
"HuidigePremiePerMaand": "0.00",
"Product": "Overlijdensrisicoverzekering",
"Vorm": "Onbekend",
"EersteAanvragerVerzekerdBedragBijLeven": "0.00",
"EersteAanvragerVerzekerdBedragBijOverlijden": "200000.00",
"EersteAanvragerDalingpercentage": null,
"TweedeAanvragerVerzekerdBedragBijLeven": null,
"TweedeAanvragerVerzekerdBedragBijOverlijden": null,
"TweedeAanvragerDalingpercentage": null,
"Ingangsdatum": "2011-09-01",
"Einddatum": "2041-09-01",
"Dossiernummer": 9
},
{
"EersteAanvragerGeslacht": null,
"EersteAanvragerGeboortedatum": "1979-11-11",
"EersteAanvragerRoker": "Nee",
"TweedeAanvragerGeslacht": "Vrouw",
"TweedeAanvragerGeboortedatum": "1976-12-14",
"TweedeAanvragerRoker": "Nee",
"HuidigePremiePerMaand": "0.00",
"Product": "Erasmus Risico Plan",
"Vorm": "Onbekend",
"EersteAanvragerVerzekerdBedragBijLeven": "0.00",
"EersteAanvragerVerzekerdBedragBijOverlijden": "175000.00",
"EersteAanvragerDalingpercentage": null,
"TweedeAanvragerVerzekerdBedragBijLeven": "0.00",
"TweedeAanvragerVerzekerdBedragBijOverlijden": "60000.00",
"TweedeAanvragerDalingpercentage": null,
"Ingangsdatum": "2014-08-01",
"Einddatum": "2014-08-01",
"Dossiernummer": 1557
}
]Events ¶
Event Collectie ¶
Event CollectieGET/api/events&id={ID}&type={TYPE}
Om te voorkomen dat een client bij meerdere bevragingen dezelfde events ontvangt, dient de client continue het laatst ontvangen ID op te slaan. Bij een volgende bevraging dient het ID in de GET mee te worden gestuurd, zodat er alleen events vanaf dit ID worden opgehaald.
Indien de client alleen geinteresseerd is in bepaalde eventtypes dan kan hierop worden gefilterd door type in de GET mee te sturen.
LET OP: het type GET variabele dient als een array te worden meegeven: &type[]=Telefoonnummer.Toegevoegd&type[]=Workflow.NAAM
Op dit moment wordt er onderscheid gemaakt tussen onderstaande eventtypes:
-
Adres.Toegevoegd
-
Adres.Gewijzigd
-
Adres.Verwijderd
-
Emailadres.Toegevoegd
-
Emailadres.Gewijzigd
-
Emailadres.Verwijderd
-
Ockto.Toegevoegd
-
Persoon.Toegevoegd
-
Persoon.Gewijzigd
-
Persoon.Verwijderd
-
Stuk.Toegevoegd
-
Telefoonnummer.Toegevoegd
-
Telefoonnummer.Gewijzigd
-
Telefoonnummer.Verwijderd
-
Workflow.X (X is dynamisch en te definiëren in de betreffende workflow)
-
Smart.X (X is dynamisch en te definiëren bij het aanmaken van het event)
-
Betalingsherinneringen.X (X is dynamisch en te definiëren bij het aanmaken van het event)
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/events&id=30&type=Telefoonnummer.Toegevoegd
URI Parameters
VerbergBekijk
- ID
int(optioneel) Voorbeeld: 30- TYPE
string(optioneel) Voorbeeld: Telefoonnummer.Toegevoegd
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
[
{
"id": "31",
"datum": "2017-12-04T09:25:54+01:00",
"type": "Telefoonnummer.Toegevoegd",
"endpoint": "api/data/klantdossiers/5526/klanten/particulier/120954/telefoonnummers/76411"
},
{
"id": "47",
"datum": "2017-12-04T12:14:45+01:00",
"type": "Workflow.NAAM",
"endpoint": "api/data/klantdossiers/5526/consumptiefkredieten/6743"
}
]Taak ¶
Taak toevoegen ¶
Taak toevoegenPOST/api/data/taken
Stamgegevens in de context van taken zijn hier te vinden: taak stamgegevens.
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/taken
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",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"prioriteit": {
"enum": [
"Laag",
"Middel",
"Hoog"
]
},
"startdatum": {
"type": "string",
"format": "date"
},
"einddatum": {
"type": "string",
"format": "date"
},
"afgerond": {
"type": "boolean"
},
"aanmaakdatum": {
"type": "string",
"format": "date"
},
"initiator": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"genodigden": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"minItems": 1,
"uniqueItems": true
},
"verantwoordelijke": {
"enum": [
"Persoon",
"Workflowgroep",
"WorkflowgroepMetPersoon"
]
},
"verantwoordelijkePersoon": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"verantwoordelijkeWorkflowgroep": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"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/htmlResponse
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": "Failed matching exactly one of the provided schemas."
}
]
}
}Taak workflow toevoegen ¶
Taak workflow toevoegenPOST/api/data/taken/{TAAK_ID}/workflows
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/data/taken/55516/workflows
URI Parameters
VerbergBekijk
- TAAK_ID
int(verplicht) Voorbeeld: 55516
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"workflow": {
"id": 21
}
}Schema
{
"properties": {
"workflow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"workflow"
]
}Response
204VerbergBekijk
Headers
Content-Type: application/jsonVragensysteem ¶
Vraag aanmaken ¶
Vraag aanmakenPOST/api/vragensysteem/{VRAGENBOX_ID}/vraag
Voorbeeld URI
POST https://{DOMEIN}.fasterforwardelements.nl/api/vragensysteem/1/vraag
URI Parameters
VerbergBekijk
- VRAGENBOX_ID
int(verplicht) Voorbeeld: 1
Request
VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"onderwerp": "Dit is een onderwerp",
"omschrijving": "Dit is een omschrijving<br/>Mooie omschrijving",
"dossier": {
"id": 28386
},
"product": {
"id": 1231
},
"aanvrager": {
"id": 149994
}
}Schema
{
"title": "Vraag",
"type": "object",
"properties": {
"onderwerp": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"omschrijving": {
"type": "string",
"minLength": 1
},
"categorieen": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"uniqueItems": true
},
"dossier": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"product": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanvrager": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
}
},
"required": [
"id"
],
"additionalProperties": false
},
"aanvragerEmailadres": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false,
"required": [
"onderwerp",
"omschrijving"
],
"anyOf": [
{
"required": [
"aanvrager"
]
},
{
"required": [
"aanvragerEmailadres"
]
}
]
}Response
200VerbergBekijk
Headers
Content-Type: text/html
Location: /api/vragensysteem/1/vraag/12312Vragencategorieën ¶
VragencategorieënGET/api/vragensysteem/stamgegevens/categorieen
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/vragensysteem/stamgegevens/categorieen
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/vragensysteem/stamgegevens/categorieen"
}
},
"_embedded": {
"categorieen": [
{
"naam": "Algemeen",
"id": 1
}
]
}
}Vragenboxen ¶
VragenboxenGET/api/vragensysteem/stamgegevens/vragenboxen
Voorbeeld URI
GET https://{DOMEIN}.fasterforwardelements.nl/api/vragensysteem/stamgegevens/vragenboxen
Response
200VerbergBekijk
Headers
Content-Type: application/jsonBody
{
"_links": {
"self": {
"href": "/api/vragensysteem/stamgegevens/vragenboxen"
}
},
"_embedded": {
"vragenboxen": [
{
"naam": "1e lijn support",
"id": 1
}
]
}
}Changelog ¶
Semantiek ¶
Het is onvermijdelijk dat er wijzigingen worden aangebracht op de initiële versie van de API. Het is voor partijen die afhankelijk zijn van de API belangrijk om inzicht te krijgen in de impact van de wijzigingen.
API wijzigingen
Van de Faster Forward Elements API is er altijd één actieve versie. Zodra er een nieuwe versie van de API wordt gereleaset, dienen ook alle afhankelijke partijen hun software daarop af te stemmen. Hiervoor zullen we wel (minimaal) één release de delen die vervallen of wijzigen als “deprecated” aanmerken. Gedurende een nader vast te leggen periode blijven deze deprecated delen nog wel actief. Afhankelijke partijen zullen hun software echter moeten aanpassen, zodat de software naar behoren blijft werken zodra de deprecated delen echt verwijderd worden.
API versie nummering
Er bestaan geen harde eisen met betrekking tot het omgaan met versies van API’s. Daarom is het zinvol om te kunnen refereren aan een bepaalde standaard waaruit blijkt wat de impact is van een wijziging voor afhankelijke partijen. Dit zijn de richtlijnen die Faster Forward Elements API volgt:
-
Een versienummer moet er als volgt uitzien: X.Y.Z, waar X, Y en Z niet-negatieve nummers zonder voorloop nullen. X is de major versie, Y is de minor versie en Z is de patch versie. Ieder element moet numeriek oplopend zijn. Als een versie is gereleased mag de inhoud van de die versie niet veranderd worden. Iedere aanpassing moet gereleased worden als een nieuwe versie.
-
Versie 1.0.0 definieert de publieke API.
-
Patch versie Z moet opgehoogd worden als er alleen backwards compatible bugfixes worden geïntroduceerd. Een bugfix is een wijziging die incorrect gedrag verhelpt.
-
Minor versie Y moet opgehoogd worden als er nieuwe backwards compatible functionaliteit wordt geïntroduceerd op de publieke API. Het moet worden opgehoogd als er publieke API-functionaliteit wordt gemarkeerd als deprecated. Het mag worden opgehoogd als substantieel nieuwe code of verbeteringen worden geïntroduceerd in de private code. Het mag patch niveau wijzigingen bevatten. De patch versie moet gereset worden naar 0 als een minor versie wordt opgehoogd.
-
Major versie X moet worden opgehoogd als er backwards incompatible wijzigingen worden geïntroduceerd op de publieke API. Het mag ook minor en patch niveau wijzigingen bevatten. Patch en minor versies moeten worden gereset naar 0 als de major versie wordt opgehoogd.
API domein De Faster Forward Elements API is bereikbaar op {domein}.fasterforwardelements.nl. Uitzondering hierop zijn klanten met een eigen url.
Wijzigingen ¶
15 oktober 2024 v1.16.3
- API[GET] Bij ophalen van een dienst is het nu mogelijk om de "Verzenddatum opdrachtbevestiging" en "Ontvangstdatum getekende opdrachtbevestiging" op te halen.
- API[POST] Bij aanmaken van een dienst is het nu mogelijk om de "Verzenddatum opdrachtbevestiging" en "Ontvangstdatum getekende opdrachtbevestiging" mee te sturen.
- API[POST] Bij het toevoegen van een product is het correspondentieadres niet meer verplicht.
- API[POST] Omschrijving toegevoegd bij het aanmaken van telefoonnummers en e-mailadressen.
- API[POST] AFD branchecodes uitgebreid volgens de laatste SIVI update.
11 oktober 2024 v1.16.2
- API[POST] Bij het aanmaken van materieel krijg je nu ook het id van het record terug in de location header
23 augustus 2024 v1.16.1
- API[POST] Aan de nabewerking van de leadinbox kan van de dienst een opleverdatum meegegeven worden.
6 augustus 2024 v1.16.0
- API[GET] Bij ophalen van een persoon is het nu mogelijk om de volledige voornamen terug te krijgen
- API[POST] Bij aanmaken van een persoon is het nu mogelijk om de volledige voornamen mee te sturen
- API[GET] Bij het ophalen van het dossier met een telefoonnummer is het nu mogelijk om dossiers te vinden waarbij er een contactpersoon verbonden is aan een organisatie met het opgegeven nummer
- API[POST] End-point toegevoegd voor het toevoegen en pinnen van schadedocumenten aan schademeldingen die onder schadeverzekeringen of inkomensverzekeringen vallen.
2 juli 2024 v1.15.0
- API[GET] Bij ophalen van een klantdossier is het nu mogelijk om de herkomst met omschrijving en URL terug te krijgen
- API[GET] Bij ophalen van een persoon is het nu mogelijk om de voorkeurstaal nld/eng/null terug te krijgen
- API[POST] Bij aanmaken van persoon is het nu mogelijk om de voorkeurstaal nld/eng/null in te vullen
- API[POST] De lijst voor bootTypes bij het toevoegen van een object voertuig is uitgebreid volgens de laatste SIVI update
- API[POST] Bij het aanmaken van materieel is de lijst met soort uitgebreid volgens de laatste SIVI update
- API[POST] Bezittingen zijn uitgebreid. Kunnen nu meer gegevens over het voertuig aan meegegeven worden.
22 mei 2024 v1.14.0
- API[GET] Bij ophalen van een persoon is het nu mogelijk om het geslacht X/null terug te krijgen
- API[POST] Bij aanmaken van persoon is het nu mogelijk geslacht X in te vullen
- API[POST] Bij meegeven van een persoon in de leadinbox is het nu mogelijk om geslacht X mee te geven
5 mei 2024 v1.13.0
- API[POST] V2 End-point toegevoegd voor inschieten van HDN Berichten
19 maart 2024 v1.12.10
- API[GET] End-point toegevoegd voor het ophalen van functies onder stamgegevens
- API[GET] Bij Schadeverzekeringen en Levensverzekeringen wordt nu alijd het veld 'handmatigprolongeren' meegegeven
- API[GET] Veld 'handmatigprolongeren' toegevoegd aan inkomensverzekeringen
- API[POST] Veld 'handmatigprolongeren' kan nu meegegeven worden aan inkomensverzekeringen
3 januari 2024 v1.12.9
- APIMogelijkheid toegevoegd om een klant onder een klantdossier toe te voegen met een bepaalde dossierrol
- APIEnd-point voor de dossierrol stamgegevens uitgebreid met niet systeem dossierrollen
- APINieuw end-point toegevoegd om alle overige partijen op te halen onder een dossier
- API [POST] Toevoegen van hypotheekleningdeel aangepast: leningDoel lijst bijgewerkt met actuele HDN lijst
- API [POST] Toevoegen van levensverzekeringdeel aangepast: box lijst bijgewerkt met actuele HDN lijst
12 december 2023 v1.12.8
- API [POST] Toevoegen crmkenmerken voor zakelijke klanten
- DOC KX Financieringsdoelen geüpdatet
24 oktober 2023 v1.12.7
- DOC leadinbox.xsd geüpdatet, maximale lengte omschrijving actie/kenmerken vergroot naar 1000
17 oktober 2023 v1.12.6
- API [GET] bevatverwijderdebijlage veld toegevoegd bij Email
19 september 2023 v1.12.5
- API id velden toegevoegd bij schademelding GET end-points
31 mei 2023 v1.12.4
- API Body limiet is opgehoogd van 25 naar 45 MB
- API Documenten die toegevoegd worden mogen maximaal 30 MB zijn
8 mei 2023 v1.12.3
- API [GET] toelichtingDoelVanFinanciering veld toegevoegd bij ConsumptiefKrediet
- API [POST] toelichtingFinancieringsdoel veld toegevoegd bij ConsumptiefKrediet
- API [POST] financieringsdoel geaccepteerde waardes bijgewerkt voor ConsumptiefKrediet
- API [GET] minimaalBedragEinddatum veld toegevoegd bij Levensverzekering ophalen
- API [POST] minimaalBedragEinddatum veld toegevoegd bij Levensverzekeringdeel kapitaal toevoegen
21 maart 2023 v1.12.2
- API [GET] Velden toegevoegd aan het ophalen van schadedelen
- API [POST] Velden toegevoegd aan het aanmaken van schadedelen
15 februari 2023 v1.12.1
- API [GET] Korting en kortingtype toegevoegd aan endpoint om contract op te halen
22 november 2022 v1.12.0
- API [GET] Endpoint toegevoegd om klantonderzoek van een klant op te halen
- API [POST] Bij het toevoegen van een Consumptief Krediet zijn de codeprovisiemijtype uitgebreid met AA01 en AA02
- API De volgende velden zijn bij het ophalen en toevoegen van een schadeverzekeringdeel toegevoegd: bedragEigenRisicoStormschade, constructiewijzeDak, staatVanOnderhoud en zonnepanelenAanwezig
- API De volgende velden zijn bij het ophalen en toevoegen van een object toegevoegd: bedragAudiovisueleApparatuur en gebruikParticulierOfZakelijk
13 september 2022 v1.11.0
- API [POST] De volgende velden zijn bij het toevoegen van alle producten hetzelfde geworden: adviseur, acceptant, acceptantWorkflowGroep, behandelaar, behandelaarWorkflowGroep
- API [GET] Endpoint toegevoegd om acties van een dossier op te halen
- API [POST] Bij de endpoint "Object voertuig toevoegen" de lijst met types boot en alarm bijwerken
17 mei 2022 v1.10.13
- API [GET] Studielening inventarisatie toegevoegd aan hypotheek ophalen
- API [GET] Aan taakcollectie is het veld 'bron' toegevoegd
26 april 2022 v1.10.12
- API [GET] Factuur en facturen endpoints voorzien van betaallink met bijbehorende verloopdatum en betaalstatus
- API [POST] Optie toegevoegd bij toevoegen van contracten om factuurverzendwijze op `Geen` te zetten
- API [POST] Materieel toevoegen onder schadeverzekeringdeel endpoint toegevoegd
- API Van dekking bij schadeverzekeringdeel dekking een vrij input veld gemaakt
22 maart 2022 v1.10.11
- DOC Mogelijke dekkingen toegevoegd aan schadeverzekeringdeel dekking toevoegen
- API [GET] Contractdelen ophalen endpoint `looptijdVerplichting` en `vervaldatum` vervallen
15 februari 2022 v1.10.10
- API [POST] Algemeen HDN endpoint voor overige bronnen toegevoegd.
- DOC leadinbox.xsd geüpdatet, mogelijkheid tot meegeven registratie onder het dossier element
- API [GET] Klant ophalen endpoint voorzien van extra informatie
- API [POST] Schademelding toevoegen onder schadeverzekering endpoint uitgebreid met bezitting
- API [GET] Schadeverzekering ophalen uitgebreid met bezitting
- API [GET] Hypotheek ophalen endpoint voorzien van extra informatie
- API [GET] Dienst ophalen endpoint voorzien van extra informatie
- API [GET] Contract ophalen endpoint voorzien van extra informatie
30 november 2021 v1.10.9
- API [POST] Levensverzekering bevat de mogelijkheid `doelverzekering` mee te geven. Dit volgt HDN LX 21.3. Hierbij is `verzekeringsmotief` deprecated. Het veld `doelverzekering` heeft voorrang op `verzekeringsmotief` wanneer beide gevuld!
- API [GET] Levensverzekering zal nu `doelverzekering` bevatten. Het veld `verzekeringsmotief` is komen deprecated en zal de waarde van `doelverzekering` bevatten
- API [POST] Hypotheken bevat de mogelijkheid `beheerrelatie` mee te geven. Dit volgt HDN LX 21.3.
- API [GET] Hypotheken zal nu `beheerrelatie` bevatten.
21 september 2021 v1.10.8
- API [POST] Bijwerken lijst met afddekkingen
- API [GET] Alle klantdossier gegevens ophalen api's uitgebreid met laatste en volgende bezoekdatum
- API [POST] Zakelijke contracten "eersteAanvrager" optioneel gemaakt
- API [POST] Zakelijke diensten "eersteAanvrager" optioneel gemaakt
- API [POST] Zakelijke levensverzekeringen "verzekerde" & "contactpersoon" optioneel gemaakt
- API [POST] Zakelijke inkomensverzekeringen "eersteAanvrager" optioneel gemaakt
- API [POST] Mogelijk maken beide omschrijving en dekking code in te vullen bij aanmaken schadeverzekering dekkingen
17 augustus 2021 v1.10.7
- API [GET] Schadeverzekeringdeel uitgebreid met mutatiestatus
- API [POST] Schadeverzekeringdeel uitgebreid met het optionele veld mutatiestatus
- API [GET] Endpoint voor ophalen NAWTE gegevens dossier toegevoegd
- API [POST] Endpoint voor inschieten "workflowberichten" op dossierniveau toegevoegd
- DOC Lijst met generieke datasets toegevoegd aan de api documentatie
26 mei 2021 v1.10.6
- API [GET] Levensverzekering het veld communicatieVanuitVerzekeraar is toegevoegd
- API [GET] Levensverzekering het veld verzekeringsmotief is toegevoegd
- API [POST] Levensverzekering het veld communicatieVanuitVerzekeraar is optioneel toegevoegd
- API [POST] Levensverzekering het veld verzekeringsmotief is optioneel toegevoegd
- API [GET] Inkomensverzekering het veld communicatieVanuitVerzekeraar is toegevoegd
- API [POST] Inkomensverzekering het veld communicatieVanuitVerzekeraar is optioneel toegevoegd
- API [GET] Stuk collectie het veld origineelAanleveren wordt vanaf HDN 21 niet meer gevuld
- API [GET] Stuk collectie het veld opgevraagdViaBron is optioneel toegevoegd
4 mei 2021 v1.10.5
- API Schadeverzekering toevoegen/ophalen veld isPakket verwijderd
- API [POST] Schadeverzekering toevoegen veld collectiviteitType verwijderd
- API [POST] Toevoegen inkomensverzekering/levensverzekering/uitvaartverzekering/schadeverzekering bijgewerkt met particulier
- API [GET] Ophalen inkomensverzekering/levensverzekering/uitvaartverzekering/schadeverzekering bijgewerkt met particulier
- API [POST] Aanpassen Schadeverzekering deel toevoegen met afd code in plaats van artikel id.
28 april 2021 v1.10.4
- API [POST] Schadeverzekering toevoegen/ophalen bijgewerkt
- API [POST] Inkomensverzekering toevoegen/ophalen bijgewerkt
- API [POST] Levensverzekering toevoegen/ophalen bijgewerkt
- API [POST] Uitvaartverzekering toevoegen/ophalen bijgewerkt
23 maart 2021 v1.10.3
- API [GET] Event endpoint uitgebreid met Betalingsherinneringen.X (X is dynamisch en te definiëren bij het aanmaken van het event)
- API Hypotheekproduct datumvelden geactualiseerd.
23 februari 2021 v1.10.2
- API [POST] HDN-endpoint voor Adviesbox toegevoegd.
- API [GET] Endpoints voor het ophalen van levensverzekeringen en schadeverzekeringen uitgebreid met velden voor TP incasso.
- API [POST] Endpoints voor het aanmaken van levensverzekeringen en schadeverzekeringen uitgebreid met velden voor TP incasso.
- API [GET] Endpoint voor het ophalen van een hypotheek uitgebreid met bankgarantievelden.
- DOC [GET] Endpoint voor het ophalen van een hypotheek geactualiseerd.
- DOC Endpoints van levensverzekeringen en schadeverzekeringen geactualiseerd.
18 januari 2021 v1.10.1
- DOC [POST] Ontbrekende endpoints voor het uploaden van documenten toegevoegd.
- DOC [GET] Ontbrekende documentatie over paginatie-opties toegevoegd aan collecties waar dit ontbrak.
12 januari 2021 v1.10.0
- API [GET] Endpoint voor het ophalen van schadevrije jaren voor klanten/organisaties is toegevoegd.
- API [GET] Endpoint voor ophalen schadeverzekering is uitgebreid met schadevrije jaren.
- API [GET] Endpoint voor het ophalen van Bezitting is uitgebreid met jaarkilometrage.
- API [POST] Toevoegen Bezitting Voertuig is uitgebreid met jaarkilometrage.
24 december 2020 v1.9.19
- API [POST] Taak aanmaken (zonder dossier)
- API [POST] Workflow starten onder een taak (zonder dossier)
8 december 2020 v1.9.18
- API [POST] Toevoegen Contractdeel is uitgebreid met verlengen/aflopend.
- API [GET] Endpoint voor het ophalen van Contract is uitgebreid met beloningpercentages en verlengen/aflopend per deel. Zie details bij specifiek endpoint.
- API [GET] Endpoint voor het ophalen van Dienst is uitgebreid met beloningpercentages per deel. Zie details bij specifiek endpoint.
- API [POST] Property verbruik bij het aanmaken van registraties toegevoegd
- API [POST] Endpoint voor aanmaken van een workflow op klantdossierniveau schadeverzekering voor schademelding toegevoegd
- API [POST] Endpoint voor aanmaken van een workflow op klantdossierniveau inkomensverzekering voor schademelding toegevoegd
- API [POST] Endpoint voor uploaden van een profielfoto klantdossierniveau voor partikuliere personen toegevoegd
- API [POST] Endpoint voor uploaden van een profielfoto klantdossierniveau voor zakelijke personen toegevoegd
- DOC Eventtypes voor events endpoint uitgebreid met Smart
3 november 2020 v1.9.17
- API [GET] Toevoegen hoofdsomPer in hypotheek leningdeel
- API [POST] Toevoegen hoofdsomPer in hypotheek leningdeel
- API [POST] Endpoint voor workflowflowstarter op klantdossierniveau toegevoegd
29 september 2020 v1.9.16
- API [GET] Property object info onder schadeverzekering (rechterdeel) toegevoegd.
- API [GET] Verpand aan toegevoegd aan levensverzekering (linkerdeel).
- API [GET] Property dekkingstype dalend percentage onder levensverzekering (rechterdeel) toegevoegd.
- API [GET] Property doel van financiering onder consumptief krediet (linkerdeel) toegevoegd.
- API [GET] Property effectieve jaarrente onder consumptief krediet deel toegevoegd.
- API [POST] Endpoint voor het toevoegen van een persoon met rol aan een dossier toegevoegd.
- API [GET] Endpoint voor het ophalen van alle beschikbare dossierrollen toegevoegd.
- API [POST] Hoofdvervaldatum toegevoegd voor het contractdeel endpoint.
25 augustus 2020 v1.9.15
- API [GET] Endpoint voor het ophalen van de beschikbaarheid van kantoor medewerkers toegevoegd.
- API [GET] Endpoint voor het ophalen van een stuk is uitgebreid met protocol, soortDocumentId en klantDieMoetAanleveren. Zie details bij specifiek endpoint.
21 juli 2020 v1.9.14
- API [GET] Endpoint voor het ophalen van Consumptief krediet is uitgebreid met slottermijn en object. Zie details bij specifiek endpoint.
- API [POST] Endpoint voor het aanmaken van Consumptief krediet is aangepast om mogelijk te maken dat er een slottermijn en object meegestuurd kan worden. Zie details bij specifiek endpoint.
- API Lijst met alarmsystemen geüpdatet.
11 juni 2020 v1.9.13
- API [POST] Nieuwe endpoint e-mail toevoegen onder het klantdossier toegevoegd.
7 april 2020 v1.9.12
- API [POST] Toevoegen van velden voor factureren op dienst en contract producten
- API [POST] Property factuurtype bij het ophalen van een contract.
- API [POST] Property factuurverzendwijze bij het ophalen van een contract.
- API [POST] Property automatischFactureren bij het ophalen van een contract.
- API [POST] Property factuurtype bij het aanmaken van een contract.
- API [POST] Property factuurverzendwijze bij het aanmaken van een contract.
- API [POST] Property automatischFactureren bij het aanmaken van een contract.
- API [POST] Property factuurtype bij het ophalen van een dienst.
- API [POST] Property factuurverzendwijze bij het ophalen van een dienst.
- API [POST] Property factuurtype bij het aanmaken van een dienst.
- API [POST] Property factuurverzendwijze bij het aanmaken van een dienst.
5 maart 2020 v1.9.11
- API [POST] Toevoegen van velden voor beloningspercentage op dienst en contract productdelen
- API [POST] Property beloningpercentagedeelnemer bij het aanmaken van een contract deel.
- API [POST] Property beloningpercentageadviseur bij het aanmaken van een contract deel.
- API [POST] Property beloningpercentagedeelnemer bij het aanmaken van een dienst deel.
- API [POST] Property beloningpercentageadviseur bij het aanmaken van een dienst deel.
17 februari 2020 v1.9.10
- API [GET] Ophalen van de huisstijl toegevoegd onder de kantoor endpoints
- API [GET] Ophalen kantoor logo eigenschappen /api/data/kantoren/{KANTOOR_ID}/logo
- API [GET] Downloaden van kantoor logo /api/data/kantoren/{KANTOOR_ID}/logo/download
16 januari 2020 v1.9.9
- API Property registratieAanmakenInDossier opgenomen in de telefonie service.
18 december 2019 v1.9.8
- API [POST] Property oorspronkelijkeHoofdsom bij het aanmaken van een hypotheek.
- API [GET] Property oorspronkelijkeHoofdsom bij het ophalen van een hypotheek.
- API [POST] Property oorspronkelijkeDeelHoofdsom bij het aanmaken van een hypotheek deel.
- API [GET] Property oorspronkelijkeDeelHoofdsom bij het ophalen van een hypotheek deel.
12 december 2018 v1.9.7
- API Endpoint Mutaties aanmaken.
20 september 2018 v1.9.6
- API [POST] Endpoint Schadeverzekering aanmaken: pakketpremievelden toegevoegd.
- API [POST] Endpoint Schadeverzekeringdeel aanmaken: het veld incassoDoor is deprecated. Om een breaking change te voorkomen wordt dit veld nog wel geaccepteerd, maar is reeds verwijderd uit Faster Forward Elements.
- API [POST] Endpoint Inkomensverzekeringdeel aanmaken: premievelden toegevoegd.
- API [POST] Endpoint Inkomensverzekering aanmaken: het veld incassowijze toegevoegd.
- API [POST] Endpoint Telefoonnummer aanmaken: telefoonnummer patroon aangepast.
- API [POST] Endpoint Persoon aanmaken: burgerlijke staat types toegevoegd.
4 september 2018 v1.9.5
- API [POST] Nieuwe endpoint factuur event sturen toegevoegd
- API [POST] Leadinbox endpoint uitgebreid met verwerking element
2 augustus 2018 v1.9.4
- DOC Deprecated request voor aanmaken taken uitgefaseerd
- DOC Eventtypes voor events endpoint uitgebreid met Stuk.Toegevoegd
- DOC Enumeratie BurgerlijkestaatType in Datatypes.xsd leadinbox uitgebreid
27 juni 2018 v1.9.3
- API [POST] Endpoint workflow onder taak toevoegen
- API [POST] Endpoint voor het aanmaken van Consumptief krediet is aangepast om zakelijke klanten te ondersteunen. Zie details bij specifiek endpoint.
- API [POST] Endpoint voor het aanmaken van Contract is aangepast om zakelijke klanten te ondersteunen. Zie details bij specifiek endpoint.
- API [POST] Endpoint voor het aanmaken van Dienst is aangepast om zakelijke klanten te ondersteunen. Zie details bij specifiek endpoint.
- API [POST] Endpoint voor het aanmaken van Hypotheek is aangepast om zakelijke klanten te ondersteunen. Zie details bij specifiek endpoint.
- API [POST] Endpoint voor het aanmaken van Inkomensverzekering is aangepast om zakelijke klanten te ondersteunen. Zie details bij specifiek endpoint.
- API [POST] Endpoint voor het aanmaken van Levensverzekering is aangepast om zakelijke klanten te ondersteunen. Zie details bij specifiek endpoint.
- API [POST] Endpoint voor het aanmaken van Pensioen is aangepast om zakelijke klanten te ondersteunen. Zie details bij specifiek endpoint.
- API [GET] Endpoints voor het ophalen van codes (zoals 'Vestigingsnummer') onder kantoren toegevoegd
24 mei 2018 v1.9.2
- DOC Product embedded property opgenomen in response van taken endpoint
- DOC Workflowgroep property opgenomen in response van taken endpoint
- DOC Filters voor taken endpoint beschreven
- DOC Beschikbare eventtypes voor events endpoint beschreven
- DOC GET variabelen voor events endpoint beschreven
20 maart 2018 v1.9.1
- API [POST] Endpoints met betrekking tot mappen onder dossiers aanmaken toegevoegd voor conversies
- API [POST] Bestand endpoint voor conversies kan nu een map bevatten uit een dossier
18 januari 2018 v1.9.0
- API Nieuwe endpoints voor Ockto toegevoegd
- API [POST] Endpoints met betrekking tot factuur aanmaken toegevoegd
- API [POST] Endpoints met betrekking tot factuurregels aanmaken toegevoegd
- API [POST] Endpoints met betrekking tot schademeldingen onder inkomensverzekeringen/schadeverzekeringen aanmaken toegevoegd
- API [GET] Endpoints met betrekking tot schademeldingen onder dossiers ophalen toegevoegd
- API [GET] Endpoints met betrekking tot schademeldingen onder schadeverzekeringen/inkomensverzekeringen ophalen toegevoegd
- API [GET] Property dossierstatus toegevoegd bij het ophalen van dossier overzicht
- API [GET] Standaard correspondentie toegevoegd bij het ophalen van dossier details
- API [GET] Property norm toegevoegd bij het ophalen van hypotheek details
14 december 2017 v1.8.0
- DOC JSON schemas opgenomen bij de POST endpoints
- API Nieuwe endpoint met betrekking tot events toegevoegd
- API Nieuwe endpoints met betrekking tot datasets toegevoegd
- API Nieuwe endpoint leveranciersdossier toevoegen.
- API Nieuwe endpoint klant -zakelijk onder leveranciersdossier toevoegen.
- API Nieuwe scopes voor leveranciersdossier (leveranciersdossier.read - leveranciersdossier.create - leveranciersdossier.update - leveranciersdossier.delete).
- API Nieuwe filters toegevoegd onder endpoints producten, panden, bezitting, e-mails, registraties en documenten bij het ophalen van collecties
- API Nieuwe endpoint onder stamgegevens toegevoegd om soort documenten op te halen.
- API Soort document id moet verplicht meegegeven worden bij endpoint document toevoegen en conversie.
- API [GET] Inkomensverzekering ophalen bevat nu dekkingen onder productdelen.
- API [GET] Property ingangsdatum toegevoegd aan endpoint levensverzekering ophalen.
- API [GET] Property maatschappij (tekstueel) toegevoegd aan endpoint levensverzekering ophalen.
- API [GET] Property soort (tekstueel) toegevoegd aan endpoint product ophalen.
- API [GET] Bestand link toegevoegd aan endpoint stuk ophalen.
- API [GET] Product link toegevoegd aan endpoint stuk ophalen indien aanwezig.
- API [GET] Property pad (folderstructuur) toegevoegd aan endpoint document ophalen.
- API [GET] Property publiek toegevoegd aan endpoint document ophalen.
- API [GET] Property aanmaakdatum toegevoegd aan endpoint document ophalen.
- API [GET] Property nationaliteit (tekstueel) toegevoegd aan endpoint klant ophalen.
- API [GET] Property burgerlijke staat (tekstueel) toegevoegd aan endpoint klant ophalen.
- API [GET] Property overleden toegevoegd aan endpoint klant ophalen.
- API [GET] Property datum overleden toegevoegd aan endpoint klant ophalen.
- API [GET] Property dossierrol toegevoegd aan endpoint klant ophalen.
- API [GET] Property nationaliteit (tekstueel) toegevoegd aan endpoint adviseur ophalen.
- API [GET] Property burgerlijke staat (tekstueel) toegevoegd aan endpoint adviseur ophalen.
- API [GET] Property overleden toegevoegd aan endpoint adviseur ophalen.
- API [GET] Property datum overleden toegevoegd aan endpoint adviseur ophalen.
- API [GET] Property nationaliteit (tekstueel) toegevoegd aan endpoint medewerker kantoor ophalen.
- API [GET] Property burgerlijke staat (tekstueel) toegevoegd aan endpoint medewerker kantoor ophalen.
- API [GET] Property overleden toegevoegd aan endpoint medewerker kantoor ophalen.
- API [GET] Property datum overleden toegevoegd aan endpoint medewerker kantoor ophalen.
16 oktober 2017 v1.7.1
- API [POST] Conversie document toevoegen: schademelding propertie toegevoegd.
- API Nieuw limiet toegevoegd: body van het request mag niet groter dan 25MB zijn.
5 september 2017 v1.7.0
- DOC Endpoint kantoren urls nagelopen op foutief gebruik van enkelvoud
- API [GET] klantdossier endpoint: adviseur, klanten/particulier, klanten/zakelijk, kantoor uitgebreid met profielfoto en download link.
- API [GET] kantoor endpoint: kantoor en medewerker uitgebreid met profielfoto en download link.
- API [GET] profielfoto property inhoud vervallen, gebruik de download link
- API [GET] documenten / document uitgebreid met download link.
- API [GET] document property inhoud vervallen, gebruik de download link
- DOC Endpoint vaste waarden toegevoegd
- API [POST] schadeverzekering onderdeel: typeHuis is nu een enumeratie geworden.
- API [POST] schadeverzekering onderdeel: hoofdvervaldatum, premievervaldatum, contractvervaldatum, prolongatiedatum, royementsdatum zijn van formaat datetime naar date gezet
- API [POST] object voertuig toevoegen deprecated geworden
- API [POST] object voertuig toevoegen nieuw endpoint toegevoegd
- API [POST] object bezittingtypetype is bezittingtype geworden bij toevoegen object
- API [POST] object bezittingtype=boot, bootType is opgenomen in de request en verplicht
- API [POST] object bezittingtype=fiets, fietsType is opgenomen in de request en optioneel
- API [POST] object bezittingtype=kostbaarheid, kostbaarheidType is opgenomen in de request en optioneel
- API [POST] object response url is aangepast
- API [POST] contractdeel toevoegen heeft nu een andere url
- API [POST] inkomenverzekering datumvelden: polisOpgevraagd, ontvangstdatumPolis en uitbetaaldatum zijn van formaat datetime naar date gezet
- API [POST] uitvaartverzekeringen begunstigde enumeratie gemaakt
24 augustus 2017 v1.6.0
- API [POST] property bewoning bij schadeverzekeringdeel uitgefaseerd
- API [POST] property heleFamilieVerzekerd bij schadeverzekeringdeel uitgefaseerd
- API [POST] property isEigenaar bij schadeverzekeringdeel uitgefaseerd
- API [POST] property opmerkingen bij schadeverzekeringdeel uitgefaseerd
- API [POST] property koopsom bij schadeverzekeringdeel uitgefaseerd
- API [POST] property polisOpgevraagd bij schadeverzekering uitgefaseerd
- API [POST/GET] property vervangingswaarde bij bezitting uitgefaseerd
- API [POST/GET] property waardeSchommeling bij bezitting uitgefaseerd
- API [POST] property uitkeringperiodeinterval bij dekking uitgefaseerd
- API [POST/GET] property uitkeringperiode bij dekking uitgefaseerd
- API [POST/GET] property uitkeringbedrag bij dekking uitgefaseerd
- API [POST/GET] property uitkeringtype bij dekking uitgefaseerd
- API [POST] endpoints voor AFD berichten toegevoegd
- API [POST] toevoegen inkomensverzekering en schadeverzekering uitgebreid met bijzonderhedenveld
- API Endpoints voor conversie beschreven
- API [GET] registraties toegevoegd voor klantdossier en onderliggende producten
- DOC [POST] registraties toevoegen onder dienst ontbrak in documentatie
15 juni 2017 v1.5.0
- DOC Documentatie verwijderd deprecated endpoint: GET - /api/data/klantdossiers/{DOSSIER_ID}/klanten
- DOC Documentatie verwijderd deprecated endpoint: GET - /api/data/klantdossiers/{DOSSIER_ID}/klanten/{KLANT_ID}
- DOC Documentatie verwijderd deprecated endpoint: POST - /api/data/klantdossiers/{DOSSIER_ID}/klanten
- DOC Documentatie verwijderd deprecated endpoint: PATCH - /api/data/klantdossiers/{DOSSIER_ID}/klanten/{KLANT_ID}
- DOC Documentatie verwijderd deprecated endpoint: GET - /api/data/klantdossiers/{DOSSIER_ID}/klanten/{PERSOON_ID}/adressen
- DOC Documentatie verwijderd deprecated endpoint: GET - /api/data/klantdossiers/{DOSSIER_ID}/klanten/{PERSOON_ID}/adressen/{ADRES_ID}
- DOC Documentatie verwijderd deprecated endpoint: GET - /api/data/klantdossiers/{DOSSIER_ID}/klanten/{PERSOON_ID}/telefoonnummers
- DOC Documentatie verwijderd deprecated endpoint: GET - /api/data/klantdossiers/{DOSSIER_ID}/klanten/{PERSOON_ID}/telefoonnummers/{TELEFOONNUMMER_ID}
- DOC Documentatie verwijderd deprecated endpoint: GET - /api/data/klantdossiers/{DOSSIER_ID}/klanten/{PERSOON_ID}/emailadressen
- DOC Documentatie verwijderd deprecated endpoint: GET - /api/data/klantdossiers/{DOSSIER_ID}/klanten/{PERSOON_ID}/emailadressen/{EMAILADRES_ID}
- DOC Documentatie verwijderd deprecated endpoint: GET - /api/data/klantdossiers/{DOSSIER_ID}/klanten/{PERSOON_ID}/kenmerken
- DOC Documentatie verwijderd deprecated endpoint: GET - /api/data/klantdossiers/{DOSSIER_ID}/klanten/{PERSOON_ID}/kenmerken/{KENMERK_ID}
- DOC Documentatie verwijderd deprecated endpoint: GET - /api/data/klantdossiers/{DOSSIER_ID}/klanten/{PERSOON_ID}/socialmedia
- DOC Documentatie verwijderd deprecated endpoint: GET - /api/data/klantdossiers/{DOSSIER_ID}/klanten/{PERSOON_ID}/socialmedia/{SOCIALMEDIA_ID}
- DOC Documentatie verwijderd deprecated endpoint: GET - /api/data/klantdossiers/{DOSSIER_ID}/klanten/{PERSOON_ID}/rekeningnummers
- DOC Documentatie verwijderd deprecated endpoint: GET - /api/data/klantdossiers/{DOSSIER_ID}/klanten/{PERSOON_ID}/rekeningnummers/{REKENINGNUMMER_ID}
- DOC Endpoint actie toevoegen
- DOC Endpoint bankgarantie taak toevoegen
- DOC Endpoint vermogen en bancair taak toevoegen
- DOC Endpoint consumptief krediet taak toevoegen
- DOC Endpoint contract taak toevoegen
- DOC Endpoint uitvaartverzekering taak toevoegen
- DOC Endpoint inkomensverzekering taak toevoegen
- DOC Endpoint levensverzekering taak toevoegen
- DOC Endpoint pensioen taak toevoegen
- DOC Endpoint dienst taak toevoegen
- DOC Endpoint schadeverzekering taak toevoegen
- DOC Endpoint hypotheek taak toevoegen
- DOC Endpoint object overige toevoegen
- DOC Endpoint object voertuig toevoegen
- DOC Endpoint schadeverzekering dekking toevoegen
- DOC Endpoint schadeverzekering deel toevoegen
- DOC Endpoint schadeverzekering workflow toevoegen
- DOC Endpoint schadeverzekering registratie toevoegen
- DOC Endpoint schadeverzekering toevoegen
- DOC Endpoint hypotheekadvies workflow toevoegen
- DOC Endpoint hypotheekadvies registratie toevoegen
- DOC Endpoint hypotheekadvies
- DOC Endpoint particuliere klant - rekeningnummer toevoegen
- DOC Endpoint particuliere klant - telefoonnummer toevoegen
- DOC Endpoint particuliere klant - emailadres toevoegen
- DOC Endpoint particuliere klant - adres toevoegen
- DOC Endpoint zakelijke klant - medewerker emailadres toevoegen
- DOC Endpoint zakelijke klant - medewerker telefoonnummer toevoegen
- DOC Endpoint zakelijke klant - medewerker toevoegen
- DOC Endpoint zakelijke klant rekeningnummer toevoegen
- DOC Endpoint zakelijke klant emailadres toevoegen
- DOC Endpoint zakelijke klant telefoonnummer toevoegen
- DOC Endpoint zakelijke klant adres toevoegen
- DOC Endpoint zakelijke klant toevoegen
- DOC Klantdossier klanten zakelijk toegevoegd met onderliggende endpoints
- DOC Endpoint bankgarantie workflow toevoegen
- DOC Endpoint vermogen en bancair workflow toevoegen
- DOC Endpoint consumptief krediet workflow toevoegen
- DOC Endpoint contract workflow toevoegen
- DOC Endpoint uitvaartverzekering workflow toevoegen
- DOC Endpoint inkomensverzekering workflow toevoegen
- DOC Endpoint levensverzekering workflow toevoegen
- DOC Endpoint pensioen workflow toevoegen
- DOC Endpoint dienst workflow toevoegen
- DOC Endpoint hypotheek workflow toevoegen
- DOC Endpoint bankgarantie registratie toevoegen
- DOC Endpoint vermogen en bancair registratie toevoegen
- DOC Endpoint consumptief krediet registratie toevoegen
- DOC Endpoint contract registratie toevoegen
- DOC Endpoint uitvaartverzekering registratie toevoegen
- DOC Endpoint inkomensverzekering registratie toevoegen
- DOC Endpoint levensverzekering registratie toevoegen
- DOC Endpoint pensioen registratie toevoegen
- DOC Endpoint hypotheek registratie toevoegen
- DOC Endpoint vermogen en bancair deel inleg toevoegen
- DOC Endpoint vermogen en bancair deel toevoegen
- DOC Endpoint vermogen en bancair toevoegen
- DOC Endpoint uitvaartverzekeringdeel kapitaal toevoegen
- DOC Endpoint uitvaartverzekeringdeel toevoegen
- DOC Endpoint uitvaartverzekering toevoegen
- DOC Endpoint pand toevoegen
- DOC Endpoint pensioendeel toevoegen
- DOC Endpoint pensioen toevoegen
- DOC Endpoint levensverzekeringdeel storting toevoegen
- DOC Endpoint levensverzekeringdeel premie toevoegen
- DOC Endpoint levensverzekeringdeel kapitaal toevoegen
- DOC Endpoint levensverzekeringdeel toevoegen
- DOC Endpoint levensverzekering toevoegen
- DOC Endpoint inkomensverzekeringdeel toevoegen
- DOC Endpoint inkomensverzekering toevoegen
- DOC Endpoint hypotheekdeel toevoegen
- DOC Endpoint hypotheek toevoegen
- DOC Endpoint registratie dossierniveau toevoegen
- DOC Endpoint dienstdeel toevoegen
- DOC Endpoint dienst toevoegen
- DOC Endpoint contractdeel toevoegen
- DOC Endpoint contract toevoegen
- DOC Endpoint consumptief krediet toevoegen
- DOC Endpoint propositie toevoegen
- DOC Endpoint klantdossier standaard correspondentieadres zetten
- DOC Endpoint klantdossier toevoegen
21 april 2017 v1.4.0
- API Klantdossier klanten deprecated gemaakt. Wordt vervangen door Klantdossier klanten particulier
- API Document download endpoint toegevoegd
- API Klantdossier panden endpoint toegevoegd
- API Telefonie service aangepast
- API Zoekwaarde als vrij zoekveld aan de klantdossiers endpoint toegevoegd
- API Null waarden ook als null in het resultaat in plaats van lege string
- API Response van POST endpoints nu HTTP status 201, met aangemaakte entiteit url in de Location header
18 april 2017 v1.3.3
- API Persoonkenmerk toegevoegd
28 december 2016 v1.3.2
- DOC Service, HDN en Leadinbox endpoints gecorrigeerd
13 december 2016 v1.3.1
- DOC Autorisatie endpoints gecorrigeerd
- API Document onder stuk toevoegen toegevoegd
6 december 2016 v1.3.0
- API Voorwaarden toegevoegd
- API Kantoor endpoints toegevoegd
- API Service telefonie toegevoegd
- API Bij adressen, telefoonnummers en emailadressen het "type" toegevoegd
- API Het veld "geslacht" onder persoon heeft geldige waarden "man" en "vrouw"
- API Het veld "woonplaats" onder adres vervangen door "plaatsnaam"
- API Het veld "burgerlijkestaat" onder persoon vervangen door "burgerlijkestaatId"
- API Stamgegevens velden aangepast
- API Link in taak resultaten toegevoegd naar gerelateerde stamgegevens
3 november 2016 v1.2.1
- API Stamgegevens in de context van taken toegevoegd
2 november 2016 v1.2.0
- API Spaties in velden vervangen door de CamelCase variant
- API Bezitting veld "archived" hernoemd naar "gearchiveerd"
- API Document veld "inhoud" toegevoegd met base64 geencodeerde waarde van het document
- API Email veld "originelemail" hernoemd naar "inhoud"
- API Kantoor en Klant veld "computednaam" hernoemd naar "weergavenaam"
- API Product veld "invoerAanvraagdatum" en "correspondentieadres" toegevoegd
- API Hypotheek velden "datumRenteaanbodAangevraagd" en "datumOntbindendeVoorwaarden" toegevoegd
- API Hypotheekdeel velden "maandelijksBedrag" en "rentebedenktijd" toegevoegd
- API Schadeverzekering velden "offerteAanvraagdatum" en "statusOfferteAanvraagdatum" en "isPakket" toegevoegd
7 oktober 2016 v1.1.1
- DOC Engelse termen vertaald naar Nederlandse termen
- API Leadinbox XSD aanpassing - BIC en rekeningnummer niet meer verplicht indien IBAN land
- API Leadinbox XSD toevoeging - Aanbrenger organisatie beschikbaar gesteld onder element aanbrengerOrganisatieId
5 september 2016 v1.1.0
- API Authorization code flow toegevoegd
- API Implicit flow toegevoegd
- API Endpoint /klandossiers zoek filters toegevoegd
- API Stukken endpoint uitgebreid met "aan te leveren door" property
- DOC Autorisatie documentatie bijgewerkt de Authorization code en Implicit flow
18 juli 2016 v1.0.0
- API Initiële release API
- DOC Initiële release API-docs