Endpoint for syncing customer property and loans information, the intended use is that you POST your customers information to this endpoint when they change in your system.
For every customer you provide a customer_identifier, this is your unique identification of each customer, other endpoints will output this identifier so you can couple the information with your customer database.
Below is a small example request, see the Full Schema section for all possible fields.
{
"customer_identifier": "124",
"isinsurveillance": "yes",
"property": {
"postal_code": "2700",
"loans": [
{
"loan_type": "Fastforrentet",
"credit_institution": "RD",
"initial_debt": 2000000,
"initial_debt_date": "2018-01-15",
"years_left": 30,
"annual_rate": 2.5
}
]
}
}
200 OK
```
Below is a small example request, see the Full Schema section for all possible fields.
{
"customer_identifier": "124test",
"isinsurveillance": "yes",
"property": {
"property_type": "Helårshus",
"address": "test address",
"city": "test city",
"tax_status": "Privatperson",
"loans": [{
"loan_type": "Fastforrentet",
"credit_institution": "RD",
"initial_debt": 2000000,
"initial_debt_date": "2018-01-01",
"years_left": 30,
"annual_rate": 2
},
{
"loan_type": "F1",
"credit_institution": "RD",
"initial_debt": 2000000,
"initial_debt_date": "2018-01-01",
"years_left": 30,
"annual_rate": 2
},
{
"loan_type": "F1",
"credit_institution": "RD",
"initial_debt": 2000000,
"initial_debt_date": "2018-01-15",
"years_left": 30,
"annual_rate": 2.5
}]
}
}
200 OK
```Optiilo can only handle 3 loans on each property. The order they are established, should correspond to the order in which they have their bidragssats calculated (typically the priority order in Tinglysning).
A customer_identifier can only have 1 property associated.
The following is a JSON schema for the customer request body:
POST /customer, endpoint for creating and updating customer information. This is the endpoint used to syncing your customer data with laanebeskeds calculation engine.
## Authentication
To authentication you should have been given your "Site" and
"Server-Auth-Token". When requesting the endpoints the following headers should
always be included:
Site:
Server-Auth-Token:
### Full Schema
The following is a JSON schema for the customer request body:
```
{
"type": "object",
"properties": {
"customer_identifier": {
"type": "string"
},
"isinsurveillance": {
"type": "string",
"enum": ["yes", "no"]
},
"property": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"city": {
"type": "string"
},
"property_type": {
"type": "string",
"enum": ["Helårshus", "Sommerhus", "Erhvervsejendom"]
},
"tax_status": {
"type": "string",
"enum": ["Privatperson", "Virksomhed", "Ikke dansk skattepligtig"]
},
"valuation_date": {
"type": "string",
"format": "date"
},
"customer_valuation": {
"type": "number"
},
"debt_to_respect": {
"type": "number"
},
"tinglysnings_amount": {
"type": "number"
},
"loans": {
"type": "array",
"minItems": 1,
"maxItems": 3,
"items": {
"type": "object",
"properties": {
"loan_type": {
"type": "string",
"enum": ["Fastforrentet", "Banklån", "F1", "F2", "F3", "F4", "F5"]
},
"ISIN_CODE": {
"type": "string"
},
"credit_institution": {
"type": "string",
"enum": ["RD", "NOR", "NYK", "BRF", "TOT"]
},
"initial_debt": {
"type": "integer"
},
"initial_debt_date": {
"type": "string",
"format": "date"
},
"years_left": {
"type": "integer"
},
"annual_rate": {
"type": "number"
},
"IO_years_left": {
"type": "integer"
},
"bidragssats": {
"type": "number"
},
"bidragssats_IO": {
"type": "number"
},
"refinansial_date": {
"type": "string",
"format": "date"
},
},
"required": ["loan_type", "credit_institution", "initial_debt", "initial_debt_date", "years_left", "annual_rate"],
"additionalProperties": false
}
},
},
"required": ["loans"],
"additionalProperties": false
}
},
"required": ["customer_identifier", "isinsurveillance", "property"],
"additionalProperties": false
}
```