Back to top

API (1.7.1)

De Faster Forward Elements API collectie is set van objectbeschrijvingen die het mogelijk maken om te connecteren met het Faster Forward Elements Platform. Met onze API kunt u o.a. volledige klantdossiers ophalen, zodat u andere applicaties of Faster Forward Elements kunt verrijken.

De API is opgebouwd rondom de volgende technieken en methodieken:

Voorwaarden

Faster Forward stimuleert het gebruik en het maken van eigen toepassingen. Hierbij dient u echter wel rekening te houden met de algemene voorwaarden van Faster Forward voor het gebruik van de API.

De API voorwaarden vindt u hier.

Limitaties

De Faster Forward Elements API kent 2 soorten limitaties:

  1. Limitaties op het aantal requests:

    • 100,000 requests per dag
    • 5 requests per seconden
  2. Limitaties op de grootte van het request:

    • De body mag niet groter zijn dan 25MB

Indien u over het aantal requests heen gaat, zult u een response ontvangen met HTTP method 429 (Too Many Requests)

In het geval van het overschrijden van de dagelijkse request limiet krijgt u in de reponse onderstaande body

{ ‘error’: “Limit exceeded of 100,000 request(s) in one day” }

bij het overschrijden van de limiet van het aantal requests per seconden krijgt u de volgende body

{ ‘error’: “Limit exceeded of 5 request(s) in 1 second(s)” }

In het geval u over de maximale grootte heen gaat, zult u een response ontvangen met HTTP method 400 (Bad Request) met onderstaande body:

{“error”:“Request body is groter dan toegestaan”,“toegestaan”:“26214400 bytes”,“ontvangen”:“139810386 bytes”}"

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:

  1. 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.

  2. Indien succesvol zal de token server een access token terugsturen naar uw applicatie.

  3. Indien u een webservice wilt gaan bevragen, zult u de access token die in stap 2 verkregen is, mee moeten sturen.

  4. Afhankelijk van welke webservice u bevraagd heeft, wordt er door webservice een response teruggeven.

  5. 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:

  1. Voor het verkrijgen van gegevens uit Elements via een derde partij kan een autorizatie code worden opgevraagd, via een HTTP GET request.

  2. 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.

  3. 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.

  4. Deze autorizatie code kunt u inwisselen voor een access token via een HTTP POST request.

  5. Indien succesvol zal de token server een access token terugsturen naar uw applicatie.

  6. Indien u een webservice wilt gaan bevragen, zult u de access token die in stap 5 verkregen is, mee moeten sturen.

  7. Afhankelijk van welke webservice u bevraagd heeft, wordt er door webservice een response teruggeven.

  8. 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:

  1. Met de configuratie gegevens kan een access token worden opgevraagd, via een HTTP GET request.

  2. 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.

  3. 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.

  4. Indien u een webservice wilt gaan bevragen, zult u de access token die in stap 2 verkregen is, mee moeten sturen.

  5. Afhankelijk van welke webservice u bevraagd heeft, wordt er door webservice een response teruggeven.

  6. 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 flow
POST/oauth/access_token

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/oauth/access_token
Request  Access Token
VerbergBekijk
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  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "access_token": "5db1cf97f8fd66f295c33eae616227e69de4d",
  "expires_in": 3600,
  "token_type": "Bearer",
  "scope": "{SCOPES}",
  "refresh_token": "6ebffce35d81e24463336fc2a8c8cc9d23b8c"
}
Response  400
VerbergBekijk
Headers
Content-Type: application/json
Body
{
    "error_description" : {ERROR_MESSAGE_DESCRIPTION},
    "error" :{ERROR_MESSAGE_CODE}
}

Authorization code flow

Authorization code flow
GET/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  200
VerbergBekijk

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 inwisselen
POST/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  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "access_token": "5db1cf97f8fd66f295c33eae616227e69de4d",
  "expires_in": 3600,
  "token_type": "Bearer",
  "scope": "{SCOPES}",
  "refresh_token": "6ebffce35d81e24463336fc2a8c8cc9d23b8c"
}
Response  400
VerbergBekijk
Headers
Content-Type: application/json
Body
{
    "error_description" : {ERROR_MESSAGE_DESCRIPTION},
    "error" :{ERROR_MESSAGE_CODE}
}

Refresh token

Refresh token
POST/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=6ebffce35d81e24463336fc2a8c8cc9d23b8c
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "access_token": "5db1cf97f8fd66f295c33eae616227e69de4d",
  "expires_in": 3600,
  "token_type": "Bearer",
  "scope": "{SCOPES}",
  "refresh_token": "6ebffce35d81e24463336fc2a8c8cc9d23b8c"
}
Response  400
VerbergBekijk
Headers
Content-Type: application/json
Body
{
    "error_description" : {ERROR_MESSAGE_DESCRIPTION},
    "error" :{ERROR_MESSAGE_CODE}
}

Implicit flow

Implicit flow
GET/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  200
VerbergBekijk

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 collectie
GET/api/data/klantdossiers{?access_token,relatienummer,omschrijving,dossierstatus,kantoor,achternaam,geboortedatum,organisatie,kvknummer,straat,nummer,postcode,plaatsnaam,telefoonnummer,emailadres,contractnummer,kenteken,zoekwaarde}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers?access_token=3b57bd2db21c46d2875508b982968d26&relatienummer=4815162342&omschrijving=dossier 5526&dossierstatus=1&kantoor=3888&achternaam=van Test&geboortedatum=1990-03-07&organisatie=Faster Forward B.V.&kvknummer=20128551&straat=Stationsstraat&nummer=14&postcode=4611CC&plaatsnaam=Bergen op Zoom&telefoonnummer=0164210240&emailadres=api@fasterforward.nl&contractnummer=16180339887&kenteken=ECTO-1&zoekwaarde=Janssen
URI Parameters
VerbergBekijk
access_token
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
relatienummer
string (optioneel) Voorbeeld: 4815162342
omschrijving
string (optioneel) Voorbeeld: dossier 5526
dossierstatus
string (optioneel) Voorbeeld: 1
kantoor
string (optioneel) Voorbeeld: 3888
achternaam
string (optioneel) Voorbeeld: van Test
geboortedatum
string (optioneel) Voorbeeld: 1990-03-07
organisatie
string (optioneel) Voorbeeld: Faster Forward B.V.
kvknummer
string (optioneel) Voorbeeld: 20128551
straat
string (optioneel) Voorbeeld: Stationsstraat
nummer
string (optioneel) Voorbeeld: 14
postcode
string (optioneel) Voorbeeld: 4611CC
plaatsnaam
string (optioneel) Voorbeeld: Bergen op Zoom
telefoonnummer
string (optioneel) Voorbeeld: 0164210240
emailadres
string (optioneel) Voorbeeld: api@fasterforward.nl
contractnummer
string (optioneel) Voorbeeld: 16180339887
kenteken
string (optioneel) Voorbeeld: ECTO-1
zoekwaarde
string (optioneel) Voorbeeld: Janssen
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers"
    }
  },
  "_embedded": {
    "klantdossiers": [
      {
        "omschrijving": "Klantdossier",
        "aanmaakdatum": "2016-07-11T00:00:00+0200",
        "deleted": null,
        "relatienummer": null,
        "id": 5526,
        "dossiertype": "klantdossier",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526"
          }
        }
      }
    ]
  }
}

Klantdossier ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "omschrijving": "Klantdossier",
  "aanmaakdatum": "2016-07-11T00:00:00+0200",
  "deleted": null,
  "relatienummer": null,
  "id": 5526,
  "dossiertype": "klantdossier",
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526"
    },
    "adviseurs": {
      "href": "/api/data/klantdossiers/5526/adviseurs"
    },
    "kantoor": {
      "href": "/api/data/klantdossiers/5526/kantoor"
    },
    "klanten": {
      "href": "/api/data/klantdossiers/5526/klanten",
      "deprecation": "http://api.fasterforward.nl"
    },
    "panden": {
      "href": "/api/data/klantdossiers/5526/panden"
    },
    "bezittingen": {
      "href": "/api/data/klantdossiers/5526/bezittingen"
    },
    "producten": {
      "href": "/api/data/klantdossiers/5526/producten"
    },
    "facturen": {
      "href": "/api/data/klantdossiers/5526/facturen"
    },
    "documenten": {
      "href": "/api/data/klantdossiers/5526/documenten"
    },
    "stukken": {
      "href": "/api/data/klantdossiers/5526/stukken"
    },
    "emails": {
      "href": "/api/data/klantdossiers/5526/emails"
    },
    "taken": {
      "href": "/api/data/klantdossiers/5526/taken"
    },
    "klanten/particulier": {
      "href": "/api/data/klantdossiers/5526/klanten/particulier"
    }
  }
}

Klantdossier toevoegen
POST/api/data/klantdossiers/?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "omschrijving": "Test dossier",
  "aanmaakdatum": "2017-01-01 10:00:00",
  "relatienummer": "12345",
  "dossierstatus": {
    "id": 1
  },
  "kantoor": {
    "id": 14830
  }
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526

Actie toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/acties?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/acties?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "actie": {
    "id": 1
  },
  "omschrijving": "Omschrijving van de actie"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/acties/2400

Object overige toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/bezittingen/overige?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bezittingen/overige?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/bezittingen/184
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "omschrijving": "test api",
  "catalogusWaarde": 50000,
  "datumAankoop": "2005-02-01",
  "aankoopwaarde": 50000,
  "huidigeWaardeDatum": "2017-01-01",
  "huidigeWaarde": 50000,
  "type": "api type",
  "bezittingtype": "Overige",
  "kostbaarheidType": "Juwelen"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/bezittingen/185

Object voertuig toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/bezittingen/voertuigen?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bezittingen/voertuigen?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/bezittingen/182
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/bezittingen/183
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/bezittingen/184

Object voertuig toevoegen DEPRECATED
POST/api/data/klantdossiers/{DOSSIER_ID}/bezittingen/voertuig?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bezittingen/voertuig?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/bezittingen/182

Pand toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/panden?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/panden?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Niet-bestaand adres

{
    "postcode" : "4651ME",
    "nummer" : "3",
    "toevoeging" : "B",
    "straat" : "Grimbergen",
    "plaatsnaam" : "Steenbergen",
    "gemeente" : "Steenbergen",
    "provincie" : "Noord-Brabant",
    "land" : "NL",
    "categorie" : "Standaard",
    "type" : "Pand"
}
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Bestaand adres

{
    "id" : 7796,
    "type" : "Pand"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/panden/7796

Propositie toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/proposities?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/proposities?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "naam": "Naam van de propositie"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/proposities/1

Registratie ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/registraties?access_token={ACCESS_TOKEN}]&publiek={PUBLIEK}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/registraties?access_token=3b57bd2db21c46d2875508b982968d26]&publiek=1
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
PUBLIEK
int (optioneel) Voorbeeld: 1
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/registraties"
    }
  },
  "_embedded": {
    "registraties": [
      {
        "omschrijving": "<p>Telefonisch contact opgenomen met de klant, hij komt binnenkort langs voor een orienterend gesprek</p>\n",
        "onderwerp": "Contact met klant",
        "publiek": true,
        "factureerbaar": null,
        "boekdatum": "2015-12-30T09:45:00+0100",
        "gearchiveerd": false,
        "verbruik": 0,
        "id": 275814,
        "registratietype": "Telefoongesprek",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/registraties/275814"
          }
        },
        "_embedded": {
          "persoon": [
            {
              "id": 120955,
              "geslacht": "vrouw",
              "initialen": "K.",
              "titel": "",
              "voornaam": "Kim",
              "tussenvoegsel": "",
              "achternaam": "Jansen - de Jong",
              "bsn": "",
              "nationaliteitId": 1,
              "burgerlijkestaatId": null,
              "weergavenaam": "Medior, Voornaam (I.)",
              "geboortedatum": null,
              "pensioendatum": null
            }
          ]
        }
      },
      {
        "omschrijving": "<p>Klant nogmaals benaderd, was nog niet langs geweest</p>\n",
        "onderwerp": "Telefoongesprek Paul",
        "publiek": true,
        "factureerbaar": true,
        "boekdatum": "2016-01-15T09:45:00+0100",
        "gearchiveerd": false,
        "verbruik": 10,
        "id": 275815,
        "registratietype": "Telefoongesprek",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/registraties/275815"
          }
        },
        "_embedded": {
          "persoon": [
            {
              "id": 120955,
              "geslacht": "vrouw",
              "initialen": "K.",
              "titel": "",
              "voornaam": "Kim",
              "tussenvoegsel": "",
              "achternaam": "Jansen - de Jong",
              "bsn": "",
              "nationaliteitId": 1,
              "burgerlijkestaatId": null,
              "weergavenaam": "Jansen - de Jong, Kim (K.)",
              "geboortedatum": null,
              "pensioendatum": null
            }
          ]
        }
      }
    ]
  }
}
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_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 toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/registraties?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/registraties?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "omschrijving": "Dit is de omschrijving",
  "onderwerp": "Dit is het onderwerp",
  "registratiedatum": "2017-01-01 10:00:00",
  "boekdatum": "2017-01-01 10:00:00",
  "activiteit": {
    "id": 1
  },
  "registratietype": {
    "id": 7
  },
  "systeemregistratie": false,
  "persoon": {
    "id": 112794
  }
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/registraties/275826

Standaard correspondentieadres wijzigen
PATCH/api/data/klantdossiers/{DOSSIER_ID}?access_token={ACCESS_TOKEN}]

Voorbeeld URI

PATCH https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "standaardCorrespondentieadres": {
    "id": 1
  }
}
Response  200
VerbergBekijk
Headers
Content-Type: text/html

Klant - particulier

Klant collectie
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/klanten/particulier"
    }
  },
  "_embedded": {
    "klanten": [
      {
        "id": 120954,
        "geslacht": "man",
        "initialen": "A.",
        "titel": "",
        "voornaam": "Aad",
        "tussenvoegsel": "",
        "achternaam": "Jansen",
        "bsn": "559795178",
        "nationaliteitId": 1,
        "burgerlijkestaatId": 1,
        "weergavenaam": "Jansen, Aad (A.)",
        "geboortedatum": "1960-01-01T00:00:00+01:00",
        "pensioendatum": "2027-01-01T00:00:00+01:00",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/particulier/120954"
          }
        }
      },
      {
        "id": 120955,
        "geslacht": "vrouw",
        "initialen": "K.",
        "titel": "",
        "voornaam": "Kim",
        "tussenvoegsel": "",
        "achternaam": "Jansen - de Jong",
        "bsn": "004864645",
        "nationaliteitId": 1,
        "burgerlijkestaatId": 1,
        "weergavenaam": "Jansen - de Jong, Kim (K.)",
        "geboortedatum": "1965-04-21T00:00:00+01:00",
        "pensioendatum": "2032-04-21T00:00:00+02:00",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/particulier/120955"
          }
        }
      }
    ]
  }
}

Klant ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PERSOON_ID
int (verplicht) Voorbeeld: 120954
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "id": 120954,
  "geslacht": "man",
  "initialen": "A.",
  "titel": "",
  "voornaam": "Aad",
  "tussenvoegsel": "",
  "achternaam": "Jansen",
  "bsn": "559795178",
  "nationaliteitId": 1,
  "burgerlijkestaatId": 1,
  "weergavenaam": "Jansen, Aad (A.)",
  "geboortedatum": "1960-01-01T00:00:00+01:00",
  "pensioendatum": "2027-01-01T00:00:00+01:00",
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/klanten/particulier/120954"
    },
    "adressen": {
      "href": "/api/data/klantdossiers/5526/klanten/particulier/120954/adressen"
    },
    "emailadressen": {
      "href": "/api/data/klantdossiers/5526/klanten/particulier/120954/emailadressen"
    },
    "profielfoto": {
      "href": "/api/data/klantdossiers/5526/klanten/particulier/120954/profielfoto"
    },
    "rekeningnummers": {
      "href": "/api/data/klantdossiers/5526/klanten/particulier/120954/rekeningnummers"
    },
    "telefoonnummers": {
      "href": "/api/data/klantdossiers/5526/klanten/particulier/120954/telefoonnummers"
    }
  }
}

Klant toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier?access_token={ACCESS_TOKEN}&rol={ROL_NAAM}

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier?access_token=3b57bd2db21c46d2875508b982968d26&rol=eerste-persoon
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
ROL_NAAM
string (verplicht) Voorbeeld: eerste-persoon

Keuzen: eerste-persoon partner kind

Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "geslacht": "Man",
  "initialen": "I.",
  "titel": "dhr",
  "voornaam": "Voornaam",
  "tussenvoegsel": "de",
  "achternaam": "Achternaam00116390",
  "bsn": "695803888",
  "geboortedatum": "1980-01-25T00:00:00+01:00"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/particulier/120961
Response  400
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "total": 1,
  "message": "Validatie fouten",
  "_links": {
    "help": {
      "href": "http://api.fasterforward.nl/",
      "title": "Validatie informatie"
    }
  },
  "_embedded": {
    "errors": [
      {
        "path": "",
        "message": "Required properties missing: [\"achternaam\"]"
      }
    ]
  }
}

Klant wijzigen
PATCH/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

PATCH https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120967?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PERSOON_ID
int (verplicht) Voorbeeld: 120967
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "standaardCorrespondentieadres": {
    "id": 7793
  }
}
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Response  400
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "total": 1,
  "message": "Validatie fouten",
  "_links": {
    "help": {
      "href": "http://api.fasterforward.nl/",
      "title": "Validatie informatie"
    }
  },
  "_embedded": {
    "errors": [
      {
        "path": "",
        "message": "Required properties missing: [\"standaardCorrespondentieadres\"]"
      }
    ]
  }
}

Adres collectie
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/adressen?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/adressen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PERSOON_ID
int (verplicht) Voorbeeld: 120954
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/klanten/particulier/120954/adressen"
    }
  },
  "_embedded": {
    "adressen": [
      {
        "id": 7790,
        "straat": "Nieuwemarkt",
        "nummer": "2",
        "toevoeging": "",
        "postcode": "3011HP",
        "plaatsnaam": "Rotterdam",
        "postcodegebied": "3011",
        "longitude": null,
        "latitude": null,
        "categorie": "default",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/particulier/120954/adressen/7790"
          }
        },
        "_embedded": {
          "types": [
            {
              "id": 7,
              "naam": "correspondentieadres"
            }
          ]
        }
      }
    ]
  }
}

Adres ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/adressen/{ADRES_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/adressen/7790?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PERSOON_ID
int (verplicht) Voorbeeld: 120954
ADRES_ID
int (verplicht) Voorbeeld: 7790
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "id": 7790,
  "straat": "Nieuwemarkt",
  "nummer": "2",
  "toevoeging": "",
  "postcode": "3011HP",
  "plaatsnaam": "Rotterdam",
  "postcodegebied": "3011",
  "longitude": null,
  "latitude": null,
  "categorie": "default",
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/klanten/particulier/120954/adressen/7790"
    }
  },
  "_embedded": {
    "types": [
      {
        "id": 7,
        "naam": "correspondentieadres"
      }
    ]
  }
}

Adres toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/adressen?access_token={ACCESS_TOKEN}

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120955/adressen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PERSOON_ID
int (verplicht) Voorbeeld: 120955
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Niet-bestaand adres

{
    "postcode" : "4651ME",
    "nummer" : "3",
    "toevoeging" : "B",
    "straat" : "Grimbergen",
    "plaatsnaam" : "Steenbergen",
    "gemeente" : "Steenbergen",
    "provincie" : "Noord-Brabant",
    "land" : "NL",
    "categorie" : "Standaard",
    "type" : "Correspondentieadres"
}
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Bestaand adres

{
    "id" : 7797,
    "type" : "Factuuradres"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/particulier/120955/adressen/7797

Emailadres collectie
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/emailadressen?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/emailadressen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PERSOON_ID
int (verplicht) Voorbeeld: 120954
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/klanten/particulier/120954/emailadressen"
    }
  },
  "_embedded": {
    "emailadressen": [
      {
        "id": 40555,
        "naam": "aad-jansen@mailprovider.nl",
        "omschrijving": null,
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/particulier/120954/emailadressen/40555"
          }
        },
        "_embedded": {
          "types": [
            {
              "id": 2,
              "naam": "Prive"
            }
          ]
        }
      }
    ]
  }
}

Emailadres ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/emailadressen/{EMAILADRES_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/emailadressen/40555?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PERSOON_ID
int (verplicht) Voorbeeld: 120954
EMAILADRES_ID
int (verplicht) Voorbeeld: 40555
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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 toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/emailadressen?access_token={ACCESS_TOKEN}

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/emailadressen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PERSOON_ID
int (verplicht) Voorbeeld: 120954
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Niet-bestaand emailadres

{
    "naam": "particulier@home.nl",
    "type" : "Algemeen"
}
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Bestaand emailadres

{
    "id": 40559,
    "type" : "Algemeen"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/particulier/120954/emailadressen/7797

Kenmerk collectie
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/kenmerken?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/kenmerken?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PERSOON_ID
int (verplicht) Voorbeeld: 120954
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/klanten/particulier/120954/kenmerken"
    }
  },
  "_embedded": {
    "kenmerken": [
      {
        "id": 4,
        "naam": "Kenmerk 1",
        "vraag": "",
        "omschrijving": "",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/particulier/120954/kenmerken/4"
          }
        }
      }
    ]
  }
}

Kenmerk ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/kenmerken/{KENMERK_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/kenmerken/4?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PERSOON_ID
int (verplicht) Voorbeeld: 120954
KENMERK_ID
int (verplicht) Voorbeeld: 4
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "id": 4,
  "naam": "Kenmerk 1",
  "vraag": "",
  "omschrijving": "",
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/klanten/particulier/120954/kenmerken/4"
    }
  }
}

Kenmerk toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/kenmerken?access_token={ACCESS_TOKEN}

Zowel kenmerk als omschrijving zijn optioneel.

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/kenmerken?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
PERSOON_ID
int (verplicht) Voorbeeld: 120954
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "vraag": {
    "id": 3
  },
  "kenmerk": {
    "id": 3
  },
  "omschrijving": "kenmerk omschrijving"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/particulier/120954/kenmerken/3
Response  400
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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 ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/profielfoto?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/profielfoto?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
PERSOON_ID
int (verplicht) Voorbeeld: 120954
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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  404
VerbergBekijk
Headers
Content-Type: application/json

Profielfoto binary downloaden
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/profielfoto/download?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/profielfoto/download?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
PERSOON_ID
int (verplicht) Voorbeeld: 120954
Response  200
VerbergBekijk
Headers
Content-Type: image/png
Body
<binary data>
Response  404
VerbergBekijk
Headers
Content-Type: application/json

Rekeningnummer collectie
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/rekeningnummers?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/rekeningnummers?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PERSOON_ID
int (verplicht) Voorbeeld: 120954
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/klanten/particulier/120954/rekeningnummers"
    }
  },
  "_embedded": {
    "rekeningnummers": [
      {
        "id": 1959,
        "nummer": "662456",
        "iban": "NL58INGB0000662456",
        "bic": "INGBNL2A",
        "land_iso": "NL",
        "naam": "Jansen, Aad (A.)",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/particulier/120954/rekeningnummers/1959"
          }
        }
      }
    ]
  }
}

Rekeningnummer ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/rekeningnummers/{REKENINGNUMMER_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/rekeningnummers/1959?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PERSOON_ID
int (verplicht) Voorbeeld: 120954
REKENINGNUMMER_ID
int (verplicht) Voorbeeld: 1959
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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 toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/rekeningnummers?access_token={ACCESS_TOKEN}

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/rekeningnummers?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PERSOON_ID
int (verplicht) Voorbeeld: 120954
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Niet-bestaand rekeningnummer

{
    "iban" : "NL25RABO0136907539",
    "bic" : "RABONL2U",
    "land" : "NL",
    "type" : "Incasso"
}
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Bestaand rekeningnummer

{
    "id" : 1964,
    "type" : "Algemeen"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/particulier/120954/rekeningnummers/1964

Socialmedia collectie
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/socialmedia?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/socialmedia?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PERSOON_ID
int (verplicht) Voorbeeld: 120954
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/klanten/particulier/120954/socialmedia"
    }
  },
  "_embedded": {
    "socialmedia": [
      {
        "id": 1,
        "type": "twitter",
        "url": "http://www.twitter.com/#!/aad-jansen",
        "publiek": "ja",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/particulier/120954/socialmedia/1"
          }
        }
      },
      {
        "id": 2,
        "type": "facebook",
        "url": "http://www.facebook.com/aad-jansen",
        "publiek": "ja",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/particulier/120954/socialmedia/2"
          }
        }
      }
    ]
  }
}

Socialmedium ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/socialmedia/{SOCIALMEDIA_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/socialmedia/1?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PERSOON_ID
int (verplicht) Voorbeeld: 120954
SOCIALMEDIA_ID
int (verplicht) Voorbeeld: 1
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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 collectie
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/telefoonnummers?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/telefoonnummers?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PERSOON_ID
int (verplicht) Voorbeeld: 120954
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/klanten/particulier/120954/telefoonnummers"
    }
  },
  "_embedded": {
    "telefoonnummers": [
      {
        "id": 76402,
        "naam": "06123456789",
        "omschrijving": " ",
        "weergavenaam": "06123456789",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/particulier/120954/telefoonnummers/76402"
          }
        },
        "_embedded": {
          "types": [
            {
              "id": 1,
              "naam": "algemeen"
            }
          ]
        }
      }
    ]
  }
}

Telefoonnummer ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/telefoonnummers/{TELEFOONNUMMER_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/telefoonnummers/76403?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PERSOON_ID
int (verplicht) Voorbeeld: 120954
TELEFOONNUMMER_ID
int (verplicht) Voorbeeld: 76403
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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 toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/klanten/particulier/{PERSOON_ID}/telefoonnummers?access_token={ACCESS_TOKEN}

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/particulier/120954/telefoonnummers?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PERSOON_ID
int (verplicht) Voorbeeld: 120954
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Niet-bestaand telefoonnummer

{
    "naam": "0610485677",
    "type": "Algemeen"
}
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Bestaand telefoonnummer

{
    "id": 76411,
    "type": "Algemeen"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/particulier/120954/telefoonnummers/76411

Klant - zakelijk

Klant collectie
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/klanten/zakelijk"
    }
  },
  "_embedded": {
    "zakelijk": [
      {
        "id": 14835,
        "type": "BV",
        "naam": "AEGON",
        "kvknummer": "",
        "btwnummer": "",
        "statutairenaam": "AEGON",
        "handelsnaam": "AEGON",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835"
          }
        }
      }
    ]
  }
}

Klant ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{KLANT_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
KLANT_ID
int (verplicht) Voorbeeld: 14835
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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 toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "naam": "Faster Forward",
  "statutairenaam": "Faster Forward",
  "handelsnaam": "Faster Forward",
  "kvknummer": "12345",
  "btwnummer": "67890",
  "type": "BV"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/zakelijk/16941

Adres collectie
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/adressen?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/adressen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ORGANISATIE_ID
int (verplicht) Voorbeeld: 14835
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/adressen"
    }
  },
  "_embedded": {
    "adressen": [
      {
        "id": 9,
        "straat": "Straatnaam",
        "nummer": "1",
        "toevoeging": "",
        "postcode": "1234AB",
        "plaatsnaam": "Plaatsnaam",
        "postcodegebied": "1234",
        "longitude": "52.02824000",
        "latitude": "5.06721000",
        "categorie": "default",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/adressen/9"
          }
        },
        "_embedded": {
          "types": [
            {
              "id": 1,
              "naam": "bezoekadres"
            }
          ]
        }
      }
    ]
  }
}

Adres ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/adressen/{ADRES_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/adressen/9?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ORGANISATIE_ID
int (verplicht) Voorbeeld: 14835
ADRES_ID
int (verplicht) Voorbeeld: 9
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "id": 9,
  "straat": "Straatnaam",
  "nummer": "1",
  "toevoeging": "",
  "postcode": "1234AB",
  "plaatsnaam": "Plaatsnaam",
  "postcodegebied": "1234",
  "longitude": "52.02824000",
  "latitude": "5.06721000",
  "categorie": "default",
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/adressen/9"
    }
  },
  "_embedded": {
    "types": [
      {
        "id": 1,
        "naam": "bezoekadres"
      }
    ]
  }
}

Adres toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/adressen?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14917/adressen?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ORGANISATIE_ID
int (verplicht) Voorbeeld: 14917
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "postcode": "4651ME",
  "nummer": "3",
  "toevoeging": "B",
  "straat": "Grimbergen",
  "plaatsnaam": "Steenbergen",
  "gemeente": "Steenbergen",
  "provincie": "Noord-Brabant",
  "land": "NL",
  "categorie": "Standaard",
  "type": "Correspondentieadres"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/zakelijk/14917/adressen/7796

Emailadres collectie
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/emailadressen?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/emailadressen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ORGANISATIE_ID
int (verplicht) Voorbeeld: 14835
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/emailadressen"
    }
  },
  "_embedded": {
    "emailadressen": [
      {
        "id": 35969,
        "naam": "email00035969@dummy.nl",
        "omschrijving": null,
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/emailadressen/35969"
          }
        },
        "_embedded": {
          "types": [
            {
              "id": 1,
              "naam": "Zakelijk"
            }
          ]
        }
      }
    ]
  }
}

Emailadres ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/emailadressen/{EMAILADRES_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/emailadressen/35969?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ORGANISATIE_ID
int (verplicht) Voorbeeld: 14835
EMAILADRES_ID
int (verplicht) Voorbeeld: 35969
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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 toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/emailadressen?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/16941/emailadressen?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ORGANISATIE_ID
int (verplicht) Voorbeeld: 16941
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Niet-bestaand emailadres

{
    "naam": "emailadres@zakelijk.nl",
    "type": "Zakelijk"
}
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Bestaand emailadres

{
    "id": 40558,
    "type" : "Algemeen"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/zakelijk/16941/emailadressen/40558

Kenmerk collectie
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/kenmerken?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/kenmerken?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ORGANISATIE_ID
int (verplicht) Voorbeeld: 14835
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/kenmerken"
    }
  },
  "_embedded": {
    "kenmerken": [
      {
        "id": 5,
        "naam": "Kenmerk 3",
        "vraag": "",
        "omschrijving": "Kenmerk 3",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/kenmerken/5"
          }
        }
      }
    ]
  }
}

Kenmerk ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/kenmerken/{ORGANISATIEKENMERK_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/kenmerken/5?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ORGANISATIE_ID
int (verplicht) Voorbeeld: 14835
ORGANISATIEKENMERK_ID
int (verplicht) Voorbeeld: 5
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "id": 5,
  "naam": "Kenmerk 3",
  "vraag": "",
  "omschrijving": "Kenmerk 3",
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/kenmerken/5"
    }
  }
}

Medewerker toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/medewerkers?access_token={ACCESS_TOKEN}

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14917/medewerkers?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ORGANISATIE_ID
int (verplicht) Voorbeeld: 14917
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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
    }
  ]
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/zakelijk/14917/medewerkers/120960

Medewerker emailadres toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/medewerkers/{PERSOON_ID}/emailadressen?access_token={ACCESS_TOKEN}

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/16941/medewerkers/112794/emailadressen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ORGANISATIE_ID
int (verplicht) Voorbeeld: 16941
PERSOON_ID
int (verplicht) Voorbeeld: 112794
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Niet-bestaand emailadres

{
    "naam": "emailadres@zakelijk.nl",
    "type": "Zakelijk"
}
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Bestaand emailadres

{
    "id": 40560,
    "type" : "Algemeen"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/zakelijk/16941/medewerkers/112794/emailadressen/40560

Medewerker rekeningnummer toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/medewerkers/{PERSOON_ID}/rekeningnummers?access_token={ACCESS_TOKEN}

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/16941/medewerkers/112794/rekeningnummers?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ORGANISATIE_ID
int (verplicht) Voorbeeld: 16941
PERSOON_ID
int (verplicht) Voorbeeld: 112794
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Niet-bestaand rekeningnummer

{
    "iban" : "NL25RABO0136907539",
    "bic" : "RABONL2U",
    "land" : "NL",
    "type" : "Incasso"
}
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Bestaand rekeningnummer

{
    "id" : 1962,
    "type" : "Algemeen"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/zakelijk/16941/medewerkers/112794/rekeningnummers/1962

Medewerker telefoonnummer toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/medewerkers/{PERSOON_ID}/telefoonnummers?access_token={ACCESS_TOKEN}

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/16941/medewerkers/112794/telefoonnummers?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ORGANISATIE_ID
int (verplicht) Voorbeeld: 16941
PERSOON_ID
int (verplicht) Voorbeeld: 112794
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Niet-bestaand telefoonnummer

{
    "naam": "0610485677",
    "type": "Algemeen"
}
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Bestaand telefoonnummer

{
    "id": 76411,
    "type": "Mobiel"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/zakelijk/16941/medewerkers/112794/telefoonnummers/76411

Profielfoto meta data ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/profielfoto?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/profielfoto?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
ORGANISATIE_ID
int (verplicht) Voorbeeld: 14835
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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  404
VerbergBekijk
Headers
Content-Type: application/json

Profielfoto binary downloaden
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/profielfoto/download?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/profielfoto/download?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
ORGANISATIE_ID
int (verplicht) Voorbeeld: 14835
Response  200
VerbergBekijk
Headers
Content-Type: image/png
Body
<binary data>
Response  404
VerbergBekijk
Headers
Content-Type: application/json

Rekeningnummer collectie
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/rekeningnummers?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/rekeningnummers?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ORGANISATIE_ID
int (verplicht) Voorbeeld: 14835
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/rekeningnummers"
    }
  },
  "_embedded": {
    "rekeningnummers": [
      {
        "id": 1962,
        "nummer": "",
        "iban": "NL02ABNA0123456789",
        "bic": "",
        "landIso": "NL",
        "naam": "AEGON",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/rekeningnummers/1962"
          }
        }
      }
    ]
  }
}

Rekeningnummer ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/rekeningnummers/{REKENINGNUMMER_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/rekeningnummers/1962?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ORGANISATIE_ID
int (verplicht) Voorbeeld: 14835
REKENINGNUMMER_ID
int (verplicht) Voorbeeld: 1962
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "id": 1962,
  "nummer": "",
  "iban": "NL02ABNA0123456789",
  "bic": "",
  "landIso": "NL",
  "naam": "AEGON",
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/rekeningnummers/1962"
    }
  }
}

Rekeningnummer toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/rekeningnummers?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/16941/rekeningnummers?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ORGANISATIE_ID
int (verplicht) Voorbeeld: 16941
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Niet-bestaand rekeningnummer

{
    "iban" : "NL25RABO0136907539",
    "bic" : "RABONL2U",
    "land" : "NL",
    "type" : "Incasso"
}
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Bestaand rekeningnummer

{
    "id" : 1963,
    "type" : "Algemeen"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/zakelijk/16941/rekeningnummers/1963

Telefoonnummer collectie
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/telefoonnummers?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/telefoonnummers?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ORGANISATIE_ID
int (verplicht) Voorbeeld: 14835
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/telefoonnummers"
    }
  },
  "_embedded": {
    "telefoonnummers": [
      {
        "id": 69304,
        "naam": "999363-933 07 60",
        "omschrijving": null,
        "weergavenaam": "9993639330760",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/zakelijk/14835/telefoonnummers/69304"
          }
        },
        "_embedded": {
          "types": [
            {
              "id": 1,
              "naam": "algemeen"
            }
          ]
        }
      }
    ]
  }
}

Telefoonnummer ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/telefoonnummers/{TELEFOONNUMMER_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/14835/telefoonnummers/69304?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ORGANISATIE_ID
int (verplicht) Voorbeeld: 14835
TELEFOONNUMMER_ID
int (verplicht) Voorbeeld: 69304
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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 toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/klanten/zakelijk/{ORGANISATIE_ID}/telefoonnummers?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/klanten/zakelijk/16941/telefoonnummers?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ORGANISATIE_ID
int (verplicht) Voorbeeld: 16941
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Niet-bestaand telefoonnummer

{
    "naam": "0610485677",
    "type": "Algemeen"
}
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Bestaand telefoonnummer

{
    "id": 76411,
    "type": "Mobiel"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/klanten/zakelijk/16941/telefoonnummers/76411

Adviseur

Adviseur collectie
GET/api/data/klantdossiers/{DOSSIER_ID}/adviseurs?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/adviseurs"
    }
  },
  "_embedded": {
    "adviseurs": [
      {
        "id": 112115,
        "geslacht": "man",
        "initialen": "I.",
        "titel": "",
        "voornaam": "Voornaam",
        "tussenvoegsel": "",
        "achternaam": "Achternaam00112115",
        "bsn": "",
        "nationaliteitId": 1,
        "burgerlijkestaatId": null,
        "weergavenaam": "Achternaam00112115, Voornaam (I.)",
        "geboortedatum": "1976-03-02T00:00:00+01:00",
        "pensioendatum": "2043-03-01T00:00:00+01:00",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/adviseurs/112115"
          }
        }
      }
    ]
  }
}

Adviseur ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/adviseurs/{ADVISEUR_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ADVISEUR_ID
int (verplicht) Voorbeeld: 112115
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "id": 112115,
  "geslacht": "man",
  "initialen": "I.",
  "titel": "",
  "voornaam": "Voornaam",
  "tussenvoegsel": "",
  "achternaam": "Achternaam00112115",
  "bsn": "",
  "nationaliteitId": 1,
  "burgerlijkestaatId": null,
  "weergavenaam": "Achternaam00112115, Voornaam (I.)",
  "geboortedatum": "1976-03-02T00:00:00+01:00",
  "pensioendatum": "2043-03-01T00:00:00+01:00",
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/adviseurs/112115"
    },
    "adressen": {
      "href": "/api/data/klantdossiers/5526/adviseurs/112115/adressen"
    },
    "emailadressen": {
      "href": "/api/data/klantdossiers/5526/adviseurs/112115/emailadressen"
    },
    "profielfoto": {
      "href": "/api/data/klantdossiers/5526/adviseurs/112115/profielfoto"
    },
    "rekeningnummers": {
      "href": "/api/data/klantdossiers/5526/adviseurs/112115/rekeningnummers"
    },
    "telefoonnummers": {
      "href": "/api/data/klantdossiers/5526/adviseurs/112115/telefoonnummers"
    }
  }
}

Adres collectie
GET/api/data/klantdossiers/{DOSSIER_ID}/adviseurs/{ADVISEUR_ID}/adressen?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/adressen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ADVISEUR_ID
int (verplicht) Voorbeeld: 112115
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/adviseurs/112115/adressen"
    }
  },
  "_embedded": {
    "adressen": [
      {
        "id": 7791,
        "straat": "Bagijnenstraat",
        "nummer": "5",
        "toevoeging": "",
        "postcode": "3011HA",
        "plaatsnaam": "Rotterdam",
        "postcodegebied": "3011",
        "longitude": "4.48430363",
        "latitude": "51.92287754",
        "categorie": "default",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/adviseurs/112115/adressen/7792"
          }
        }
      }
    ]
  }
}

Adres ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/adviseurs/{ADVISEUR_ID}/adressen/{ADRES_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/adressen/7792?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ADVISEUR_ID
int (verplicht) Voorbeeld: 112115
ADRES_ID
int (verplicht) Voorbeeld: 7792
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "id": 7792,
  "straat": "Bagijnenstraat",
  "nummer": "5",
  "toevoeging": "",
  "postcode": "3011HA",
  "plaatsnaam": "Rotterdam",
  "postcodegebied": "3011",
  "longitude": "4.48430363",
  "latitude": "51.92287754",
  "categorie": "default",
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/adviseurs/112115/adressen/7792"
    }
  }
}

Emailadres collectie
GET/api/data/klantdossiers/{DOSSIER_ID}/adviseurs/{ADVISEUR_ID}/emailadressen?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/emailadressen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ADVISEUR_ID
int (verplicht) Voorbeeld: 112115
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/adviseurs/112115/emailadressen"
    }
  },
  "_embedded": {
    "emailadressen": [
      {
        "id": 35897,
        "naam": "email00035897@dummy.nl",
        "omschrijving": null,
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/adviseurs/112115/emailadressen/35897"
          }
        },
        "_embedded": {
          "types": [
            {
              "id": 3,
              "naam": "Algemeen"
            }
          ]
        }
      }
    ]
  }
}

Emailadres ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/adviseurs/{ADVISEUR_ID}/emailadressen/{EMAILADRES_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/emailadressen/35897?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ADVISEUR_ID
int (verplicht) Voorbeeld: 112115
EMAILADRES_ID
int (verplicht) Voorbeeld: 35897
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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 ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/adviseurs/{ADVISEUR_ID}/profielfoto?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/profielfoto?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ADVISEUR_ID
int (verplicht) Voorbeeld: 112115
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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  404
VerbergBekijk
Headers
Content-Type: application/json

Profielfoto binary downloaden
GET/api/data/klantdossiers/{DOSSIER_ID}/adviseurs/{ADVISEUR_ID}/profielfoto/download?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/profielfoto/download?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ADVISEUR_ID
int (verplicht) Voorbeeld: 112115
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: image/png
Body
<binary data>
Response  404
VerbergBekijk
Headers
Content-Type: application/json

Rekeningnummer collectie
GET/api/data/klantdossiers/{DOSSIER_ID}/adviseurs/{ADVISEUR_ID}/rekeningnummers?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/rekeningnummers?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ADVISEUR_ID
int (verplicht) Voorbeeld: 112115
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/adviseurs/112115/rekeningnummers"
    }
  },
  "_embedded": {
    "rekeningnummers": [
      {
        "id": 1958,
        "nummer": "662632",
        "iban": "NL59INGB0000662632",
        "bic": "INGBNL2A",
        "land_iso": "NL",
        "naam": "Achternaam00112115, Voornaam (I.)",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/adviseurs/112115/rekeningnummers/1958"
          }
        }
      }
    ]
  }
}

Rekeningnummer ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/adviseurs/{ADVISEUR_ID}/rekeningnummers/{REKENINGNUMMER_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/rekeningnummers/1958?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ADVISEUR_ID
int (verplicht) Voorbeeld: 112115
REKENINGNUMMER_ID
int (verplicht) Voorbeeld: 1958
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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 collectie
GET/api/data/klantdossiers/{DOSSIER_ID}/adviseurs/{ADVISEUR_ID}/telefoonnummers?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/telefoonnummers?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ADVISEUR_ID
int (verplicht) Voorbeeld: 112115
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/adviseurs/112115/telefoonnummers"
    }
  },
  "_embedded": {
    "telefoonnummers": [
      {
        "id": 75383,
        "naam": "9993693079369",
        "omschrijving": null,
        "computednaam": "9993693079369",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/adviseurs/112115/telefoonnummers/75383"
          }
        },
        "_embedded": {
          "types": [
            {
              "id": 5,
              "naam": "mobiel"
            }
          ]
        }
      }
    ]
  }
}

Telefoonnummer ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/adviseurs/{ADVISEUR_ID}/telefoonnummers/{TELEFOONNUMMER_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/adviseurs/112115/telefoonnummers/75383?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ADVISEUR_ID
int (verplicht) Voorbeeld: 112115
TELEFOONNUMMER_ID
int (verplicht) Voorbeeld: 75383
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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 ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/kantoor?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/kantoor?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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 collectie
GET/api/data/klantdossiers/{DOSSIER_ID}/kantoor/adressen?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/kantoor/adressen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/kantoor/adressen"
    }
  },
  "_embedded": {
    "adressen": [
      {
        "id": 7791,
        "straat": "Nieuwemarkt",
        "nummer": "3",
        "toevoeging": "",
        "postcode": "3011HP",
        "plaatsnaam": "Rotterdam",
        "postcodegebied": "3011",
        "longitude": "4.48752316",
        "latitude": "51.92270340",
        "categorie": "default",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/kantoor/adressen/7791"
          }
        }
      }
    ]
  }
}

Adres ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/kantoor/adressen/{ADRES_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/kantoor/adressen/7791?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ADRES_ID
int (verplicht) Voorbeeld: 7791
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "id": 7791,
  "straat": "Nieuwemarkt",
  "nummer": "3",
  "toevoeging": "",
  "postcode": "3011HP",
  "plaatsnaam": "Rotterdam",
  "postcodegebied": "3011",
  "longitude": "4.48752316",
  "latitude": "51.92270340",
  "categorie": "default",
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/kantoor/adressen/7791"
    }
  }
}

Emailadres collectie
GET/api/data/klantdossiers/{DOSSIER_ID}/kantoor/emailadressen?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/kantoor/emailadressen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/kantoor/emailadressen"
    }
  },
  "_embedded": {
    "emailadressen": [
      {
        "id": 40557,
        "naam": "deelnemer@deelnemer.nl",
        "omschrijving": "",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/kantoor/emailadressen/40557"
          }
        },
        "_embedded": {
          "types": [
            {
              "id": 1,
              "naam": "Zakelijk"
            }
          ]
        }
      }
    ]
  }
}

Emailadres ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/kantoor/emailadressen/{EMAILADRES_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/kantoor/emailadressen/40557?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
EMAILADRES_ID
int (verplicht) Voorbeeld: 40557
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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 ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/kantoor/profielfoto?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/kantoor/profielfoto?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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  404
VerbergBekijk
Headers
Content-Type: application/json

Profielfoto binary downloaden
GET/api/data/klantdossiers/{DOSSIER_ID}/kantoor/profielfoto/download?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/kantoor/profielfoto/download?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: image/png
Body
<binary data>
Response  404
VerbergBekijk
Headers
Content-Type: application/json

Telefoonnummer collectie
GET/api/data/klantdossiers/{DOSSIER_ID}/kantoor/telefoonnummers?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/kantoor/telefoonnummers?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/kantoor/telefoonnummers"
    }
  },
  "_embedded": {
    "telefoonnummers": [
      {
        "id": 76408,
        "naam": "0611112222",
        "omschrijving": "",
        "weergavenaam": "0611112222",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/kantoor/telefoonnummers/76408"
          }
        },
        "_embedded": {
          "types": [
            {
              "id": 1,
              "naam": "algemeen"
            }
          ]
        }
      }
    ]
  }
}

Telefoonnummer ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/kantoor/telefoonnummers/{TELEFOONNUMMER_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/kantoor/telefoonnummers/76408?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
TELEFOONNUMMER_ID
int (verplicht) Voorbeeld: 76408
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "id": 76408,
  "naam": "0611112222",
  "omschrijving": "",
  "weergavenaam": "0611112222",
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/kantoor/telefoonnummers/76408"
    }
  },
  "_embedded": {
    "types": [
      {
        "id": 1,
        "naam": "algemeen"
      }
    ]
  }
}

Bezitting

Bezitting collectie
GET/api/data/klantdossiers/{DOSSIER_ID}/bezittingen?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bezittingen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/bezittingen"
    }
  },
  "_embedded": {
    "bezittingen": [
      {
        "id": 179,
        "omschrijving": "Opel Astra",
        "merk": "Opel",
        "cataloguswaarde": "24000.00",
        "aankoopbedrag": "5000.00",
        "huidigeWaardedatum": "2014-06-01T00:00:00+02:00",
        "huidigeWaarde": "4000.00",
        "waardewisseling": "0.0000",
        "kenteken": "11-AA-11",
        "bouwjaar": "2004-02-20T00:00:00+01:00",
        "gewicht": 1160,
        "type": "car",
        "model": "",
        "gearchiveerd": false,
        "categorie": "vehicle",
        "soort": null,
        "aankoopdatum": "2012-03-01T00:00:00+01:00",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/bezittingen/179"
          }
        }
      }
    ]
  }
}

Bezitting ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/bezittingen/{BEZITTING_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bezittingen/179?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
BEZITTING_ID
int (verplicht) Voorbeeld: 179
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "id": 179,
  "omschrijving": "Opel Astra",
  "merk": "Opel",
  "cataloguswaarde": "24000.00",
  "aankoopbedrag": "5000.00",
  "huidigeWaardedatum": "2014-06-01T00:00:00+02:00",
  "huidigeWaarde": "4000.00",
  "waardewisseling": "0.0000",
  "kenteken": "11-AA-11",
  "bouwjaar": "2004-02-20T00:00:00+01:00",
  "gewicht": 1160,
  "type": "car",
  "model": "",
  "gearchiveerd": false,
  "categorie": "vehicle",
  "soort": null,
  "aankoopdatum": "2012-03-01T00:00:00+01:00",
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/bezittingen/179"
    }
  }
}

Producten

Product collectie
GET/api/data/klantdossiers/{DOSSIER_ID}/producten?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/producten?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/producten"
    }
  },
  "_embedded": {
    "producten": [
      {
        "id": 6732,
        "type": 1,
        "offertenummer": "",
        "omschrijving": "Hypotheek",
        "status": "Aanvraag nieuw",
        "invoerAanvraag": "2016-07-11T00:00:00+02:00",
        "maatschappij": "ABN AMRO",
        "passeerdatum": "2010-09-01T00:00:00+02:00",
        "passeerdatumDefinitief": "nee",
        "hoofdsom": "200000.00",
        "inschrijving": "225000.00",
        "renteaanbodAangevraagd": "2010-07-11T00:00:00+02:00",
        "ontbindendeVoorwaarden": "2010-07-17T00:00:00+02:00",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/hypotheken/6732"
          }
        }
      },
      {
        "id": 6733,
        "type": 11,
        "offertenummer": "1010",
        "omschrijving": "Profile print",
        "status": "Aanvraag compleet",
        "invoerAanvraag": "2016-07-11T00:00:00+02:00",
        "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",
        "omschrijving": "Dienst",
        "status": "Aanvraag nieuw",
        "invoerAanvraag": "2016-07-11T00:00:00+02:00",
        "maatschappij": "CO00014830",
        "ingangsdatum": "2011-03-08T00:00:00+01:00",
        "ingangsdatumDefinitief": "ja",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/diensten/6734"
          }
        }
      },
      {
        "id": 6735,
        "type": 15,
        "offertenummer": " ",
        "omschrijving": "Hypotheekadvies",
        "status": "Aanvraag nieuw",
        "invoerAanvraag": "2016-07-11T00:00:00+02:00",
        "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,
        "offertenummer": "1234-A",
        "omschrijving": "Bankgarantie",
        "status": "Aanvraag nieuw",
        "invoerAanvraag": "2016-07-11T00:00:00+02:00",
        "maatschappij": "ABN AMRO",
        "passeerdatum": "2010-02-22T00:00:00+01:00",
        "passeerdatumDefinitief": "nee",
        "hoofdsom": "200000.00",
        "inschrijving": "225000.00",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/bankgaranties/6736"
          }
        }
      },
      {
        "id": 6741,
        "type": 9,
        "offertenummer": "140",
        "omschrijving": "Contract",
        "status": "Aanvraag nieuw",
        "invoerAanvraag": "2016-07-11T00:00:00+02:00",
        "maatschappij": "CO00014830",
        "startdatum": "2012-09-08T00:00:00+02:00",
        "startdatumDefinitief": "ja",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/contracten/6741"
          }
        }
      },
      {
        "id": 6742,
        "type": 2,
        "offertenummer": "111018(1)",
        "omschrijving": "ORV annuïtair dalend",
        "status": "Aanvraag nieuw",
        "invoerAanvraag": "2016-07-11T00:00:00+02:00",
        "garantiekapitaal": "0.00",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/levensverzekeringen/6742"
          }
        }
      },
      {
        "id": 6743,
        "type": 48,
        "offertenummer": "132",
        "omschrijving": "Consumptief krediet",
        "status": "Aanvraag nieuw",
        "invoerAanvraag": "2016-07-11T00:00:00+02:00",
        "maatschappij": "DAK Hypotheken",
        "ingangsdatum": "2011-10-14T00:00:00+02:00",
        "ingangsdatumDefinitief": "ja",
        "gewenstBedrag": "20000.00",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/consumptiefkredieten/6743"
          }
        }
      },
      {
        "id": 6744,
        "type": 5,
        "offertenummer": "9874F874-B",
        "omschrijving": "Inkomensverzekering",
        "status": "Aanvraag nieuw",
        "invoerAanvraag": "2016-07-11T00:00:00+02:00",
        "maatschappij": "Callas Group",
        "ingangsdatum": "2016-09-01T00:00:00+02:00",
        "ingangsdatumDefinitief": "ja",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/inkomensverzekeringen/6744"
          }
        }
      },
      {
        "id": 6745,
        "type": 8,
        "offertenummer": "134",
        "omschrijving": "Pensioen",
        "status": "Aanvraag nieuw",
        "invoerAanvraag": "2016-07-11T00:00:00+02:00",
        "maatschappij": "Reaal",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/pensioenen/6745"
          }
        }
      },
      {
        "id": 6747,
        "type": 3,
        "offertenummer": "144",
        "omschrijving": "Vermogen en bancair",
        "status": "Aanvraag nieuw",
        "invoerAanvraag": "2016-07-11T00:00:00+02:00",
        "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,
        "offertenummer": "15N27530735",
        "omschrijving": "Uitvaartverz. olv dhr.",
        "status": "Aanvraag nieuw",
        "invoerAanvraag": "2016-07-11T00:00:00+02:00",
        "maatschappij": "Dela Verzekeringen",
        "ingangsdatum": "2016-06-06T00:00:00+02:00",
        "kinderenMeeverzekeren": "nee",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/uitvaartverzekeringen/6748"
          }
        }
      }
    ]
  }
}

Bankgarantie ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/bankgaranties/{PRODUCT_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bankgaranties/6736?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6736
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "id": 6736,
  "type": 19,
  "offertenummer": "1234-A",
  "omschrijving": "Bankgarantie",
  "status": "Aanvraag nieuw",
  "invoerAanvraag": "2016-07-11T00:00:00+02:00",
  "maatschappij": "ABN AMRO",
  "passeerdatum": "2010-02-22T00:00:00+01:00",
  "passeerdatumDefinitief": "nee",
  "hoofdsom": "200000.00",
  "inschrijving": "225000.00",
  "_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 ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/bankgaranties/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]&publiek={publiek}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bankgaranties/6736/registraties?access_token=3b57bd2db21c46d2875508b982968d26]&publiek=0
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6736
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
publiek
int (optioneel) Voorbeeld: 0
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_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 toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/bankgaranties/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bankgaranties/6736/registraties?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6736
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Zie Klantdossier - Registratie toevoegen
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/bankgaranties/6736/registraties/275826

Bankgarantie taak toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/bankgaranties/{PRODUCT_ID}/taken?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bankgaranties/6736/taken?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6736
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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
  }
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/bankgaranties/6736/taken/55519

Bankgarantie workflow toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/bankgaranties/{PRODUCT_ID}/workflows?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/bankgaranties/6736/workflows?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6736
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "workflow": {
    "id": 21
  }
}
Response  204
VerbergBekijk
Headers
Content-Type: application/json

Consumptief krediet ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/consumptiefkredieten/{PRODUCT_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/consumptiefkredieten/6743?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6743
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "id": 6743,
  "type": 48,
  "offertenummer": "132",
  "omschrijving": "Consumptief krediet",
  "status": "Aanvraag nieuw",
  "invoerAanvraag": "2016-07-11T00:00:00+02:00",
  "maatschappij": "DAK Hypotheken",
  "ingangsdatum": "2011-10-14T00:00:00+02:00",
  "ingangsdatumDefinitief": "ja",
  "gewenstBedrag": "20000.00",
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/consumptiefkredieten/6743"
    }
  },
  "_embedded": {
    "correspondentieadres": {
      "id": 7793,
      "straat": "Groenhof",
      "nummer": "1",
      "toevoeging": "",
      "postcode": "1275BB",
      "plaatsnaam": "Huizen",
      "postcodegebied": "1275",
      "longitude": "5.26394006",
      "latitude": "52.28904947",
      "categorie": "default",
      "_embedded": {
        "types": [
          {
            "id": 1,
            "naam": "bezoekadres"
          }
        ]
      }
    },
    "aanvragers": [
      {
        "id": 120954,
        "geslacht": "man",
        "initialen": "A.",
        "titel": "",
        "voornaam": "Aad",
        "tussenvoegsel": "",
        "achternaam": "Jansen",
        "bsn": "559795178",
        "nationaliteitId": 1,
        "burgerlijkestaatId": 1,
        "weergavenaam": "Jansen, Aad (A.)",
        "geboortedatum": "1960-01-01T00:00:00+01:00",
        "pensioendatum": "2027-01-01T00:00:00+01:00",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/120954"
          },
          "adressen": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/adressen"
          },
          "emailadressen": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/emailadressen"
          },
          "rekeningnummers": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/rekeningnummers"
          },
          "telefoonnummers": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/telefoonnummers"
          }
        }
      }
    ],
    "productdelen": [
      {
        "id": 7904,
        "product": "Persoonlijke lening",
        "productgroep": "Persoonlijke lening",
        "leenbedrag": "20000.00",
        "contractnummer": "132",
        "termijnbedrag": "500.00",
        "theoretischeLooptijd": 12,
        "theoretischeEinddatum": "2012-10-14T00:00:00+02:00"
      }
    ]
  }
}

Consumptief krediet toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/consumptiefkredieten?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/consumptiefkredieten?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "omschrijving": "Consumptief Krediet",
  "status": {
    "id": 1
  },
  "bestaandePropositie": {
    "id": 3334
  },
  "afgeslotenDoor": {
    "id": 112115
  },
  "acceptantWorkflowgroep": {
    "id": 45
  },
  "dossierVerantwoordelijkeWorkflowgroep": {
    "id": 45
  },
  "bronvermelding": {
    "id": 3
  },
  "aanbrengerPersoon": {
    "id": 120956
  },
  "aanbrengerOrganisatie": {
    "id": 14851
  },
  "offertenummer": "12345",
  "aanvraagVerzonden": "2016-01-01",
  "aanvraagVerzondenDefinitief": true,
  "uitbetalingsdatum": "2016-01-01",
  "uitbetalingsdatumDefinitief": true,
  "akkoordBank": "2016-01-01",
  "contractOntvangen": "2016-01-01",
  "stukkenOpgevraagd": "2016-01-01",
  "contractVerzondenNaarKlant": "2016-01-01",
  "stukkenCompleet": "2016-01-01",
  "contractGetekendRetour": "2016-01-01",
  "getekendContractNaarMaatschappij": "2016-01-01",
  "contractVervaldatum": "2016-01-01",
  "aanvragersParticulier": [
    {
      "id": 120954
    },
    {
      "id": 120955
    }
  ],
  "eersteAanvrager": {
    "id": 120955
  },
  "correspondentieadres": {
    "id": 7793
  },
  "financieringsdoel": "(Nog) Niet bekend",
  "maatschappij": {
    "id": 14876
  },
  "inkoopVia": {
    "id": 15100
  },
  "gewenstbedrag": 2000,
  "gewenstMaandbedrag": 100,
  "aantalKinderen": 1,
  "toelichting": "nvt",
  "artikel": {
    "id": 20684
  },
  "codeprovisiemijtype": "CE001",
  "contractnummer": "12345",
  "leenbedrag": 2000,
  "depot": 100,
  "blokkade": true,
  "inlossaldo": 100,
  "uitTeBetalen": 100,
  "termijnbedrag": 100,
  "percentageDoorlopendKrediet": 100,
  "aflossingsvrij": 100,
  "nominaleMaandrente": 100,
  "effectieveJaarrente": 100,
  "kredietvergoeding": 100,
  "totaleKredietsom": 100,
  "theoretischeLooptijd": 100,
  "theoretischeEinddatum": "2016-01-01",
  "uitbetalingLand": "AD",
  "uitbetalingBank": "RABOBANK NEDERLAND",
  "uitbetalingRekeningnummer": "136907539",
  "uitbetalingBicnummer": "RABONL2U",
  "uitbetalingIbannummer": "NL25RABO0136907539",
  "toonindigimap": true,
  "gearchiveerd": false
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/consumptiefkredieten/6758

Consumptief krediet registratie ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/consumptiefkredieten/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]&publiek={publiek}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/consumptiefkredieten/6743/registraties?access_token=3b57bd2db21c46d2875508b982968d26]&publiek=0
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6743
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
publiek
int (optioneel) Voorbeeld: 0
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_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 toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/consumptiefkredieten/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/consumptiefkredieten/6743/registraties?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6743
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Zie Klantdossier - Registratie toevoegen
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/consumptiefkredieten/6743/registraties/275826

Consumptief krediet taak toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/consumptiefkredieten/{PRODUCT_ID}/taken?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/consumptiefkredieten/6755/taken?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6755
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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
  }
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/consumptiefkredieten/6755/taken/55519

Consumptief krediet workflow toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/consumptiefkredieten/{PRODUCT_ID}/workflows?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/consumptiefkredieten/6743/workflows?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6743
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "workflow": {
    "id": 21
  }
}
Response  204
VerbergBekijk
Headers
Content-Type: application/json

Contract ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/contracten/{PRODUCT_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/contracten/6741?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6741
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "id": 6741,
  "type": 9,
  "offertenummer": "140",
  "omschrijving": "Contract",
  "status": "Aanvraag nieuw",
  "invoerAanvraag": "2016-07-11T00:00:00+02:00",
  "maatschappij": "CO00014830",
  "startdatum": "2012-09-08T00:00:00+02:00",
  "startdatumDefinitief": "ja",
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/contracten/6741"
    }
  },
  "_embedded": {
    "correspondentieadres": {
      "id": 7793,
      "straat": "Groenhof",
      "nummer": "1",
      "toevoeging": "",
      "postcode": "1275BB",
      "plaatsnaam": "Huizen",
      "postcodegebied": "1275",
      "longitude": "5.26394006",
      "latitude": "52.28904947",
      "categorie": "default",
      "_embedded": {
        "types": [
          {
            "id": 1,
            "naam": "bezoekadres"
          }
        ]
      }
    },
    "aanvragers": [
      {
        "id": 120954,
        "geslacht": "man",
        "initialen": "A.",
        "titel": "",
        "voornaam": "Aad",
        "tussenvoegsel": "",
        "achternaam": "Jansen",
        "bsn": "559795178",
        "nationaliteitId": 1,
        "burgerlijkestaatId": 1,
        "weergavenaam": "Jansen, Aad (A.)",
        "geboortedatum": "1960-01-01T00:00:00+01:00",
        "pensioendatum": "2027-01-01T00:00:00+01:00",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/120954"
          },
          "adressen": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/adressen"
          },
          "emailadressen": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/emailadressen"
          },
          "rekeningnummers": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/rekeningnummers"
          },
          "telefoonnummers": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/telefoonnummers"
          }
        }
      }
    ],
    "productdelen": [
      {
        "id": 7902,
        "product": "Contract",
        "referentie": "cntr",
        "verkoopprijs": "125.00",
        "premietermijn": "eenmalig",
        "contractduur": 12,
        "hoofdvervaldatum": "2013-09-08T00:00:00+02:00",
        "looptijdVerplichting": 6,
        "vervaldatum": "2013-03-08T00:00:00+01:00"
      }
    ]
  }
}

Contract toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/contracten?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/contracten?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "omschrijving": "Contract",
  "status": {
    "id": 1
  },
  "bestaandePropositie": {
    "id": 3334
  },
  "accountmanager": {
    "id": 112115
  },
  "administratieWorkflowgroep": {
    "id": 45
  },
  "accountBeheerderWorkflowgroep": {
    "id": 45
  },
  "bronvermelding": {
    "id": 3
  },
  "aanbrengerPersoon": {
    "id": 120956
  },
  "aanbrengerOrganisatie": {
    "id": 14851
  },
  "aanvragersParticulier": [
    {
      "id": 120954
    },
    {
      "id": 120955
    }
  ],
  "eersteAanvrager": {
    "id": 120955
  },
  "correspondentieadres": {
    "id": 7793
  },
  "contractnummer": "12345",
  "contractDatum": "2016-01-01",
  "contractDatumDefinitief": true,
  "startdatum": "2016-01-01",
  "startdatumDefinitief": true,
  "eindeTekendatum": "2016-01-01",
  "getekendContractOntvangen": "2016-01-01",
  "dossierCompleet": "2016-01-01",
  "finaalAkkoord": "2016-01-01",
  "leverancier": {
    "id": 14830
  },
  "inkoopVia": {
    "id": 15100
  },
  "toelichting": "nvt",
  "gearchiveerd": false,
  "toonindigimap": true
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/contracten/6757

Contractdeel toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/contracten/{PRODUCT_ID}/onderdelen?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/contracten/6757/onderdelen?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6757
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "artikel": {
    "id": 16198
  },
  "referentie": "12345",
  "kostprijs": 100,
  "btw": {
    "id": 5
  },
  "aantal": 1,
  "verkoopprijs": 250,
  "premietermijnverkoopprijs": "Maand",
  "marge": 0,
  "korting": 0,
  "kortingtype": "Bedrag",
  "incasso": 0,
  "betalingstermijn": "Maand",
  "looptijdverplichting": 12,
  "vervaldatum": "2018-01-01"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/contracten/6757/onderdelen/7919

Contract registratie ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/contracten/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]&publiek={publiek}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/contracten/6757/registraties?access_token=3b57bd2db21c46d2875508b982968d26]&publiek=0
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6757
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
publiek
int (optioneel) Voorbeeld: 0
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_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 toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/contracten/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/contracten/6757/registraties?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6757
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Zie Klantdossier - Registratie toevoegen
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/contracten/6757/registraties/275826

Contract taak toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/contracten/{PRODUCT_ID}/taken?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/contracten/6755/taken?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6755
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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
  }
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/contracten/6755/taken/55519

Contract workflow toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/contracten/{PRODUCT_ID}/workflows?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/contracten/6757/workflows?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6757
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "workflow": {
    "id": 21
  }
}
Response  204
VerbergBekijk
Headers
Content-Type: application/json

Dienst ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/diensten/{PRODUCT_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/diensten/6734?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6734
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "id": 6734,
  "type": 43,
  "offertenummer": "120",
  "omschrijving": "Dienst",
  "status": "Aanvraag nieuw",
  "invoerAanvraag": "2016-07-11T00:00:00+02:00",
  "maatschappij": "CO00014830",
  "ingangsdatum": "2011-03-08T00:00:00+01:00",
  "ingangsdatumDefinitief": "ja",
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/diensten/6734"
    }
  },
  "_embedded": {
    "correspondentieadres": {
      "id": 7793,
      "straat": "Groenhof",
      "nummer": "1",
      "toevoeging": "",
      "postcode": "1275BB",
      "plaatsnaam": "Huizen",
      "postcodegebied": "1275",
      "longitude": "5.26394006",
      "latitude": "52.28904947",
      "categorie": "default",
      "_embedded": {
        "types": [
          {
            "id": 1,
            "naam": "bezoekadres"
          }
        ]
      }
    },
    "aanvragers": [
      {
        "id": 120954,
        "geslacht": "man",
        "initialen": "A.",
        "titel": "",
        "voornaam": "Aad",
        "tussenvoegsel": "",
        "achternaam": "Jansen",
        "bsn": "559795178",
        "nationaliteitId": 1,
        "burgerlijkestaatId": 1,
        "weergavenaam": "Jansen, Aad (A.)",
        "geboortedatum": "1960-01-01T00:00:00+01:00",
        "pensioendatum": "2027-01-01T00:00:00+01:00",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/120954"
          }
        }
      }
    ],
    "productdelen": [
      {
        "id": 7893,
        "product": "Abonnement Comfort Family",
        "omschrijving": "Abonnement comfort",
        "betalingstermijn": "maand",
        "verkoopprijs": "1.46",
        "btw": "BTW 19% exclusief"
      },
      {
        "id": 7895,
        "product": "Advies - Doorstromer",
        "omschrijving": "Hypotheekadvies",
        "betalingstermijn": "eenmalig",
        "verkoopprijs": "1500.00",
        "btw": null
      }
    ]
  }
}

Dienst toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/diensten?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/diensten?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "omschrijving": "Dienst",
  "status": {
    "id": 1
  },
  "bestaandePropositie": {
    "id": 3334
  },
  "accountmanager": {
    "id": 112115
  },
  "administratieWorkflowgroep": {
    "id": 45
  },
  "accountBeheerderWorkflowgroep": {
    "id": 45
  },
  "bronvermelding": {
    "id": 3
  },
  "aanbrengerPersoon": {
    "id": 120956
  },
  "aanbrengerOrganisatie": {
    "id": 14851
  },
  "offertenummer": "12345",
  "tekendatum": "2016-01-01",
  "tekendatumDefinitief": true,
  "opleverdatum": "2016-01-01",
  "opleverdatumDefinitief": true,
  "aanvragerRol": "Particulier",
  "aanvragersParticulier": [
    {
      "id": 120954
    },
    {
      "id": 120955
    }
  ],
  "eersteAanvrager": {
    "id": 120954
  },
  "correspondentieadres": {
    "id": 7793
  },
  "leverancier": {
    "id": 14830
  },
  "inkoopVia": {
    "id": 15100
  },
  "toelichting": "nvt",
  "toonindigimap": true,
  "gearchiveerd": false
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/diensten/6754

Dienstdeel toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/diensten/{PRODUCT_ID}/delen?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/diensten/6754/delen?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6754
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "artikel": {
    "id": 20615
  },
  "omschrijving": "Dienst",
  "kostprijs": 80,
  "btw": {
    "id": 5
  },
  "aantalStuks": 1,
  "verkoopprijs": 100,
  "verkoopprijsTermijn": "Maand",
  "marge": 0,
  "kortingtype": "Bedrag",
  "korting": 5,
  "betalingstermijn": "Maand",
  "looptijd": 1,
  "hoofdvervaldatum": "2017-02-01",
  "looptijdVerplichting": 100,
  "vervaldatum": "2017-02-01"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/diensten/6754/delen/7916

Dienst registratie toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/diensten/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/diensten/6755/registraties?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6755
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Zie Klantdossier - Registratie toevoegen
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/diensten/6755/registraties/275826

Dienst taak toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/diensten/{PRODUCT_ID}/taken?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/diensten/6755/taken?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6755
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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
  }
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/diensten/6755/taken/55519

Dienst workflow toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/diensten/{PRODUCT_ID}/workflows?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/diensten/6754/workflows?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6754
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "workflow": {
    "id": 21
  }
}
Response  204
VerbergBekijk
Headers
Content-Type: application/json

Hypotheek ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/hypotheken/{PRODUCT_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheken/6732?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6732
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "id": 6732,
  "type": 1,
  "offertenummer": "",
  "omschrijving": "Hypotheek",
  "status": "Aanvraag nieuw",
  "invoerAanvraag": "2016-07-11T00:00:00+02:00",
  "maatschappij": "ABN AMRO",
  "passeerdatum": "2010-09-01T00:00:00+02:00",
  "passeerdatumDefinitief": "nee",
  "hoofdsom": "200000.00",
  "inschrijving": "225000.00",
  "renteaanbodAangevraagd": "2010-07-11T00:00:00+02:00",
  "ontbindendeVoorwaarden": "2010-07-17T00:00:00+02:00",
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/hypotheken/6732"
    }
  },
  "_embedded": {
    "onderpandadres": {
      "id": 7790,
      "straat": "Nieuwemarkt",
      "nummer": "2",
      "toevoeging": "",
      "postcode": "3011HP",
      "plaatsnaam": "Rotterdam",
      "postcodegebied": "3011",
      "longitude": null,
      "latitude": null,
      "categorie": "default",
      "_links": {
        "self": {
          "href": "/api/data/klantdossiers/5526/hypotheken/6732/adressen/7790"
        }
      },
      "_embedded": {
        "types": [
          {
            "id": 7,
            "naam": "correspondentieadres"
          },
          {
            "id": 7,
            "naam": "correspondentieadres"
          }
        ]
      }
    },
    "correspondentieadres": {
      "id": 7793,
      "straat": "Groenhof",
      "nummer": "1",
      "toevoeging": "",
      "postcode": "1275BB",
      "plaatsnaam": "Huizen",
      "postcodegebied": "1275",
      "longitude": "5.26394006",
      "latitude": "52.28904947",
      "categorie": "default",
      "_embedded": {
        "types": [
          {
            "id": 1,
            "naam": "bezoekadres"
          }
        ]
      }
    },
    "aanvrager": [
      {
        "id": 120954,
        "geslacht": "man",
        "initialen": "A.",
        "titel": "",
        "voornaam": "Aad",
        "tussenvoegsel": "",
        "achternaam": "Jansen",
        "bsn": "559795178",
        "nationaliteitId": 1,
        "burgerlijkestaatId": 1,
        "weergavenaam": "Jansen, Aad (A.)",
        "geboortedatum": "1960-01-01T00:00:00+01:00",
        "pensioendatum": "2027-01-01T00:00:00+01:00",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/120954"
          }
        }
      },
      {
        "id": 120955,
        "geslacht": "vrouw",
        "initialen": "K.",
        "titel": "",
        "voornaam": "Kim",
        "tussenvoegsel": "",
        "achternaam": "Jansen - de Jong",
        "bsn": "004864645",
        "nationaliteitId": 1,
        "burgerlijkestaatId": 1,
        "weergavenaam": "Jansen - de Jong, Kim (K.)",
        "geboortedatum": "1965-04-21T00:00:00+01:00",
        "pensioendatum": "2032-04-21T00:00:00+02:00",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/120955"
          }
        }
      }
    ],
    "productdelen": [
      {
        "id": 7891,
        "product": "ABN AMRO Aflossingsvrije hypotheek (ABN AMRO Basis Hypotheek - 2)",
        "looptijd": 360,
        "hypotheeknummer": "ABN-001",
        "hypotheekvorm": "Aflossingsvrije hypotheek",
        "deelHoofdsom": "80000.00",
        "maandelijksBedrag": "400.00",
        "einddatum": "2040-09-01T00:00:00+01:00",
        "rentepercentage": "5.00",
        "rentetype": "Rentevast",
        "rentevastperiode": 240,
        "rentevastEinddatum": "2030-09-01T00:00:00+02:00",
        "rentekorting": "0.10",
        "rentebedenktijd": null
      },
      {
        "id": 7892,
        "product": "ABN AMRO Spaargroeihypotheek (ABN AMRO Basis Hypotheek - 2)",
        "looptijd": 360,
        "hypotheeknummer": "0984-B",
        "hypotheekvorm": "Spaarverzekering",
        "deelHoofdsom": "120000.00",
        "maandelijksBedrag": "0.00",
        "einddatum": "2040-09-01T00:00:00+01:00",
        "rentepercentage": "5.00",
        "rentetype": "Rentevast",
        "rentevastperiode": 240,
        "rentevastEinddatum": "2030-09-01T00:00:00+02:00",
        "rentekorting": null,
        "rentebedenktijd": null
      }
    ]
  }
}

Hypotheek toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/hypotheken?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheken?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "portefeuille": "Eigen beheer",
  "omschrijving": "Omschrijving",
  "status": {
    "id": 1
  },
  "bestaandePropositie": {
    "id": 3334
  },
  "propositietype": "Derde vervolghypotheek (nieuwe geldgever)",
  "afgeslotenDoor": {
    "id": 112115
  },
  "acceptantWorkflowgroep": {
    "id": 45
  },
  "dossierVerantwoordelijkeWorkflowgroep": {
    "id": 45
  },
  "bronvermelding": {
    "id": 3
  },
  "aanbrengerPersoon": {
    "id": 120956
  },
  "aanbrengerOrganisatie": {
    "id": 14851
  },
  "offertenummer": "12345",
  "renteaanbodAangevraagd": "2016-01-01",
  "ontbindendeVoorwaarden": "2016-01-01",
  "passeerdatum": "2016-01-01",
  "passeerdatumDefinitief": true,
  "ontvangstRenteaanbod": "2016-01-01",
  "eindeTekendatumRenteaanbod": "2016-01-01",
  "verloopdatumRenteaanbod": "2016-01-01",
  "getekendRenteaanbodOntvangen": "2016-01-01",
  "getekendRenteaanbodNaarMaatschappij": "2016-01-01",
  "dossierCompleet": "2016-01-01",
  "dossierCompleetNaarMaatschappij": "2016-01-01",
  "finaalAkkoord": "2016-01-01",
  "ontvangstHypotheekaanbod": "2016-01-01",
  "eindeTekendatumHypotheekaanbod": "2016-01-01",
  "verloopdatumHypotheekaanbod": "2016-01-01",
  "getekendHypotheekaanbodOntvangen": "2016-01-01",
  "getekendHypotheekaanbodNaarMaatschappij": "2016-01-01",
  "dossierNaarNotaris": "2016-01-01",
  "ontvangstAfrekening": "2016-01-01",
  "afrekeningGecontroleerd": "2016-01-01",
  "einddatumVerlenging": "2016-01-01",
  "verhuisdatum": "2016-01-01",
  "afgelegd": "2016-01-01",
  "aanvragersParticulier": [
    {
      "id": 120954
    },
    {
      "id": 120955
    }
  ],
  "eersteAanvrager": {
    "id": 120954
  },
  "maatschappij": {
    "id": 14831
  },
  "productgroep": {
    "id": 801
  },
  "inkoopVia": {
    "id": 15100
  },
  "hoofdsom": 250000,
  "norm": "NHG",
  "borgtochtprovisieNHG": 100,
  "risicoklasse": 100,
  "risicoklassebepaling": "Marktwaarde",
  "inschrijving": 300000,
  "bankgarantieBenodigd": "Ja",
  "bankgarantie": 2500,
  "bankgarantieSteldatum": "2016-01-01",
  "eenmaligeVergoeding": 0,
  "koopsomWoonAOV": 100,
  "koopsubsidie": true,
  "koopsubsidieDossiercode": "Dossier Code",
  "koopsubsidieTotaleContanteWaarde": 100,
  "koopsubsidieBedrag": 100,
  "koopsubsidieBedragPremietermijn": "Maand",
  "starterslening": true,
  "startersleningBedrag": 100,
  "bestaandeHypotheek": true,
  "bestaandeHypotheekHoofdsomBox1": 100,
  "bestaandeHypotheekHoofdsomBox3": 100,
  "bestaandeHypotheekStartdatum": "2016-01-01",
  "bestaandeHypotheekRente": 100,
  "bestaandeHypotheekBoeterente": 100,
  "bestaandeHypotheekInschrijving": 100,
  "bestaandeHypotheekNorm": "NHG",
  "bestaandeHypotheekMaatschappij": "Aegon",
  "notaris": {
    "id": 16387
  },
  "verkopendeMakelaar": {
    "id": 16389
  },
  "taxerendeMakelaar": {
    "id": 16427
  },
  "onderpand": {
    "id": 7790
  },
  "correspondentieadres": {
    "id": 7793
  },
  "toelichting": "Dit is de toelichting",
  "toonindigimap": true,
  "gearchiveerd": false
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/hypotheken/6752

Hypotheekdeel toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/hypotheken/{PRODUCT_ID}/leningdelen?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheken/6752/leningdelen?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6752
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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": "Aankoop / Verbouwing eigen woning (box1)",
  "doelKapitaal": 0,
  "dekking": 0,
  "tweedeDekking": 0
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/hypotheken/6752/leningdelen/7914

Hypotheek registratie ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/hypotheken/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]&publiek={publiek}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheken/6752/registraties?access_token=3b57bd2db21c46d2875508b982968d26]&publiek=0
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6752
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
publiek
int (optioneel) Voorbeeld: 0
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_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 toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/hypotheken/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheken/6752/registraties?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6752
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Zie Klantdossier - Registratie toevoegen
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/hypotheken/6752/registraties/275826

Hypotheek taak toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/hypotheken/{PRODUCT_ID}/taken?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheken/6755/taken?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6755
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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
  }
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/hypotheken/6755/taken/55519

Hypotheek workflow toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/hypotheken/{PRODUCT_ID}/workflows?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheken/6752/workflows?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6752
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "workflow": {
    "id": 21
  }
}
Response  204
VerbergBekijk
Headers
Content-Type: application/json

Hypotheekadvies ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/hypotheekadviezen/{PRODUCT_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheekadviezen/6735?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6735
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "id": 6735,
  "type": 15,
  "offertenummer": "12345",
  "omschrijving": "Hypotheekadvies",
  "status": "Aanvraag nieuw",
  "invoerAanvraag": "2016-07-11T00:00:00+02:00",
  "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"
    }
  },
  "_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 ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/hypotheekadviezen/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]&publiek={publiek}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheekadviezen/6735/registraties?access_token=3b57bd2db21c46d2875508b982968d26]&publiek=0
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6735
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
publiek
int (optioneel) Voorbeeld: 0
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_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 toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/hypotheekadviezen/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheekadviezen/6735/registraties?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6735
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Zie Klantdossier - Registratie toevoegen
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/hypotheekadviezen/6735/registraties/275826

Hypotheekadvies taak toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/hypotheekadviezen/{PRODUCT_ID}/taken?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheekadviezen/6755/taken?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6755
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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
  }
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/hypotheekadviezen/6755/taken/55519

Hypotheekadvies workflow toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/hypotheekadviezen/{PRODUCT_ID}/workflows?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/hypotheekadviezen/6735/workflows?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6735
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "workflow": {
    "id": 21
  }
}
Response  204
VerbergBekijk
Headers
Content-Type: application/json

Inkomensverzekering ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/inkomensverzekeringen/{PRODUCT_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/inkomensverzekeringen/6744?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6744
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "id": 6744,
  "type": 5,
  "offertenummer": "9874F874-B",
  "omschrijving": "Inkomensverzekering",
  "status": "Aanvraag nieuw",
  "invoerAanvraag": "2016-07-11T00:00:00+02:00",
  "maatschappij": "Callas Group",
  "ingangsdatum": "2016-09-01T00:00:00+02:00",
  "ingangsdatumDefinitief": "ja",
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/inkomensverzekeringen/6744"
    }
  },
  "_embedded": {
    "correspondentieadres": {
      "id": 7793,
      "straat": "Groenhof",
      "nummer": "1",
      "toevoeging": "",
      "postcode": "1275BB",
      "plaatsnaam": "Huizen",
      "postcodegebied": "1275",
      "longitude": "5.26394006",
      "latitude": "52.28904947",
      "categorie": "default",
      "_embedded": {
        "types": [
          {
            "id": 1,
            "naam": "bezoekadres"
          }
        ]
      }
    },
    "aanvragers": [
      {
        "id": 120954,
        "geslacht": "man",
        "initialen": "A.",
        "titel": "",
        "voornaam": "Aad",
        "tussenvoegsel": "",
        "achternaam": "Jansen",
        "bsn": "559795178",
        "nationaliteitId": 1,
        "burgerlijkestaatId": 1,
        "weergavenaam": "Jansen, Aad (A.)",
        "geboortedatum": "1960-01-01T00:00:00+01:00",
        "pensioendatum": "2027-01-01T00:00:00+01:00",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/120954"
          },
          "adressen": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/adressen"
          },
          "emailadressen": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/emailadressen"
          },
          "rekeningnummers": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/rekeningnummers"
          },
          "telefoonnummers": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/telefoonnummers"
          }
        }
      },
      {
        "id": 120955,
        "geslacht": "vrouw",
        "initialen": "K.",
        "titel": "",
        "voornaam": "Kim",
        "tussenvoegsel": "",
        "achternaam": "Jansen - de Jong",
        "bsn": "004864645",
        "nationaliteitId": 1,
        "burgerlijkestaatId": 1,
        "weergavenaam": "Jansen - de Jong, Kim (K.)",
        "geboortedatum": "1965-04-21T00:00:00+01:00",
        "pensioendatum": "2032-04-21T00:00:00+02:00",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/120955"
          },
          "adressen": {
            "href": "/api/data/klantdossiers/5526/klanten/120955/adressen"
          },
          "emailadressen": {
            "href": "/api/data/klantdossiers/5526/klanten/120955/emailadressen"
          },
          "rekeningnummers": {
            "href": "/api/data/klantdossiers/5526/klanten/120955/rekeningnummers"
          },
          "telefoonnummers": {
            "href": "/api/data/klantdossiers/5526/klanten/120955/telefoonnummers"
          }
        }
      }
    ],
    "productdelen": [
      {
        "id": 7905,
        "product": "Arbeidsongeschiktheid",
        "productgroep": "Arbeidsongeschiktsverzekering",
        "polisnummer": "",
        "polisLooptijd": 180,
        "hoofdvervaldatum": "2031-09-01T00:00:00+02:00",
        "brutoPremie": "9.86",
        "premietermijn": "maand",
        "premieLooptijd": "180",
        "premievervaldatum": "2031-09-01T00:00:00+02:00",
        "verzekerdBedrag": "0.00",
        "verzekerdTermijnbedrag": "0.00",
        "eigenRisicoWachttijd": null,
        "koopsom": "0.00"
      }
    ]
  }
}

Inkomensverzekering toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/inkomensverzekeringen?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/inkomensverzekeringen?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "portefeuille": "Eigen beheer",
  "omschrijving": "Inkomensverzekering",
  "status": {
    "id": 1
  },
  "bestaandePropositie": {
    "id": 3334
  },
  "afgeslotenDoor": {
    "id": 112115
  },
  "acceptantWorkflowgroep": {
    "id": 45
  },
  "dossierVerantwoordelijkeWorkflowgroep": {
    "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,
  "bijzonderheden": "Overgevoerd vanuit NN"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/inkomensverzekeringen/6755

Inkomensverzekeringdeel toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/inkomensverzekeringen/{PRODUCT_ID}/onderdelen?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/inkomensverzekeringen/6755/onderdelen?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6755
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/inkomensverzekeringen/6755/onderdelen/7917

Inkomensverzekering registratie ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/inkomensverzekeringen/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]&publiek={publiek}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/inkomensverzekeringen/6735/registraties?access_token=3b57bd2db21c46d2875508b982968d26]&publiek=0
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6735
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
publiek
int (optioneel) Voorbeeld: 0
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_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 toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/inkomensverzekeringen/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/inkomensverzekeringen/6755/registraties?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6755
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Zie Klantdossier - Registratie toevoegen
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/inkomensverzekeringen/6755/registraties/275826

Inkomensverzekering taak toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/inkomensverzekeringen/{PRODUCT_ID}/taken?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/inkomensverzekeringen/6755/taken?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6755
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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
  }
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/inkomensverzekeringen/6755/taken/55519

Inkomensverzekering workflow toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/inkomensverzekeringen/{PRODUCT_ID}/workflows?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/inkomensverzekeringen/6755/workflows?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6755
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "workflow": {
    "id": 21
  }
}
Response  204
VerbergBekijk
Headers
Content-Type: application/json

Levensverzekering ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/levensverzekeringen/{PRODUCT_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/levensverzekeringen/6742?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6742
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "id": 6742,
  "type": 2,
  "offertenummer": "111018(1)",
  "omschrijving": "ORV annuïtair dalend",
  "status": "Aanvraag nieuw",
  "invoerAanvraag": "2016-07-11T00:00:00+02:00",
  "garantiekapitaal": "0.00",
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/levensverzekeringen/6742"
    }
  },
  "_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"
          }
        ]
      }
    },
    "verzekeringsnemers": [
      {
        "id": 120954,
        "geslacht": "man",
        "initialen": "A.",
        "titel": "",
        "voornaam": "Aad",
        "tussenvoegsel": "",
        "achternaam": "Jansen",
        "bsn": "559795178",
        "nationaliteitId": 1,
        "burgerlijkestaatId": 1,
        "weergavenaam": "Jansen, Aad (A.)",
        "geboortedatum": "1960-01-01T00:00:00+01:00",
        "pensioendatum": "2027-01-01T00:00:00+01:00",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/120954"
          },
          "adressen": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/adressen"
          },
          "emailadressen": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/emailadressen"
          },
          "rekeningnummers": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/rekeningnummers"
          },
          "telefoonnummers": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/telefoonnummers"
          }
        }
      },
      {
        "id": 120955,
        "geslacht": "vrouw",
        "initialen": "K.",
        "titel": "",
        "voornaam": "Kim",
        "tussenvoegsel": "",
        "achternaam": "Jansen - de Jong",
        "bsn": "004864645",
        "nationaliteitId": 1,
        "burgerlijkestaatId": 1,
        "weergavenaam": "Jansen - de Jong, Kim (K.)",
        "geboortedatum": "1965-04-21T00:00:00+01:00",
        "pensioendatum": "2032-04-21T00:00:00+02:00",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/120955"
          },
          "adressen": {
            "href": "/api/data/klantdossiers/5526/klanten/120955/adressen"
          },
          "emailadressen": {
            "href": "/api/data/klantdossiers/5526/klanten/120955/emailadressen"
          },
          "rekeningnummers": {
            "href": "/api/data/klantdossiers/5526/klanten/120955/rekeningnummers"
          },
          "telefoonnummers": {
            "href": "/api/data/klantdossiers/5526/klanten/120955/telefoonnummers"
          }
        }
      }
    ],
    "contactpersonen": [
      {
        "id": 120954,
        "geslacht": "man",
        "initialen": "A.",
        "titel": "",
        "voornaam": "Aad",
        "tussenvoegsel": "",
        "achternaam": "Jansen",
        "bsn": "559795178",
        "nationaliteitId": 1,
        "burgerlijkestaatId": 1,
        "weergavenaam": "Jansen, Aad (A.)",
        "geboortedatum": "1960-01-01T00:00:00+01:00",
        "pensioendatum": "2027-01-01T00:00:00+01:00",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/120954"
          },
          "adressen": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/adressen"
          },
          "emailadressen": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/emailadressen"
          },
          "rekeningnummers": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/rekeningnummers"
          },
          "telefoonnummers": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/telefoonnummers"
          }
        }
      },
      {
        "id": 120955,
        "geslacht": "vrouw",
        "initialen": "K.",
        "titel": "",
        "voornaam": "Kim",
        "tussenvoegsel": "",
        "achternaam": "Jansen - de Jong",
        "bsn": "004864645",
        "nationaliteitId": 1,
        "burgerlijkestaatId": 1,
        "weergavenaam": "Jansen - de Jong, Kim (K.)",
        "geboortedatum": "1965-04-21T00:00:00+01:00",
        "pensioendatum": "2032-04-21T00:00:00+02:00",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/120955"
          },
          "adressen": {
            "href": "/api/data/klantdossiers/5526/klanten/120955/adressen"
          },
          "emailadressen": {
            "href": "/api/data/klantdossiers/5526/klanten/120955/emailadressen"
          },
          "rekeningnummers": {
            "href": "/api/data/klantdossiers/5526/klanten/120955/rekeningnummers"
          },
          "telefoonnummers": {
            "href": "/api/data/klantdossiers/5526/klanten/120955/telefoonnummers"
          }
        }
      }
    ],
    "verzekerden": [
      {
        "id": 120954,
        "geslacht": "man",
        "initialen": "A.",
        "titel": "",
        "voornaam": "Aad",
        "tussenvoegsel": "",
        "achternaam": "Jansen",
        "bsn": "559795178",
        "nationaliteitId": 1,
        "burgerlijkestaatId": 1,
        "weergavenaam": "Jansen, Aad (A.)",
        "geboortedatum": "1960-01-01T00:00:00+01:00",
        "pensioendatum": "2027-01-01T00:00:00+01:00",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/120954"
          },
          "adressen": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/adressen"
          },
          "emailadressen": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/emailadressen"
          },
          "rekeningnummers": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/rekeningnummers"
          },
          "telefoonnummers": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/telefoonnummers"
          }
        }
      }
    ],
    "productdelen": [
      {
        "id": 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",
              "_embedded": {
                "persoon": [
                  {
                    "id": 120954,
                    "geslacht": "man",
                    "initialen": "A.",
                    "titel": "",
                    "voornaam": "Aad",
                    "tussenvoegsel": "",
                    "achternaam": "Jansen",
                    "bsn": "559795178",
                    "nationaliteitId": 1,
                    "burgerlijkestaatId": 1,
                    "weergavenaam": "Jansen, Aad (A.)",
                    "geboortedatum": "1960-01-01T00:00:00+01:00",
                    "pensioendatum": "2027-01-01T00:00:00+01:00",
                    "_links": {
                      "self": {
                        "href": "/api/data/klantdossiers/5526/klanten/120954"
                      },
                      "adressen": {
                        "href": "/api/data/klantdossiers/5526/klanten/120954/adressen"
                      },
                      "emailadressen": {
                        "href": "/api/data/klantdossiers/5526/klanten/120954/emailadressen"
                      },
                      "rekeningnummers": {
                        "href": "/api/data/klantdossiers/5526/klanten/120954/rekeningnummers"
                      },
                      "telefoonnummers": {
                        "href": "/api/data/klantdossiers/5526/klanten/120954/telefoonnummers"
                      }
                    }
                  }
                ]
              }
            }
          ],
          "inleg": [
            {
              "bedrag": "5000.00",
              "datum": "2016-07-11T00:00:00+02:00",
              "nummer": 1
            }
          ]
        }
      }
    ]
  }
}

Levensverzekering toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/levensverzekeringen?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/levensverzekeringen?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "portefeuille": "Eigen beheer",
  "omschrijving": "Levensverzekering",
  "status": {
    "id": 1
  },
  "bestaandePropositie": {
    "id": 3334
  },
  "verpandAan": {
    "id": 6752
  },
  "afgeslotenDoor": {
    "id": 112115
  },
  "acceptantWorkflowgroep": {
    "id": 45
  },
  "dossierVerantwoordelijkeWorkflowgroep": {
    "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",
  "verzekeringnemers": [
    {
      "id": 120954
    },
    {
      "id": 120955
    }
  ],
  "verzekerden": [
    {
      "id": 120954
    },
    {
      "id": 120955
    }
  ],
  "contactpersoon": {
    "id": 120955
  },
  "premiebetalerPersoon": {
    "id": 120955
  },
  "kruislingseVerzekering": true,
  "begunstigde": "Standaard",
  "maatschappij": {
    "id": 14831
  },
  "inkoopVia": {
    "id": 15100
  },
  "doelKapitaal": 100,
  "garantiekapitaal": 100,
  "brutovoorbeeldRendement": 100,
  "correspondentieadres": {
    "id": 7793
  },
  "toelichting": "nvt",
  "toonindigimap": true,
  "gearchiveerd": false
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/levensverzekeringen/6753

Levensverzekeringdeel toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/levensverzekeringen/{PRODUCT_ID}/verzekeringdelen?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/levensverzekeringen/6753/verzekeringdelen?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6753
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "artikel": {
    "id": 20795
  },
  "polisnummer": "12345",
  "zeroProduct": true,
  "box": "Box 1 / KEW",
  "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
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/levensverzekeringen/6753/verzekeringdelen/7915

Levensverzekeringdeel kapitaal toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/levensverzekeringen/{PRODUCT_ID}/verzekeringdelen/{PRODUCTDEEL_ID}/kapitalen?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/levensverzekeringen/6753/verzekeringdelen/7915/kapitalen?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6753
PRODUCTDEEL_ID
int (verplicht) Voorbeeld: 7915
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "kapitaalBijOverlijden": 100000,
  "kapitaalBijOverlijdenPercentage": 75,
  "kapitaalBijLeven": 100000,
  "kapitaalBijLevenType": "Prognose",
  "kapitaalBijLevenPercentage": 50,
  "medischeOpslag": true,
  "persoon": {
    "id": 120954
  }
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/levensverzekeringen/6753/verzekeringdelen/7915/kapitalen/5158

Levensverzekeringdeel premie toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/levensverzekeringen/{PRODUCT_ID}/verzekeringdelen/{PRODUCTDEEL_ID}/premies?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/levensverzekeringen/6753/verzekeringdelen/7915/premies?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6753
PRODUCTDEEL_ID
int (verplicht) Voorbeeld: 7915
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "startdatum": "2016-01-01",
  "einddatum": "2016-01-01",
  "premieduur": 1,
  "premiebedrag": 100,
  "spaarpremie": 100,
  "risicopremie": 100,
  "premietype": "Laag",
  "premietermijn": "Maand"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/levensverzekeringen/6753/verzekeringdelen/7915/premies/1599

Levensverzekeringdeel storting toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/levensverzekeringen/{PRODUCT_ID}/verzekeringdelen/{PRODUCTDEEL_ID}/stortingen?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/levensverzekeringen/6753/verzekeringdelen/7915/stortingen?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6753
PRODUCTDEEL_ID
int (verplicht) Voorbeeld: 7915
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "bedrag": 100
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/levensverzekeringen/6753/verzekeringdelen/7915/stortingen/1078

Levensverzekering registratie ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/levensverzekeringen/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]&publiek={publiek}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/levensverzekeringen/6753/registraties?access_token=3b57bd2db21c46d2875508b982968d26]&publiek=0
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6753
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
publiek
int (optioneel) Voorbeeld: 0
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_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 toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/levensverzekeringen/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/levensverzekeringen/6753/registraties?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6753
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Zie Klantdossier - Registratie toevoegen
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/levensverzekeringen/6753/registraties/275826

Levensverzekering taak toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/levensverzekeringen/{PRODUCT_ID}/taken?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/levensverzekeringen/6755/taken?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6755
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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
  }
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/levensverzekeringen/6755/taken/55519

Levensverzekering workflow toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/levensverzekeringen/{PRODUCT_ID}/workflows?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/levensverzekeringen/6753/workflows?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6753
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "workflow": {
    "id": 21
  }
}
Response  204
VerbergBekijk
Headers
Content-Type: application/json

Pensioen ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/pensioenen/{PRODUCT_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/pensioenen/6745?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6745
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "id": 6745,
  "type": 8,
  "offertenummer": "134",
  "omschrijving": "Pensioen",
  "status": "Aanvraag nieuw",
  "invoerAanvraag": "2016-07-11T00:00:00+02:00",
  "maatschappij": "Reaal",
  "_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",
        "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 toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/pensioenen?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/pensioenen?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "portefeuille": "Eigen beheer",
  "omschrijving": "Pensioen",
  "status": {
    "id": 1
  },
  "bestaandePropositie": {
    "id": 3334
  },
  "afgeslotenDoor": {
    "id": 112115
  },
  "acceptantWorkflowgroep": {
    "id": 45
  },
  "dossierVerantwoordelijkeWorkflowgroep": {
    "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
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/pensioenen/6759

Pensioendeel toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/pensioenen/{PRODUCT_ID}/delen?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/pensioenen/6759/delen?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6759
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/pensioenen/6759/delen/7921

Pensioen registratie ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/pensioenen/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]&publiek={publiek}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/pensioenen/6759/registraties?access_token=3b57bd2db21c46d2875508b982968d26]&publiek=0
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6759
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
publiek
int (optioneel) Voorbeeld: 0
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_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 toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/pensioenen/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/pensioenen/6759/registraties?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6759
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Zie Klantdossier - Registratie toevoegen
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/pensioenen/6752/registraties/275826

Pensioen taak toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/pensioenen/{PRODUCT_ID}/taken?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/pensioenen/6755/taken?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6755
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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
  }
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/pensioenen/6755/taken/55519

Pensioen workflow toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/pensioenen/{PRODUCT_ID}/workflows?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/pensioenen/6759/workflows?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6759
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "workflow": {
    "id": 21
  }
}
Response  204
VerbergBekijk
Headers
Content-Type: application/json

Schadeverzekering ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/schadeverzekeringen/{PRODUCT_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/schadeverzekeringen/6746?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6746
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "id": 6746,
  "type": 4,
  "offertenummer": "98037192",
  "omschrijving": "auto 29-KQB-3",
  "status": "Aanvraag nieuw",
  "invoerAanvraag": null,
  "maatschappij": "Klaverblad",
  "ingangsdatum": "2012-10-29T00:00:00+01:00",
  "ingangsdatumDefinitief": "ja",
  "offerteAanvraagdatum": "2012-10-29T00:00:00+01:00",
  "offerteAanvraagdatumDefinitief": "ja",
  "isPakket": "nee",
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/schadeverzekeringen/6746"
    }
  },
  "_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"
          }
        ]
      }
    },
    "verzekeringsnemers": [
      {
        "id": 120954,
        "geslacht": "man",
        "initialen": "A.",
        "titel": "",
        "voornaam": "Aad",
        "tussenvoegsel": "",
        "achternaam": "Jansen",
        "bsn": "559795178",
        "nationaliteitId": 1,
        "burgerlijkestaatId": 1,
        "weergavenaam": "Jansen, Aad (A.)",
        "geboortedatum": "1960-01-01T00:00:00+01:00",
        "pensioendatum": "2027-01-01T00:00:00+01:00",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/120954"
          },
          "adressen": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/adressen"
          },
          "emailadressen": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/emailadressen"
          },
          "rekeningnummers": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/rekeningnummers"
          },
          "telefoonnummers": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/telefoonnummers"
          }
        }
      }
    ],
    "productdelen": [
      {
        "id": 7906,
        "product": "Motorrijtuig",
        "productgroep": "Motorrijtuigen",
        "naam": "Motorrijtuig",
        "looptijdPolis": 12,
        "looptijdPremie": 12,
        "nettoPremie": "348.75",
        "termijnbedragTotaal": "421.99",
        "_embedded": {
          "dekkingen": [
            {
              "dekking": "Overig motorrijtuigen",
              "dekkingcode": "2999",
              "omschrijving": "",
              "verzekerdbedrag": "9250.00",
              "eigenrisicotype": "amount",
              "eigenrisicobedrag": "100.00"
            }
          ]
        }
      }
    ]
  }
}

Schadeverzekering toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/schadeverzekeringen?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/schadeverzekeringen?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "portefeuille": "Eigen beheer",
  "omschrijving": "Schadeverzekering",
  "status": {
    "id": 1
  },
  "bestaandePropositie": {
    "id": 3334
  },
  "afgeslotenDoor": {
    "id": 112115
  },
  "acceptantWorkflowgroep": {
    "id": 45
  },
  "dossierVerantwoordelijkeWorkflowgroep": {
    "id": 45
  },
  "aanbrengerPersoon": {
    "id": 120956
  },
  "aanbrengerOrganisatie": {
    "id": 14851
  },
  "bronvermelding": {
    "id": 3
  },
  "polisOfPakketNummer": "12345",
  "offerteaanvraagdatum": "2016-01-01",
  "offerteaanvraagdatumDefinitief": true,
  "startdatum": "2016-01-01",
  "startdatumDefinitief": true,
  "verzondenNaarMaatschappij": "2016-01-01",
  "ontvangstdatumPolis": "2016-01-01",
  "datumAfgelegd": "2016-01-01",
  "verzekeringnemerRol": "Particulier",
  "verzekeringnemerParticulier": {
    "id": 120954
  },
  "maatschappij": {
    "id": 16200
  },
  "isPakket": false,
  "inkoopVia": {
    "id": 15100
  },
  "collectiviteitType": "Niet van toepassing",
  "correspondentieadres": {
    "id": 7793
  },
  "toelichting": "nvt",
  "toonindigimap": true,
  "gearchiveerd": false,
  "bijzonderheden": "Overgevoerd vanuit NN"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/schadeverzekeringen/6753

Schadeverzekeringdeel toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/schadeverzekeringen/{PRODUCT_ID}/onderdelen?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/schadeverzekeringen/6753/onderdelen?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6753
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Autoverzekering

{
    "artikel": {
        "id": 8696
    },
    "polisnummer": "12345",
    "productOmschrijving": "Autoverzekering",
    "zeroProduct": true,
    "verzekerdeRol": "Particulier",
    "verzekerdenParticulier": [
        {
            "id": 120954
        }
    ],
    "termijnbedragBrutopremie": 125,
    "termijnbedragKorting": 5,
    "termijnbedragNettopremie": 120,
    "termijnbedragPoliskosten": 4,
    "termijnbedragAssurantiebelasting": 26.04,
    "termijnbedragTotaal": 150.04,
    "premietermijn": "Maand",
    "incassoDoor": "Maatschappij",
    "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
    }
}
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Inboedel

{
    "artikel": {
        "id": 8703
    },
    "polisnummer": "12345",
    "productOmschrijving": "Inboedelverzekering",
    "zeroProduct": true,
    "termijnbedragBrutopremie": 100,
    "termijnbedragKorting": 5,
    "termijnbedragNettopremie": 95,
    "termijnbedragPoliskosten": 0,
    "termijnbedragAssurantiebelasting": 19.95,
    "termijnbedragTotaal": 114.95,
    "premietermijn": "Maand",
    "incassoDoor": "Maatschappij",
    "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
    }
}
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Aansprakelijkheid

{
    "artikel": {
        "id": 8695
    },
    "polisnummer": "12345",
    "productOmschrijving": "Aansprakelijkheidsverzekering",
    "zeroProduct": true,
    "verzekerdeRol": "Particulier",
    "verzekerdenParticulier": [
        {
            "id": 120954
        }
    ],
    "termijnbedragBrutopremie": 25,
    "termijnbedragKorting": 0,
    "termijnbedragNettopremie": 25,
    "termijnbedragPoliskosten": 0,
    "termijnbedragAssurantiebelasting": 5.25,
    "termijnbedragTotaal": 30.25,
    "premietermijn": "Maand",
    "incassoDoor": "Maatschappij",
    "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
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/schadeverzekeringen/6753/onderdelen/7918

Schadeverzekeringdeel dekking toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/schadeverzekeringen/{PRODUCT_ID}/onderdelen/{PRODUCTDEEL_ID}/dekkingen?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/schadeverzekeringen/6753/onderdelen/7917/dekkingen?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6753
PRODUCTDEEL_ID
int (verplicht) Voorbeeld: 7917
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "dekking": "2001 - WA Wettelijke Aansprakelijkheid",
  "omschrijving": "WA",
  "verzekerdbedrag": 25,
  "eigenrisicotype": "Vast bedrag",
  "eigenrisicobedrag": 0
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/schadeverzekeringen/6753/onderdelen/7917/dekkingen/1

Schadeverzekering registratie ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/schadeverzekeringen/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]&publiek={publiek}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/schadeverzekeringen/6753/registraties?access_token=3b57bd2db21c46d2875508b982968d26]&publiek=0
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6753
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
publiek
int (optioneel) Voorbeeld: 0
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_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 toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/schadeverzekeringen/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/schadeverzekeringen/6753/registraties?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6753
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Zie Klantdossier - Registratie toevoegen
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/schadeverzekeringen/6753/registraties/275827

Schadeverzekering taak toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/schadeverzekeringen/{PRODUCT_ID}/taken?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/schadeverzekeringen/6755/taken?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6755
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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
  }
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/schadeverzekeringen/6755/taken/55519

Schadeverzekering workflow toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/schadeverzekeringen/{PRODUCT_ID}/workflows?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/schadeverzekeringen/6753/workflows?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6753
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "workflow": {
    "id": 21
  }
}
Response  204
VerbergBekijk
Headers
Content-Type: application/json

Uitvaartverzekering ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/uitvaartverzekeringen/{PRODUCT_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/uitvaartverzekeringen/6748?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6748
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "id": 6748,
  "type": 21,
  "offertenummer": "15N27530735",
  "omschrijving": "Uitvaartverz. olv dhr.",
  "status": "Aanvraag nieuw",
  "invoerAanvraag": "2016-07-11T00:00:00+02:00",
  "maatschappij": "Dela Verzekeringen",
  "ingangsdatum": "2016-06-06T00:00:00+02:00",
  "kinderenMeeverzekeren": "nee",
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/uitvaartverzekeringen/6748"
    }
  },
  "_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"
          }
        ]
      }
    },
    "verzekeringsnemers": [
      {
        "id": 120954,
        "geslacht": "man",
        "initialen": "A.",
        "titel": "",
        "voornaam": "Aad",
        "tussenvoegsel": "",
        "achternaam": "Jansen",
        "bsn": "559795178",
        "nationaliteitId": 1,
        "burgerlijkestaatId": 1,
        "weergavenaam": "Jansen, Aad (A.)",
        "geboortedatum": "1960-01-01T00:00:00+01:00",
        "pensioendatum": "2027-01-01T00:00:00+01:00",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/120954"
          },
          "adressen": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/adressen"
          },
          "emailadressen": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/emailadressen"
          },
          "rekeningnummers": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/rekeningnummers"
          },
          "telefoonnummers": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/telefoonnummers"
          }
        }
      },
      {
        "id": 120955,
        "geslacht": "vrouw",
        "initialen": "K.",
        "titel": "",
        "voornaam": "Kim",
        "tussenvoegsel": "",
        "achternaam": "Jansen - de Jong",
        "bsn": "004864645",
        "nationaliteitId": 1,
        "burgerlijkestaatId": 1,
        "weergavenaam": "Jansen - de Jong, Kim (K.)",
        "geboortedatum": "1965-04-21T00:00:00+01:00",
        "pensioendatum": "2032-04-21T00:00:00+02:00",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/120955"
          },
          "adressen": {
            "href": "/api/data/klantdossiers/5526/klanten/120955/adressen"
          },
          "emailadressen": {
            "href": "/api/data/klantdossiers/5526/klanten/120955/emailadressen"
          },
          "rekeningnummers": {
            "href": "/api/data/klantdossiers/5526/klanten/120955/rekeningnummers"
          },
          "telefoonnummers": {
            "href": "/api/data/klantdossiers/5526/klanten/120955/telefoonnummers"
          }
        }
      }
    ],
    "contactpersonen": [
      {
        "id": 120954,
        "geslacht": "man",
        "initialen": "A.",
        "titel": "",
        "voornaam": "Aad",
        "tussenvoegsel": "",
        "achternaam": "Jansen",
        "bsn": "559795178",
        "nationaliteitId": 1,
        "burgerlijkestaatId": 1,
        "weergavenaam": "Jansen, Aad (A.)",
        "geboortedatum": "1960-01-01T00:00:00+01:00",
        "pensioendatum": "2027-01-01T00:00:00+01:00",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/120954"
          },
          "adressen": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/adressen"
          },
          "emailadressen": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/emailadressen"
          },
          "rekeningnummers": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/rekeningnummers"
          },
          "telefoonnummers": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/telefoonnummers"
          }
        }
      }
    ],
    "verzekerden": [
      {
        "id": 120954,
        "geslacht": "man",
        "initialen": "A.",
        "titel": "",
        "voornaam": "Aad",
        "tussenvoegsel": "",
        "achternaam": "Jansen",
        "bsn": "559795178",
        "nationaliteitId": 1,
        "burgerlijkestaatId": 1,
        "weergavenaam": "Jansen, Aad (A.)",
        "geboortedatum": "1960-01-01T00:00:00+01:00",
        "pensioendatum": "2027-01-01T00:00:00+01:00",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/klanten/120954"
          },
          "adressen": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/adressen"
          },
          "emailadressen": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/emailadressen"
          },
          "rekeningnummers": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/rekeningnummers"
          },
          "telefoonnummers": {
            "href": "/api/data/klantdossiers/5526/klanten/120954/telefoonnummers"
          }
        }
      }
    ],
    "productdelen": [
      {
        "id": 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",
                    "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"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

Uitvaartverzekering toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/uitvaartverzekeringen?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/uitvaartverzekeringen?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "portefeuille": "Eigen beheer",
  "omschrijving": "Uitvaartverzekering",
  "status": {
    "id": 1
  },
  "bestaandePropositie": {
    "id": 3334
  },
  "afgeslotenDoor": {
    "id": 112115
  },
  "acceptantWorkflowgroep": {
    "id": 45
  },
  "dossierVerantwoordelijkeWorkflowgroep": {
    "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
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/uitvaartverzekeringen/6760

Uitvaartverzekeringdeel toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/uitvaartverzekeringen/{PRODUCT_ID}/onderdelen?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/uitvaartverzekeringen/6760/onderdelen?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6760
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "artikel": {
    "id": 20764
  },
  "zeroProduct": true,
  "polisnummer": "12345",
  "brutoKoopsom": 125,
  "brutotermijnpremie": 150,
  "premietermijnPer": "Maand",
  "premieduur": 12,
  "prolongatieProvisiebedrag": 0,
  "royementsdatum": "2017-01-01",
  "betalingsprofiel": {
    "id": 1
  }
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/uitvaartverzekeringen/6760/onderdelen/7922

Uitvaartverzekeringdeel kapitaal toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/uitvaartverzekeringen/{PRODUCT_ID}/onderdelen/{PRODUCTDEEL_ID}/kapitalen?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/uitvaartverzekeringen/6760/onderdelen/7922/kapitalen?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6760
PRODUCTDEEL_ID
int (verplicht) Voorbeeld: 7922
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "soortNaturadekking": "Basisdekking",
  "verzekerdBedrag": 100000,
  "geindexeerd": true,
  "indexpercentage": 100,
  "repatriering": true,
  "persoon": {
    "id": 120954
  },
  "premie": 75
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/uitvaartverzekeringen/6760/onderdelen/7922/kapitalen/2

Uitvaartverzekering registratie ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/uitvaartverzekeringen/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]&publiek={publiek}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/uitvaartverzekeringen/6760/registraties?access_token=3b57bd2db21c46d2875508b982968d26]&publiek=0
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6760
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
publiek
int (optioneel) Voorbeeld: 0
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_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 toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/uitvaartverzekeringen/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/uitvaartverzekeringen/6760/registraties?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6760
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Zie Klantdossier - Registratie toevoegen
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/uitvaartverzekeringen/6760/registraties/275826

Uitvaartverzekering taak toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/uitvaartverzekeringen/{PRODUCT_ID}/taken?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/uitvaartverzekeringen/6755/taken?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6755
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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
  }
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/uitvaartverzekeringen/6755/taken/55519

Uitvaartverzekering workflow toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/uitvaartverzekeringen/{PRODUCT_ID}/workflows?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/uitvaartverzekeringen/6760/workflows?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6760
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "workflow": {
    "id": 21
  }
}
Response  204
VerbergBekijk
Headers
Content-Type: application/json

Vermogen en bancair ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/vermogenenbancair/{PRODUCT_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/vermogenenbancair/6747?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6747
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "id": 6747,
  "type": 3,
  "offertenummer": "144",
  "omschrijving": "Vermogen en bancair",
  "status": "Aanvraag nieuw",
  "invoerAanvraag": "2016-07-11T00:00:00+02:00",
  "leverancier": "ING",
  "startdatum": "2014-02-01T00:00:00+01:00",
  "verpandAan": null,
  "_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",
        "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 toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/vermogenenbancair?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/vermogenenbancair?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "portefeuille": "Eigen beheer",
  "omschrijving": "Vermogen en bancair",
  "status": {
    "id": 1
  },
  "bestaandePropositie": {
    "id": 3334
  },
  "afgeslotenDoor": {
    "id": 112115
  },
  "acceptantWorkflowgroep": {
    "id": 45
  },
  "dossierVerantwoordelijkeWorkflowgroep": {
    "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
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/vermogenenbancair/6756

Vermogen en bancair deel toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/vermogenenbancair/{PRODUCT_ID}/onderdelen?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/vermogenenbancair/6756/onderdelen?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6756
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/vermogenenbancair/6756/onderdelen/7918

Vermogen en bancair deel inleg toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/vermogenenbancair/{PRODUCT_ID}/onderdelen/{PRODUCTDEEL_ID}/inleggen?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/vermogenenbancair/6756/onderdelen/7918/inleggen?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6756
PRODUCTDEEL_ID
int (verplicht) Voorbeeld: 7918
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "inleg": 100,
  "huidigeWaarde": 100,
  "koers": 100,
  "datum": "2016-01-01"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/vermogenenbancair/6756/onderdelen/7918/inleggen/495

Vermogen en bancair registratie ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/vermogenenbancair/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]&publiek={publiek}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/vermogenenbancair/6756/registraties?access_token=3b57bd2db21c46d2875508b982968d26]&publiek=0
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6756
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
publiek
int (optioneel) Voorbeeld: 0
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_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 toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/vermogenenbancair/{PRODUCT_ID}/registraties?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/vermogenenbancair/6756/registraties?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6756
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
Zie Klantdossier - Registratie toevoegen
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/vermogenenbancair/6756/registraties/275826

Vermogen en bancair taak toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/vermogenenbancair/{PRODUCT_ID}/taken?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/vermogenenbancair/6755/taken?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6755
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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
  }
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/vermogenenbancair/6755/taken/55519

Vermogen en bancair workflow toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/vermogenenbancair/{PRODUCT_ID}/workflows?access_token={ACCESS_TOKEN}]

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/vermogenenbancair/6756/workflows?access_token=3b57bd2db21c46d2875508b982968d26]
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
PRODUCT_ID
int (verplicht) Voorbeeld: 6756
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "workflow": {
    "id": 21
  }
}
Response  204
VerbergBekijk
Headers
Content-Type: application/json

Factuur

Factuur collectie
GET/api/data/klantdossiers/{DOSSIER_ID}/facturen?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/facturen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/facturen"
    }
  },
  "_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",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/facturen/10"
          }
        }
      }
    ]
  }
}

Factuur ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/facturen/{FACTUUR_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/facturen/10?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
FACTUUR_ID
int (verplicht) Voorbeeld: 10
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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",
  "_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"
      }
    ]
  }
}

Document

Document collectie
GET/api/data/klantdossiers/{DOSSIER_ID}/documenten?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/documenten?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/documenten"
    }
  },
  "_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)",
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/documenten/1"
          },
          "download": {
            "href": "/api/data/klantdossiers/5526/documenten/1/download"
          }
        }
      }
    ]
  }
}

Document ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/documenten/{DOCUMENT_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/documenten/1?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
DOCUMENT_ID
int (verplicht) Voorbeeld: 1
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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)",
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/documenten/1"
    },
    "download": {
      "href": "/api/data/klantdossiers/5526/documenten/1/download"
    }
  }
}

Document downloaden
GET/api/data/klantdossiers/{DOSSIER_ID}/documenten/{DOCUMENT_ID}/download?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/documenten/1/download?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
DOCUMENT_ID
int (verplicht) Voorbeeld: 1
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: image/png
Content-Disposition: inline; filename="fasterforward.png"

Document toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/documenten?access_token={ACCESS_TOKEN}

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/2818/documenten?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 2818
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
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"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/documenten/16
Response  400
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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 collectie
GET/api/data/klantdossiers/{DOSSIER_ID}/stukken?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/stukken?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/stukken"
    }
  },
  "_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,
        "verzendwijze": null,
        "bron": "elements",
        "aanTeLeverenDoor": "klant",
        "toelichtingAanTeLeverenDocument": null,
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/stukken/91"
          }
        }
      }
    ]
  }
}

Stuk ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/stukken/{STUK_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/stukken/91?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
STUK_ID
int (verplicht) Voorbeeld: 91
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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,
  "verzendwijze": null,
  "bron": "elements",
  "aanTeLeverenDoor": "klant",
  "toelichtingAanTeLeverenDocument": null,
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/stukken/91"
    }
  }
}

Document onder stuk toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/stukken/{STUK_ID}/documenttoevoegen?access_token={ACCESS_TOKEN}

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/stukken/91/documenttoevoegen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
STUK_ID
int (verplicht) Voorbeeld: 91
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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"
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Location: /api/data/klantdossiers/5526/documenten/16

Email

Email collectie
GET/api/data/klantdossiers/{DOSSIER_ID}/emails?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/emails?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/emails"
    }
  },
  "_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,
        "_links": {
          "self": {
            "href": "/api/data/klantdossiers/5526/emails/7"
          }
        }
      }
    ]
  }
}

Email ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/emails/{EMAIL_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/emails/7?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
EMAIL_ID
int (verplicht) Voorbeeld: 7
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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,
  "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"
    }
  }
}

Taak

Taak collectie
GET/api/data/klantdossiers/{DOSSIER_ID}/taken?access_token={ACCESS_TOKEN}

Stamgegevens in de context van taken zijn hier te vinden: taak stamgegevens.

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/taken?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/taken"
    }
  },
  "_embedded": {
    "taken": [
      {
        "id": 55516,
        "naam": "Contact opnemen met de klant nav aanvraag",
        "omschrijving": "",
        "aanmaakdatum": "2016-07-27T09:36:17+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": "man",
              "initialen": "I.",
              "titel": "",
              "voornaam": "Voornaam",
              "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",
              "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 ophalen
GET/api/data/klantdossiers/{DOSSIER_ID}/taken/{TAAK_ID}?access_token={ACCESS_TOKEN}

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?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
TAAK_ID
int (verplicht) Voorbeeld: 55516
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "id": 55516,
  "naam": "Contact opnemen met de klant nav aanvraag",
  "omschrijving": "",
  "aanmaakdatum": "2016-07-27T09:36:17+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": "man",
        "initialen": "I.",
        "titel": "",
        "voornaam": "Voornaam",
        "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",
        "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 toevoegen
POST/api/data/klantdossiers/{DOSSIER_ID}/taken?access_token={ACCESS_TOKEN}

Stamgegevens in de context van taken zijn hier te vinden: taak stamgegevens.

Voorbeeld URI

POST https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/taken?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Request
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "naam": "00054739 - afspraak",
  "omschrijving": "Omschrijving",
  "typeId": 1,
  "prioriteitId": 1,
  "statusId": 1,
  "startdatum": "2016-07-05 17:07:04",
  "einddatum": "2016-07-05 18:07:04",
  "initiator": {
    "id": 112116
  },
  "genodigden": [
    {
      "id": 115693
    }
  ],
  "eigenaar": {
    "id": 115693
  }
}
Response  201
VerbergBekijk
Headers
Content-Type: text/html
Response  400
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "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."
      }
    ]
  }
}

Pand

Pand collectie
GET/api/data/klantdossiers/{DOSSIER_ID}/panden?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/klantdossiers/5526/panden?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
DOSSIER_ID
int (verplicht) Voorbeeld: 5526
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/klantdossiers/5526/panden"
    }
  },
  "_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"
          }
        }
      }
    ]
  }
}

Kantoor

Collectie

Collectie
GET/api/data/kantoren?access_token={ACCESS_TOKEN}

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?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/kantoren"
    }
  },
  "_embedded": {
    "kantoren": [
      {
        "id": 14830,
        "type": null,
        "naam": "CO00014830",
        "kvknummer": "",
        "btwnummer": "",
        "statutairenaam": "CO00014830",
        "handelsnaam": "CO00014830",
        "_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"
          }
        }
      },
      {
        "id": 16319,
        "type": null,
        "naam": "Deelnemer00016319",
        "kvknummer": "",
        "btwnummer": "",
        "statutairenaam": "Deelnemer00016319",
        "handelsnaam": "Deelnemer00016319",
        "_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"
          },
          "medewerkers": {
            "href": "/api/data/kantoren/16319/medewerkers"
          },
          "profielfoto": {
            "href": "/api/data/kantoren/16319/profielfoto"
          }
        }
      }
    ]
  }
}

Kantoor

Kantoor
GET/api/data/kantoren/{ORGANISATIE_ID}?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/kantoren/14830?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
ORGANISATIE_ID
int (verplicht) Voorbeeld: 14830
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "id": 14830,
  "type": null,
  "naam": "CO00014830",
  "kvknummer": "",
  "btwnummer": "",
  "statutairenaam": "CO00014830",
  "handelsnaam": "CO00014830",
  "_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"
    }
  },
  "_embedded": {
    "openingstijden": [
      {
        "dag": "Dinsdag",
        "van": "10:00",
        "tot": "13:00",
        "omschrijving": ""
      }
    ]
  }
}

Adressen collectie

Adressen collectie
GET/api/data/kantoren/{ORGANISATIE_ID}/adressen?access_token={ACCESS_TOKEN}

Voorbeeld URI

GET https://{DOMEIN}.fasterforwardelements.nl/api/data/kantoren/14830/adressen?access_token=3b57bd2db21c46d2875508b982968d26
URI Parameters
VerbergBekijk
ORGANISATIE_ID
int (verplicht) Voorbeeld: 14830
ACCESS_TOKEN
string (verplicht) Voorbeeld: 3b57bd2db21c46d2875508b982968d26
Response  200
VerbergBekijk
Headers
Content-Type: application/json
Body
{
  "_links": {
    "self": {
      "href": "/api/data/kantoren/14830/adressen"
    }
  },
  "_embedded": {
    "adressen": [
      {
        "id": 7368,
        "straat": "Postbus",
        "nummer": "1",
        "toevoeging": "",
        "postcode": "1234AB",
        "plaatsnaam": "Plaatsnaam",
        "postcodegebied": "1234",
        "longitude":