Data in a settlement

When creating a settlement, the following information is available:

Unique ID (technical)
Flow (broker intention) & status
Real estates involved
- Sellers with fraction
- Buyers with fraction
Assignment number (oppdragsnummer)
Contract details
- Purchase price
- Additional cost
- Handover date
- Account and KID info
Intentions
- Bank intention
Documents (For example mortgage document)
- Attachments (For example prerequisites or grunnboksutskrift)

For more details, see the one the following links: redoc or swagger documentation.

GET settlement

There are various filters for getting data in a settlement. Example

[GET] /v1/settlements?buyerIdentificationNumber=
<official id>

See API for more details

Example settlement response:

{
  "uniqueIdentifier": "SET-a3531bd2-eade-4224-9dbc-fa6959e314bf", //Unique id of the settlement
  "status": "MORTGAGE_IN_PROGRESS",
  "flow": "DIGITAL",              //The brokers intention 
  "flowValidations": [],          //List of flow validations that led to paper flow (empty = digital) 
  "assignmentNumber": "A-1234",   //Broker settlement reference (oppdragsnummer)
  "contractDetails": {            //Information from the buyers contract  
    "payment": {
      "purchasePrice": {
        "value":4000000.00,
        "currency": "NOK"
      },          
      "additionalCost": {
        "value": 60000,
        "currency": "NOK"
        },
      "accountNumber": "3214.32.12345", 
      "customerIdentificationNumber": "1231238423423"
    },
    "handoverDate": "2019-12-31"
  },
  "realEstates": [                //List of properties involved
    {
      "propertyKey": "987654322-1",
      "ownershipType": "COOPRATIVE",
      "cooperativeShare": {
        "organizationNumber": 987654322,
        "shareNumber": 1
      },
      "sellers": [
        {
          "seller": {
            "officialId": "123456789012",
            "name": "KARI"
          },
          "fraction": {
            "numerator": 1,
            "denominator": 1
          }
        }
      ],
      "buyers": [ 
        {
          "buyer": {
            "officialId": "123456789034",
            "name": "OLA"
          },
          "fraction": {
            "numerator": 1,
            "denominator": 1
          }
        }
      ]
    }
  ],
  "intentionsFromBank": [         //List of intentions from bank
    {
      "uniqueIdentifier": "INT-835cd2af-d87c-4df9-83a8-4785eae367b1",
      "created": "2019-12-18T15:38:26.747",
      "capability": {
        "flow": "DIGITAL",
        "reason": ""              //If provided by bank
      },
      "bankInformation": {
        "department": {
          "name": "Bank Dept",
          "organization": {
            "name": "Bank",
            "orgNr": "987654321"
          }
        }
      }
    }
  ],
  "documents": [                  //List of documents
  ],
  "owner": {                      //Broker (Owner)
    "organization": {
      "name": "BrokerOrg",
      "orgNr": "987654321"
    }
  },
  "contactInformation": {         //Contact information broker 
    "contactPerson": {
      "email": "test@broker.com",
      "name": "Frank",
      "phoneNumber": "43215678",
      "phoneNumberDirect": "98726351"
    },
    "organizationId": "987654321",
    "organizationName": "BrokerOrg"
  }
}