DossierData API
Welcome to the DossierData API. This API provides access to a all data from a tenant within DossierData.
Authentication ¶
This section describes the authentication process.
OAuth2
Authentication is done based on OAuth2. Tokens have an expiration time of 24 hours and can be refreshed 30 days after they were generated.
Client
To use the api you need to request an OAuth client with which you can request an access token.
In your request you need to supply the following:
-
Company details
-
A callback URL for OAuth
-
A detailed description of what you plan to use the API for
Please send your OAuth Client request to info@dossierdata.nl
.
Login
When you’ve received your client credentials, you can prompt your users for an access token access. They need to login with their DossierData account and approve that your client can access their data. After this process you obtain an access key.
Authentication
Requesting any endpoint except the authentication will require you to send an access token, this can be done in two-ways. Either by Header of in the Query of the request.
OAuth Header example request ¶
Use the following header to provide the access token
Notice Bearer has a capital B
Header ExampleGET/protected
Example URI
Headers
Authorization: Bearer vr5HmMkzlxKE70W1y4MibiJUusZwZC25NOVBEx3BD1
200
Headers
Content-Type: application/json
Body
{
"status": "ok"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "string"
}
},
"required": [
"status"
]
}
400
If the request is missing input or parameters the following response is to be expected.
Headers
Content-Type: application/json
Body
{
"error": "invalid_request",
"error_description": "The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"%\" parameter."
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string"
},
"error_description": {
"type": "string"
}
}
}
401
If invalid credentials have been provided or you don’t have access to this specific resource the following response is to be expected.
Headers
Content-Type: application/json
Body
{
"error": "access_denied",
"error_description": "The resource owner or authorization server denied the request."
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string"
},
"error_description": {
"type": "string"
}
}
}
OAuth Query example request ¶
Use the following query to provide the token
Query ExampleGET/protected{?token}
Example URI
- token
string
(required) Example: vr5HmMkzlxKE70W1y4MibiJUusZwZC25NOVBEx3BD1
200
Headers
Content-Type: application/json
Body
{
"status": "ok"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "string"
}
},
"required": [
"status"
]
}
400
If the request is missing input or parameters the following response is to be expected.
Headers
Content-Type: application/json
Body
{
"error": "invalid_request",
"error_description": "The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the \"%\" parameter."
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string"
},
"error_description": {
"type": "string"
}
}
}
401
If invalid credentials have been provided or you don’t have access to this specific resource the following response is to be expected.
Headers
Content-Type: application/json
Body
{
"error": "access_denied",
"error_description": "The resource owner or authorization server denied the request."
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string"
},
"error_description": {
"type": "string"
}
}
}
Addresses ¶
All calls for Address management
Addresses ¶
Address functions
ListGET/address{?perPage}
Get a list of all Addresses.
Example URI
- perPage
integer
(optional) Default: 15 Example: 25The maximum number of objects to return
200
Headers
Content-Type: application/json
Body
{
"data": [
{
"type": 4,
"postcode": "9712VL",
"houseNumber": "46",
"streetName": "Noorderhaven",
"city": "Groningen",
"houseNumberAddition": "``",
"customer": 4482,
"active": true,
"lat": 53.219708,
"lng": 6.558785,
"country": "Netherlands"
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 15,
"current": 1,
"total_pages": 1,
"links": []
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number",
"description": "Total number of objects"
},
"count": {
"type": "number",
"description": "Object on this page"
},
"per_page": {
"type": "number",
"description": "Object per page"
},
"current": {
"type": "number",
"description": "Current page number"
},
"total_pages": {
"type": "number",
"description": "Total number of pages"
},
"links": {
"description": "Array of meta links"
}
}
}
}
}
}
}
ShowGET/address/{address_id}
Example URI
- address_id
integer
(required) Example: 1The id of an address
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
CreatePOST/address
Example URI
Headers
Content-Type: application/json
Accept: application/json
Body
{
"type": 4,
"postcode": "9712VL",
"houseNumber": "46",
"streetName": "Noorderhaven",
"city": "Groningen",
"houseNumberAddition": "``",
"customer": 4482,
"active": true,
"lat": 53.219708,
"lng": 6.558785,
"country": "Netherlands"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"type": {
"type": "number",
"description": "Type of address"
},
"postcode": {
"type": "string",
"description": "Postal code of the address"
},
"houseNumber": {
"type": "string",
"description": "House number of the address"
},
"streetName": {
"type": "string",
"description": "Street name of the address"
},
"city": {
"type": "string",
"description": "City of the address"
},
"houseNumberAddition": {
"type": "string",
"description": "House number addition of the address"
},
"customer": {
"type": "number",
"description": "ID of the related customer"
},
"active": {
"type": "boolean",
"description": "Is the address active?"
},
"lat": {
"type": "number",
"description": "Latitude of the address"
},
"lng": {
"type": "number",
"description": "Longitude of the address"
},
"country": {
"type": "string",
"description": "Country of the address"
}
}
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
UpdatePUT/address/{address_id}
Example URI
- address_id
integer
(required) Example: 1The id of an address
Headers
Content-Type: application/json
Accept: application/json
Body
{
"type": 4,
"postcode": "9712VL",
"houseNumber": "46",
"streetName": "Noorderhaven",
"city": "Groningen",
"houseNumberAddition": "``",
"customer": 4482,
"active": true,
"lat": 53.219708,
"lng": 6.558785,
"country": "Netherlands"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"type": {
"type": "number",
"description": "Type of address"
},
"postcode": {
"type": "string",
"description": "Postal code of the address"
},
"houseNumber": {
"type": "string",
"description": "House number of the address"
},
"streetName": {
"type": "string",
"description": "Street name of the address"
},
"city": {
"type": "string",
"description": "City of the address"
},
"houseNumberAddition": {
"type": "string",
"description": "House number addition of the address"
},
"customer": {
"type": "number",
"description": "ID of the related customer"
},
"active": {
"type": "boolean",
"description": "Is the address active?"
},
"lat": {
"type": "number",
"description": "Latitude of the address"
},
"lng": {
"type": "number",
"description": "Longitude of the address"
},
"country": {
"type": "string",
"description": "Country of the address"
}
}
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
DeleteDELETE/address/{address_id}
Example URI
- address_id
integer
(required) Example: 1The id of an address
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of deleted data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
Customers ¶
All calls for Customer management
Customers ¶
Customer functions
ListGET/customer{?perPage}
Get a list of all Customers.
Example URI
- perPage
integer
(optional) Default: 15 Example: 25The maximum number of objects to return
200
Headers
Content-Type: application/json
Body
{
"data": [
{
"initials": "AB",
"firstName": "Albert",
"suffix": "de",
"lastName": "Vries",
"dateOfBirth": "``",
"phone": "0512345678",
"mobile": "0612345678",
"sex": 1,
"emailaddress": "ab.de.vries@test.nl",
"smoking": false,
"martialStatus": 1,
"mariedBefore": true,
"office": 1,
"type": 1,
"parent": 2,
"partner": 3,
"houseOwned": true,
"advisor": 1,
"employer": "Rapide Internet",
"position": "Positie",
"mailingEnabled": false,
"salary": 123456,
"title": 1,
"accountNumber": "``",
"iban": "NL 12 ABCD 012345678",
"businessname": "Rapide Internet",
"businesstype": 1,
"kvkNumber": "123456789",
"numberOfEmployees": 2,
"revenue": 123456,
"payroll": 123456,
"retirement_income": 123456,
"passed_away": true,
"passed_away_at": "null",
"salary_date": "null",
"retirement_income_date": "null"
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 15,
"current": 1,
"total_pages": 1,
"links": []
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number",
"description": "Total number of objects"
},
"count": {
"type": "number",
"description": "Object on this page"
},
"per_page": {
"type": "number",
"description": "Object per page"
},
"current": {
"type": "number",
"description": "Current page number"
},
"total_pages": {
"type": "number",
"description": "Total number of pages"
},
"links": {
"description": "Array of meta links"
}
}
}
}
}
}
}
CreatePOST/customer
Example URI
Headers
Content-Type: application/json
Accept: application/json
Body
{
"initials": "AB",
"firstName": "Albert",
"suffix": "de",
"lastName": "Vries",
"dateOfBirth": "``",
"phone": "0512345678",
"mobile": "0612345678",
"sex": 1,
"emailaddress": "ab.de.vries@test.nl",
"smoking": false,
"martialStatus": 1,
"mariedBefore": true,
"office": 1,
"type": 1,
"parent": 2,
"partner": 3,
"houseOwned": true,
"advisor": 1,
"employer": "Rapide Internet",
"position": "Positie",
"mailingEnabled": false,
"salary": 123456,
"title": 1,
"accountNumber": "``",
"iban": "NL 12 ABCD 012345678",
"businessname": "Rapide Internet",
"businesstype": 1,
"kvkNumber": "123456789",
"numberOfEmployees": 2,
"revenue": 123456,
"payroll": 123456,
"retirement_income": 123456,
"passed_away": true,
"passed_away_at": "null",
"salary_date": "null",
"retirement_income_date": "null"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"initials": {
"type": "string",
"description": "Initials of the customer"
},
"firstName": {
"type": "string",
"description": "FirstName of the customer"
},
"suffix": {
"type": "string",
"description": "Suffix of the customer"
},
"lastName": {
"type": "string",
"description": "LastName of the customer"
},
"dateOfBirth": {
"type": "string",
"description": "Date of birth of the customer"
},
"phone": {
"type": "string",
"description": "Phonenumber of the customer"
},
"mobile": {
"type": "string",
"description": "Mobile phonenumber of the customer"
},
"sex": {
"type": "number",
"enum": [
0,
1
],
"default": "0",
"description": "Sex of the customer\n\nGender enum:\n0: Female, 1: Male"
},
"emailaddress": {
"type": "string",
"description": "Emailaddress of the customer"
},
"smoking": {
"type": "boolean",
"description": "Does the customer smoke?"
},
"martialStatus": {
"type": "number",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10
],
"default": "0",
"description": "Martial status of the customer\n\nMarital status enum:\n`0`: Alleenstaand, `1`: Gehuwd (gvg), `2`: Gehuwd (hv), `3`: Partnerregistratie (gvg), `4`: Partnerregistratie onder registratievoorwaarden, `5`: Samenwonend met samenlevingscontract, `6`: Samenwonend zonder samenlevingscontract, `7`: Gescheiden, `8`: Weduwe/Weduwenaar, `9`: Inwonend, `10`: Gehuwd volgens buitenlands recht"
},
"mariedBefore": {
"type": "boolean",
"description": "Was the customer married befoer?"
},
"office": {
"type": "number",
"description": "The office of the customer"
},
"type": {
"type": "number",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
],
"default": "1",
"description": "The type of the customer\n\nCustomer type enum:\n1: Particulier, 2: Aflopend, 3: Bank relatie, 4: Hypotheek relatie, 5: Prospect, 6: Totaalklant, 7: Vervallen, 8: Verzekeringsrelatie, 9: Zakelijke relatie, 10: Prospect Zakelijk, 11: Zakelijk vervallen,"
},
"parent": {
"type": "number",
"description": "The parent customer_id of the customer"
},
"partner": {
"type": "number",
"description": "The id of the partner"
},
"houseOwned": {
"type": "boolean",
"description": "Does the customer own a house",
"default": false
},
"advisor": {
"type": "number",
"description": "Id of the advisor of the customer"
},
"employer": {
"type": "string",
"description": "Employer of the customer"
},
"position": {
"type": "string",
"description": "Position at company of the customer"
},
"mailingEnabled": {
"type": "boolean",
"description": "Does the customer want to receive emails"
},
"salary": {
"type": "number",
"description": "The salary of the customer"
},
"title": {
"type": "number",
"description": "The title of the customer",
"default": 1
},
"accountNumber": {
"type": "string",
"description": "The account of the customer"
},
"iban": {
"type": "string",
"description": "The iban of the customer"
},
"businessname": {
"type": "string",
"description": "The name of the business of the customer"
},
"businesstype": {
"type": "number",
"description": "The type of the business of the customer"
},
"kvkNumber": {
"type": "string",
"description": "The kvk number of the customer"
},
"numberOfEmployees": {
"type": "number",
"description": "The number of employees of the customer"
},
"revenue": {
"type": "number",
"description": "The revenue of the customer"
},
"payroll": {
"type": "number",
"description": "The payroll of the customer"
},
"retirement_income": {
"type": "number",
"description": "Retirement income of the customer"
},
"passed_away": {
"type": "boolean",
"description": "Did the customer pass away"
},
"passed_away_at": {
"type": "string",
"description": "The date the customer passed away, format d/m/Y"
},
"salary_date": {
"type": "string",
"description": "The date the customer gets their salary, format d/m/Y"
},
"retirement_income_date": {
"type": "string",
"description": "The date the customer gets their retirement income, format d/m/Y"
}
},
"required": [
"firstName",
"lastName",
"dateOfBirth"
]
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
Create leadPOST/customer/lead
Example URI
Headers
Content-Type: application/json
Accept: application/json
Body
{
"firstName": "Albert",
"initials": "AB",
"suffix": "de",
"lastName": "Vries",
"emailaddress": "ab.de.vries@test.nl",
"dateOfBirth": "20/01/1985",
"status": "Nieuw"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"firstName": {
"type": "string",
"description": "FirstName of the customer, required if initials are not provided"
},
"initials": {
"type": "string",
"description": "Initials of the customer, required if first name is not provided"
},
"suffix": {
"type": "string",
"description": "Suffix of the customer"
},
"lastName": {
"type": "string",
"description": "LastName of the customer"
},
"emailaddress": {
"type": "string",
"description": "Email address of the customer"
},
"dateOfBirth": {
"type": "string",
"description": "Date of birth of the customer, format d/m/Y"
},
"status": {
"type": "string",
"description": "The status that you want to give this new lead. If the status does not exist yet it will be created and attached to this customer. You can filter your customers by this status on the customer lead dashboard."
}
},
"required": [
"firstName",
"lastName",
"emailaddress"
]
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
OpenGET/customer/open/{customer_id_or_uuid}
Get URL to open dashboard of customer
Example URI
- customer_id_or_uuid
integer
(required) Example: 1The ID or UUID of a customer.
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
Create mortgage leadPOST/customer/mortgage_lead
Example URI
Headers
Content-Type: application/json
Accept: application/json
Body
{
"firstName": "Albert",
"initials": "AB",
"suffix": "de",
"lastName": "Vries",
"emailaddress": "ab.de.vries@test.nl",
"dateOfBirth": "20/01/1985",
"visitDate": "20/01/1985",
"dateOfTransfer": "20/01/1985",
"dateFundReserves": "20/01/1985",
"dateBankGuarantee": "20/01/1985",
"status": "Nieuw"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"firstName": {
"type": "string",
"description": "FirstName of the customer, required if initials are not provided"
},
"initials": {
"type": "string",
"description": "Initials of the customer, required if first name is not provided"
},
"suffix": {
"type": "string",
"description": "Suffix of the customer"
},
"lastName": {
"type": "string",
"description": "LastName of the customer"
},
"emailaddress": {
"type": "string",
"description": "Email address of the customer"
},
"dateOfBirth": {
"type": "string",
"description": "Date of birth of the customer, format d/m/Y"
},
"visitDate": {
"type": "string",
"description": "Last visit date of the customer, format d/m/Y"
},
"dateOfTransfer": {
"type": "string",
"description": "The date of transfer for the mortgage (Datum overdracht), format d/m/Y"
},
"dateFundReserves": {
"type": "string",
"description": "The expiration date for the fund reserves (Datum financieringsvoorbehoud), format d/m/Y"
},
"dateBankGuarantee": {
"type": "string",
"description": "The expiration date for the bank guarantee (Datum bankgarantie), format d/m/Y"
},
"status": {
"type": "string",
"description": "The status that you want to give this new lead. If the status does not exist yet it will be created and attached to this customer. You can filter your customers by this status on the customer lead dashboard."
}
},
"required": [
"firstName",
"lastName",
"emailaddress"
]
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
AX Message ¶
Customer AX Message functions
FindPOST/customer/ax_message{?perPage}
Example URI
- perPage
integer
(optional) Default: 15 Example: 25The maximum number of objects to return
Headers
Content-Type: application/xml
Body
<?xml version="1.0" encoding="utf-8"?>
<OfferteAanvraag>
<Header Volgnummer="745">
<VerzenderNrHDN>33</VerzenderNrHDN>
<VerzenderNaam>str1234</VerzenderNaam>
<OntvangerNrHDN>33</OntvangerNrHDN>
<OntvangerNaam>str1234</OntvangerNaam>
<BerichtSoort>AX OfferteAandfvraag</BerichtSoort>
<BerichtVersie>17.0</BerichtVersie>
<OntvangerCode>AA ABN AMRO Bank</OntvangerCode>
<VerzendDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</VerzendDt>
<VerzendTijd>
<Uur>12</Uur>
<Minuten>33</Minuten>
<Seconden>33</Seconden>
</VerzendTijd>
<AanvraagVolgNr>str1234</AanvraagVolgNr>
<AanvraagVersie>33</AanvraagVersie>
<PakketNaam>str1234</PakketNaam>
<PakketVersie>str1234</PakketVersie>
</Header>
<HuidigObject Volgnummer="745" ID="ab1">
<StraatNaam>str1234</StraatNaam>
<HuisNr>33</HuisNr>
<HuisNrToevoeging>str1234</HuisNrToevoeging>
<Postcode>1234</Postcode>
<PlaatsNaam>str1234</PlaatsNaam>
<Gemeente>str1234</Gemeente>
<Land>AD Andorra</Land>
<TeVerkopen>J Ja</TeVerkopen>
<VerkochtJN>J Ja</VerkochtJN>
<VerkoopakteJN>J Ja</VerkoopakteJN>
<VerkoopPrijs>123.45</VerkoopPrijs>
<MarktWaarde>123.45</MarktWaarde>
<VerkoopDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</VerkoopDt>
<CodeVerhuur>01 geen verhuur</CodeVerhuur>
<Huurinkomsten>123.45</Huurinkomsten>
<OverbruggingJN>J Ja</OverbruggingJN>
<OverbruggingsBedrag>123.45</OverbruggingsBedrag>
<HuidigeFinancieringJN>J Ja</HuidigeFinancieringJN>
<HuidigeFinanciering Volgnummer="745">
<AflossenJN>J Ja</AflossenJN>
<FinancierBestaandeHyp>AA ABN AMRO Bank N.V.</FinancierBestaandeHyp>
<OmschrFinancier>str1234</OmschrFinancier>
<SaldoBestaandeHyp>123.45</SaldoBestaandeHyp>
<OorsprHoofdsom>123.45</OorsprHoofdsom>
<BedragInschrijving>123.45</BedragInschrijving>
<NrBestaandeHyp>str1234</NrBestaandeHyp>
<OorspronkelijkeIngDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</OorspronkelijkeIngDt>
<EigenWonSchuld>123.45</EigenWonSchuld>
<Garantie>01 NHG-garantie</Garantie>
<RangOrde>33</RangOrde>
<HuidigLeningdeel Volgnummer="745">
<AflossenJN>J Ja</AflossenJN>
<AflossingsVormHuidigLeningdeel>01 Annuiteit</AflossingsVormHuidigLeningdeel>
<RenteVastInMndHuidigLeningdeel>33</RenteVastInMndHuidigLeningdeel>
<DuurInMndHuidigLeningdeel>33</DuurInMndHuidigLeningdeel>
<BedragHuidigLeningdeel>123.45</BedragHuidigLeningdeel>
<RestantSaldoHuidigLeningdeel>123.45</RestantSaldoHuidigLeningdeel>
<RentePctHuidigLeningdeel>1.234</RentePctHuidigLeningdeel>
</HuidigLeningdeel>
</HuidigeFinanciering>
</HuidigObject>
<Hypotheekgever Volgnummer="745">
<RefPartijNAWData IDREF="ab1" />
<TelefoonNrPrive>0612345678</TelefoonNrPrive>
<TelefoonNrWerk>0612345678</TelefoonNrWerk>
<TelefoonNrMobiel>0612345678</TelefoonNrMobiel>
<E-mailadres>test@test.com</E-mailadres>
<BurgerlijkeStaat>01 Gehuwd (gemeenschap van goederen)</BurgerlijkeStaat>
<HuwelijkOntbonden>J Ja</HuwelijkOntbonden>
<HuwelijkOntbondenDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</HuwelijkOntbondenDt>
<WeduweWeduwnaar>J Ja</WeduweWeduwnaar>
<HoofdAanspr>J Ja</HoofdAanspr>
<EersteHypotheekOoit>J Ja</EersteHypotheekOoit>
<EigenWonReserve>123.45</EigenWonReserve>
<AfwKlantProfiel>J Ja</AfwKlantProfiel>
<Inkomsten Volgnummer="745">
<LandBelastingVerplichting>AD Andorra</LandBelastingVerplichting>
<DienstBetrekking Volgnummer="745">
<SoortDienstBetrekking>01 loondienst fulltime vast</SoortDienstBetrekking>
<IngangsDtDienstBetrekking>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</IngangsDtDienstBetrekking>
<ProeftijdJN>J Ja</ProeftijdJN>
<ProeftijdVerstrekenJN>J Ja</ProeftijdVerstrekenJN>
<EindDtDienstBetrekking>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</EindDtDienstBetrekking>
<Werkgever>str1234</Werkgever>
<StraatNaamWerkgever>str1234</StraatNaamWerkgever>
<HuisNrWerkgever>33</HuisNrWerkgever>
<PostcodeWerkgever>str1234</PostcodeWerkgever>
<PlaatsNaamWerkgever>str1234</PlaatsNaamWerkgever>
<LandWerkgever>AD Andorra</LandWerkgever>
<LandBelastingVerplichting>AD Andorra</LandBelastingVerplichting>
<GemUrenWeek>33</GemUrenWeek>
<BrutoJaarSalaris>123.45</BrutoJaarSalaris>
<VakantieToeslag>123.45</VakantieToeslag>
<OnregelmatigheidsToeslag>123.45</OnregelmatigheidsToeslag>
<Vaste13eMnd>123.45</Vaste13eMnd>
<ProvisiePerJaar>123.45</ProvisiePerJaar>
<VasteEindejaarsuitkering>123.45</VasteEindejaarsuitkering>
<OverwerkPerJaar>123.45</OverwerkPerJaar>
<BrutoJaarInkVariabel>123.45</BrutoJaarInkVariabel>
<VEB>123.45</VEB>
<InkomstenToeslag>123.45</InkomstenToeslag>
<PctInkomenMeetellen>1.234</PctInkomenMeetellen>
<DuurInMndMeetellen>33</DuurInMndMeetellen>
<InkomenPeriode>01 per maand</InkomenPeriode>
<LoonbeslagJN>J Ja</LoonbeslagJN>
<InkomenFlexibel1jr>123.45</InkomenFlexibel1jr>
<InkomenFlexibel2jr>123.45</InkomenFlexibel2jr>
<InkomenFlexibel3jr>123.45</InkomenFlexibel3jr>
</DienstBetrekking>
<Onderneming Volgnummer="745" ID="ab2">
<RechtsVorm>01 Eenmanszaak</RechtsVorm>
<SoortOnderneming>01 Zelfstandige Zonder Personeel (ZZP)</SoortOnderneming>
<IngangsDtOnderneming>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</IngangsDtOnderneming>
<KvKnummer>33</KvKnummer>
<Inkomenzelfstandige>123.45</Inkomenzelfstandige>
<Inkomen1jr>123.45</Inkomen1jr>
<Inkomen2jr>123.45</Inkomen2jr>
<Inkomen3jr>123.45</Inkomen3jr>
<DGAJN>J Ja</DGAJN>
<PctAandelen>1.234</PctAandelen>
</Onderneming>
<Uitkering Volgnummer="745">
<SoortUitkering>02 Bijstand</SoortUitkering>
<SoortVerzekering>01 Lijfrente verzekering</SoortVerzekering>
<BrutoJaarUitkering>123.45</BrutoJaarUitkering>
<VakantieToeslag>123.45</VakantieToeslag>
<IngangsDtUitkering>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</IngangsDtUitkering>
<EindDtUitkering>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</EindDtUitkering>
<VolledigeAOWOpbouwJN>J Ja</VolledigeAOWOpbouwJN>
<AantalAOWJaren>33</AantalAOWJaren>
<LandBelastingVerplichting>AD Andorra</LandBelastingVerplichting>
<PctInkomenMeetellen>1.234</PctInkomenMeetellen>
<DuurInMndMeetellen>33</DuurInMndMeetellen>
</Uitkering>
<Pensioen Volgnummer="745">
<PensioenInkomen>123.45</PensioenInkomen>
<IngangsDtPensioen>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</IngangsDtPensioen>
<EindDtPensioen>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</EindDtPensioen>
<LandBelastingVerplichting>AD Andorra</LandBelastingVerplichting>
</Pensioen>
<Overige Volgnummer="745">
<SoortOverigeInkomsten>01 Alimentatie</SoortOverigeInkomsten>
<BrutoJaarBedragOverigeInkomsten>123.45</BrutoJaarBedragOverigeInkomsten>
<EindDtOverigeInkomsten>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</EindDtOverigeInkomsten>
</Overige>
</Inkomsten>
<Verplichtingen Volgnummer="745">
<VerplichtingLopendJN>J Ja</VerplichtingLopendJN>
<NrBestaandContract>str1234</NrBestaandContract>
<Maatschappij>AA ABN AMRO Bank N.V.</Maatschappij>
<MaatschappijOmschr>str1234</MaatschappijOmschr>
<Verplichting>01 Alimentatieverplichting t.g.v. kinderen</Verplichting>
<VerplichtingOmschr>str1234</VerplichtingOmschr>
<VerplichtingPerJaar>123.45</VerplichtingPerJaar>
<VerplichtingBedrag>123.45</VerplichtingBedrag>
<OorspronkelijkKredietBedrag>123.45</OorspronkelijkKredietBedrag>
<LimietDoorlopendKrediet>123.45</LimietDoorlopendKrediet>
<VerplichtingInMnd>33</VerplichtingInMnd>
<AflosBedrag>123.45</AflosBedrag>
<AfgelostDoorHypotheek>J Ja</AfgelostDoorHypotheek>
<ExtraAfgelostBedrag>123.45</ExtraAfgelostBedrag>
</Verplichtingen>
<BezittingenBoxDrie Volgnummer="745">
<SoortBezittingBoxDrie>01 banktegoeden</SoortBezittingBoxDrie>
<WaardeBezittingBoxDrie>123.45</WaardeBezittingBoxDrie>
</BezittingenBoxDrie>
<Identificatie Volgnummer="745">
<BSN>12345678</BSN>
<LegitimatieSoort>EI Europese identiteitskaart</LegitimatieSoort>
<LegitimatieNr>str1234</LegitimatieNr>
<LegitimatieAfgifteDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</LegitimatieAfgifteDt>
<LegitimatieAfgiftePlaats>str1234</LegitimatieAfgiftePlaats>
<LegitimatieAfgifteLand>AD Andorra</LegitimatieAfgifteLand>
<LegitimatieEindDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</LegitimatieEindDt>
<VerblijfsVergunning>01 onbekend</VerblijfsVergunning>
<VerblijfsVergunningNr>str1234</VerblijfsVergunningNr>
<VerblijfsVergunningEindDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</VerblijfsVergunningEindDt>
</Identificatie>
</Hypotheekgever>
<PartijNAWData Volgnummer="745" ID="ab3">
<SoortPartij>01 natuurlijk persoon</SoortPartij>
<AchterNaam>Vries</AchterNaam>
<VoorNaam>Albert</VoorNaam>
<TussenVoegsels>de</TussenVoegsels>
<GeboorteNaamJN>J Ja</GeboorteNaamJN>
<GebAchterNaam>str1234</GebAchterNaam>
<GebTussenVoegsels>str1234</GebTussenVoegsels>
<Nationaliteit>AD Andorra</Nationaliteit>
<GeboortePlaats>str1234</GeboortePlaats>
<GeboorteLand>AD Andorra</GeboorteLand>
<VoorLetters>AB</VoorLetters>
<Geslacht>M mannelijk</Geslacht>
<GeboorteDt>
<Dag>16</Dag>
<Maand>1</Maand>
<Jaar>1980</Jaar>
</GeboorteDt>
<StraatNaam>str1234</StraatNaam>
<HuisNr>33</HuisNr>
<HuisNrToevoeging>str1234</HuisNrToevoeging>
<Postcode>1234</Postcode>
<PlaatsNaam>str1234</PlaatsNaam>
<Land>AD Andorra</Land>
<RekeningNr>NL12ABNA01234567</RekeningNr>
</PartijNAWData>
<Notaris Volgnummer="745">
<RefContactPersoonData IDREF="ab1" />
<BedrijfsNaam>str1234</BedrijfsNaam>
<CodeNotaris>1 Passerend</CodeNotaris>
<TelefoonNrWerk>0612345678</TelefoonNrWerk>
</Notaris>
<TussenPersoon Volgnummer="745">
<RefContactPersoonData IDREF="ab1" />
<BedrijfsNaam>str1234</BedrijfsNaam>
<TussenpersoonNr>str1234</TussenpersoonNr>
<TelefoonNrWerk>0612345678</TelefoonNrWerk>
<E-mailadres>test@test.com</E-mailadres>
<TelefoonNrMobiel>0612345678</TelefoonNrMobiel>
<AFMRegistratieNr>str1234</AFMRegistratieNr>
<ServiceProvider Volgnummer="745">
<RefContactPersoonData IDREF="ab1" />
<ServiceProviderNaam>str1234</ServiceProviderNaam>
<ServiceProviderNr>str1234</ServiceProviderNr>
<TelefoonNrWerk>0612345678</TelefoonNrWerk>
<TelefoonNrMobiel>0612345678</TelefoonNrMobiel>
<E-mailadres>test@test.com</E-mailadres>
<ServiceProviderAFMRegistratieNr>str1234</ServiceProviderAFMRegistratieNr>
<Internetadres>str1234</Internetadres>
</ServiceProvider>
</TussenPersoon>
<Object Volgnummer="745" ID="ab4">
<CodeObject>01 eengezinswoning</CodeObject>
<Onderpand>01 bestaand</Onderpand>
<StraatNaam>str1234</StraatNaam>
<HuisNr>33</HuisNr>
<HuisNrToevoeging>str1234</HuisNrToevoeging>
<Postcode>1234</Postcode>
<PlaatsNaam>str1234</PlaatsNaam>
<Land>AD Andorra</Land>
<BouwPlanNr>str1234</BouwPlanNr>
<SituatieNr>str1234</SituatieNr>
<EigenBewoning>J Ja</EigenBewoning>
<CodeVerhuur>01 geen verhuur</CodeVerhuur>
<Huurinkomsten>123.45</Huurinkomsten>
<AfkoopExPartner>123.45</AfkoopExPartner>
<Erfpacht>J Ja</Erfpacht>
<ErfpachtEeuwigDurend>J Ja</ErfpachtEeuwigDurend>
<ErfpachtBeginDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</ErfpachtBeginDt>
<ErfpachtEindDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</ErfpachtEindDt>
<ErfpachtCanon>123.45</ErfpachtCanon>
<ErfpachtAfkoopsom>123.45</ErfpachtAfkoopsom>
<ErfpachtMeeFinancieren>J Ja</ErfpachtMeeFinancieren>
<SubsidieRegeling>01 Koopsubsidie</SubsidieRegeling>
<SubsidieRegelingBedrag>123.45</SubsidieRegelingBedrag>
<BouwJaar>33</BouwJaar>
<AppartementsRecht>J Ja</AppartementsRecht>
<BedragKwaliteitsverbeteringEBV>123.45</BedragKwaliteitsverbeteringEBV>
<HoofdVerblijf>J Ja</HoofdVerblijf>
<TaxatieAanwezig>J Ja</TaxatieAanwezig>
<TaxatieDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</TaxatieDt>
<KostenTaxatie>123.45</KostenTaxatie>
<MarktWaarde>123.45</MarktWaarde>
<Koopsom>123.45</Koopsom>
<RoerendeZaken>123.45</RoerendeZaken>
<WOZWaarde>123.45</WOZWaarde>
<WOZWaardeTaxatieDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</WOZWaardeTaxatieDt>
<AchterstalligOnderhoud>123.45</AchterstalligOnderhoud>
<VerbouwingsKosten>123.45</VerbouwingsKosten>
<MarktWaardeNaVerb>123.45</MarktWaardeNaVerb>
<VerbouwingsDepot>123.45</VerbouwingsDepot>
<ZelfBouw>J Ja</ZelfBouw>
<KoopsomGrond>123.45</KoopsomGrond>
<RenteVerlies>123.45</RenteVerlies>
<Meerwerk>123.45</Meerwerk>
<OpleveringsDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</OpleveringsDt>
<BouwRente>123.45</BouwRente>
<ServiceKosten>123.45</ServiceKosten>
<KostenLeveringsAkteSpec>123.45</KostenLeveringsAkteSpec>
<MakelaarsKostenSpec>123.45</MakelaarsKostenSpec>
<OverdrachtsBelastingSpec>123.45</OverdrachtsBelastingSpec>
<VerkoopOnderVoorwaardenJN>J Ja</VerkoopOnderVoorwaardenJN>
<KostenBouwkundigeKeuring>123.45</KostenBouwkundigeKeuring>
<PremieOpstalverzekeringPerJaar>123.45</PremieOpstalverzekeringPerJaar>
<AanneemSom>123.45</AanneemSom>
<AfkoopErfpachtJN>J Ja</AfkoopErfpachtJN>
<KadastraleAanduiding Volgnummer="745">
<Sectie>st</Sectie>
<Nr>33</Nr>
<Grootte>33</Grootte>
<KadastraleGemeente>str1234</KadastraleGemeente>
</KadastraleAanduiding>
</Object>
<Lening Volgnummer="745">
<HypotheekBedrag>123.45</HypotheekBedrag>
<HypothecaireInschrijving>123.45</HypothecaireInschrijving>
<Financier>AA ABN AMRO Bank N.V.</Financier>
<Regeling>01 eerste hypotheek (nieuw)</Regeling>
<RangOrde>33</RangOrde>
<NrBestaandeHyp>str1234</NrBestaandeHyp>
<CodeLeningMij>AA001 ABN AMRO Woninghypotheek</CodeLeningMij>
<PasseerDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</PasseerDt>
<IngebEigenMiddelen>123.45</IngebEigenMiddelen>
<BankGarantieBedrag>123.45</BankGarantieBedrag>
<BankGarantieKosten>123.45</BankGarantieKosten>
<NettoAdvieskosten>123.45</NettoAdvieskosten>
<BemiddelingsKosten>123.45</BemiddelingsKosten>
<BoeteRente>123.45</BoeteRente>
<NHG>J Ja</NHG>
<Mutatie>01 Aankoop woning</Mutatie>
<HypotheekAkteKostenSpec>123.45</HypotheekAkteKostenSpec>
<NHGKostenSpec>123.45</NHGKostenSpec>
<AankoopWoningJN>J Ja</AankoopWoningJN>
<Leningdeel Volgnummer="745">
<CodeLeningDeel>1 Nieuw</CodeLeningDeel>
<BelastingBox>01 Box 1</BelastingBox>
<CodeDeelMij>AA001 ABN AMRO Annuïteiten hypotheek</CodeDeelMij>
<DuurInMnd>33</DuurInMnd>
<LeningDeelBedrag>123.45</LeningDeelBedrag>
<AflossingsVorm>01 Annuiteit</AflossingsVorm>
<RenteAfspraak>01 rentevast</RenteAfspraak>
<RenteVastInMnd>33</RenteVastInMnd>
<RenteBedenkTijd>01 geen</RenteBedenkTijd>
<RenteBedenkTijdInMnd>33</RenteBedenkTijdInMnd>
<BetalingsTermijn>01 per maand</BetalingsTermijn>
<BetalingAchteraf>J Ja</BetalingAchteraf>
<RentePct>1.234</RentePct>
<RenteAfspraakOmschr>str1234</RenteAfspraakOmschr>
<RentePctBovenMarge>1.234</RentePctBovenMarge>
<RentePctOnderMarge>1.234</RentePctOnderMarge>
<PctConsumptief>1.234</PctConsumptief>
<ConsumptiefBedrag>123.45</ConsumptiefBedrag>
<RenteAftrekEindDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</RenteAftrekEindDt>
<FinancieleDekking Volgnummer="745">
<CodeFinancieleDekking>01 levensverzekering</CodeFinancieleDekking>
<FiscaalGeruislozeVoortzettingJN>J Ja</FiscaalGeruislozeVoortzettingJN>
<AanvangsDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</AanvangsDt>
<DuurInMnd>33</DuurInMnd>
<ProductNaam>str1234</ProductNaam>
<Maatschappij>AA ABN AMRO Bank N.V.</Maatschappij>
<MaatschappijOmschr>str1234</MaatschappijOmschr>
<PolisLopendJN>J Ja</PolisLopendJN>
<MaatschappijPolisLopend>AA ABN AMRO Bank N.V.</MaatschappijPolisLopend>
<MaatschappijPolisLopendOmschr>str1234</MaatschappijPolisLopendOmschr>
<PolisNr>str1234</PolisNr>
<PolisAfkoopWaarde>123.45</PolisAfkoopWaarde>
<PolisOmzetting>J Ja</PolisOmzetting>
<BerekeningsUitgangspunt>01 Van premie naar kapitaal</BerekeningsUitgangspunt>
<VerpandJN>J Ja</VerpandJN>
<PremieAfspraken Volgnummer="745">
<SoortPremie>01 Risicopremie normaal</SoortPremie>
<AanvangNaIngangsDtInMnd>33</AanvangNaIngangsDtInMnd>
<DuurInMnd>33</DuurInMnd>
<PremieBedrag>123.45</PremieBedrag>
<BetalingsTermijn>01 per maand</BetalingsTermijn>
<RefDebiteurNAWData IDREF="ab1" />
</PremieAfspraken>
<Verzekerde Volgnummer="745">
<RefPartijNAWData IDREF="ab1" />
</Verzekerde>
<VerzekeringNemer Volgnummer="745">
<RefPartijNAWData IDREF="ab1" />
<BSN>12345678</BSN>
</VerzekeringNemer>
<VerzekerdeBedragen Volgnummer="745">
<SoortVerzekerdKap>01 Verzekerd bedrag bij overlijden</SoortVerzekerdKap>
<VerzekerdKap>123.45</VerzekerdKap>
<VerzekerdKap2>123.45</VerzekerdKap2>
<BelastingBox>01 Box 1</BelastingBox>
<CodeUitkering>01 Lineair dalend</CodeUitkering>
</VerzekerdeBedragen>
<FiscaalGeruislozeVoortzetting Volgnummer="745">
<FiscaleVormDekking>01 SEW</FiscaleVormDekking>
<DekkingNr>str1234</DekkingNr>
<AanvangsDtBox1>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</AanvangsDtBox1>
<DekkingLopendBetalingLaag>123.45</DekkingLopendBetalingLaag>
<DekkingLopendBetalingHoog>123.45</DekkingLopendBetalingHoog>
<BedragBetaaldLopendJaar>123.45</BedragBetaaldLopendJaar>
<CumulatieveBetalingEindDt>123.45</CumulatieveBetalingEindDt>
<DekkingOverdrachtsWaarde>123.45</DekkingOverdrachtsWaarde>
<EerdereUitkeringDekking>123.45</EerdereUitkeringDekking>
<PremieBedrag>123.45</PremieBedrag>
<OorspronkelijkeEindDtLopendeDekking>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</OorspronkelijkeEindDtLopendeDekking>
</FiscaalGeruislozeVoortzetting>
</FinancieleDekking>
<BancaireDekking Volgnummer="745">
<Aanbieder>AA ABN AMRO Bank N.V.</Aanbieder>
<CodeBancaireDekking>01 Spaarrekening</CodeBancaireDekking>
<FiscaalGeruislozeVoortzettingJN>J Ja</FiscaalGeruislozeVoortzettingJN>
<AanvangsDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</AanvangsDt>
<DuurInMnd>33</DuurInMnd>
<ContractLopendJN>J Ja</ContractLopendJN>
<ContractOmzettingJN>J Ja</ContractOmzettingJN>
<ContractNr>str1234</ContractNr>
<InlegAfspraken Volgnummer="745">
<SoortInleg>01 Periodieke inleg</SoortInleg>
<AanvangNaIngangsDtInMnd>33</AanvangNaIngangsDtInMnd>
<DuurInMnd>33</DuurInMnd>
<InlegBedrag>123.45</InlegBedrag>
<BetalingsTermijn>01 per maand</BetalingsTermijn>
<RefDebiteurNAWData IDREF="ab1" />
</InlegAfspraken>
<Contractant Volgnummer="745">
<RefPartijNAWData IDREF="ab1" />
<BSN>12345678</BSN>
</Contractant>
<Waarden Volgnummer="745">
<SoortWaarde>01 Waarde op einddatum</SoortWaarde>
<BedragWaarde>123.45</BedragWaarde>
<BelastingBox>01 Box 1</BelastingBox>
<RekenRentePct>1.234</RekenRentePct>
<IngangsDtWaarde>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</IngangsDtWaarde>
</Waarden>
<FiscaalGeruislozeVoortzetting Volgnummer="745">
<FiscaleVormDekking>01 SEW</FiscaleVormDekking>
<MaatschappijDekkingLopend>AA ABN AMRO Bank N.V.</MaatschappijDekkingLopend>
<MaatschappijDekkingLopendOmschr>str1234</MaatschappijDekkingLopendOmschr>
<StortingDtNieuweDekking>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</StortingDtNieuweDekking>
<DekkingLopendBetalingLaag>123.45</DekkingLopendBetalingLaag>
<DekkingLopendBetalingHoog>123.45</DekkingLopendBetalingHoog>
<BedragBetaaldLopendJaar>123.45</BedragBetaaldLopendJaar>
<DekkingOverdrachtsWaarde>123.45</DekkingOverdrachtsWaarde>
</FiscaalGeruislozeVoortzetting>
</BancaireDekking>
</Leningdeel>
</Lening>
<FinancieleDekking Volgnummer="745">
<CodeFinancieleDekking>01 levensverzekering</CodeFinancieleDekking>
<AanvangsDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</AanvangsDt>
<DuurInMnd>33</DuurInMnd>
<ProductNaam>str1234</ProductNaam>
<Maatschappij>AA ABN AMRO Bank N.V.</Maatschappij>
<MaatschappijOmschr>str1234</MaatschappijOmschr>
<PolisLopendJN>J Ja</PolisLopendJN>
<MaatschappijPolisLopend>AA ABN AMRO Bank N.V.</MaatschappijPolisLopend>
<PolisNr>str1234</PolisNr>
<PolisAfkoopWaarde>123.45</PolisAfkoopWaarde>
<PolisOmzetting>J Ja</PolisOmzetting>
<BerekeningsUitgangspunt>01 Van premie naar kapitaal</BerekeningsUitgangspunt>
<PremieDepot Volgnummer="745" />
<PremieAfspraken Volgnummer="745">
<SoortPremie>01 Risicopremie normaal</SoortPremie>
<AanvangNaIngangsDtInMnd>33</AanvangNaIngangsDtInMnd>
<DuurInMnd>33</DuurInMnd>
<PremieBedrag>123.45</PremieBedrag>
<BetalingsTermijn>01 per maand</BetalingsTermijn>
<RefDebiteurNAWData IDREF="ab1" />
<PremieUitDepot>123.45</PremieUitDepot>
</PremieAfspraken>
<Verzekerde Volgnummer="745">
<RefPartijNAWData IDREF="ab1" />
<Beroep>0111 Docenten hoger onderwijs en hoogleraren</Beroep>
</Verzekerde>
<VerzekeringNemer Volgnummer="745">
<RefPartijNAWData IDREF="ab1" />
<BSN>12345678</BSN>
</VerzekeringNemer>
<VerzekerdeBedragen Volgnummer="745">
<SoortVerzekerdKap>01 Verzekerd bedrag bij overlijden</SoortVerzekerdKap>
<VerzekerdKap>123.45</VerzekerdKap>
<VerzekerdKap2>123.45</VerzekerdKap2>
<BelastingBox>01 Box 1</BelastingBox>
<CodeUitkering>01 Lineair dalend</CodeUitkering>
<VerzekerdPct>1.234</VerzekerdPct>
<VerzekerdPct2>1.234</VerzekerdPct2>
<DuurInMnd>33</DuurInMnd>
<EindWaardeDekking>123.45</EindWaardeDekking>
</VerzekerdeBedragen>
</FinancieleDekking>
</OfferteAanvraag>
200
Headers
Content-Type: application/json
Body
{
"data": [
{
"initials": "AB",
"firstName": "Albert",
"suffix": "de",
"lastName": "Vries",
"dateOfBirth": "``",
"phone": "0512345678",
"mobile": "0612345678",
"sex": 1,
"emailaddress": "ab.de.vries@test.nl",
"smoking": false,
"martialStatus": 1,
"mariedBefore": true,
"office": 1,
"type": 1,
"parent": 2,
"partner": 3,
"houseOwned": true,
"advisor": 1,
"employer": "Rapide Internet",
"position": "Positie",
"mailingEnabled": false,
"salary": 123456,
"title": 1,
"accountNumber": "``",
"iban": "NL 12 ABCD 012345678",
"businessname": "Rapide Internet",
"businesstype": 1,
"kvkNumber": "123456789",
"numberOfEmployees": 2,
"revenue": 123456,
"payroll": 123456,
"retirement_income": 123456,
"passed_away": true,
"passed_away_at": "null",
"salary_date": "null",
"retirement_income_date": "null"
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 15,
"current": 1,
"total_pages": 1,
"links": []
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number",
"description": "Total number of objects"
},
"count": {
"type": "number",
"description": "Object on this page"
},
"per_page": {
"type": "number",
"description": "Object per page"
},
"current": {
"type": "number",
"description": "Current page number"
},
"total_pages": {
"type": "number",
"description": "Total number of pages"
},
"links": {
"description": "Array of meta links"
}
}
}
}
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"message": "Could not validate content, no parsers found"
},
{
"message": "Could not parse content, no parsers found"
},
{
"message": "Supplied message is not an AX Message"
},
{
"message": "XML parse error. Line: 1 Column: 0"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
UpdatePUT/customer/{customer_id}/ax_message
Update a Customer with all data from an AX Message.
Example URI
- customer_id
integer
(required) Example: 1The id of a customer
Headers
Content-Type: application/xml
Body
<?xml version="1.0" encoding="utf-8"?>
<OfferteAanvraag>
<Header Volgnummer="745">
<VerzenderNrHDN>33</VerzenderNrHDN>
<VerzenderNaam>str1234</VerzenderNaam>
<OntvangerNrHDN>33</OntvangerNrHDN>
<OntvangerNaam>str1234</OntvangerNaam>
<BerichtSoort>AX OfferteAandfvraag</BerichtSoort>
<BerichtVersie>17.0</BerichtVersie>
<OntvangerCode>AA ABN AMRO Bank</OntvangerCode>
<VerzendDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</VerzendDt>
<VerzendTijd>
<Uur>12</Uur>
<Minuten>33</Minuten>
<Seconden>33</Seconden>
</VerzendTijd>
<AanvraagVolgNr>str1234</AanvraagVolgNr>
<AanvraagVersie>33</AanvraagVersie>
<PakketNaam>str1234</PakketNaam>
<PakketVersie>str1234</PakketVersie>
</Header>
<HuidigObject Volgnummer="745" ID="ab1">
<StraatNaam>str1234</StraatNaam>
<HuisNr>33</HuisNr>
<HuisNrToevoeging>str1234</HuisNrToevoeging>
<Postcode>1234</Postcode>
<PlaatsNaam>str1234</PlaatsNaam>
<Gemeente>str1234</Gemeente>
<Land>AD Andorra</Land>
<TeVerkopen>J Ja</TeVerkopen>
<VerkochtJN>J Ja</VerkochtJN>
<VerkoopakteJN>J Ja</VerkoopakteJN>
<VerkoopPrijs>123.45</VerkoopPrijs>
<MarktWaarde>123.45</MarktWaarde>
<VerkoopDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</VerkoopDt>
<CodeVerhuur>01 geen verhuur</CodeVerhuur>
<Huurinkomsten>123.45</Huurinkomsten>
<OverbruggingJN>J Ja</OverbruggingJN>
<OverbruggingsBedrag>123.45</OverbruggingsBedrag>
<HuidigeFinancieringJN>J Ja</HuidigeFinancieringJN>
<HuidigeFinanciering Volgnummer="745">
<AflossenJN>J Ja</AflossenJN>
<FinancierBestaandeHyp>AA ABN AMRO Bank N.V.</FinancierBestaandeHyp>
<OmschrFinancier>str1234</OmschrFinancier>
<SaldoBestaandeHyp>123.45</SaldoBestaandeHyp>
<OorsprHoofdsom>123.45</OorsprHoofdsom>
<BedragInschrijving>123.45</BedragInschrijving>
<NrBestaandeHyp>str1234</NrBestaandeHyp>
<OorspronkelijkeIngDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</OorspronkelijkeIngDt>
<EigenWonSchuld>123.45</EigenWonSchuld>
<Garantie>01 NHG-garantie</Garantie>
<RangOrde>33</RangOrde>
<HuidigLeningdeel Volgnummer="745">
<AflossenJN>J Ja</AflossenJN>
<AflossingsVormHuidigLeningdeel>01 Annuiteit</AflossingsVormHuidigLeningdeel>
<RenteVastInMndHuidigLeningdeel>33</RenteVastInMndHuidigLeningdeel>
<DuurInMndHuidigLeningdeel>33</DuurInMndHuidigLeningdeel>
<BedragHuidigLeningdeel>123.45</BedragHuidigLeningdeel>
<RestantSaldoHuidigLeningdeel>123.45</RestantSaldoHuidigLeningdeel>
<RentePctHuidigLeningdeel>1.234</RentePctHuidigLeningdeel>
</HuidigLeningdeel>
</HuidigeFinanciering>
</HuidigObject>
<Hypotheekgever Volgnummer="745">
<RefPartijNAWData IDREF="ab1" />
<TelefoonNrPrive>0612345678</TelefoonNrPrive>
<TelefoonNrWerk>0612345678</TelefoonNrWerk>
<TelefoonNrMobiel>0612345678</TelefoonNrMobiel>
<E-mailadres>test@test.com</E-mailadres>
<BurgerlijkeStaat>01 Gehuwd (gemeenschap van goederen)</BurgerlijkeStaat>
<HuwelijkOntbonden>J Ja</HuwelijkOntbonden>
<HuwelijkOntbondenDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</HuwelijkOntbondenDt>
<WeduweWeduwnaar>J Ja</WeduweWeduwnaar>
<HoofdAanspr>J Ja</HoofdAanspr>
<EersteHypotheekOoit>J Ja</EersteHypotheekOoit>
<EigenWonReserve>123.45</EigenWonReserve>
<AfwKlantProfiel>J Ja</AfwKlantProfiel>
<Inkomsten Volgnummer="745">
<LandBelastingVerplichting>AD Andorra</LandBelastingVerplichting>
<DienstBetrekking Volgnummer="745">
<SoortDienstBetrekking>01 loondienst fulltime vast</SoortDienstBetrekking>
<IngangsDtDienstBetrekking>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</IngangsDtDienstBetrekking>
<ProeftijdJN>J Ja</ProeftijdJN>
<ProeftijdVerstrekenJN>J Ja</ProeftijdVerstrekenJN>
<EindDtDienstBetrekking>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</EindDtDienstBetrekking>
<Werkgever>str1234</Werkgever>
<StraatNaamWerkgever>str1234</StraatNaamWerkgever>
<HuisNrWerkgever>33</HuisNrWerkgever>
<PostcodeWerkgever>str1234</PostcodeWerkgever>
<PlaatsNaamWerkgever>str1234</PlaatsNaamWerkgever>
<LandWerkgever>AD Andorra</LandWerkgever>
<LandBelastingVerplichting>AD Andorra</LandBelastingVerplichting>
<GemUrenWeek>33</GemUrenWeek>
<BrutoJaarSalaris>123.45</BrutoJaarSalaris>
<VakantieToeslag>123.45</VakantieToeslag>
<OnregelmatigheidsToeslag>123.45</OnregelmatigheidsToeslag>
<Vaste13eMnd>123.45</Vaste13eMnd>
<ProvisiePerJaar>123.45</ProvisiePerJaar>
<VasteEindejaarsuitkering>123.45</VasteEindejaarsuitkering>
<OverwerkPerJaar>123.45</OverwerkPerJaar>
<BrutoJaarInkVariabel>123.45</BrutoJaarInkVariabel>
<VEB>123.45</VEB>
<InkomstenToeslag>123.45</InkomstenToeslag>
<PctInkomenMeetellen>1.234</PctInkomenMeetellen>
<DuurInMndMeetellen>33</DuurInMndMeetellen>
<InkomenPeriode>01 per maand</InkomenPeriode>
<LoonbeslagJN>J Ja</LoonbeslagJN>
<InkomenFlexibel1jr>123.45</InkomenFlexibel1jr>
<InkomenFlexibel2jr>123.45</InkomenFlexibel2jr>
<InkomenFlexibel3jr>123.45</InkomenFlexibel3jr>
</DienstBetrekking>
<Onderneming Volgnummer="745" ID="ab2">
<RechtsVorm>01 Eenmanszaak</RechtsVorm>
<SoortOnderneming>01 Zelfstandige Zonder Personeel (ZZP)</SoortOnderneming>
<IngangsDtOnderneming>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</IngangsDtOnderneming>
<KvKnummer>33</KvKnummer>
<Inkomenzelfstandige>123.45</Inkomenzelfstandige>
<Inkomen1jr>123.45</Inkomen1jr>
<Inkomen2jr>123.45</Inkomen2jr>
<Inkomen3jr>123.45</Inkomen3jr>
<DGAJN>J Ja</DGAJN>
<PctAandelen>1.234</PctAandelen>
</Onderneming>
<Uitkering Volgnummer="745">
<SoortUitkering>02 Bijstand</SoortUitkering>
<SoortVerzekering>01 Lijfrente verzekering</SoortVerzekering>
<BrutoJaarUitkering>123.45</BrutoJaarUitkering>
<VakantieToeslag>123.45</VakantieToeslag>
<IngangsDtUitkering>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</IngangsDtUitkering>
<EindDtUitkering>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</EindDtUitkering>
<VolledigeAOWOpbouwJN>J Ja</VolledigeAOWOpbouwJN>
<AantalAOWJaren>33</AantalAOWJaren>
<LandBelastingVerplichting>AD Andorra</LandBelastingVerplichting>
<PctInkomenMeetellen>1.234</PctInkomenMeetellen>
<DuurInMndMeetellen>33</DuurInMndMeetellen>
</Uitkering>
<Pensioen Volgnummer="745">
<PensioenInkomen>123.45</PensioenInkomen>
<IngangsDtPensioen>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</IngangsDtPensioen>
<EindDtPensioen>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</EindDtPensioen>
<LandBelastingVerplichting>AD Andorra</LandBelastingVerplichting>
</Pensioen>
<Overige Volgnummer="745">
<SoortOverigeInkomsten>01 Alimentatie</SoortOverigeInkomsten>
<BrutoJaarBedragOverigeInkomsten>123.45</BrutoJaarBedragOverigeInkomsten>
<EindDtOverigeInkomsten>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</EindDtOverigeInkomsten>
</Overige>
</Inkomsten>
<Verplichtingen Volgnummer="745">
<VerplichtingLopendJN>J Ja</VerplichtingLopendJN>
<NrBestaandContract>str1234</NrBestaandContract>
<Maatschappij>AA ABN AMRO Bank N.V.</Maatschappij>
<MaatschappijOmschr>str1234</MaatschappijOmschr>
<Verplichting>01 Alimentatieverplichting t.g.v. kinderen</Verplichting>
<VerplichtingOmschr>str1234</VerplichtingOmschr>
<VerplichtingPerJaar>123.45</VerplichtingPerJaar>
<VerplichtingBedrag>123.45</VerplichtingBedrag>
<OorspronkelijkKredietBedrag>123.45</OorspronkelijkKredietBedrag>
<LimietDoorlopendKrediet>123.45</LimietDoorlopendKrediet>
<VerplichtingInMnd>33</VerplichtingInMnd>
<AflosBedrag>123.45</AflosBedrag>
<AfgelostDoorHypotheek>J Ja</AfgelostDoorHypotheek>
<ExtraAfgelostBedrag>123.45</ExtraAfgelostBedrag>
</Verplichtingen>
<BezittingenBoxDrie Volgnummer="745">
<SoortBezittingBoxDrie>01 banktegoeden</SoortBezittingBoxDrie>
<WaardeBezittingBoxDrie>123.45</WaardeBezittingBoxDrie>
</BezittingenBoxDrie>
<Identificatie Volgnummer="745">
<BSN>12345678</BSN>
<LegitimatieSoort>EI Europese identiteitskaart</LegitimatieSoort>
<LegitimatieNr>str1234</LegitimatieNr>
<LegitimatieAfgifteDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</LegitimatieAfgifteDt>
<LegitimatieAfgiftePlaats>str1234</LegitimatieAfgiftePlaats>
<LegitimatieAfgifteLand>AD Andorra</LegitimatieAfgifteLand>
<LegitimatieEindDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</LegitimatieEindDt>
<VerblijfsVergunning>01 onbekend</VerblijfsVergunning>
<VerblijfsVergunningNr>str1234</VerblijfsVergunningNr>
<VerblijfsVergunningEindDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</VerblijfsVergunningEindDt>
</Identificatie>
</Hypotheekgever>
<PartijNAWData Volgnummer="745" ID="ab3">
<SoortPartij>01 natuurlijk persoon</SoortPartij>
<AchterNaam>Vries</AchterNaam>
<VoorNaam>Albert</VoorNaam>
<TussenVoegsels>de</TussenVoegsels>
<GeboorteNaamJN>J Ja</GeboorteNaamJN>
<GebAchterNaam>str1234</GebAchterNaam>
<GebTussenVoegsels>str1234</GebTussenVoegsels>
<Nationaliteit>AD Andorra</Nationaliteit>
<GeboortePlaats>str1234</GeboortePlaats>
<GeboorteLand>AD Andorra</GeboorteLand>
<VoorLetters>AB</VoorLetters>
<Geslacht>M mannelijk</Geslacht>
<GeboorteDt>
<Dag>16</Dag>
<Maand>1</Maand>
<Jaar>1980</Jaar>
</GeboorteDt>
<StraatNaam>str1234</StraatNaam>
<HuisNr>33</HuisNr>
<HuisNrToevoeging>str1234</HuisNrToevoeging>
<Postcode>1234</Postcode>
<PlaatsNaam>str1234</PlaatsNaam>
<Land>AD Andorra</Land>
<RekeningNr>NL12ABNA01234567</RekeningNr>
</PartijNAWData>
<Notaris Volgnummer="745">
<RefContactPersoonData IDREF="ab1" />
<BedrijfsNaam>str1234</BedrijfsNaam>
<CodeNotaris>1 Passerend</CodeNotaris>
<TelefoonNrWerk>0612345678</TelefoonNrWerk>
</Notaris>
<TussenPersoon Volgnummer="745">
<RefContactPersoonData IDREF="ab1" />
<BedrijfsNaam>str1234</BedrijfsNaam>
<TussenpersoonNr>str1234</TussenpersoonNr>
<TelefoonNrWerk>0612345678</TelefoonNrWerk>
<E-mailadres>test@test.com</E-mailadres>
<TelefoonNrMobiel>0612345678</TelefoonNrMobiel>
<AFMRegistratieNr>str1234</AFMRegistratieNr>
<ServiceProvider Volgnummer="745">
<RefContactPersoonData IDREF="ab1" />
<ServiceProviderNaam>str1234</ServiceProviderNaam>
<ServiceProviderNr>str1234</ServiceProviderNr>
<TelefoonNrWerk>0612345678</TelefoonNrWerk>
<TelefoonNrMobiel>0612345678</TelefoonNrMobiel>
<E-mailadres>test@test.com</E-mailadres>
<ServiceProviderAFMRegistratieNr>str1234</ServiceProviderAFMRegistratieNr>
<Internetadres>str1234</Internetadres>
</ServiceProvider>
</TussenPersoon>
<Object Volgnummer="745" ID="ab4">
<CodeObject>01 eengezinswoning</CodeObject>
<Onderpand>01 bestaand</Onderpand>
<StraatNaam>str1234</StraatNaam>
<HuisNr>33</HuisNr>
<HuisNrToevoeging>str1234</HuisNrToevoeging>
<Postcode>1234</Postcode>
<PlaatsNaam>str1234</PlaatsNaam>
<Land>AD Andorra</Land>
<BouwPlanNr>str1234</BouwPlanNr>
<SituatieNr>str1234</SituatieNr>
<EigenBewoning>J Ja</EigenBewoning>
<CodeVerhuur>01 geen verhuur</CodeVerhuur>
<Huurinkomsten>123.45</Huurinkomsten>
<AfkoopExPartner>123.45</AfkoopExPartner>
<Erfpacht>J Ja</Erfpacht>
<ErfpachtEeuwigDurend>J Ja</ErfpachtEeuwigDurend>
<ErfpachtBeginDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</ErfpachtBeginDt>
<ErfpachtEindDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</ErfpachtEindDt>
<ErfpachtCanon>123.45</ErfpachtCanon>
<ErfpachtAfkoopsom>123.45</ErfpachtAfkoopsom>
<ErfpachtMeeFinancieren>J Ja</ErfpachtMeeFinancieren>
<SubsidieRegeling>01 Koopsubsidie</SubsidieRegeling>
<SubsidieRegelingBedrag>123.45</SubsidieRegelingBedrag>
<BouwJaar>33</BouwJaar>
<AppartementsRecht>J Ja</AppartementsRecht>
<BedragKwaliteitsverbeteringEBV>123.45</BedragKwaliteitsverbeteringEBV>
<HoofdVerblijf>J Ja</HoofdVerblijf>
<TaxatieAanwezig>J Ja</TaxatieAanwezig>
<TaxatieDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</TaxatieDt>
<KostenTaxatie>123.45</KostenTaxatie>
<MarktWaarde>123.45</MarktWaarde>
<Koopsom>123.45</Koopsom>
<RoerendeZaken>123.45</RoerendeZaken>
<WOZWaarde>123.45</WOZWaarde>
<WOZWaardeTaxatieDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</WOZWaardeTaxatieDt>
<AchterstalligOnderhoud>123.45</AchterstalligOnderhoud>
<VerbouwingsKosten>123.45</VerbouwingsKosten>
<MarktWaardeNaVerb>123.45</MarktWaardeNaVerb>
<VerbouwingsDepot>123.45</VerbouwingsDepot>
<ZelfBouw>J Ja</ZelfBouw>
<KoopsomGrond>123.45</KoopsomGrond>
<RenteVerlies>123.45</RenteVerlies>
<Meerwerk>123.45</Meerwerk>
<OpleveringsDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</OpleveringsDt>
<BouwRente>123.45</BouwRente>
<ServiceKosten>123.45</ServiceKosten>
<KostenLeveringsAkteSpec>123.45</KostenLeveringsAkteSpec>
<MakelaarsKostenSpec>123.45</MakelaarsKostenSpec>
<OverdrachtsBelastingSpec>123.45</OverdrachtsBelastingSpec>
<VerkoopOnderVoorwaardenJN>J Ja</VerkoopOnderVoorwaardenJN>
<KostenBouwkundigeKeuring>123.45</KostenBouwkundigeKeuring>
<PremieOpstalverzekeringPerJaar>123.45</PremieOpstalverzekeringPerJaar>
<AanneemSom>123.45</AanneemSom>
<AfkoopErfpachtJN>J Ja</AfkoopErfpachtJN>
<KadastraleAanduiding Volgnummer="745">
<Sectie>st</Sectie>
<Nr>33</Nr>
<Grootte>33</Grootte>
<KadastraleGemeente>str1234</KadastraleGemeente>
</KadastraleAanduiding>
</Object>
<Lening Volgnummer="745">
<HypotheekBedrag>123.45</HypotheekBedrag>
<HypothecaireInschrijving>123.45</HypothecaireInschrijving>
<Financier>AA ABN AMRO Bank N.V.</Financier>
<Regeling>01 eerste hypotheek (nieuw)</Regeling>
<RangOrde>33</RangOrde>
<NrBestaandeHyp>str1234</NrBestaandeHyp>
<CodeLeningMij>AA001 ABN AMRO Woninghypotheek</CodeLeningMij>
<PasseerDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</PasseerDt>
<IngebEigenMiddelen>123.45</IngebEigenMiddelen>
<BankGarantieBedrag>123.45</BankGarantieBedrag>
<BankGarantieKosten>123.45</BankGarantieKosten>
<NettoAdvieskosten>123.45</NettoAdvieskosten>
<BemiddelingsKosten>123.45</BemiddelingsKosten>
<BoeteRente>123.45</BoeteRente>
<NHG>J Ja</NHG>
<Mutatie>01 Aankoop woning</Mutatie>
<HypotheekAkteKostenSpec>123.45</HypotheekAkteKostenSpec>
<NHGKostenSpec>123.45</NHGKostenSpec>
<AankoopWoningJN>J Ja</AankoopWoningJN>
<Leningdeel Volgnummer="745">
<CodeLeningDeel>1 Nieuw</CodeLeningDeel>
<BelastingBox>01 Box 1</BelastingBox>
<CodeDeelMij>AA001 ABN AMRO Annuïteiten hypotheek</CodeDeelMij>
<DuurInMnd>33</DuurInMnd>
<LeningDeelBedrag>123.45</LeningDeelBedrag>
<AflossingsVorm>01 Annuiteit</AflossingsVorm>
<RenteAfspraak>01 rentevast</RenteAfspraak>
<RenteVastInMnd>33</RenteVastInMnd>
<RenteBedenkTijd>01 geen</RenteBedenkTijd>
<RenteBedenkTijdInMnd>33</RenteBedenkTijdInMnd>
<BetalingsTermijn>01 per maand</BetalingsTermijn>
<BetalingAchteraf>J Ja</BetalingAchteraf>
<RentePct>1.234</RentePct>
<RenteAfspraakOmschr>str1234</RenteAfspraakOmschr>
<RentePctBovenMarge>1.234</RentePctBovenMarge>
<RentePctOnderMarge>1.234</RentePctOnderMarge>
<PctConsumptief>1.234</PctConsumptief>
<ConsumptiefBedrag>123.45</ConsumptiefBedrag>
<RenteAftrekEindDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</RenteAftrekEindDt>
<FinancieleDekking Volgnummer="745">
<CodeFinancieleDekking>01 levensverzekering</CodeFinancieleDekking>
<FiscaalGeruislozeVoortzettingJN>J Ja</FiscaalGeruislozeVoortzettingJN>
<AanvangsDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</AanvangsDt>
<DuurInMnd>33</DuurInMnd>
<ProductNaam>str1234</ProductNaam>
<Maatschappij>AA ABN AMRO Bank N.V.</Maatschappij>
<MaatschappijOmschr>str1234</MaatschappijOmschr>
<PolisLopendJN>J Ja</PolisLopendJN>
<MaatschappijPolisLopend>AA ABN AMRO Bank N.V.</MaatschappijPolisLopend>
<MaatschappijPolisLopendOmschr>str1234</MaatschappijPolisLopendOmschr>
<PolisNr>str1234</PolisNr>
<PolisAfkoopWaarde>123.45</PolisAfkoopWaarde>
<PolisOmzetting>J Ja</PolisOmzetting>
<BerekeningsUitgangspunt>01 Van premie naar kapitaal</BerekeningsUitgangspunt>
<VerpandJN>J Ja</VerpandJN>
<PremieAfspraken Volgnummer="745">
<SoortPremie>01 Risicopremie normaal</SoortPremie>
<AanvangNaIngangsDtInMnd>33</AanvangNaIngangsDtInMnd>
<DuurInMnd>33</DuurInMnd>
<PremieBedrag>123.45</PremieBedrag>
<BetalingsTermijn>01 per maand</BetalingsTermijn>
<RefDebiteurNAWData IDREF="ab1" />
</PremieAfspraken>
<Verzekerde Volgnummer="745">
<RefPartijNAWData IDREF="ab1" />
</Verzekerde>
<VerzekeringNemer Volgnummer="745">
<RefPartijNAWData IDREF="ab1" />
<BSN>12345678</BSN>
</VerzekeringNemer>
<VerzekerdeBedragen Volgnummer="745">
<SoortVerzekerdKap>01 Verzekerd bedrag bij overlijden</SoortVerzekerdKap>
<VerzekerdKap>123.45</VerzekerdKap>
<VerzekerdKap2>123.45</VerzekerdKap2>
<BelastingBox>01 Box 1</BelastingBox>
<CodeUitkering>01 Lineair dalend</CodeUitkering>
</VerzekerdeBedragen>
<FiscaalGeruislozeVoortzetting Volgnummer="745">
<FiscaleVormDekking>01 SEW</FiscaleVormDekking>
<DekkingNr>str1234</DekkingNr>
<AanvangsDtBox1>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</AanvangsDtBox1>
<DekkingLopendBetalingLaag>123.45</DekkingLopendBetalingLaag>
<DekkingLopendBetalingHoog>123.45</DekkingLopendBetalingHoog>
<BedragBetaaldLopendJaar>123.45</BedragBetaaldLopendJaar>
<CumulatieveBetalingEindDt>123.45</CumulatieveBetalingEindDt>
<DekkingOverdrachtsWaarde>123.45</DekkingOverdrachtsWaarde>
<EerdereUitkeringDekking>123.45</EerdereUitkeringDekking>
<PremieBedrag>123.45</PremieBedrag>
<OorspronkelijkeEindDtLopendeDekking>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</OorspronkelijkeEindDtLopendeDekking>
</FiscaalGeruislozeVoortzetting>
</FinancieleDekking>
<BancaireDekking Volgnummer="745">
<Aanbieder>AA ABN AMRO Bank N.V.</Aanbieder>
<CodeBancaireDekking>01 Spaarrekening</CodeBancaireDekking>
<FiscaalGeruislozeVoortzettingJN>J Ja</FiscaalGeruislozeVoortzettingJN>
<AanvangsDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</AanvangsDt>
<DuurInMnd>33</DuurInMnd>
<ContractLopendJN>J Ja</ContractLopendJN>
<ContractOmzettingJN>J Ja</ContractOmzettingJN>
<ContractNr>str1234</ContractNr>
<InlegAfspraken Volgnummer="745">
<SoortInleg>01 Periodieke inleg</SoortInleg>
<AanvangNaIngangsDtInMnd>33</AanvangNaIngangsDtInMnd>
<DuurInMnd>33</DuurInMnd>
<InlegBedrag>123.45</InlegBedrag>
<BetalingsTermijn>01 per maand</BetalingsTermijn>
<RefDebiteurNAWData IDREF="ab1" />
</InlegAfspraken>
<Contractant Volgnummer="745">
<RefPartijNAWData IDREF="ab1" />
<BSN>12345678</BSN>
</Contractant>
<Waarden Volgnummer="745">
<SoortWaarde>01 Waarde op einddatum</SoortWaarde>
<BedragWaarde>123.45</BedragWaarde>
<BelastingBox>01 Box 1</BelastingBox>
<RekenRentePct>1.234</RekenRentePct>
<IngangsDtWaarde>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</IngangsDtWaarde>
</Waarden>
<FiscaalGeruislozeVoortzetting Volgnummer="745">
<FiscaleVormDekking>01 SEW</FiscaleVormDekking>
<MaatschappijDekkingLopend>AA ABN AMRO Bank N.V.</MaatschappijDekkingLopend>
<MaatschappijDekkingLopendOmschr>str1234</MaatschappijDekkingLopendOmschr>
<StortingDtNieuweDekking>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</StortingDtNieuweDekking>
<DekkingLopendBetalingLaag>123.45</DekkingLopendBetalingLaag>
<DekkingLopendBetalingHoog>123.45</DekkingLopendBetalingHoog>
<BedragBetaaldLopendJaar>123.45</BedragBetaaldLopendJaar>
<DekkingOverdrachtsWaarde>123.45</DekkingOverdrachtsWaarde>
</FiscaalGeruislozeVoortzetting>
</BancaireDekking>
</Leningdeel>
</Lening>
<FinancieleDekking Volgnummer="745">
<CodeFinancieleDekking>01 levensverzekering</CodeFinancieleDekking>
<AanvangsDt>
<Dag>1</Dag>
<Maand>1</Maand>
<Jaar>2017</Jaar>
</AanvangsDt>
<DuurInMnd>33</DuurInMnd>
<ProductNaam>str1234</ProductNaam>
<Maatschappij>AA ABN AMRO Bank N.V.</Maatschappij>
<MaatschappijOmschr>str1234</MaatschappijOmschr>
<PolisLopendJN>J Ja</PolisLopendJN>
<MaatschappijPolisLopend>AA ABN AMRO Bank N.V.</MaatschappijPolisLopend>
<PolisNr>str1234</PolisNr>
<PolisAfkoopWaarde>123.45</PolisAfkoopWaarde>
<PolisOmzetting>J Ja</PolisOmzetting>
<BerekeningsUitgangspunt>01 Van premie naar kapitaal</BerekeningsUitgangspunt>
<PremieDepot Volgnummer="745" />
<PremieAfspraken Volgnummer="745">
<SoortPremie>01 Risicopremie normaal</SoortPremie>
<AanvangNaIngangsDtInMnd>33</AanvangNaIngangsDtInMnd>
<DuurInMnd>33</DuurInMnd>
<PremieBedrag>123.45</PremieBedrag>
<BetalingsTermijn>01 per maand</BetalingsTermijn>
<RefDebiteurNAWData IDREF="ab1" />
<PremieUitDepot>123.45</PremieUitDepot>
</PremieAfspraken>
<Verzekerde Volgnummer="745">
<RefPartijNAWData IDREF="ab1" />
<Beroep>0111 Docenten hoger onderwijs en hoogleraren</Beroep>
</Verzekerde>
<VerzekeringNemer Volgnummer="745">
<RefPartijNAWData IDREF="ab1" />
<BSN>12345678</BSN>
</VerzekeringNemer>
<VerzekerdeBedragen Volgnummer="745">
<SoortVerzekerdKap>01 Verzekerd bedrag bij overlijden</SoortVerzekerdKap>
<VerzekerdKap>123.45</VerzekerdKap>
<VerzekerdKap2>123.45</VerzekerdKap2>
<BelastingBox>01 Box 1</BelastingBox>
<CodeUitkering>01 Lineair dalend</CodeUitkering>
<VerzekerdPct>1.234</VerzekerdPct>
<VerzekerdPct2>1.234</VerzekerdPct2>
<DuurInMnd>33</DuurInMnd>
<EindWaardeDekking>123.45</EindWaardeDekking>
</VerzekerdeBedragen>
</FinancieleDekking>
</OfferteAanvraag>
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of updated data (can be empty on array inserts)"
}
}
}
404
Headers
Content-Type: application/json
Body
{
"errors": [
{
"message": "Not found"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
Dossiers ¶
All calls for Dossier management
Dossiers ¶
Dossier functions
ListGET/dossier{?perPage}
Get a list of all Dossiers.
Example URI
- perPage
integer
(optional) Default: 15 Example: 25The maximum number of objects to return
200
Headers
Content-Type: application/json
Body
{
"data": [
{
"uuid": 1,
"customer_id": "700004",
"status": "AA-BB-12"
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 15,
"current": 1,
"total_pages": 1,
"links": []
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number",
"description": "Total number of objects"
},
"count": {
"type": "number",
"description": "Object on this page"
},
"per_page": {
"type": "number",
"description": "Object per page"
},
"current": {
"type": "number",
"description": "Current page number"
},
"total_pages": {
"type": "number",
"description": "Total number of pages"
},
"links": {
"description": "Array of meta links"
}
}
}
}
}
}
}
ShowGET/dossier/{dossier_id}
Example URI
- dossier_id
integer
(required) Example: 1The id of the dossier
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
CreatePOST/dossier
Example URI
Headers
Content-Type: application/json
Accept: application/json
Body
{
"uuid": 1,
"customer_id": "700004",
"status": "AA-BB-12"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"uuid": {
"type": "number",
"description": "UUID of dossier"
},
"customer_id": {
"type": "string",
"description": "Customer ID of dossier"
},
"status": {
"type": "string",
"description": "Status of dossier"
}
},
"required": [
"uuid"
]
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
UpdatePUT/dossier/{dossier_id}
Example URI
- dossier_id
integer
(required) Example: 1The id of a dossier
Headers
Content-Type: application/json
Accept: application/json
Body
{
"uuid": 1,
"customer_id": "700004",
"status": "AA-BB-12"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"uuid": {
"type": "number",
"description": "UUID of dossier"
},
"customer_id": {
"type": "string",
"description": "Customer ID of dossier"
},
"status": {
"type": "string",
"description": "Status of dossier"
}
},
"required": [
"uuid"
]
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
DeleteDELETE/dossier/{dossier_id}
Example URI
- dossier_id
integer
(required) Example: 1The id of the dossier
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of deleted data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
EmailAccount ¶
All calls for EmailAccount management
EmailAccounts ¶
Emailaccount functions
ListGET/emailAccount{?perPage}
Get a list of all EmailAccounts.
Example URI
- perPage
integer
(optional) Default: 15 Example: 25The maximum number of objects to return
200
Headers
Content-Type: application/json
Body
{
"data": [
{
"name": "John Doe",
"address": "test@test.nl",
"host": "imap.gmail.com",
"port": 143,
"username": "test@test.nl",
"validate_cert": false,
"encryption": 1,
"signature": "Yours truly",
"sync_enabled": false,
"synced_at": "01/01/2018",
"locked": false,
"auto_match": false,
"auto_process": false,
"process_email_account_folder_id": 0
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 15,
"current": 1,
"total_pages": 1,
"links": []
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number",
"description": "Total number of objects"
},
"count": {
"type": "number",
"description": "Object on this page"
},
"per_page": {
"type": "number",
"description": "Object per page"
},
"current": {
"type": "number",
"description": "Current page number"
},
"total_pages": {
"type": "number",
"description": "Total number of pages"
},
"links": {
"description": "Array of meta links"
}
}
}
}
}
}
}
ShowGET/emailAccount/{emailAccount_id}
Example URI
- emailAccount_id
integer
(required) Example: 1The id of the emailaccount
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
CreatePOST/emailAccount
Example URI
Headers
Content-Type: application/json
Accept: application/json
Body
{
"name": "John Doe",
"address": "test@test.nl",
"host": "imap.gmail.com",
"port": 143,
"username": "test@test.nl",
"validate_cert": false,
"encryption": 1,
"signature": "Yours truly",
"sync_enabled": false,
"synced_at": "01/01/2018",
"locked": false,
"auto_match": false,
"auto_process": false,
"process_email_account_folder_id": 0
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of Emailaccount holder"
},
"address": {
"type": "string",
"description": "Emailaddress of Emailaccount holder"
},
"host": {
"type": "string",
"description": "Hostname of Emailaccount"
},
"port": {
"type": "number",
"description": "Port of Emailaccount"
},
"username": {
"type": "string",
"description": "Username of Emailaccount"
},
"validate_cert": {
"type": "boolean",
"description": "Emailaccount has validation certificate?"
},
"encryption": {
"type": "number",
"enum": [
0,
1,
2
],
"default": "0",
"description": "Type of encryption of Emailaccount\n\nEncryptionTypes enum:\n0: none, 1: ssl, 2: tls"
},
"signature": {
"type": "string",
"description": "Signature of Emailaccount"
},
"sync_enabled": {
"type": "boolean",
"description": "Is sync enabled?"
},
"synced_at": {
"type": "string",
"description": "Date of sync, format d/m/Y"
},
"locked": {
"type": "boolean",
"description": "Emailaccount locked?"
},
"auto_match": {
"type": "boolean",
"description": "Auto match Emailaccount?"
},
"auto_process": {
"type": "boolean",
"description": "Auto process Emailaccount?"
},
"process_email_account_folder_id": {
"type": "number",
"description": "Branche code of insurance company"
}
},
"required": [
"name",
"address"
]
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
UpdatePUT/emailAccount/{emailAccount_id}
Example URI
- emailAccount_id
integer
(required) Example: 1The id of an emailaccount
Headers
Content-Type: application/json
Accept: application/json
Body
{
"name": "John Doe",
"address": "test@test.nl",
"host": "imap.gmail.com",
"port": 143,
"username": "test@test.nl",
"validate_cert": false,
"encryption": 1,
"signature": "Yours truly",
"sync_enabled": false,
"synced_at": "01/01/2018",
"locked": false,
"auto_match": false,
"auto_process": false,
"process_email_account_folder_id": 0
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of Emailaccount holder"
},
"address": {
"type": "string",
"description": "Emailaddress of Emailaccount holder"
},
"host": {
"type": "string",
"description": "Hostname of Emailaccount"
},
"port": {
"type": "number",
"description": "Port of Emailaccount"
},
"username": {
"type": "string",
"description": "Username of Emailaccount"
},
"validate_cert": {
"type": "boolean",
"description": "Emailaccount has validation certificate?"
},
"encryption": {
"type": "number",
"enum": [
0,
1,
2
],
"default": "0",
"description": "Type of encryption of Emailaccount\n\nEncryptionTypes enum:\n0: none, 1: ssl, 2: tls"
},
"signature": {
"type": "string",
"description": "Signature of Emailaccount"
},
"sync_enabled": {
"type": "boolean",
"description": "Is sync enabled?"
},
"synced_at": {
"type": "string",
"description": "Date of sync, format d/m/Y"
},
"locked": {
"type": "boolean",
"description": "Emailaccount locked?"
},
"auto_match": {
"type": "boolean",
"description": "Auto match Emailaccount?"
},
"auto_process": {
"type": "boolean",
"description": "Auto process Emailaccount?"
},
"process_email_account_folder_id": {
"type": "number",
"description": "Branche code of insurance company"
}
},
"required": [
"name",
"address"
]
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
DeleteDELETE/emailAccount/{emailAccount_id}
Example URI
- emailAccount_id
integer
(required) Example: 1The id of the emailaccount
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of deleted data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
Letters ¶
All calls for Letter management
Letters ¶
Letter functions
ListGET/letter{?perPage}
Get a list of all Letters.
Example URI
- perPage
integer
(optional) Default: 15 Example: 25The maximum number of objects to return
200
Headers
Content-Type: application/json
Body
{
"data": [
{
"name": "Test letter",
"address": "Test",
"content": "Test",
"customer_id": 1,
"user_id": 1,
"for_instance_class": 1,
"for_instance_id": 1,
"category_id": 1,
"template_id": 1
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 15,
"current": 1,
"total_pages": 1,
"links": []
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number",
"description": "Total number of objects"
},
"count": {
"type": "number",
"description": "Object on this page"
},
"per_page": {
"type": "number",
"description": "Object per page"
},
"current": {
"type": "number",
"description": "Current page number"
},
"total_pages": {
"type": "number",
"description": "Total number of pages"
},
"links": {
"description": "Array of meta links"
}
}
}
}
}
}
}
ShowGET/letter/{letter_id}
Example URI
- letter_id
integer
(required) Example: 1The id of the letter
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
CreatePOST/letter
Example URI
Headers
Content-Type: application/json
Accept: application/json
Body
{
"name": "Test letter",
"address": "Test",
"content": "Test",
"customer_id": 1,
"user_id": 1,
"for_instance_class": 1,
"for_instance_id": 1,
"category_id": 1,
"template_id": 1
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the letter"
},
"address": {
"type": "string",
"description": "Address of the letter"
},
"content": {
"type": "string",
"description": "Content of the letter"
},
"customer_id": {
"type": "number",
"description": "ID of the customer"
},
"user_id": {
"type": "number",
"description": "ID of the user"
},
"for_instance_class": {
"type": "number",
"description": "For instance class of the letter"
},
"for_instance_id": {
"type": "number",
"description": "For instance id of the letter"
},
"category_id": {
"type": "number",
"description": "ID of the category of the letter"
},
"template_id": {
"type": "number",
"description": "ID of the template of the letter"
}
},
"required": [
"name",
"address",
"content",
"customer_id",
"user_id",
"category_id",
"template_id"
]
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
UpdatePUT/letter/{letter_id}
Example URI
- letter_id
integer
(required) Example: 1The id of a letter
Headers
Content-Type: application/json
Accept: application/json
Body
{
"name": "Test letter",
"address": "Test",
"content": "Test",
"customer_id": 1,
"user_id": 1,
"for_instance_class": 1,
"for_instance_id": 1,
"category_id": 1,
"template_id": 1
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the letter"
},
"address": {
"type": "string",
"description": "Address of the letter"
},
"content": {
"type": "string",
"description": "Content of the letter"
},
"customer_id": {
"type": "number",
"description": "ID of the customer"
},
"user_id": {
"type": "number",
"description": "ID of the user"
},
"for_instance_class": {
"type": "number",
"description": "For instance class of the letter"
},
"for_instance_id": {
"type": "number",
"description": "For instance id of the letter"
},
"category_id": {
"type": "number",
"description": "ID of the category of the letter"
},
"template_id": {
"type": "number",
"description": "ID of the template of the letter"
}
},
"required": [
"name",
"address",
"content",
"customer_id",
"user_id",
"category_id",
"template_id"
]
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
DeleteDELETE/letter/{letter_id}
Example URI
- letter_id
integer
(required) Example: 1The id of the letter
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of deleted data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
Lock ¶
All calls for Lock management
Locks ¶
Lock functions
ListGET/lock{?perPage}
Get a list of all locks.
Example URI
- perPage
integer
(optional) Default: 15 Example: 25The maximum number of objects to return
200
Headers
Content-Type: application/json
Body
{
"data": [
{
"lockable_type": "test",
"lockable_id": 1,
"user_id": 1
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 15,
"current": 1,
"total_pages": 1,
"links": []
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number",
"description": "Total number of objects"
},
"count": {
"type": "number",
"description": "Object on this page"
},
"per_page": {
"type": "number",
"description": "Object per page"
},
"current": {
"type": "number",
"description": "Current page number"
},
"total_pages": {
"type": "number",
"description": "Total number of pages"
},
"links": {
"description": "Array of meta links"
}
}
}
}
}
}
}
ShowGET/lock/{lock_id}
Example URI
- lock_id
integer
(required) Example: 1The id of the lock
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
CreatePOST/lock
Example URI
Headers
Content-Type: application/json
Accept: application/json
Body
{
"lockable_type": "test",
"lockable_id": 1,
"user_id": 1
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"lockable_type": {
"type": "string",
"description": "Type of the lockable"
},
"lockable_id": {
"type": "number",
"description": "ID of the lockable"
},
"user_id": {
"type": "number",
"description": "ID of the user"
}
},
"required": [
"lockable_type",
"lockable_id",
"user_id"
]
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
UpdatePUT/lock/{lock_id}
Example URI
- lock_id
integer
(required) Example: 1The id of an lock
Headers
Content-Type: application/json
Accept: application/json
Body
{
"lockable_type": "test",
"lockable_id": 1,
"user_id": 1
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"lockable_type": {
"type": "string",
"description": "Type of the lockable"
},
"lockable_id": {
"type": "number",
"description": "ID of the lockable"
},
"user_id": {
"type": "number",
"description": "ID of the user"
}
},
"required": [
"lockable_type",
"lockable_id",
"user_id"
]
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
DeleteDELETE/lock/{lock_id}
Example URI
- lock_id
integer
(required) Example: 1The id of the lock
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of deleted data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
Mortgages ¶
All calls for Mortgage management
Mortgages ¶
Mortgage functions
ListGET/mortgage{?perPage}
Get a list of all Mortgages.
Example URI
- perPage
integer
(optional) Default: 15 Example: 25The maximum number of objects to return
200
Headers
Content-Type: application/json
Body
{
"data": [
{
"customer_id": 1,
"hypotheeknummer": "12345678",
"koopsom": 250000,
"onderpandsgegevens": "Hoofdstraat 1, Hoofdstad",
"redenHypotheek": "Bestaande bouw",
"hoofdsomHypotheek": 100000,
"hypotheciareInschrijving": "150000",
"taxateur_id": 1,
"marktwaarde": 250000,
"datumTaxatie": "01-01-2018",
"wozWaarde": 250000,
"wozDatum": "01-01-2018",
"totaalSom": 0,
"bouwdepot": "25000",
"notaris_id": 1,
"passeerdatum": "01-01-2018",
"verkopendMakelaar_id": 1,
"geldverstrekker_id": 1,
"label_id": 1,
"nhg": true,
"rate": 1,
"rangorde": 1,
"status": 1,
"getekend": "01-01-2018",
"voor_verlenging": "01-01-2018",
"na_verlening": "01-01-2018",
"financiering": "01-01-2018",
"bankgarantie": "01-01-20184",
"passeerdatumVoortgang": "01-01-2018",
"collateral_address": "Teststraat",
"collateral_city": "Teststad",
"collateral_postcode": "9123HH",
"collateral_housenumber": "61",
"collateral_county": "Netherlands",
"restantHoofdsom": 500000,
"executiewaarde": 100000,
"type_woning": 1,
"offerteNummer": 100,
"datumAanvraag": "01-01-2018",
"datumOfferte": "01-01-2018",
"datumGeldigheidOfferte": "01-01-2018",
"datumOfferteGetekend": "01-01-2018",
"vovVoorVerbouwing": 200000,
"vovNaVerbouwing": 250000,
"ewVoorVerbouwing": 150000,
"ewNaVerbouwing": 175000,
"trackingNumber": 1,
"collateral_addition": "A",
"purchasing_broker_id": 1,
"validity_unsigned_offer_date": "01-01-2018",
"validity_signed_offer_date": "01-01-2018",
"end_financing_reservation_date": "401-01-2018",
"has_bank_guarantee_date": "01-01-2018",
"bank_guarantee_date": "01-01-2018",
"mortgage_property_id": 1,
"financier_agency_id": 1,
"arrangement_type": 1,
"existing_mortgage_number": "1",
"own_resources_amount": 1,
"mutation_code": 1,
"is_property_purchase": false,
"bank_guarantee_costs": 50000,
"net_consultancy_costs": 50000,
"mortgage_deed_cost_specification": 5000,
"national_mortgage_guarantee_costs": 5000,
"fine_interest": 1,
"loan_type": "14",
"secondary_customer_id": 1,
"loan_to_value": 1,
"risk_class": 1,
"risk_class_type": 1
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 15,
"current": 1,
"total_pages": 1,
"links": []
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number",
"description": "Total number of objects"
},
"count": {
"type": "number",
"description": "Object on this page"
},
"per_page": {
"type": "number",
"description": "Object per page"
},
"current": {
"type": "number",
"description": "Current page number"
},
"total_pages": {
"type": "number",
"description": "Total number of pages"
},
"links": {
"description": "Array of meta links"
}
}
}
}
}
}
}
ShowGET/mortgage/{mortgage_id}
Example URI
- mortgage_id
integer
(required) Example: 1The id of the mortgage
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
CreatePOST/mortgage
Example URI
Headers
Content-Type: application/json
Accept: application/json
Body
{
"customer_id": 1,
"hypotheeknummer": "12345678",
"koopsom": 250000,
"onderpandsgegevens": "Hoofdstraat 1, Hoofdstad",
"redenHypotheek": "Bestaande bouw",
"hoofdsomHypotheek": 100000,
"hypotheciareInschrijving": "150000",
"taxateur_id": 1,
"marktwaarde": 250000,
"datumTaxatie": "01-01-2018",
"wozWaarde": 250000,
"wozDatum": "01-01-2018",
"totaalSom": 0,
"bouwdepot": "25000",
"notaris_id": 1,
"passeerdatum": "01-01-2018",
"verkopendMakelaar_id": 1,
"geldverstrekker_id": 1,
"label_id": 1,
"nhg": true,
"rate": 1,
"rangorde": 1,
"status": 1,
"getekend": "01-01-2018",
"voor_verlenging": "01-01-2018",
"na_verlening": "01-01-2018",
"financiering": "01-01-2018",
"bankgarantie": "01-01-20184",
"passeerdatumVoortgang": "01-01-2018",
"collateral_address": "Teststraat",
"collateral_city": "Teststad",
"collateral_postcode": "9123HH",
"collateral_housenumber": "61",
"collateral_county": "Netherlands",
"restantHoofdsom": 500000,
"executiewaarde": 100000,
"type_woning": 1,
"offerteNummer": 100,
"datumAanvraag": "01-01-2018",
"datumOfferte": "01-01-2018",
"datumGeldigheidOfferte": "01-01-2018",
"datumOfferteGetekend": "01-01-2018",
"vovVoorVerbouwing": 200000,
"vovNaVerbouwing": 250000,
"ewVoorVerbouwing": 150000,
"ewNaVerbouwing": 175000,
"trackingNumber": 1,
"collateral_addition": "A",
"purchasing_broker_id": 1,
"validity_unsigned_offer_date": "01-01-2018",
"validity_signed_offer_date": "01-01-2018",
"end_financing_reservation_date": "401-01-2018",
"has_bank_guarantee_date": "01-01-2018",
"bank_guarantee_date": "01-01-2018",
"mortgage_property_id": 1,
"financier_agency_id": 1,
"arrangement_type": 1,
"existing_mortgage_number": "1",
"own_resources_amount": 1,
"mutation_code": 1,
"is_property_purchase": false,
"bank_guarantee_costs": 50000,
"net_consultancy_costs": 50000,
"mortgage_deed_cost_specification": 5000,
"national_mortgage_guarantee_costs": 5000,
"fine_interest": 1,
"loan_type": "14",
"secondary_customer_id": 1,
"loan_to_value": 1,
"risk_class": 1,
"risk_class_type": 1
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"customer_id": {
"type": "number",
"description": "ID of the customer"
},
"hypotheeknummer": {
"type": "string",
"description": "Number of mortgage"
},
"koopsom": {
"type": "number",
"description": "Buying price of property"
},
"onderpandsgegevens": {
"type": "string",
"description": "Credentials of collateral"
},
"redenHypotheek": {
"type": "string",
"description": "Reason of mortgage"
},
"hoofdsomHypotheek": {
"type": "number",
"description": "Main sum mortgage"
},
"hypotheciareInschrijving": {
"type": "string",
"description": "Mortgage registration"
},
"taxateur_id": {
"type": "number",
"description": "ID of appraiser"
},
"marktwaarde": {
"type": "number",
"description": "Market value of property"
},
"datumTaxatie": {
"type": "string",
"description": "Date of taxation"
},
"wozWaarde": {
"type": "number",
"description": "Cadastral value"
},
"wozDatum": {
"type": "string",
"description": "Date of cadastral"
},
"totaalSom": {
"type": "number",
"description": "Total sum"
},
"bouwdepot": {
"type": "string",
"description": "Building fund of mortgage"
},
"notaris_id": {
"type": "number",
"description": "ID of notary"
},
"passeerdatum": {
"type": "string",
"description": "Date when the mortgage papers are signed by the notary"
},
"verkopendMakelaar_id": {
"type": "number",
"description": "ID of realtor"
},
"geldverstrekker_id": {
"type": "number",
"description": "ID of company that gave the mortgage"
},
"label_id": {
"type": "number",
"description": "ID of label"
},
"nhg": {
"type": "boolean",
"description": "Is mortgage under Nationale Hypotheek Garantie (NHG)?"
},
"rate": {
"type": "number",
"description": "Rate of mortgage"
},
"rangorde": {
"type": "number",
"description": "Rank of mortgage"
},
"status": {
"type": "number",
"description": "Status of mortgage"
},
"getekend": {
"type": "string",
"description": "Date of signing"
},
"voor_verlenging": {
"type": "string",
"description": "Date before extension"
},
"na_verlening": {
"type": "string",
"description": "Date after extension"
},
"financiering": {
"type": "string",
"description": "Date of financing"
},
"bankgarantie": {
"type": "string",
"description": "Date of bank guarantee"
},
"passeerdatumVoortgang": {
"type": "string",
"description": "Date of passing date progress"
},
"collateral_address": {
"type": "string",
"description": "Collateral address of mortgage"
},
"collateral_city": {
"type": "string",
"description": "Collateral city of mortgage"
},
"collateral_postcode": {
"type": "string",
"description": "Collateral postal code of mortgage"
},
"collateral_housenumber": {
"type": "string",
"description": "Collateral house number of mortgage"
},
"collateral_county": {
"type": "string",
"description": "Collateral county of mortgage"
},
"restantHoofdsom": {
"type": "number",
"description": "Remainder of total sum of mortgage"
},
"executiewaarde": {
"type": "number",
"description": "Execution value of mortgage"
},
"type_woning": {
"type": "number",
"description": "ID type of property"
},
"offerteNummer": {
"type": "number",
"description": "Quotation of mortgage"
},
"datumAanvraag": {
"type": "string",
"description": "Date of application"
},
"datumOfferte": {
"type": "string",
"description": "Date of quotation"
},
"datumGeldigheidOfferte": {
"type": "string",
"description": "Date of validity for quotation"
},
"datumOfferteGetekend": {
"type": "string",
"description": "Date of quotation signed"
},
"vovVoorVerbouwing": {
"type": "number",
"description": "Vrije onderhandse verkoopwaarde (VOV) before construction"
},
"vovNaVerbouwing": {
"type": "number",
"description": "Vrije onderhandse verkoopwaarde (VOV) after construction"
},
"ewVoorVerbouwing": {
"type": "number",
"description": "Execution value before construction"
},
"ewNaVerbouwing": {
"type": "number",
"description": "Execution value after construction"
},
"trackingNumber": {
"type": "number",
"description": "Tracking number of mortgage"
},
"collateral_addition": {
"type": "string",
"description": "Collateral addition of mortgage"
},
"purchasing_broker_id": {
"type": "number",
"description": "ID of purchasing broker"
},
"validity_unsigned_offer_date": {
"type": "string",
"description": "Validity of unsigned offer date"
},
"validity_signed_offer_date": {
"type": "string",
"description": "Validity of signed offer date"
},
"end_financing_reservation_date": {
"type": "string",
"description": "End of financing reservation date"
},
"has_bank_guarantee_date": {
"type": "string",
"description": "Date of bank guarantee"
},
"bank_guarantee_date": {
"type": "string",
"description": "Date of bank guarantee"
},
"mortgage_property_id": {
"type": "number",
"description": "ID of mortgage property"
},
"financier_agency_id": {
"type": "number",
"description": "ID of financier agency"
},
"arrangement_type": {
"type": "number",
"description": "ID of arrangement"
},
"existing_mortgage_number": {
"type": "string",
"description": "Number of existing mortgage number"
},
"own_resources_amount": {
"type": "number",
"description": "Amount of own resources"
},
"mutation_code": {
"type": "number",
"description": "Code of mutation of mortgage"
},
"is_property_purchase": {
"type": "boolean",
"description": "Is property purchased?"
},
"bank_guarantee_costs": {
"type": "number",
"description": "Costs of bank guarantee"
},
"net_consultancy_costs": {
"type": "number",
"description": "Net consultancy costs"
},
"mortgage_deed_cost_specification": {
"type": "number",
"description": "Costs of mortgage deed"
},
"national_mortgage_guarantee_costs": {
"type": "number",
"description": "National mortgage guarantee costs"
},
"fine_interest": {
"type": "number",
"description": "Fine intereset of mortgage"
},
"loan_type": {
"type": "string",
"description": "Type of loan"
},
"secondary_customer_id": {
"type": "number",
"description": "ID of secondary customer"
},
"loan_to_value": {
"type": "number",
"description": "Value to loan of mortgage"
},
"risk_class": {
"type": "number",
"description": "Risk class of mortgage"
},
"risk_class_type": {
"type": "number",
"description": "Type of risk class of mortgage"
}
},
"required": [
"customer_id"
]
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
UpdatePUT/mortgage/{mortgage_id}
Example URI
- mortgage_id
integer
(required) Example: 1The id of a mortgage
Headers
Content-Type: application/json
Accept: application/json
Body
{
"customer_id": 1,
"hypotheeknummer": "12345678",
"koopsom": 250000,
"onderpandsgegevens": "Hoofdstraat 1, Hoofdstad",
"redenHypotheek": "Bestaande bouw",
"hoofdsomHypotheek": 100000,
"hypotheciareInschrijving": "150000",
"taxateur_id": 1,
"marktwaarde": 250000,
"datumTaxatie": "01-01-2018",
"wozWaarde": 250000,
"wozDatum": "01-01-2018",
"totaalSom": 0,
"bouwdepot": "25000",
"notaris_id": 1,
"passeerdatum": "01-01-2018",
"verkopendMakelaar_id": 1,
"geldverstrekker_id": 1,
"label_id": 1,
"nhg": true,
"rate": 1,
"rangorde": 1,
"status": 1,
"getekend": "01-01-2018",
"voor_verlenging": "01-01-2018",
"na_verlening": "01-01-2018",
"financiering": "01-01-2018",
"bankgarantie": "01-01-20184",
"passeerdatumVoortgang": "01-01-2018",
"collateral_address": "Teststraat",
"collateral_city": "Teststad",
"collateral_postcode": "9123HH",
"collateral_housenumber": "61",
"collateral_county": "Netherlands",
"restantHoofdsom": 500000,
"executiewaarde": 100000,
"type_woning": 1,
"offerteNummer": 100,
"datumAanvraag": "01-01-2018",
"datumOfferte": "01-01-2018",
"datumGeldigheidOfferte": "01-01-2018",
"datumOfferteGetekend": "01-01-2018",
"vovVoorVerbouwing": 200000,
"vovNaVerbouwing": 250000,
"ewVoorVerbouwing": 150000,
"ewNaVerbouwing": 175000,
"trackingNumber": 1,
"collateral_addition": "A",
"purchasing_broker_id": 1,
"validity_unsigned_offer_date": "01-01-2018",
"validity_signed_offer_date": "01-01-2018",
"end_financing_reservation_date": "401-01-2018",
"has_bank_guarantee_date": "01-01-2018",
"bank_guarantee_date": "01-01-2018",
"mortgage_property_id": 1,
"financier_agency_id": 1,
"arrangement_type": 1,
"existing_mortgage_number": "1",
"own_resources_amount": 1,
"mutation_code": 1,
"is_property_purchase": false,
"bank_guarantee_costs": 50000,
"net_consultancy_costs": 50000,
"mortgage_deed_cost_specification": 5000,
"national_mortgage_guarantee_costs": 5000,
"fine_interest": 1,
"loan_type": "14",
"secondary_customer_id": 1,
"loan_to_value": 1,
"risk_class": 1,
"risk_class_type": 1
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"customer_id": {
"type": "number",
"description": "ID of the customer"
},
"hypotheeknummer": {
"type": "string",
"description": "Number of mortgage"
},
"koopsom": {
"type": "number",
"description": "Buying price of property"
},
"onderpandsgegevens": {
"type": "string",
"description": "Credentials of collateral"
},
"redenHypotheek": {
"type": "string",
"description": "Reason of mortgage"
},
"hoofdsomHypotheek": {
"type": "number",
"description": "Main sum mortgage"
},
"hypotheciareInschrijving": {
"type": "string",
"description": "Mortgage registration"
},
"taxateur_id": {
"type": "number",
"description": "ID of appraiser"
},
"marktwaarde": {
"type": "number",
"description": "Market value of property"
},
"datumTaxatie": {
"type": "string",
"description": "Date of taxation"
},
"wozWaarde": {
"type": "number",
"description": "Cadastral value"
},
"wozDatum": {
"type": "string",
"description": "Date of cadastral"
},
"totaalSom": {
"type": "number",
"description": "Total sum"
},
"bouwdepot": {
"type": "string",
"description": "Building fund of mortgage"
},
"notaris_id": {
"type": "number",
"description": "ID of notary"
},
"passeerdatum": {
"type": "string",
"description": "Date when the mortgage papers are signed by the notary"
},
"verkopendMakelaar_id": {
"type": "number",
"description": "ID of realtor"
},
"geldverstrekker_id": {
"type": "number",
"description": "ID of company that gave the mortgage"
},
"label_id": {
"type": "number",
"description": "ID of label"
},
"nhg": {
"type": "boolean",
"description": "Is mortgage under Nationale Hypotheek Garantie (NHG)?"
},
"rate": {
"type": "number",
"description": "Rate of mortgage"
},
"rangorde": {
"type": "number",
"description": "Rank of mortgage"
},
"status": {
"type": "number",
"description": "Status of mortgage"
},
"getekend": {
"type": "string",
"description": "Date of signing"
},
"voor_verlenging": {
"type": "string",
"description": "Date before extension"
},
"na_verlening": {
"type": "string",
"description": "Date after extension"
},
"financiering": {
"type": "string",
"description": "Date of financing"
},
"bankgarantie": {
"type": "string",
"description": "Date of bank guarantee"
},
"passeerdatumVoortgang": {
"type": "string",
"description": "Date of passing date progress"
},
"collateral_address": {
"type": "string",
"description": "Collateral address of mortgage"
},
"collateral_city": {
"type": "string",
"description": "Collateral city of mortgage"
},
"collateral_postcode": {
"type": "string",
"description": "Collateral postal code of mortgage"
},
"collateral_housenumber": {
"type": "string",
"description": "Collateral house number of mortgage"
},
"collateral_county": {
"type": "string",
"description": "Collateral county of mortgage"
},
"restantHoofdsom": {
"type": "number",
"description": "Remainder of total sum of mortgage"
},
"executiewaarde": {
"type": "number",
"description": "Execution value of mortgage"
},
"type_woning": {
"type": "number",
"description": "ID type of property"
},
"offerteNummer": {
"type": "number",
"description": "Quotation of mortgage"
},
"datumAanvraag": {
"type": "string",
"description": "Date of application"
},
"datumOfferte": {
"type": "string",
"description": "Date of quotation"
},
"datumGeldigheidOfferte": {
"type": "string",
"description": "Date of validity for quotation"
},
"datumOfferteGetekend": {
"type": "string",
"description": "Date of quotation signed"
},
"vovVoorVerbouwing": {
"type": "number",
"description": "Vrije onderhandse verkoopwaarde (VOV) before construction"
},
"vovNaVerbouwing": {
"type": "number",
"description": "Vrije onderhandse verkoopwaarde (VOV) after construction"
},
"ewVoorVerbouwing": {
"type": "number",
"description": "Execution value before construction"
},
"ewNaVerbouwing": {
"type": "number",
"description": "Execution value after construction"
},
"trackingNumber": {
"type": "number",
"description": "Tracking number of mortgage"
},
"collateral_addition": {
"type": "string",
"description": "Collateral addition of mortgage"
},
"purchasing_broker_id": {
"type": "number",
"description": "ID of purchasing broker"
},
"validity_unsigned_offer_date": {
"type": "string",
"description": "Validity of unsigned offer date"
},
"validity_signed_offer_date": {
"type": "string",
"description": "Validity of signed offer date"
},
"end_financing_reservation_date": {
"type": "string",
"description": "End of financing reservation date"
},
"has_bank_guarantee_date": {
"type": "string",
"description": "Date of bank guarantee"
},
"bank_guarantee_date": {
"type": "string",
"description": "Date of bank guarantee"
},
"mortgage_property_id": {
"type": "number",
"description": "ID of mortgage property"
},
"financier_agency_id": {
"type": "number",
"description": "ID of financier agency"
},
"arrangement_type": {
"type": "number",
"description": "ID of arrangement"
},
"existing_mortgage_number": {
"type": "string",
"description": "Number of existing mortgage number"
},
"own_resources_amount": {
"type": "number",
"description": "Amount of own resources"
},
"mutation_code": {
"type": "number",
"description": "Code of mutation of mortgage"
},
"is_property_purchase": {
"type": "boolean",
"description": "Is property purchased?"
},
"bank_guarantee_costs": {
"type": "number",
"description": "Costs of bank guarantee"
},
"net_consultancy_costs": {
"type": "number",
"description": "Net consultancy costs"
},
"mortgage_deed_cost_specification": {
"type": "number",
"description": "Costs of mortgage deed"
},
"national_mortgage_guarantee_costs": {
"type": "number",
"description": "National mortgage guarantee costs"
},
"fine_interest": {
"type": "number",
"description": "Fine intereset of mortgage"
},
"loan_type": {
"type": "string",
"description": "Type of loan"
},
"secondary_customer_id": {
"type": "number",
"description": "ID of secondary customer"
},
"loan_to_value": {
"type": "number",
"description": "Value to loan of mortgage"
},
"risk_class": {
"type": "number",
"description": "Risk class of mortgage"
},
"risk_class_type": {
"type": "number",
"description": "Type of risk class of mortgage"
}
},
"required": [
"customer_id"
]
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
DeleteDELETE/mortgage/{mortgage_id}
Example URI
- mortgage_id
integer
(required) Example: 1The id of the mortgage
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of deleted data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
MortgageParts ¶
All calls for MortgagePart management
MortgageParts ¶
MortgagePart functions
ListGET/mortgagePart{?perPage}
Get a list of all mortgageParts.
Example URI
- perPage
integer
(optional) Default: 15 Example: 25The maximum number of objects to return
200
Headers
Content-Type: application/json
Body
{
"data": [
{
"mortgage_id": 1,
"hypotheeknummer": "1",
"leningdeelnummer": "1",
"soortLening": "lening",
"hoofdsom": 150000,
"begindatum": "01-01-2018",
"einddatum": "01-01-2019",
"rente": 4,
"rentevasteperiode": "10",
"einddatumRentevast": "01-01-2019",
"created_at": "01-01-2018 12:00:00",
"updated_at": "01-01-2018 12:00:00",
"begindatumRentevast": "2018-01-01",
"renteType": 1,
"duur": 360,
"hypotheekType": 1,
"afsluitprovisie": 0,
"bedenktijd": false,
"bedenktijdStartDatum": "2018-01-01",
"type": 2,
"agency_code": "1",
"tax_box_type": 3,
"repayment_type": 1,
"interest_agreement_type": 1,
"interest_cooling_off_period_type": 1,
"interest_cooling_off_period_in_months": 1,
"payment_term": 1,
"consumptive_percentage": 1,
"consumptive_amount": 1,
"national_mortgage_guarantee": true,
"coverage_percentage": 1,
"rate_based_on": 1
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 15,
"current": 1,
"total_pages": 1,
"links": []
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number",
"description": "Total number of objects"
},
"count": {
"type": "number",
"description": "Object on this page"
},
"per_page": {
"type": "number",
"description": "Object per page"
},
"current": {
"type": "number",
"description": "Current page number"
},
"total_pages": {
"type": "number",
"description": "Total number of pages"
},
"links": {
"description": "Array of meta links"
}
}
}
}
}
}
}
ShowGET/mortgagePart/{mortgagePart_id}
Example URI
- mortgagePart_id
integer
(required) Example: 1The id of the mortgagePart
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
CreatePOST/mortgagePart
Example URI
Headers
Content-Type: application/json
Accept: application/json
Body
{
"mortgage_id": 1,
"hypotheeknummer": "1",
"leningdeelnummer": "1",
"soortLening": "lening",
"hoofdsom": 150000,
"begindatum": "01-01-2018",
"einddatum": "01-01-2019",
"rente": 4,
"rentevasteperiode": "10",
"einddatumRentevast": "01-01-2019",
"created_at": "01-01-2018 12:00:00",
"updated_at": "01-01-2018 12:00:00",
"begindatumRentevast": "2018-01-01",
"renteType": 1,
"duur": 360,
"hypotheekType": 1,
"afsluitprovisie": 0,
"bedenktijd": false,
"bedenktijdStartDatum": "2018-01-01",
"type": 2,
"agency_code": "1",
"tax_box_type": 3,
"repayment_type": 1,
"interest_agreement_type": 1,
"interest_cooling_off_period_type": 1,
"interest_cooling_off_period_in_months": 1,
"payment_term": 1,
"consumptive_percentage": 1,
"consumptive_amount": 1,
"national_mortgage_guarantee": true,
"coverage_percentage": 1,
"rate_based_on": 1
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"mortgage_id": {
"type": "number",
"description": "ID of mortgage"
},
"hypotheeknummer": {
"type": "string",
"description": "Number of mortgage"
},
"leningdeelnummer": {
"type": "string",
"description": "Part number of loan"
},
"soortLening": {
"type": "string",
"description": "Sort of loan"
},
"hoofdsom": {
"type": "number",
"description": "Main price"
},
"begindatum": {
"type": "string",
"description": "Start date"
},
"einddatum": {
"type": "string",
"description": "End date"
},
"rente": {
"type": "number",
"description": "Interest"
},
"rentevasteperiode": {
"type": "string",
"description": "Fixed interest period"
},
"einddatumRentevast": {
"type": "string",
"description": "End date of fixed interest period"
},
"created_at": {
"type": "string",
"description": "Timestamp of creation"
},
"updated_at": {
"type": "string",
"description": "Timestamp of last updated"
},
"begindatumRentevast": {
"type": "string",
"description": "Start date of fixed interest period"
},
"renteType": {
"type": "number",
"description": "Type of intereset"
},
"duur": {
"type": "number",
"description": "Duration"
},
"hypotheekType": {
"type": "number",
"description": "Type of mortgage"
},
"afsluitprovisie": {
"type": "number",
"description": "Commission"
},
"bedenktijd": {
"type": "boolean",
"description": "Time for consideration"
},
"bedenktijdStartDatum": {
"type": "string",
"description": "Start date of consideration"
},
"type": {
"type": "number",
"description": "Type"
},
"agency_code": {
"type": "string",
"description": "Code of agency"
},
"tax_box_type": {
"type": "number",
"description": "The tax box type number"
},
"repayment_type": {
"type": "number",
"description": "Type of repayment"
},
"interest_agreement_type": {
"type": "number",
"description": "Type of interest agreement"
},
"interest_cooling_off_period_type": {
"type": "number",
"description": "Type of interest cooling off period type"
},
"interest_cooling_off_period_in_months": {
"type": "number",
"description": "Type of interest colling off period in months"
},
"payment_term": {
"type": "number",
"description": "Payment term"
},
"consumptive_percentage": {
"type": "number",
"description": "Consumptive percentage"
},
"consumptive_amount": {
"type": "number",
"description": "Consumptive amount"
},
"national_mortgage_guarantee": {
"type": "boolean",
"description": "National mortgage guarantee"
},
"coverage_percentage": {
"type": "number",
"description": "Coverage percentage"
},
"rate_based_on": {
"type": "number",
"description": "Rate based on"
}
},
"required": [
"mortgage_id"
]
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
UpdatePUT/mortgagePart/{mortgagePart_id}
Example URI
- mortgagePart_id
integer
(required) Example: 1The id of a mortgagePart
Headers
Content-Type: application/json
Accept: application/json
Body
{
"mortgage_id": 1,
"hypotheeknummer": "1",
"leningdeelnummer": "1",
"soortLening": "lening",
"hoofdsom": 150000,
"begindatum": "01-01-2018",
"einddatum": "01-01-2019",
"rente": 4,
"rentevasteperiode": "10",
"einddatumRentevast": "01-01-2019",
"created_at": "01-01-2018 12:00:00",
"updated_at": "01-01-2018 12:00:00",
"begindatumRentevast": "2018-01-01",
"renteType": 1,
"duur": 360,
"hypotheekType": 1,
"afsluitprovisie": 0,
"bedenktijd": false,
"bedenktijdStartDatum": "2018-01-01",
"type": 2,
"agency_code": "1",
"tax_box_type": 3,
"repayment_type": 1,
"interest_agreement_type": 1,
"interest_cooling_off_period_type": 1,
"interest_cooling_off_period_in_months": 1,
"payment_term": 1,
"consumptive_percentage": 1,
"consumptive_amount": 1,
"national_mortgage_guarantee": true,
"coverage_percentage": 1,
"rate_based_on": 1
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"mortgage_id": {
"type": "number",
"description": "ID of mortgage"
},
"hypotheeknummer": {
"type": "string",
"description": "Number of mortgage"
},
"leningdeelnummer": {
"type": "string",
"description": "Part number of loan"
},
"soortLening": {
"type": "string",
"description": "Sort of loan"
},
"hoofdsom": {
"type": "number",
"description": "Main price"
},
"begindatum": {
"type": "string",
"description": "Start date"
},
"einddatum": {
"type": "string",
"description": "End date"
},
"rente": {
"type": "number",
"description": "Interest"
},
"rentevasteperiode": {
"type": "string",
"description": "Fixed interest period"
},
"einddatumRentevast": {
"type": "string",
"description": "End date of fixed interest period"
},
"created_at": {
"type": "string",
"description": "Timestamp of creation"
},
"updated_at": {
"type": "string",
"description": "Timestamp of last updated"
},
"begindatumRentevast": {
"type": "string",
"description": "Start date of fixed interest period"
},
"renteType": {
"type": "number",
"description": "Type of intereset"
},
"duur": {
"type": "number",
"description": "Duration"
},
"hypotheekType": {
"type": "number",
"description": "Type of mortgage"
},
"afsluitprovisie": {
"type": "number",
"description": "Commission"
},
"bedenktijd": {
"type": "boolean",
"description": "Time for consideration"
},
"bedenktijdStartDatum": {
"type": "string",
"description": "Start date of consideration"
},
"type": {
"type": "number",
"description": "Type"
},
"agency_code": {
"type": "string",
"description": "Code of agency"
},
"tax_box_type": {
"type": "number",
"description": "The tax box type number"
},
"repayment_type": {
"type": "number",
"description": "Type of repayment"
},
"interest_agreement_type": {
"type": "number",
"description": "Type of interest agreement"
},
"interest_cooling_off_period_type": {
"type": "number",
"description": "Type of interest cooling off period type"
},
"interest_cooling_off_period_in_months": {
"type": "number",
"description": "Type of interest colling off period in months"
},
"payment_term": {
"type": "number",
"description": "Payment term"
},
"consumptive_percentage": {
"type": "number",
"description": "Consumptive percentage"
},
"consumptive_amount": {
"type": "number",
"description": "Consumptive amount"
},
"national_mortgage_guarantee": {
"type": "boolean",
"description": "National mortgage guarantee"
},
"coverage_percentage": {
"type": "number",
"description": "Coverage percentage"
},
"rate_based_on": {
"type": "number",
"description": "Rate based on"
}
},
"required": [
"mortgage_id"
]
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
DeleteDELETE/mortgagePart/{mortgagePart_id}
Example URI
- mortgagePart_id
integer
(required) Example: 1The id of the mortgagePart
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of deleted data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
MortgageProgress ¶
All calls for MortgageProgress management
MortgageProgress ¶
MortgageProgress functions
ListGET/mortgageProgress{?perPage}
Get a list of all MortgageProgresses.
Example URI
- perPage
integer
(optional) Default: 15 Example: 25The maximum number of objects to return
200
Headers
Content-Type: application/json
Body
{
"data": [
{
"id": 1,
"mortgage_id": 1,
"name": "Testverklaring",
"sent": true,
"received": true,
"completed": true,
"comment": "Comment",
"date": "01-01-2018",
"created_at": "test",
"updated_at": "test"
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 15,
"current": 1,
"total_pages": 1,
"links": []
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number",
"description": "Total number of objects"
},
"count": {
"type": "number",
"description": "Object on this page"
},
"per_page": {
"type": "number",
"description": "Object per page"
},
"current": {
"type": "number",
"description": "Current page number"
},
"total_pages": {
"type": "number",
"description": "Total number of pages"
},
"links": {
"description": "Array of meta links"
}
}
}
}
}
}
}
ShowGET/mortgageProgress/{mortgageProgress_id}
Example URI
- mortgageProgress_id
integer
(required) Example: 1The id of the mortgageProgress
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
CreatePOST/mortgageProgress
Example URI
Headers
Content-Type: application/json
Accept: application/json
Body
{
"id": 1,
"mortgage_id": 1,
"name": "Testverklaring",
"sent": true,
"received": true,
"completed": true,
"comment": "Comment",
"date": "01-01-2018",
"created_at": "test",
"updated_at": "test"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID of entity"
},
"mortgage_id": {
"type": "number",
"description": "ID of related mortgage"
},
"name": {
"type": "string",
"description": "Name of mortgage progress"
},
"sent": {
"type": "boolean",
"description": "Has the mortgage progress been sent?"
},
"received": {
"type": "boolean",
"description": "Has the mortgage progress been received?"
},
"completed": {
"type": "boolean",
"description": "Has the mortgage progress been completed?"
},
"comment": {
"type": "string",
"description": "Comment that belongs to the mortgage progress"
},
"date": {
"type": "string",
"description": "Date that corresponds to the mortgage progress"
},
"created_at": {
"type": "string",
"description": "Timestamp of creation"
},
"updated_at": {
"type": "string",
"description": "Timestamp of latest update"
}
},
"required": [
"mortgage_id"
]
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
UpdatePUT/mortgageProgress/{mortgageProgress_id}
Example URI
- mortgageProgress_id
integer
(required) Example: 1The id of the mortgageProgress
Headers
Content-Type: application/json
Accept: application/json
Body
{
"id": 1,
"mortgage_id": 1,
"name": "Testverklaring",
"sent": true,
"received": true,
"completed": true,
"comment": "Comment",
"date": "01-01-2018",
"created_at": "test",
"updated_at": "test"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID of entity"
},
"mortgage_id": {
"type": "number",
"description": "ID of related mortgage"
},
"name": {
"type": "string",
"description": "Name of mortgage progress"
},
"sent": {
"type": "boolean",
"description": "Has the mortgage progress been sent?"
},
"received": {
"type": "boolean",
"description": "Has the mortgage progress been received?"
},
"completed": {
"type": "boolean",
"description": "Has the mortgage progress been completed?"
},
"comment": {
"type": "string",
"description": "Comment that belongs to the mortgage progress"
},
"date": {
"type": "string",
"description": "Date that corresponds to the mortgage progress"
},
"created_at": {
"type": "string",
"description": "Timestamp of creation"
},
"updated_at": {
"type": "string",
"description": "Timestamp of latest update"
}
},
"required": [
"mortgage_id"
]
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
DeleteDELETE/mortgageProgress/{mortgageProgress_id}
Example URI
- mortgageProgress_id
integer
(required) Example: 1The id of the mortgageProgress
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of deleted data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
Damages ¶
All calls for Damage management
Damages ¶
Damage functions
ListGET/damage{?perPage}
Get a list of all Damages.
Example URI
- perPage
integer
(optional) Default: 15 Example: 25The maximum number of objects to return
200
Headers
Content-Type: application/json
Body
{
"data": [
{
"customer_id": 1,
"damage_number": "700004",
"licenseplate": "AA-BB-12",
"policy_id": 564,
"insurance_branche_code": 0,
"policy_contractNumber": "702519615",
"insurance_agency_id": 0,
"settled": true,
"date": "2008-11-12",
"blame": true,
"cause": "Letselschade, oorzaak onbekend",
"notes": "Notities",
"agency_id": 8,
"agency_contact_id": 0,
"agency_contact": "Jan Modaal",
"agency_phone": "0612345678",
"agency_emailaddress": "test@test.nl",
"external_number": "0612345678",
"wa": 0,
"casco": 500,
"deductible": 200,
"garage_id": 1,
"garage_contact_id": 1,
"user_id": 1,
"trackingNumber": "5",
"expert_id": 1,
"expert_case_number": "1",
"pay_to": 1,
"status": 1,
"wa_at": "1",
"casco_at": "1",
"deductible_at": "1",
"estimated": 1
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 15,
"current": 1,
"total_pages": 1,
"links": []
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number",
"description": "Total number of objects"
},
"count": {
"type": "number",
"description": "Object on this page"
},
"per_page": {
"type": "number",
"description": "Object per page"
},
"current": {
"type": "number",
"description": "Current page number"
},
"total_pages": {
"type": "number",
"description": "Total number of pages"
},
"links": {
"description": "Array of meta links"
}
}
}
}
}
}
}
ShowGET/damage/{damage_id}
Example URI
- damage_id
integer
(required) Example: 1The id of the damage
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
CreatePOST/damage
Example URI
Headers
Content-Type: application/json
Accept: application/json
Body
{
"customer_id": 1,
"damage_number": "700004",
"licenseplate": "AA-BB-12",
"policy_id": 564,
"insurance_branche_code": 0,
"policy_contractNumber": "702519615",
"insurance_agency_id": 0,
"settled": true,
"date": "2008-11-12",
"blame": true,
"cause": "Letselschade, oorzaak onbekend",
"notes": "Notities",
"agency_id": 8,
"agency_contact_id": 0,
"agency_contact": "Jan Modaal",
"agency_phone": "0612345678",
"agency_emailaddress": "test@test.nl",
"external_number": "0612345678",
"wa": 0,
"casco": 500,
"deductible": 200,
"garage_id": 1,
"garage_contact_id": 1,
"user_id": 1,
"trackingNumber": "5",
"expert_id": 1,
"expert_case_number": "1",
"pay_to": 1,
"status": 1,
"wa_at": "1",
"casco_at": "1",
"deductible_at": "1",
"estimated": 1
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"customer_id": {
"type": "number",
"description": "ID of customer"
},
"damage_number": {
"type": "string",
"description": "Number of damage"
},
"licenseplate": {
"type": "string",
"description": "License plate of car of the insuree involved in damage"
},
"policy_id": {
"type": "number",
"description": "ID of policy"
},
"insurance_branche_code": {
"type": "number",
"description": "Branche code of insurance company"
},
"policy_contractNumber": {
"type": "string",
"description": "Contract number of policy"
},
"insurance_agency_id": {
"type": "number",
"description": "ID of insurance agency"
},
"settled": {
"type": "boolean",
"description": "Is the damage settled?"
},
"date": {
"type": "string",
"description": "Date when damage occured"
},
"blame": {
"type": "boolean",
"description": "Is the insuree to blame?"
},
"cause": {
"type": "string",
"description": "Cause of the damage"
},
"notes": {
"type": "string",
"description": "Notes belonging to damage"
},
"agency_id": {
"type": "number",
"description": "ID of agency"
},
"agency_contact_id": {
"type": "number",
"description": "ID of contact of agency"
},
"agency_contact": {
"type": "string",
"description": "Name of agency contact"
},
"agency_phone": {
"type": "string",
"description": "Phone number of agency"
},
"agency_emailaddress": {
"type": "string",
"description": "Email address of agency"
},
"external_number": {
"type": "string",
"description": "External number of damage"
},
"wa": {
"type": "number",
"description": "Liability insurance"
},
"casco": {
"type": "number",
"description": "Insurance of object involved in damage (casco)"
},
"deductible": {
"type": "number",
"description": "Amount that is deductible"
},
"garage_id": {
"type": "number",
"description": "ID of garage involved"
},
"garage_contact_id": {
"type": "number",
"description": "ID of contact of garage involved"
},
"user_id": {
"type": "number",
"description": "ID of user"
},
"trackingNumber": {
"type": "string",
"description": "Tracking number"
},
"expert_id": {
"type": "number",
"description": "ID of expert involved"
},
"expert_case_number": {
"type": "string",
"description": "Case number of expert"
},
"pay_to": {
"type": "number",
"description": "Pay to"
},
"status": {
"type": "number",
"description": "Status"
},
"wa_at": {
"type": "string",
"description": "Liable at"
},
"casco_at": {
"type": "string",
"description": "Casco at"
},
"deductible_at": {
"type": "string",
"description": "Deductible at"
},
"estimated": {
"type": "number",
"description": "Estimation"
}
},
"required": [
"customer_id"
]
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
UpdatePUT/damage/{damage_id}
Example URI
- damage_id
integer
(required) Example: 1The id of the damage
Headers
Content-Type: application/json
Accept: application/json
Body
{
"customer_id": 1,
"damage_number": "700004",
"licenseplate": "AA-BB-12",
"policy_id": 564,
"insurance_branche_code": 0,
"policy_contractNumber": "702519615",
"insurance_agency_id": 0,
"settled": true,
"date": "2008-11-12",
"blame": true,
"cause": "Letselschade, oorzaak onbekend",
"notes": "Notities",
"agency_id": 8,
"agency_contact_id": 0,
"agency_contact": "Jan Modaal",
"agency_phone": "0612345678",
"agency_emailaddress": "test@test.nl",
"external_number": "0612345678",
"wa": 0,
"casco": 500,
"deductible": 200,
"garage_id": 1,
"garage_contact_id": 1,
"user_id": 1,
"trackingNumber": "5",
"expert_id": 1,
"expert_case_number": "1",
"pay_to": 1,
"status": 1,
"wa_at": "1",
"casco_at": "1",
"deductible_at": "1",
"estimated": 1
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"customer_id": {
"type": "number",
"description": "ID of customer"
},
"damage_number": {
"type": "string",
"description": "Number of damage"
},
"licenseplate": {
"type": "string",
"description": "License plate of car of the insuree involved in damage"
},
"policy_id": {
"type": "number",
"description": "ID of policy"
},
"insurance_branche_code": {
"type": "number",
"description": "Branche code of insurance company"
},
"policy_contractNumber": {
"type": "string",
"description": "Contract number of policy"
},
"insurance_agency_id": {
"type": "number",
"description": "ID of insurance agency"
},
"settled": {
"type": "boolean",
"description": "Is the damage settled?"
},
"date": {
"type": "string",
"description": "Date when damage occured"
},
"blame": {
"type": "boolean",
"description": "Is the insuree to blame?"
},
"cause": {
"type": "string",
"description": "Cause of the damage"
},
"notes": {
"type": "string",
"description": "Notes belonging to damage"
},
"agency_id": {
"type": "number",
"description": "ID of agency"
},
"agency_contact_id": {
"type": "number",
"description": "ID of contact of agency"
},
"agency_contact": {
"type": "string",
"description": "Name of agency contact"
},
"agency_phone": {
"type": "string",
"description": "Phone number of agency"
},
"agency_emailaddress": {
"type": "string",
"description": "Email address of agency"
},
"external_number": {
"type": "string",
"description": "External number of damage"
},
"wa": {
"type": "number",
"description": "Liability insurance"
},
"casco": {
"type": "number",
"description": "Insurance of object involved in damage (casco)"
},
"deductible": {
"type": "number",
"description": "Amount that is deductible"
},
"garage_id": {
"type": "number",
"description": "ID of garage involved"
},
"garage_contact_id": {
"type": "number",
"description": "ID of contact of garage involved"
},
"user_id": {
"type": "number",
"description": "ID of user"
},
"trackingNumber": {
"type": "string",
"description": "Tracking number"
},
"expert_id": {
"type": "number",
"description": "ID of expert involved"
},
"expert_case_number": {
"type": "string",
"description": "Case number of expert"
},
"pay_to": {
"type": "number",
"description": "Pay to"
},
"status": {
"type": "number",
"description": "Status"
},
"wa_at": {
"type": "string",
"description": "Liable at"
},
"casco_at": {
"type": "string",
"description": "Casco at"
},
"deductible_at": {
"type": "string",
"description": "Deductible at"
},
"estimated": {
"type": "number",
"description": "Estimation"
}
},
"required": [
"customer_id"
]
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
DeleteDELETE/damage/{damage_id}
Example URI
- damage_id
integer
(required) Example: 1The id of the damage
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of deleted data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
Documents ¶
All calls for Document management
Documents ¶
Document functions
ListGET/document{?perPage}
Get a list of all Documents.
Example URI
- perPage
integer
(optional) Default: 15 Example: 25The maximum number of objects to return
200
Headers
Content-Type: application/json
Body
{
"data": [
{
"name": "Testverklaring voor testverzekering",
"file": "url/naar/bestand.pdf",
"type": "Microsoft Outlook",
"mime_type": "application/pdf",
"customer_id": 1,
"documentcategory_id": 1,
"extension": "pdf",
"migrated": true,
"filesize": 1000,
"decoded": true,
"user_id": 1
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 15,
"current": 1,
"total_pages": 1,
"links": []
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number",
"description": "Total number of objects"
},
"count": {
"type": "number",
"description": "Object on this page"
},
"per_page": {
"type": "number",
"description": "Object per page"
},
"current": {
"type": "number",
"description": "Current page number"
},
"total_pages": {
"type": "number",
"description": "Total number of pages"
},
"links": {
"description": "Array of meta links"
}
}
}
}
}
}
}
ShowGET/document/{document_id}
Example URI
- document_id
integer
(required) Example: 1The id of the document
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
CreatePOST/document
Example URI
Headers
Content-Type: application/json
Accept: application/json
Body
{
"name": "Testverklaring voor testverzekering",
"file": "url/naar/bestand.pdf",
"type": "Microsoft Outlook",
"mime_type": "application/pdf",
"customer_id": 1,
"documentcategory_id": 1,
"extension": "pdf",
"migrated": true,
"filesize": 1000,
"decoded": true,
"user_id": 1
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Naam van het document"
},
"file": {
"type": "string",
"description": "Bestandslocatie van het document"
},
"type": {
"type": "string",
"description": "Documenttype"
},
"mime_type": {
"type": "string",
"description": "MIME-type van het document"
},
"customer_id": {
"type": "number",
"description": "ID van klant"
},
"documentcategory_id": {
"type": "number",
"description": "ID van categorie"
},
"extension": {
"type": "string",
"description": "Bestandsextensie van het document"
},
"migrated": {
"type": "boolean",
"description": "Is het document gemigreerd?"
},
"filesize": {
"type": "number",
"description": "Bestandsgrootte van het document (in bytes)"
},
"decoded": {
"type": "boolean",
"description": "Is het document gedecodeerd?"
},
"user_id": {
"type": "number",
"description": "ID van gebruiker"
}
}
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
UpdatePUT/document/{document_id}
Example URI
- document_id
integer
(required) Example: 1The id of a document
Headers
Content-Type: application/json
Accept: application/json
Body
{
"name": "Testverklaring voor testverzekering",
"file": "url/naar/bestand.pdf",
"type": "Microsoft Outlook",
"mime_type": "application/pdf",
"customer_id": 1,
"documentcategory_id": 1,
"extension": "pdf",
"migrated": true,
"filesize": 1000,
"decoded": true,
"user_id": 1
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Naam van het document"
},
"file": {
"type": "string",
"description": "Bestandslocatie van het document"
},
"type": {
"type": "string",
"description": "Documenttype"
},
"mime_type": {
"type": "string",
"description": "MIME-type van het document"
},
"customer_id": {
"type": "number",
"description": "ID van klant"
},
"documentcategory_id": {
"type": "number",
"description": "ID van categorie"
},
"extension": {
"type": "string",
"description": "Bestandsextensie van het document"
},
"migrated": {
"type": "boolean",
"description": "Is het document gemigreerd?"
},
"filesize": {
"type": "number",
"description": "Bestandsgrootte van het document (in bytes)"
},
"decoded": {
"type": "boolean",
"description": "Is het document gedecodeerd?"
},
"user_id": {
"type": "number",
"description": "ID van gebruiker"
}
}
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
DeleteDELETE/document/{document_id}
Example URI
- document_id
integer
(required) Example: 1The id of the document
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of deleted data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
Emails ¶
All calls for Email management
Emails ¶
Email functions
ListGET/email{?perPage}
Get a list of all Emails.
Example URI
- perPage
integer
(optional) Default: 15 Example: 25The maximum number of objects to return
200
Headers
Content-Type: application/json
Body
{
"data": [
{}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 15,
"current": 1,
"total_pages": 1,
"links": []
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number",
"description": "Total number of objects"
},
"count": {
"type": "number",
"description": "Object on this page"
},
"per_page": {
"type": "number",
"description": "Object per page"
},
"current": {
"type": "number",
"description": "Current page number"
},
"total_pages": {
"type": "number",
"description": "Total number of pages"
},
"links": {
"description": "Array of meta links"
}
}
}
}
}
}
}
ShowGET/email/{email_id}
Example URI
- email_id
integer
(required) Example: 1The id of the email
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
CreatePOST/email
Example URI
Headers
Content-Type: application/json
Accept: application/json
Body
{}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {}
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
UpdatePUT/email/{email_id}
Example URI
- email_id
integer
(required) Example: 1The id of a email
Headers
Content-Type: application/json
Accept: application/json
Body
{}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {}
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
DeleteDELETE/email/{email_id}
Example URI
- email_id
integer
(required) Example: 1The id of the email
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of deleted data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
Templates ¶
All calls for Template management
Templates ¶
Template functions
ListGET/template{?perPage}
Get a list of all Templates.
Example URI
- perPage
integer
(optional) Default: 15 Example: 25The maximum number of objects to return
200
Headers
Content-Type: application/json
Body
{
"data": [
{
"id": 4,
"title": "Template",
"nameInSystem": "Test template",
"content": "Test content",
"type": 1,
"primaryMail": "test@test.nl",
"category": 1,
"created_at": "2018-01-01 12:00:00",
"updated_at": "2018-01-02 12:00:00",
"deleted_at": "2018-01-03 12:00:00",
"agency_id": 1
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 15,
"current": 1,
"total_pages": 1,
"links": []
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number",
"description": "Total number of objects"
},
"count": {
"type": "number",
"description": "Object on this page"
},
"per_page": {
"type": "number",
"description": "Object per page"
},
"current": {
"type": "number",
"description": "Current page number"
},
"total_pages": {
"type": "number",
"description": "Total number of pages"
},
"links": {
"description": "Array of meta links"
}
}
}
}
}
}
}
ShowGET/template/{template_id}
Example URI
- template_id
integer
(required) Example: 1The id of the template
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
CreatePOST/template
Example URI
Headers
Content-Type: application/json
Accept: application/json
Body
{
"id": 4,
"title": "Template",
"nameInSystem": "Test template",
"content": "Test content",
"type": 1,
"primaryMail": "test@test.nl",
"category": 1,
"created_at": "2018-01-01 12:00:00",
"updated_at": "2018-01-02 12:00:00",
"deleted_at": "2018-01-03 12:00:00",
"agency_id": 1
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID of template"
},
"title": {
"type": "string",
"description": "Title of template"
},
"nameInSystem": {
"type": "string",
"description": "Name in system of template"
},
"content": {
"type": "string",
"description": "Content of template"
},
"type": {
"type": "number",
"description": "Type of template"
},
"primaryMail": {
"type": "string",
"description": "Primary mail of template"
},
"category": {
"type": "number",
"description": "Category of template"
},
"created_at": {
"type": "string",
"description": "Timestamp of creation"
},
"updated_at": {
"type": "string",
"description": "Timestamp of latest update"
},
"deleted_at": {
"type": "string",
"description": "Timestamp of deletion"
},
"agency_id": {
"type": "number",
"description": "ID of agency of template"
}
}
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
UpdatePUT/template/{template_id}
Example URI
- template_id
integer
(required) Example: 1The id of a template
Headers
Content-Type: application/json
Accept: application/json
Body
{
"id": 4,
"title": "Template",
"nameInSystem": "Test template",
"content": "Test content",
"type": 1,
"primaryMail": "test@test.nl",
"category": 1,
"created_at": "2018-01-01 12:00:00",
"updated_at": "2018-01-02 12:00:00",
"deleted_at": "2018-01-03 12:00:00",
"agency_id": 1
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID of template"
},
"title": {
"type": "string",
"description": "Title of template"
},
"nameInSystem": {
"type": "string",
"description": "Name in system of template"
},
"content": {
"type": "string",
"description": "Content of template"
},
"type": {
"type": "number",
"description": "Type of template"
},
"primaryMail": {
"type": "string",
"description": "Primary mail of template"
},
"category": {
"type": "number",
"description": "Category of template"
},
"created_at": {
"type": "string",
"description": "Timestamp of creation"
},
"updated_at": {
"type": "string",
"description": "Timestamp of latest update"
},
"deleted_at": {
"type": "string",
"description": "Timestamp of deletion"
},
"agency_id": {
"type": "number",
"description": "ID of agency of template"
}
}
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
DeleteDELETE/template/{template_id}
Example URI
- template_id
integer
(required) Example: 1The id of the template
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of deleted data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
Notes ¶
All calls for Note management
Notes ¶
Note functions
ListGET/note{?perPage}
Get a list of all Notes.
Example URI
- perPage
integer
(optional) Default: 15 Example: 25The maximum number of objects to return
200
Headers
Content-Type: application/json
Body
{
"data": [
{
"id": 1,
"title": "Notitie",
"content": "Call was made by customer XXX at 13:48",
"datetime": "01-01-2018",
"category_id": 1,
"entity_id": "3",
"created_at": "2018-01-01 12:00:00",
"updated_at": "2018-01-02 12:00:00",
"deleted_at": "2018-01-03 12:00:00",
"user_id": "1",
"file": "test",
"call_event_id": "test"
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 15,
"current": 1,
"total_pages": 1,
"links": []
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number",
"description": "Total number of objects"
},
"count": {
"type": "number",
"description": "Object on this page"
},
"per_page": {
"type": "number",
"description": "Object per page"
},
"current": {
"type": "number",
"description": "Current page number"
},
"total_pages": {
"type": "number",
"description": "Total number of pages"
},
"links": {
"description": "Array of meta links"
}
}
}
}
}
}
}
ShowGET/note/{note_id}
Example URI
- note_id
integer
(required) Example: 1The id of the note
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
CreatePOST/note
Example URI
Headers
Content-Type: application/json
Accept: application/json
Body
{
"id": 1,
"title": "Notitie",
"content": "Call was made by customer XXX at 13:48",
"datetime": "01-01-2018",
"category_id": 1,
"entity_id": "3",
"created_at": "2018-01-01 12:00:00",
"updated_at": "2018-01-02 12:00:00",
"deleted_at": "2018-01-03 12:00:00",
"user_id": "1",
"file": "test",
"call_event_id": "test"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID of note"
},
"title": {
"type": "string",
"description": "Title of note"
},
"content": {
"type": "string",
"description": "Content of note"
},
"datetime": {
"type": "string",
"description": "Datetime of note"
},
"category_id": {
"type": "number",
"description": "ID of category of note"
},
"entity_id": {
"type": "string",
"description": "ID of related entity"
},
"created_at": {
"type": "string",
"description": "Timestamp of creation"
},
"updated_at": {
"type": "string",
"description": "Timestamp of latest update"
},
"deleted_at": {
"type": "string",
"description": "Timestamp of deletion"
},
"user_id": {
"type": "string",
"description": "ID of user"
},
"file": {
"type": "string",
"description": "File of note"
},
"call_event_id": {
"type": "string",
"description": "ID of call event of note"
}
},
"required": [
"title"
]
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
UpdatePUT/note/{note_id}
Example URI
- note_id
integer
(required) Example: 1The id of the note
Headers
Content-Type: application/json
Accept: application/json
Body
{
"id": 1,
"title": "Notitie",
"content": "Call was made by customer XXX at 13:48",
"datetime": "01-01-2018",
"category_id": 1,
"entity_id": "3",
"created_at": "2018-01-01 12:00:00",
"updated_at": "2018-01-02 12:00:00",
"deleted_at": "2018-01-03 12:00:00",
"user_id": "1",
"file": "test",
"call_event_id": "test"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID of note"
},
"title": {
"type": "string",
"description": "Title of note"
},
"content": {
"type": "string",
"description": "Content of note"
},
"datetime": {
"type": "string",
"description": "Datetime of note"
},
"category_id": {
"type": "number",
"description": "ID of category of note"
},
"entity_id": {
"type": "string",
"description": "ID of related entity"
},
"created_at": {
"type": "string",
"description": "Timestamp of creation"
},
"updated_at": {
"type": "string",
"description": "Timestamp of latest update"
},
"deleted_at": {
"type": "string",
"description": "Timestamp of deletion"
},
"user_id": {
"type": "string",
"description": "ID of user"
},
"file": {
"type": "string",
"description": "File of note"
},
"call_event_id": {
"type": "string",
"description": "ID of call event of note"
}
},
"required": [
"title"
]
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
DeleteDELETE/note/{note_id}
Example URI
- note_id
integer
(required) Example: 1The id of the note
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of deleted data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
Signals ¶
All calls for signal management
Signals ¶
Signal functions
ListGET/signal{?perPage}
Get a list of all Signals.
Example URI
- perPage
integer
(optional) Default: 15 Example: 25The maximum number of objects to return
200
Headers
Content-Type: application/json
Body
{
"data": [
{
"id": 1,
"signal_query_id": 1,
"customer_id": 1,
"status": 1,
"snoozed_until": "01-01-2018 12:00:00",
"comment": "test",
"finished_by": 1,
"finished_at": "01-01-2018 12:00:00",
"created_at": "01-01-2018 12:00:00",
"updated_at": "01-01-2018 12:00:00"
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 15,
"current": 1,
"total_pages": 1,
"links": []
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number",
"description": "Total number of objects"
},
"count": {
"type": "number",
"description": "Object on this page"
},
"per_page": {
"type": "number",
"description": "Object per page"
},
"current": {
"type": "number",
"description": "Current page number"
},
"total_pages": {
"type": "number",
"description": "Total number of pages"
},
"links": {
"description": "Array of meta links"
}
}
}
}
}
}
}
ShowGET/signal/{signal_id}
Example URI
- signal_id
integer
(required) Example: 1The id of the signal
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
CreatePOST/signal
Example URI
Headers
Content-Type: application/json
Accept: application/json
Body
{
"id": 1,
"signal_query_id": 1,
"customer_id": 1,
"status": 1,
"snoozed_until": "01-01-2018 12:00:00",
"comment": "test",
"finished_by": 1,
"finished_at": "01-01-2018 12:00:00",
"created_at": "01-01-2018 12:00:00",
"updated_at": "01-01-2018 12:00:00"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID of signal"
},
"signal_query_id": {
"type": "number",
"description": "ID of signal query"
},
"customer_id": {
"type": "number",
"description": "ID of customer"
},
"status": {
"type": "number",
"description": "Status of signal"
},
"snoozed_until": {
"type": "string",
"description": "Signal snoozed until date"
},
"comment": {
"type": "string",
"description": "Comment of signal"
},
"finished_by": {
"type": "number",
"description": "Signal finished by"
},
"finished_at": {
"type": "string",
"description": "Signal finished at date"
},
"created_at": {
"type": "string",
"description": "Signal created at timestamp"
},
"updated_at": {
"type": "string",
"description": "Signal latest update timestamp"
}
}
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
UpdatePUT/signal/{signal_id}
Example URI
- signal_id
integer
(required) Example: 1The id of the signal
Headers
Content-Type: application/json
Accept: application/json
Body
{
"id": 1,
"signal_query_id": 1,
"customer_id": 1,
"status": 1,
"snoozed_until": "01-01-2018 12:00:00",
"comment": "test",
"finished_by": 1,
"finished_at": "01-01-2018 12:00:00",
"created_at": "01-01-2018 12:00:00",
"updated_at": "01-01-2018 12:00:00"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID of signal"
},
"signal_query_id": {
"type": "number",
"description": "ID of signal query"
},
"customer_id": {
"type": "number",
"description": "ID of customer"
},
"status": {
"type": "number",
"description": "Status of signal"
},
"snoozed_until": {
"type": "string",
"description": "Signal snoozed until date"
},
"comment": {
"type": "string",
"description": "Comment of signal"
},
"finished_by": {
"type": "number",
"description": "Signal finished by"
},
"finished_at": {
"type": "string",
"description": "Signal finished at date"
},
"created_at": {
"type": "string",
"description": "Signal created at timestamp"
},
"updated_at": {
"type": "string",
"description": "Signal latest update timestamp"
}
}
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
DeleteDELETE/signal/{signal_id}
Example URI
- signal_id
integer
(required) Example: 1The id of the signal
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of deleted data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
Accounts ¶
All calls for Account management
Accounts ¶
Account functions
ListGET/account{?perPage}
Get a list of all Accounts.
Example URI
- perPage
integer
(optional) Default: 15 Example: 25The maximum number of objects to return
200
Headers
Content-Type: application/json
Body
{
"data": [
{
"id": 1,
"type": 4,
"active": true,
"number": "4",
"customer_id": 4,
"inzake": "4",
"joint_id": "1",
"primary": true,
"created_at": "4",
"updated_at": "4"
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 15,
"current": 1,
"total_pages": 1,
"links": []
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number",
"description": "Total number of objects"
},
"count": {
"type": "number",
"description": "Object on this page"
},
"per_page": {
"type": "number",
"description": "Object per page"
},
"current": {
"type": "number",
"description": "Current page number"
},
"total_pages": {
"type": "number",
"description": "Total number of pages"
},
"links": {
"description": "Array of meta links"
}
}
}
}
}
}
}
ShowGET/account/{account_id}
Example URI
- account_id
integer
(required) Example: 1The id of the account
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
CreatePOST/account
Example URI
Headers
Content-Type: application/json
Accept: application/json
Body
{
"id": 1,
"type": 4,
"active": true,
"number": "4",
"customer_id": 4,
"inzake": "4",
"joint_id": "1",
"primary": true,
"created_at": "4",
"updated_at": "4"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID of account"
},
"type": {
"type": "number",
"description": "Type of account"
},
"active": {
"type": "boolean",
"description": "Is account active?"
},
"number": {
"type": "string",
"description": "Number of account"
},
"customer_id": {
"type": "number",
"description": "ID of customer of account"
},
"inzake": {
"type": "string",
"description": "Subject"
},
"joint_id": {
"type": "string",
"description": "ID of joint of account"
},
"primary": {
"type": "boolean",
"description": "Is account primary?"
},
"created_at": {
"type": "string",
"description": "Timestamp of creation"
},
"updated_at": {
"type": "string",
"description": "Timestamp of latest update"
}
},
"required": [
"type",
"number",
"customer_id"
]
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
UpdatePUT/account/{account_id}
Example URI
- account_id
integer
(required) Example: 1The id of an account
Headers
Content-Type: application/json
Accept: application/json
Body
{
"id": 1,
"type": 4,
"active": true,
"number": "4",
"customer_id": 4,
"inzake": "4",
"joint_id": "1",
"primary": true,
"created_at": "4",
"updated_at": "4"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID of account"
},
"type": {
"type": "number",
"description": "Type of account"
},
"active": {
"type": "boolean",
"description": "Is account active?"
},
"number": {
"type": "string",
"description": "Number of account"
},
"customer_id": {
"type": "number",
"description": "ID of customer of account"
},
"inzake": {
"type": "string",
"description": "Subject"
},
"joint_id": {
"type": "string",
"description": "ID of joint of account"
},
"primary": {
"type": "boolean",
"description": "Is account primary?"
},
"created_at": {
"type": "string",
"description": "Timestamp of creation"
},
"updated_at": {
"type": "string",
"description": "Timestamp of latest update"
}
},
"required": [
"type",
"number",
"customer_id"
]
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
DeleteDELETE/account/{account_id}
Example URI
- account_id
integer
(required) Example: 1The id of the account
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of deleted data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
Offices ¶
All calls for Office management
Offices ¶
Office functions
ListGET/office{?perPage}
Get a list of all Offices.
Example URI
- perPage
integer
(optional) Default: 15 Example: 25The maximum number of objects to return
200
Headers
Content-Type: application/json
Body
{
"data": [
{
"id": 1,
"name": "1",
"owner_id": 1,
"code": "1",
"phone": "1",
"postcode": "1",
"houseNumber": "1",
"streetName": "1",
"city": "1",
"houseNumberAddition": "1",
"email": "1",
"website": "1"
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 15,
"current": 1,
"total_pages": 1,
"links": []
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number",
"description": "Total number of objects"
},
"count": {
"type": "number",
"description": "Object on this page"
},
"per_page": {
"type": "number",
"description": "Object per page"
},
"current": {
"type": "number",
"description": "Current page number"
},
"total_pages": {
"type": "number",
"description": "Total number of pages"
},
"links": {
"description": "Array of meta links"
}
}
}
}
}
}
}
ShowGET/office/{office_id}
Example URI
- office_id
integer
(required) Example: 1The id of the office
Headers
Content-Type: application/json
Accept: application/json
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Success true or false"
},
"id": {
"type": "string",
"description": "Id of stored data (can be empty on array inserts)"
}
}
}
401
Headers
Content-Type: application/json
Body
{
"errors": [
{
"code": 1,
"type": "generic_exception",
"message": "Generic error"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "An array of error messages"
}
}
}
CreatePOST/office
Example URI
Headers
Content-Type: application/json
Accept: application/json
Body
{
"id": 1,
"name": "1",
"owner_id": 1,
"code": "1",
"phone": "1",
"postcode": "1",
"houseNumber": "1",
"streetName": "1",
"city": "1",
"houseNumberAddition": "1",
"email": "1",
"website": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "ID of office"
},
"name": {
"type": "string",
"description": "Name of office"
},
"owner_id": {
"type": "number",
"description": "ID of owner of office"
},
"code": {
"type": "string",
"description": "Code of office"
},
"phone": {
"type": "string",
"description": "Phone number of office"
},
"postcode": {
"type": "string",
"description": "Postal code of office"
},
"houseNumber": {
"type": "string",
"description": "House number of office"
},
"streetName": {
"type": "string",
"description": "Street name of office"
},
"city": {
"type": "string",
"description": "City of office"
},
"houseNumberAddition": {
"type": "string",
"description": "House number addition of office"
},
"email": {
"type": "string",
"description": "Email address of office"
},
"website": {
"type": "string",
"description": "Website of office"
}
},
"required": [
"name"
]
}
200
Headers
Content-Type: application/json
Body
{
"success": true,
"id": "1"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties":