3.9. loanStructure

General properties

The loanStructure is the main structure for exchanging and storing mortgage or other loan data, and is usually made up of the loan entity and two party entities indicating the parties mutually involved in the loan agreement. All relevant entities may be used to elaborate on any aspects of loan-related information.

Mandatory components

The table below contains the mandatory entities and attributes of the loanStructure. Please note: these are only the mandatory components; in this case only the presence of a loan. In many functions and messages, the message will be more extensive, including party and object entities, and often a commonFunctional entity for meta-data. See later in this section for a more detailed example. More information about functions related to loani will be available soon in chapter Domain specific functions under Contract.

See AFD 2.0 Online for the complete and up-to-date data catalog with all entities, entityTypes and attributes, associated with the loanStructure. More documentation on the use of SIVI AFS is available in chapter Where to find elements of SIVI AFS. A general description of AFD structures is provided in Introduction to AFD structures, while information on details of AFD structures is available in chapter Where to find details about AFD structures.

JSON example

Below is an example of a loanStructure, including the party lending the mortgage and the loan (as loanPart) on a building. Note that at the top level within JSON, the loanStructure entity is not explicitly mentioned. In XML, the structure is always explicitly defined (as loanStructure) at the highest level.

{	
	"commonFunctional": [ {
			"entityType": "default",
			"dataCatalogVersion": "34C"
			"afdDefinitionName": "Hypotheek 123",
			"afdDefinitionVersion": "001.00",
		} ],
	"loan": [ {
			"entityType": "mortgage",
			"mortgageType": "I",
			"loan": [ {
					"entityType": "loanPart",
					"interestRate": 1.12,
					"loanAmount": 185000.00,
					"nhg": true
			}
			"object": [ {
					"entityType": "building",
					"appraisalValue": 175000,
					"maintenanceLevel": "G",
					"asbestosPresent": false
			} ],
			"party": [ {
					"entityType": "mortgageLender",
					"surname": "Jansen",
					"initials": "G.A.",
					"birthDate": "1980-09-03"
			} ],
	} ],
	"document": [ {
			"entityType": "default",
			"sequenceNumber": 1,
			"contentEncoding": "base64",
			"contentType": "text/xml; charset=cp858",
			"fileName": "afd001.xml",
			"fileExtension": "xml",
			"content": "VGhpcyBpcyBhIGJhc2U2NCBlbmNvZGVkIGV4YW1wbGUg"
	} ]
}