NAV Navbar

Collateral API v1.0

Scroll down for example requests and responses.

collateral-api-controller

Collateral Api Controller

createCollateralAgreementUsingPOST

Code samples

POST /api/v1/agreement

createCollateralAgreement

Create new collateral contract

Example responses

200 Response

{
  "data": {
    "notary": true,
    "signingDate": "2000-01-23",
    "collateralAgreementId": 0,
    "notaryOffice": "notaryOffice",
    "agreementNumber": "agreementNumber",
    "fileId": 6,
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_CollateralAgreementJson_

findCollateralAgreementUsingGET

Code samples

GET /api/v1/agreement/{agreementId}

findCollateralAgreement

Get collateral agreement by unique identifier

Parameters

Parameter In Type Required Description
agreementId path integer(int64) true Agreement identifier

Example responses

200 Response

{
  "data": {
    "notary": true,
    "signingDate": "2000-01-23",
    "collateralAgreementId": 0,
    "notaryOffice": "notaryOffice",
    "agreementNumber": "agreementNumber",
    "fileId": 6,
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_CollateralAgreementJson_

activateCollateralAgreementUsingPOST

Code samples

POST /api/v1/agreement/{agreementId}/activate

activateCollateralAgreement

Activate contract agreement

Parameters

Parameter In Type Required Description
agreementId path integer(int64) true Agreement identifier

Example responses

200 Response

{
  "data": {
    "notary": true,
    "signingDate": "2000-01-23",
    "collateralAgreementId": 0,
    "notaryOffice": "notaryOffice",
    "agreementNumber": "agreementNumber",
    "fileId": 6,
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_CollateralAgreementJson_

signCollateralAgreementUsingPOST

Code samples

POST /api/v1/agreement/{agreementId}/sign

signCollateralAgreement

Initiate digital signing of collateral agreement

Body parameter

{
  "signingDate": "2000-01-23",
  "notaryOffice": "notaryOffice",
  "fileId": 0
}

Parameters

Parameter In Type Required Description
agreementId path integer(int64) true Collateral agreement unique identifier
body body SignCollateralAgreementJson true json

Example responses

200 Response

{
  "data": {
    "notary": true,
    "signingDate": "2000-01-23",
    "collateralAgreementId": 0,
    "notaryOffice": "notaryOffice",
    "agreementNumber": "agreementNumber",
    "fileId": 6,
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_CollateralAgreementJson_

prepareCollateralAgreementForSigningUsingPOST

Code samples

POST /api/v1/agreement/{agreementId}/sign/prepare

prepareCollateralAgreementForSigning

Prepare collateral agreement for signing

Parameters

Parameter In Type Required Description
agreementId path integer(int64) true Collateral agreement unique identifier

Example responses

200 Response

{
  "data": {
    "notary": true,
    "signingDate": "2000-01-23",
    "collateralAgreementId": 0,
    "notaryOffice": "notaryOffice",
    "agreementNumber": "agreementNumber",
    "fileId": 6,
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_CollateralAgreementJson_

createCollateralsUsingPOST

Code samples

POST /api/v1/collateral

createCollaterals

Create new collateral based on asset

Body parameter

{
  "assetId": 0,
  "collateralAgreementId": 6,
  "collateralTypeCode": "collateralTypeCode",
  "expirationDate": "2000-01-23"
}

Parameters

Parameter In Type Required Description
body body CreateCollateralJson true json

Example responses

200 Response

{
  "data": [
    {
      "availableAmount": 1.4658129805029452,
      "collateralStatusCode": "collateralStatusCode",
      "assetId": 6,
      "collateralAmount": 5.962133916683182,
      "collateralTypeCode": "collateralTypeCode",
      "personId": 2,
      "collateralId": 5,
      "currencyCode": "currencyCode"
    },
    {
      "availableAmount": 1.4658129805029452,
      "collateralStatusCode": "collateralStatusCode",
      "assetId": 6,
      "collateralAmount": 5.962133916683182,
      "collateralTypeCode": "collateralTypeCode",
      "personId": 2,
      "collateralId": 5,
      "currencyCode": "currencyCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_List_CollateralJson_

createCollateralUsageUsingPOST

Code samples

POST /api/v1/collateral/usage

createCollateralUsage

Add pledge data to collateral

Body parameter

{
  "contractId": 0,
  "usages": [
    {
      "pledgeAmount": 1.4658129805029452,
      "description": "description",
      "main": true,
      "collateralId": 6
    },
    {
      "pledgeAmount": 1.4658129805029452,
      "description": "description",
      "main": true,
      "collateralId": 6
    }
  ]
}

Parameters

Parameter In Type Required Description
body body CreateCollateralUsageJson true json

Example responses

200 Response

{
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_Void_

findCollateralUsingGET

Code samples

GET /api/v1/collateral/{collateralId}

findCollateral

Get collateral by unique identifier

Parameters

Parameter In Type Required Description
collateralId path integer(int64) true Reference to collateral

Example responses

200 Response

{
  "data": {
    "availableAmount": 1.4658129805029452,
    "collateralStatusCode": "collateralStatusCode",
    "assetId": 6,
    "collateralAmount": 5.962133916683182,
    "collateralTypeCode": "collateralTypeCode",
    "personId": 2,
    "collateralId": 5,
    "currencyCode": "currencyCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_CollateralJson_

activateCollateralUsingPOST

Code samples

POST /api/v1/collateral/{collateralId}/activate

activateCollateral

Activate collateral so that it could be used for backing loans

Parameters

Parameter In Type Required Description
collateralId path integer(int64) true Reference to collateral

Example responses

200 Response

{
  "data": {
    "availableAmount": 1.4658129805029452,
    "collateralStatusCode": "collateralStatusCode",
    "assetId": 6,
    "collateralAmount": 5.962133916683182,
    "collateralTypeCode": "collateralTypeCode",
    "personId": 2,
    "collateralId": 5,
    "currencyCode": "currencyCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_CollateralJson_

createCollateralRightsUsingPOST

Code samples

POST /api/v1/collateral/{collateralId}/rights

createCollateralRights

Add new rights for collateral

Body parameter

{
  "rights": [
    {
      "personId": 0,
      "loanTypeCode": "loanTypeCode"
    },
    {
      "personId": 0,
      "loanTypeCode": "loanTypeCode"
    }
  ]
}

Parameters

Parameter In Type Required Description
collateralId path integer(int64) true Reference to collateral
body body CreateCollateralRightsJson true json

Example responses

200 Response

{
  "data": {
    "availableAmount": 1.4658129805029452,
    "collateralStatusCode": "collateralStatusCode",
    "assetId": 6,
    "collateralAmount": 5.962133916683182,
    "collateralTypeCode": "collateralTypeCode",
    "personId": 2,
    "collateralId": 5,
    "currencyCode": "currencyCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_CollateralJson_

searchCollateralUsagesUsingGET

Code samples

GET /api/v1/collaterals/search

searchCollateralUsages

Search on collateral usage by loan contract

Parameters

Parameter In Type Required Description
contractId query integer(int64) true Loan contract reference

Example responses

200 Response

{
  "data": [
    {
      "assetId": 0,
      "pledgeAmount": 5.962133916683182,
      "contractId": 1,
      "rank": 5,
      "main": true,
      "collateralId": 6,
      "collateral": {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      },
      "currencyCode": "currencyCode"
    },
    {
      "assetId": 0,
      "pledgeAmount": 5.962133916683182,
      "contractId": 1,
      "rank": 5,
      "main": true,
      "collateralId": 6,
      "collateral": {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      },
      "currencyCode": "currencyCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_List_CollateralUsageJson_

findPersonCollateralsUsingGET

Code samples

GET /api/v1/persons/{personId}/collateral

findPersonCollaterals

Find the registered collateral of customer

Parameters

Parameter In Type Required Description
personId path integer(int64) true Customer reference

Example responses

200 Response

{
  "data": [
    {
      "availableAmount": 1.4658129805029452,
      "collateralStatusCode": "collateralStatusCode",
      "assetId": 6,
      "collateralAmount": 5.962133916683182,
      "collateralTypeCode": "collateralTypeCode",
      "personId": 2,
      "collateralId": 5,
      "currencyCode": "currencyCode"
    },
    {
      "availableAmount": 1.4658129805029452,
      "collateralStatusCode": "collateralStatusCode",
      "assetId": 6,
      "collateralAmount": 5.962133916683182,
      "collateralTypeCode": "collateralTypeCode",
      "personId": 2,
      "collateralId": 5,
      "currencyCode": "currencyCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_List_CollateralJson_

system-api-controller

System Api Controller

findAssetTypesUsingGET

Code samples

GET /api/v1/asset-types

findAssetTypes

Get all asset types

Example responses

200 Response

{
  "data": [
    {
      "insuranceNeeded": true,
      "assetTypeCode": "assetTypeCode",
      "notaryNeeded": true
    },
    {
      "insuranceNeeded": true,
      "assetTypeCode": "assetTypeCode",
      "notaryNeeded": true
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_List_AssetTypeJson_

findAssetTypeUsingGET

Code samples

GET /api/v1/asset-types/{assetTypeCode}

findAssetType

Get asset by asset type code

Parameters

Parameter In Type Required Description
assetTypeCode path string true VEHICLE, SURETY, REAL_ESTATE, FINANCIAL_ASSET, COMMERCIAL_PLEDGE, BANK_GUARANTEE

Example responses

200 Response

{
  "data": {
    "insuranceNeeded": true,
    "assetTypeCode": "assetTypeCode",
    "notaryNeeded": true
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_AssetTypeJson_

changePostingDateUsingPOST

Code samples

POST /api/v1/posting-date

changePostingDate

Change banking day in module and trigger reevaluations

Body parameter

{
  "newPostingDate": "2000-01-23"
}

Parameters

Parameter In Type Required Description
body body PostingDateChangeJson true json

Example responses

200 Response

{
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_Void_

asset-api-controller

Asset Api Controller

createAssetUsingPOST

Code samples

POST /api/v1/assets

createAsset

Create new asset

Body parameter

{
  "description": "description",
  "assetTypeCode": "assetTypeCode"
}

Parameters

Parameter In Type Required Description
body body CreateAssetJson true json

Example responses

200 Response

{
  "data": {
    "commercialPledgeAsset": {
      "commercialPledgeId": 3,
      "assetId": 7,
      "pledgeAmount": 2.027123023002322,
      "balanceSheetItem": "balanceSheetItem",
      "description": "description",
      "balanceSheetValue": 9.301444243932576,
      "validityRange": {
        "endDate": "2000-01-23",
        "startDate": "2000-01-23"
      }
    },
    "suretyAsset": {
      "solvency": 7.143538047012306,
      "amount": 3.353193347011243,
      "assetId": 3,
      "description": "description",
      "suretyId": 0
    },
    "evaluations": [
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      },
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      }
    ],
    "insurances": [
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      },
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      }
    ],
    "assetStatusCode": "assetStatusCode",
    "collaterals": [
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      },
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      }
    ],
    "ownerships": [
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      },
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      }
    ],
    "description": "description",
    "depositAsset": {
      "amount": 4.145608029883936,
      "bank": "bank",
      "depositId": 7,
      "description": "description",
      "financialAssetId": 1,
      "accountNumber": "accountNumber",
      "bic": "bic",
      "currencyCode": "currencyCode"
    },
    "securityAsset": {
      "numberOfSecurities": 5,
      "name": "name",
      "description": "description",
      "marketValue": 6.778324963048013,
      "financialAssetId": 2,
      "securityId": 6,
      "currencyCode": "currencyCode",
      "nominalValue": 6.878052220127876
    },
    "assetId": 0,
    "liabilities": [
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      },
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      }
    ],
    "vehicleAsset": {
      "manufacturingYear": 6,
      "registryNumber": "registryNumber",
      "assetId": 7,
      "registrationDate": "2000-01-23",
      "vehicleTypeCode": "vehicleTypeCode",
      "model": "model",
      "vehicleId": 0,
      "factoryIdentification": "factoryIdentification",
      "manufacturer": "manufacturer"
    },
    "assetTypeCode": "assetTypeCode",
    "realEstateAsset": {
      "realEstateId": 3,
      "renovationYear": 6,
      "city": "city",
      "conditionTypeCode": "conditionTypeCode",
      "constructionYear": 6,
      "postalCode": "postalCode",
      "houseNumber": "houseNumber",
      "municipality": "municipality",
      "propertyTypeCode": "propertyTypeCode",
      "description": "description",
      "cityDistrict": "cityDistrict",
      "registryNumber": "registryNumber",
      "assetId": 9,
      "countryCode": "countryCode",
      "street": "street",
      "landPlotArea": 6.438423552598547,
      "effectiveSurfaceArea": 8.762042012749001,
      "floorNumber": 9,
      "totalArea": 1.284659006116532
    }
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_AssetJson_

findAssetUsingGET

Code samples

GET /api/v1/assets/{assetId}

findAsset

Get asset by unique identifier

Parameters

Parameter In Type Required Description
assetId path integer(int64) true Reference to abstract asset object

Example responses

200 Response

{
  "data": {
    "commercialPledgeAsset": {
      "commercialPledgeId": 3,
      "assetId": 7,
      "pledgeAmount": 2.027123023002322,
      "balanceSheetItem": "balanceSheetItem",
      "description": "description",
      "balanceSheetValue": 9.301444243932576,
      "validityRange": {
        "endDate": "2000-01-23",
        "startDate": "2000-01-23"
      }
    },
    "suretyAsset": {
      "solvency": 7.143538047012306,
      "amount": 3.353193347011243,
      "assetId": 3,
      "description": "description",
      "suretyId": 0
    },
    "evaluations": [
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      },
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      }
    ],
    "insurances": [
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      },
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      }
    ],
    "assetStatusCode": "assetStatusCode",
    "collaterals": [
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      },
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      }
    ],
    "ownerships": [
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      },
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      }
    ],
    "description": "description",
    "depositAsset": {
      "amount": 4.145608029883936,
      "bank": "bank",
      "depositId": 7,
      "description": "description",
      "financialAssetId": 1,
      "accountNumber": "accountNumber",
      "bic": "bic",
      "currencyCode": "currencyCode"
    },
    "securityAsset": {
      "numberOfSecurities": 5,
      "name": "name",
      "description": "description",
      "marketValue": 6.778324963048013,
      "financialAssetId": 2,
      "securityId": 6,
      "currencyCode": "currencyCode",
      "nominalValue": 6.878052220127876
    },
    "assetId": 0,
    "liabilities": [
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      },
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      }
    ],
    "vehicleAsset": {
      "manufacturingYear": 6,
      "registryNumber": "registryNumber",
      "assetId": 7,
      "registrationDate": "2000-01-23",
      "vehicleTypeCode": "vehicleTypeCode",
      "model": "model",
      "vehicleId": 0,
      "factoryIdentification": "factoryIdentification",
      "manufacturer": "manufacturer"
    },
    "assetTypeCode": "assetTypeCode",
    "realEstateAsset": {
      "realEstateId": 3,
      "renovationYear": 6,
      "city": "city",
      "conditionTypeCode": "conditionTypeCode",
      "constructionYear": 6,
      "postalCode": "postalCode",
      "houseNumber": "houseNumber",
      "municipality": "municipality",
      "propertyTypeCode": "propertyTypeCode",
      "description": "description",
      "cityDistrict": "cityDistrict",
      "registryNumber": "registryNumber",
      "assetId": 9,
      "countryCode": "countryCode",
      "street": "street",
      "landPlotArea": 6.438423552598547,
      "effectiveSurfaceArea": 8.762042012749001,
      "floorNumber": 9,
      "totalArea": 1.284659006116532
    }
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_AssetJson_

activateAssetUsingPOST

Code samples

POST /api/v1/assets/{assetId}/activate

activateAsset

Activate asset and allow it to be used for collateral

Parameters

Parameter In Type Required Description
assetId path integer(int64) true Reference to abstract asset object

Example responses

200 Response

{
  "data": {
    "commercialPledgeAsset": {
      "commercialPledgeId": 3,
      "assetId": 7,
      "pledgeAmount": 2.027123023002322,
      "balanceSheetItem": "balanceSheetItem",
      "description": "description",
      "balanceSheetValue": 9.301444243932576,
      "validityRange": {
        "endDate": "2000-01-23",
        "startDate": "2000-01-23"
      }
    },
    "suretyAsset": {
      "solvency": 7.143538047012306,
      "amount": 3.353193347011243,
      "assetId": 3,
      "description": "description",
      "suretyId": 0
    },
    "evaluations": [
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      },
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      }
    ],
    "insurances": [
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      },
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      }
    ],
    "assetStatusCode": "assetStatusCode",
    "collaterals": [
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      },
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      }
    ],
    "ownerships": [
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      },
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      }
    ],
    "description": "description",
    "depositAsset": {
      "amount": 4.145608029883936,
      "bank": "bank",
      "depositId": 7,
      "description": "description",
      "financialAssetId": 1,
      "accountNumber": "accountNumber",
      "bic": "bic",
      "currencyCode": "currencyCode"
    },
    "securityAsset": {
      "numberOfSecurities": 5,
      "name": "name",
      "description": "description",
      "marketValue": 6.778324963048013,
      "financialAssetId": 2,
      "securityId": 6,
      "currencyCode": "currencyCode",
      "nominalValue": 6.878052220127876
    },
    "assetId": 0,
    "liabilities": [
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      },
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      }
    ],
    "vehicleAsset": {
      "manufacturingYear": 6,
      "registryNumber": "registryNumber",
      "assetId": 7,
      "registrationDate": "2000-01-23",
      "vehicleTypeCode": "vehicleTypeCode",
      "model": "model",
      "vehicleId": 0,
      "factoryIdentification": "factoryIdentification",
      "manufacturer": "manufacturer"
    },
    "assetTypeCode": "assetTypeCode",
    "realEstateAsset": {
      "realEstateId": 3,
      "renovationYear": 6,
      "city": "city",
      "conditionTypeCode": "conditionTypeCode",
      "constructionYear": 6,
      "postalCode": "postalCode",
      "houseNumber": "houseNumber",
      "municipality": "municipality",
      "propertyTypeCode": "propertyTypeCode",
      "description": "description",
      "cityDistrict": "cityDistrict",
      "registryNumber": "registryNumber",
      "assetId": 9,
      "countryCode": "countryCode",
      "street": "street",
      "landPlotArea": 6.438423552598547,
      "effectiveSurfaceArea": 8.762042012749001,
      "floorNumber": 9,
      "totalArea": 1.284659006116532
    }
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_AssetJson_

createCommercialPledgeAssetUsingPOST

Code samples

POST /api/v1/assets/{assetId}/commercial-pledge

createCommercialPledgeAsset

Create new commercial pledge type of asset

Body parameter

{
  "pledgeAmount": 6.027456183070403,
  "balanceSheetItem": "balanceSheetItem",
  "description": "description",
  "balanceSheetValue": 0.8008281904610115
}

Parameters

Parameter In Type Required Description
assetId path integer(int64) true Reference to abstract asset object
body body CreateCommercialPledgeAssetJson true json

Example responses

200 Response

{
  "data": {
    "commercialPledgeAsset": {
      "commercialPledgeId": 3,
      "assetId": 7,
      "pledgeAmount": 2.027123023002322,
      "balanceSheetItem": "balanceSheetItem",
      "description": "description",
      "balanceSheetValue": 9.301444243932576,
      "validityRange": {
        "endDate": "2000-01-23",
        "startDate": "2000-01-23"
      }
    },
    "suretyAsset": {
      "solvency": 7.143538047012306,
      "amount": 3.353193347011243,
      "assetId": 3,
      "description": "description",
      "suretyId": 0
    },
    "evaluations": [
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      },
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      }
    ],
    "insurances": [
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      },
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      }
    ],
    "assetStatusCode": "assetStatusCode",
    "collaterals": [
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      },
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      }
    ],
    "ownerships": [
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      },
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      }
    ],
    "description": "description",
    "depositAsset": {
      "amount": 4.145608029883936,
      "bank": "bank",
      "depositId": 7,
      "description": "description",
      "financialAssetId": 1,
      "accountNumber": "accountNumber",
      "bic": "bic",
      "currencyCode": "currencyCode"
    },
    "securityAsset": {
      "numberOfSecurities": 5,
      "name": "name",
      "description": "description",
      "marketValue": 6.778324963048013,
      "financialAssetId": 2,
      "securityId": 6,
      "currencyCode": "currencyCode",
      "nominalValue": 6.878052220127876
    },
    "assetId": 0,
    "liabilities": [
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      },
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      }
    ],
    "vehicleAsset": {
      "manufacturingYear": 6,
      "registryNumber": "registryNumber",
      "assetId": 7,
      "registrationDate": "2000-01-23",
      "vehicleTypeCode": "vehicleTypeCode",
      "model": "model",
      "vehicleId": 0,
      "factoryIdentification": "factoryIdentification",
      "manufacturer": "manufacturer"
    },
    "assetTypeCode": "assetTypeCode",
    "realEstateAsset": {
      "realEstateId": 3,
      "renovationYear": 6,
      "city": "city",
      "conditionTypeCode": "conditionTypeCode",
      "constructionYear": 6,
      "postalCode": "postalCode",
      "houseNumber": "houseNumber",
      "municipality": "municipality",
      "propertyTypeCode": "propertyTypeCode",
      "description": "description",
      "cityDistrict": "cityDistrict",
      "registryNumber": "registryNumber",
      "assetId": 9,
      "countryCode": "countryCode",
      "street": "street",
      "landPlotArea": 6.438423552598547,
      "effectiveSurfaceArea": 8.762042012749001,
      "floorNumber": 9,
      "totalArea": 1.284659006116532
    }
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_AssetJson_

createAssetEvaluationUsingPOST

Code samples

POST /api/v1/assets/{assetId}/evaluation

createAssetEvaluation

Add new evaluation entry to asset

Body parameter

{
  "evaluationDate": "2000-01-23",
  "valueTypeCode": "valueTypeCode",
  "currencyCode": "currencyCode",
  "evaluatorId": 0,
  "value": 6.027456183070403
}

Parameters

Parameter In Type Required Description
assetId path integer(int64) true Reference to abstract asset object
body body CreateAssetEvaluationJson true json

Example responses

200 Response

{
  "data": {
    "commercialPledgeAsset": {
      "commercialPledgeId": 3,
      "assetId": 7,
      "pledgeAmount": 2.027123023002322,
      "balanceSheetItem": "balanceSheetItem",
      "description": "description",
      "balanceSheetValue": 9.301444243932576,
      "validityRange": {
        "endDate": "2000-01-23",
        "startDate": "2000-01-23"
      }
    },
    "suretyAsset": {
      "solvency": 7.143538047012306,
      "amount": 3.353193347011243,
      "assetId": 3,
      "description": "description",
      "suretyId": 0
    },
    "evaluations": [
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      },
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      }
    ],
    "insurances": [
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      },
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      }
    ],
    "assetStatusCode": "assetStatusCode",
    "collaterals": [
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      },
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      }
    ],
    "ownerships": [
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      },
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      }
    ],
    "description": "description",
    "depositAsset": {
      "amount": 4.145608029883936,
      "bank": "bank",
      "depositId": 7,
      "description": "description",
      "financialAssetId": 1,
      "accountNumber": "accountNumber",
      "bic": "bic",
      "currencyCode": "currencyCode"
    },
    "securityAsset": {
      "numberOfSecurities": 5,
      "name": "name",
      "description": "description",
      "marketValue": 6.778324963048013,
      "financialAssetId": 2,
      "securityId": 6,
      "currencyCode": "currencyCode",
      "nominalValue": 6.878052220127876
    },
    "assetId": 0,
    "liabilities": [
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      },
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      }
    ],
    "vehicleAsset": {
      "manufacturingYear": 6,
      "registryNumber": "registryNumber",
      "assetId": 7,
      "registrationDate": "2000-01-23",
      "vehicleTypeCode": "vehicleTypeCode",
      "model": "model",
      "vehicleId": 0,
      "factoryIdentification": "factoryIdentification",
      "manufacturer": "manufacturer"
    },
    "assetTypeCode": "assetTypeCode",
    "realEstateAsset": {
      "realEstateId": 3,
      "renovationYear": 6,
      "city": "city",
      "conditionTypeCode": "conditionTypeCode",
      "constructionYear": 6,
      "postalCode": "postalCode",
      "houseNumber": "houseNumber",
      "municipality": "municipality",
      "propertyTypeCode": "propertyTypeCode",
      "description": "description",
      "cityDistrict": "cityDistrict",
      "registryNumber": "registryNumber",
      "assetId": 9,
      "countryCode": "countryCode",
      "street": "street",
      "landPlotArea": 6.438423552598547,
      "effectiveSurfaceArea": 8.762042012749001,
      "floorNumber": 9,
      "totalArea": 1.284659006116532
    }
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_AssetJson_

prepareAssetEvaluationUsingPOST

Code samples

POST /api/v1/assets/{assetId}/evaluation/prepare

prepareAssetEvaluation

Prepare new asset evaluation

Parameters

Parameter In Type Required Description
assetId path integer(int64) true Reference to abstract asset object

Example responses

200 Response

{
  "data": {
    "commercialPledgeAsset": {
      "commercialPledgeId": 3,
      "assetId": 7,
      "pledgeAmount": 2.027123023002322,
      "balanceSheetItem": "balanceSheetItem",
      "description": "description",
      "balanceSheetValue": 9.301444243932576,
      "validityRange": {
        "endDate": "2000-01-23",
        "startDate": "2000-01-23"
      }
    },
    "suretyAsset": {
      "solvency": 7.143538047012306,
      "amount": 3.353193347011243,
      "assetId": 3,
      "description": "description",
      "suretyId": 0
    },
    "evaluations": [
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      },
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      }
    ],
    "insurances": [
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      },
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      }
    ],
    "assetStatusCode": "assetStatusCode",
    "collaterals": [
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      },
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      }
    ],
    "ownerships": [
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      },
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      }
    ],
    "description": "description",
    "depositAsset": {
      "amount": 4.145608029883936,
      "bank": "bank",
      "depositId": 7,
      "description": "description",
      "financialAssetId": 1,
      "accountNumber": "accountNumber",
      "bic": "bic",
      "currencyCode": "currencyCode"
    },
    "securityAsset": {
      "numberOfSecurities": 5,
      "name": "name",
      "description": "description",
      "marketValue": 6.778324963048013,
      "financialAssetId": 2,
      "securityId": 6,
      "currencyCode": "currencyCode",
      "nominalValue": 6.878052220127876
    },
    "assetId": 0,
    "liabilities": [
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      },
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      }
    ],
    "vehicleAsset": {
      "manufacturingYear": 6,
      "registryNumber": "registryNumber",
      "assetId": 7,
      "registrationDate": "2000-01-23",
      "vehicleTypeCode": "vehicleTypeCode",
      "model": "model",
      "vehicleId": 0,
      "factoryIdentification": "factoryIdentification",
      "manufacturer": "manufacturer"
    },
    "assetTypeCode": "assetTypeCode",
    "realEstateAsset": {
      "realEstateId": 3,
      "renovationYear": 6,
      "city": "city",
      "conditionTypeCode": "conditionTypeCode",
      "constructionYear": 6,
      "postalCode": "postalCode",
      "houseNumber": "houseNumber",
      "municipality": "municipality",
      "propertyTypeCode": "propertyTypeCode",
      "description": "description",
      "cityDistrict": "cityDistrict",
      "registryNumber": "registryNumber",
      "assetId": 9,
      "countryCode": "countryCode",
      "street": "street",
      "landPlotArea": 6.438423552598547,
      "effectiveSurfaceArea": 8.762042012749001,
      "floorNumber": 9,
      "totalArea": 1.284659006116532
    }
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_AssetJson_

createFinancialAssetUsingPOST

Code samples

POST /api/v1/assets/{assetId}/financial

createFinancialAsset

Create new financial asset

Body parameter

{
  "security": {
    "numberOfSecurities": 5,
    "name": "name",
    "description": "description",
    "marketValue": 6.027456183070403,
    "currencyCode": "currencyCode",
    "nominalValue": 1.4658129805029452
  },
  "deposit": {
    "amount": 0.8008281904610115,
    "bank": "bank",
    "description": "description",
    "accountNumber": "accountNumber",
    "bic": "bic",
    "currencyCode": "currencyCode"
  },
  "financialAssetTypeCode": "financialAssetTypeCode"
}

Parameters

Parameter In Type Required Description
assetId path integer(int64) true Reference to abstract asset object
body body CreateFinancialAssetJson true json

Example responses

200 Response

{
  "data": {
    "commercialPledgeAsset": {
      "commercialPledgeId": 3,
      "assetId": 7,
      "pledgeAmount": 2.027123023002322,
      "balanceSheetItem": "balanceSheetItem",
      "description": "description",
      "balanceSheetValue": 9.301444243932576,
      "validityRange": {
        "endDate": "2000-01-23",
        "startDate": "2000-01-23"
      }
    },
    "suretyAsset": {
      "solvency": 7.143538047012306,
      "amount": 3.353193347011243,
      "assetId": 3,
      "description": "description",
      "suretyId": 0
    },
    "evaluations": [
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      },
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      }
    ],
    "insurances": [
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      },
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      }
    ],
    "assetStatusCode": "assetStatusCode",
    "collaterals": [
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      },
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      }
    ],
    "ownerships": [
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      },
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      }
    ],
    "description": "description",
    "depositAsset": {
      "amount": 4.145608029883936,
      "bank": "bank",
      "depositId": 7,
      "description": "description",
      "financialAssetId": 1,
      "accountNumber": "accountNumber",
      "bic": "bic",
      "currencyCode": "currencyCode"
    },
    "securityAsset": {
      "numberOfSecurities": 5,
      "name": "name",
      "description": "description",
      "marketValue": 6.778324963048013,
      "financialAssetId": 2,
      "securityId": 6,
      "currencyCode": "currencyCode",
      "nominalValue": 6.878052220127876
    },
    "assetId": 0,
    "liabilities": [
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      },
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      }
    ],
    "vehicleAsset": {
      "manufacturingYear": 6,
      "registryNumber": "registryNumber",
      "assetId": 7,
      "registrationDate": "2000-01-23",
      "vehicleTypeCode": "vehicleTypeCode",
      "model": "model",
      "vehicleId": 0,
      "factoryIdentification": "factoryIdentification",
      "manufacturer": "manufacturer"
    },
    "assetTypeCode": "assetTypeCode",
    "realEstateAsset": {
      "realEstateId": 3,
      "renovationYear": 6,
      "city": "city",
      "conditionTypeCode": "conditionTypeCode",
      "constructionYear": 6,
      "postalCode": "postalCode",
      "houseNumber": "houseNumber",
      "municipality": "municipality",
      "propertyTypeCode": "propertyTypeCode",
      "description": "description",
      "cityDistrict": "cityDistrict",
      "registryNumber": "registryNumber",
      "assetId": 9,
      "countryCode": "countryCode",
      "street": "street",
      "landPlotArea": 6.438423552598547,
      "effectiveSurfaceArea": 8.762042012749001,
      "floorNumber": 9,
      "totalArea": 1.284659006116532
    }
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_AssetJson_

createAssetInsuranceUsingPOST

Code samples

POST /api/v1/assets/{assetId}/insurance

createAssetInsurance

Add new insurance to asset

Body parameter

{
  "insuranceDate": "2000-01-23",
  "amount": 0.8008281904610115,
  "description": "description",
  "agreementNumber": "agreementNumber",
  "currencyCode": "currencyCode",
  "insuranceCompany": "insuranceCompany"
}

Parameters

Parameter In Type Required Description
assetId path integer(int64) true Reference to abstract asset object
body body CreateAssetInsuranceJson true json

Example responses

200 Response

{
  "data": {
    "commercialPledgeAsset": {
      "commercialPledgeId": 3,
      "assetId": 7,
      "pledgeAmount": 2.027123023002322,
      "balanceSheetItem": "balanceSheetItem",
      "description": "description",
      "balanceSheetValue": 9.301444243932576,
      "validityRange": {
        "endDate": "2000-01-23",
        "startDate": "2000-01-23"
      }
    },
    "suretyAsset": {
      "solvency": 7.143538047012306,
      "amount": 3.353193347011243,
      "assetId": 3,
      "description": "description",
      "suretyId": 0
    },
    "evaluations": [
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      },
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      }
    ],
    "insurances": [
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      },
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      }
    ],
    "assetStatusCode": "assetStatusCode",
    "collaterals": [
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      },
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      }
    ],
    "ownerships": [
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      },
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      }
    ],
    "description": "description",
    "depositAsset": {
      "amount": 4.145608029883936,
      "bank": "bank",
      "depositId": 7,
      "description": "description",
      "financialAssetId": 1,
      "accountNumber": "accountNumber",
      "bic": "bic",
      "currencyCode": "currencyCode"
    },
    "securityAsset": {
      "numberOfSecurities": 5,
      "name": "name",
      "description": "description",
      "marketValue": 6.778324963048013,
      "financialAssetId": 2,
      "securityId": 6,
      "currencyCode": "currencyCode",
      "nominalValue": 6.878052220127876
    },
    "assetId": 0,
    "liabilities": [
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      },
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      }
    ],
    "vehicleAsset": {
      "manufacturingYear": 6,
      "registryNumber": "registryNumber",
      "assetId": 7,
      "registrationDate": "2000-01-23",
      "vehicleTypeCode": "vehicleTypeCode",
      "model": "model",
      "vehicleId": 0,
      "factoryIdentification": "factoryIdentification",
      "manufacturer": "manufacturer"
    },
    "assetTypeCode": "assetTypeCode",
    "realEstateAsset": {
      "realEstateId": 3,
      "renovationYear": 6,
      "city": "city",
      "conditionTypeCode": "conditionTypeCode",
      "constructionYear": 6,
      "postalCode": "postalCode",
      "houseNumber": "houseNumber",
      "municipality": "municipality",
      "propertyTypeCode": "propertyTypeCode",
      "description": "description",
      "cityDistrict": "cityDistrict",
      "registryNumber": "registryNumber",
      "assetId": 9,
      "countryCode": "countryCode",
      "street": "street",
      "landPlotArea": 6.438423552598547,
      "effectiveSurfaceArea": 8.762042012749001,
      "floorNumber": 9,
      "totalArea": 1.284659006116532
    }
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_AssetJson_

prepareAssetInsuranceUsingPOST

Code samples

POST /api/v1/assets/{assetId}/insurance/prepare

prepareAssetInsurance

Prepare asset insurance

Parameters

Parameter In Type Required Description
assetId path integer(int64) true Reference to abstract asset object

Example responses

200 Response

{
  "data": {
    "commercialPledgeAsset": {
      "commercialPledgeId": 3,
      "assetId": 7,
      "pledgeAmount": 2.027123023002322,
      "balanceSheetItem": "balanceSheetItem",
      "description": "description",
      "balanceSheetValue": 9.301444243932576,
      "validityRange": {
        "endDate": "2000-01-23",
        "startDate": "2000-01-23"
      }
    },
    "suretyAsset": {
      "solvency": 7.143538047012306,
      "amount": 3.353193347011243,
      "assetId": 3,
      "description": "description",
      "suretyId": 0
    },
    "evaluations": [
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      },
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      }
    ],
    "insurances": [
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      },
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      }
    ],
    "assetStatusCode": "assetStatusCode",
    "collaterals": [
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      },
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      }
    ],
    "ownerships": [
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      },
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      }
    ],
    "description": "description",
    "depositAsset": {
      "amount": 4.145608029883936,
      "bank": "bank",
      "depositId": 7,
      "description": "description",
      "financialAssetId": 1,
      "accountNumber": "accountNumber",
      "bic": "bic",
      "currencyCode": "currencyCode"
    },
    "securityAsset": {
      "numberOfSecurities": 5,
      "name": "name",
      "description": "description",
      "marketValue": 6.778324963048013,
      "financialAssetId": 2,
      "securityId": 6,
      "currencyCode": "currencyCode",
      "nominalValue": 6.878052220127876
    },
    "assetId": 0,
    "liabilities": [
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      },
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      }
    ],
    "vehicleAsset": {
      "manufacturingYear": 6,
      "registryNumber": "registryNumber",
      "assetId": 7,
      "registrationDate": "2000-01-23",
      "vehicleTypeCode": "vehicleTypeCode",
      "model": "model",
      "vehicleId": 0,
      "factoryIdentification": "factoryIdentification",
      "manufacturer": "manufacturer"
    },
    "assetTypeCode": "assetTypeCode",
    "realEstateAsset": {
      "realEstateId": 3,
      "renovationYear": 6,
      "city": "city",
      "conditionTypeCode": "conditionTypeCode",
      "constructionYear": 6,
      "postalCode": "postalCode",
      "houseNumber": "houseNumber",
      "municipality": "municipality",
      "propertyTypeCode": "propertyTypeCode",
      "description": "description",
      "cityDistrict": "cityDistrict",
      "registryNumber": "registryNumber",
      "assetId": 9,
      "countryCode": "countryCode",
      "street": "street",
      "landPlotArea": 6.438423552598547,
      "effectiveSurfaceArea": 8.762042012749001,
      "floorNumber": 9,
      "totalArea": 1.284659006116532
    }
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_AssetJson_

createAssetLiabilityUsingPOST

Code samples

POST /api/v1/assets/{assetId}/liability

createAssetLiability

Add liability to asset

Body parameter

{
  "liabilities": [
    {
      "pledgeAmount": 6.027456183070403,
      "description": "description",
      "rank": 1,
      "currencyCode": "currencyCode",
      "loanAmount": 0.8008281904610115,
      "loanTypeCode": "loanTypeCode",
      "pledgee": "pledgee"
    },
    {
      "pledgeAmount": 6.027456183070403,
      "description": "description",
      "rank": 1,
      "currencyCode": "currencyCode",
      "loanAmount": 0.8008281904610115,
      "loanTypeCode": "loanTypeCode",
      "pledgee": "pledgee"
    }
  ]
}

Parameters

Parameter In Type Required Description
assetId path integer(int64) true Reference to abstract asset object
body body CreateAssetLiabilityJson true json

Example responses

200 Response

{
  "data": {
    "commercialPledgeAsset": {
      "commercialPledgeId": 3,
      "assetId": 7,
      "pledgeAmount": 2.027123023002322,
      "balanceSheetItem": "balanceSheetItem",
      "description": "description",
      "balanceSheetValue": 9.301444243932576,
      "validityRange": {
        "endDate": "2000-01-23",
        "startDate": "2000-01-23"
      }
    },
    "suretyAsset": {
      "solvency": 7.143538047012306,
      "amount": 3.353193347011243,
      "assetId": 3,
      "description": "description",
      "suretyId": 0
    },
    "evaluations": [
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      },
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      }
    ],
    "insurances": [
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      },
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      }
    ],
    "assetStatusCode": "assetStatusCode",
    "collaterals": [
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      },
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      }
    ],
    "ownerships": [
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      },
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      }
    ],
    "description": "description",
    "depositAsset": {
      "amount": 4.145608029883936,
      "bank": "bank",
      "depositId": 7,
      "description": "description",
      "financialAssetId": 1,
      "accountNumber": "accountNumber",
      "bic": "bic",
      "currencyCode": "currencyCode"
    },
    "securityAsset": {
      "numberOfSecurities": 5,
      "name": "name",
      "description": "description",
      "marketValue": 6.778324963048013,
      "financialAssetId": 2,
      "securityId": 6,
      "currencyCode": "currencyCode",
      "nominalValue": 6.878052220127876
    },
    "assetId": 0,
    "liabilities": [
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      },
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      }
    ],
    "vehicleAsset": {
      "manufacturingYear": 6,
      "registryNumber": "registryNumber",
      "assetId": 7,
      "registrationDate": "2000-01-23",
      "vehicleTypeCode": "vehicleTypeCode",
      "model": "model",
      "vehicleId": 0,
      "factoryIdentification": "factoryIdentification",
      "manufacturer": "manufacturer"
    },
    "assetTypeCode": "assetTypeCode",
    "realEstateAsset": {
      "realEstateId": 3,
      "renovationYear": 6,
      "city": "city",
      "conditionTypeCode": "conditionTypeCode",
      "constructionYear": 6,
      "postalCode": "postalCode",
      "houseNumber": "houseNumber",
      "municipality": "municipality",
      "propertyTypeCode": "propertyTypeCode",
      "description": "description",
      "cityDistrict": "cityDistrict",
      "registryNumber": "registryNumber",
      "assetId": 9,
      "countryCode": "countryCode",
      "street": "street",
      "landPlotArea": 6.438423552598547,
      "effectiveSurfaceArea": 8.762042012749001,
      "floorNumber": 9,
      "totalArea": 1.284659006116532
    }
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_AssetJson_

createAssetOwnershipUsingPOST

Code samples

POST /api/v1/assets/{assetId}/ownership

createAssetOwnership

Add new owners data to assets

Body parameter

{
  "ownerships": [
    {
      "ownershipSize": 0.8008281904610115,
      "ownershipTypeCode": "ownershipTypeCode",
      "personId": 6
    },
    {
      "ownershipSize": 0.8008281904610115,
      "ownershipTypeCode": "ownershipTypeCode",
      "personId": 6
    }
  ]
}

Parameters

Parameter In Type Required Description
assetId path integer(int64) true Reference to abstract asset object
body body CreateAssetOwnershipsJson true json

Example responses

200 Response

{
  "data": {
    "commercialPledgeAsset": {
      "commercialPledgeId": 3,
      "assetId": 7,
      "pledgeAmount": 2.027123023002322,
      "balanceSheetItem": "balanceSheetItem",
      "description": "description",
      "balanceSheetValue": 9.301444243932576,
      "validityRange": {
        "endDate": "2000-01-23",
        "startDate": "2000-01-23"
      }
    },
    "suretyAsset": {
      "solvency": 7.143538047012306,
      "amount": 3.353193347011243,
      "assetId": 3,
      "description": "description",
      "suretyId": 0
    },
    "evaluations": [
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      },
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      }
    ],
    "insurances": [
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      },
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      }
    ],
    "assetStatusCode": "assetStatusCode",
    "collaterals": [
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      },
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      }
    ],
    "ownerships": [
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      },
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      }
    ],
    "description": "description",
    "depositAsset": {
      "amount": 4.145608029883936,
      "bank": "bank",
      "depositId": 7,
      "description": "description",
      "financialAssetId": 1,
      "accountNumber": "accountNumber",
      "bic": "bic",
      "currencyCode": "currencyCode"
    },
    "securityAsset": {
      "numberOfSecurities": 5,
      "name": "name",
      "description": "description",
      "marketValue": 6.778324963048013,
      "financialAssetId": 2,
      "securityId": 6,
      "currencyCode": "currencyCode",
      "nominalValue": 6.878052220127876
    },
    "assetId": 0,
    "liabilities": [
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      },
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      }
    ],
    "vehicleAsset": {
      "manufacturingYear": 6,
      "registryNumber": "registryNumber",
      "assetId": 7,
      "registrationDate": "2000-01-23",
      "vehicleTypeCode": "vehicleTypeCode",
      "model": "model",
      "vehicleId": 0,
      "factoryIdentification": "factoryIdentification",
      "manufacturer": "manufacturer"
    },
    "assetTypeCode": "assetTypeCode",
    "realEstateAsset": {
      "realEstateId": 3,
      "renovationYear": 6,
      "city": "city",
      "conditionTypeCode": "conditionTypeCode",
      "constructionYear": 6,
      "postalCode": "postalCode",
      "houseNumber": "houseNumber",
      "municipality": "municipality",
      "propertyTypeCode": "propertyTypeCode",
      "description": "description",
      "cityDistrict": "cityDistrict",
      "registryNumber": "registryNumber",
      "assetId": 9,
      "countryCode": "countryCode",
      "street": "street",
      "landPlotArea": 6.438423552598547,
      "effectiveSurfaceArea": 8.762042012749001,
      "floorNumber": 9,
      "totalArea": 1.284659006116532
    }
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_AssetJson_

createRealEstateAssetUsingPOST

Code samples

POST /api/v1/assets/{assetId}/real-estate

createRealEstateAsset

Create new real estate asset

Body parameter

{
  "renovationYear": 5,
  "city": "city",
  "conditionTypeCode": "conditionTypeCode",
  "constructionYear": 0,
  "postalCode": "postalCode",
  "houseNumber": "houseNumber",
  "municipality": "municipality",
  "propertyTypeCode": "propertyTypeCode",
  "description": "description",
  "cityDistrict": "cityDistrict",
  "registryNumber": "registryNumber",
  "countryCode": "countryCode",
  "street": "street",
  "landPlotArea": 5.962133916683182,
  "effectiveSurfaceArea": 6.027456183070403,
  "floorNumber": 1,
  "totalArea": 2.3021358869347655
}

Parameters

Parameter In Type Required Description
assetId path integer(int64) true Reference to abstract asset object
body body CreateRealEstateAssetJson true json

Example responses

200 Response

{
  "data": {
    "commercialPledgeAsset": {
      "commercialPledgeId": 3,
      "assetId": 7,
      "pledgeAmount": 2.027123023002322,
      "balanceSheetItem": "balanceSheetItem",
      "description": "description",
      "balanceSheetValue": 9.301444243932576,
      "validityRange": {
        "endDate": "2000-01-23",
        "startDate": "2000-01-23"
      }
    },
    "suretyAsset": {
      "solvency": 7.143538047012306,
      "amount": 3.353193347011243,
      "assetId": 3,
      "description": "description",
      "suretyId": 0
    },
    "evaluations": [
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      },
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      }
    ],
    "insurances": [
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      },
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      }
    ],
    "assetStatusCode": "assetStatusCode",
    "collaterals": [
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      },
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      }
    ],
    "ownerships": [
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      },
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      }
    ],
    "description": "description",
    "depositAsset": {
      "amount": 4.145608029883936,
      "bank": "bank",
      "depositId": 7,
      "description": "description",
      "financialAssetId": 1,
      "accountNumber": "accountNumber",
      "bic": "bic",
      "currencyCode": "currencyCode"
    },
    "securityAsset": {
      "numberOfSecurities": 5,
      "name": "name",
      "description": "description",
      "marketValue": 6.778324963048013,
      "financialAssetId": 2,
      "securityId": 6,
      "currencyCode": "currencyCode",
      "nominalValue": 6.878052220127876
    },
    "assetId": 0,
    "liabilities": [
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      },
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      }
    ],
    "vehicleAsset": {
      "manufacturingYear": 6,
      "registryNumber": "registryNumber",
      "assetId": 7,
      "registrationDate": "2000-01-23",
      "vehicleTypeCode": "vehicleTypeCode",
      "model": "model",
      "vehicleId": 0,
      "factoryIdentification": "factoryIdentification",
      "manufacturer": "manufacturer"
    },
    "assetTypeCode": "assetTypeCode",
    "realEstateAsset": {
      "realEstateId": 3,
      "renovationYear": 6,
      "city": "city",
      "conditionTypeCode": "conditionTypeCode",
      "constructionYear": 6,
      "postalCode": "postalCode",
      "houseNumber": "houseNumber",
      "municipality": "municipality",
      "propertyTypeCode": "propertyTypeCode",
      "description": "description",
      "cityDistrict": "cityDistrict",
      "registryNumber": "registryNumber",
      "assetId": 9,
      "countryCode": "countryCode",
      "street": "street",
      "landPlotArea": 6.438423552598547,
      "effectiveSurfaceArea": 8.762042012749001,
      "floorNumber": 9,
      "totalArea": 1.284659006116532
    }
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_AssetJson_

createSuretyAssetUsingPOST

Code samples

POST /api/v1/assets/{assetId}/surety

createSuretyAsset

Create new surety type of asset

Body parameter

{
  "solvency": 6.027456183070403,
  "amount": 0.8008281904610115,
  "description": "description"
}

Parameters

Parameter In Type Required Description
assetId path integer(int64) true Reference to abstract asset object
body body CreateSuretyAssetJson true json

Example responses

200 Response

{
  "data": {
    "commercialPledgeAsset": {
      "commercialPledgeId": 3,
      "assetId": 7,
      "pledgeAmount": 2.027123023002322,
      "balanceSheetItem": "balanceSheetItem",
      "description": "description",
      "balanceSheetValue": 9.301444243932576,
      "validityRange": {
        "endDate": "2000-01-23",
        "startDate": "2000-01-23"
      }
    },
    "suretyAsset": {
      "solvency": 7.143538047012306,
      "amount": 3.353193347011243,
      "assetId": 3,
      "description": "description",
      "suretyId": 0
    },
    "evaluations": [
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      },
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      }
    ],
    "insurances": [
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      },
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      }
    ],
    "assetStatusCode": "assetStatusCode",
    "collaterals": [
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      },
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      }
    ],
    "ownerships": [
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      },
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      }
    ],
    "description": "description",
    "depositAsset": {
      "amount": 4.145608029883936,
      "bank": "bank",
      "depositId": 7,
      "description": "description",
      "financialAssetId": 1,
      "accountNumber": "accountNumber",
      "bic": "bic",
      "currencyCode": "currencyCode"
    },
    "securityAsset": {
      "numberOfSecurities": 5,
      "name": "name",
      "description": "description",
      "marketValue": 6.778324963048013,
      "financialAssetId": 2,
      "securityId": 6,
      "currencyCode": "currencyCode",
      "nominalValue": 6.878052220127876
    },
    "assetId": 0,
    "liabilities": [
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      },
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      }
    ],
    "vehicleAsset": {
      "manufacturingYear": 6,
      "registryNumber": "registryNumber",
      "assetId": 7,
      "registrationDate": "2000-01-23",
      "vehicleTypeCode": "vehicleTypeCode",
      "model": "model",
      "vehicleId": 0,
      "factoryIdentification": "factoryIdentification",
      "manufacturer": "manufacturer"
    },
    "assetTypeCode": "assetTypeCode",
    "realEstateAsset": {
      "realEstateId": 3,
      "renovationYear": 6,
      "city": "city",
      "conditionTypeCode": "conditionTypeCode",
      "constructionYear": 6,
      "postalCode": "postalCode",
      "houseNumber": "houseNumber",
      "municipality": "municipality",
      "propertyTypeCode": "propertyTypeCode",
      "description": "description",
      "cityDistrict": "cityDistrict",
      "registryNumber": "registryNumber",
      "assetId": 9,
      "countryCode": "countryCode",
      "street": "street",
      "landPlotArea": 6.438423552598547,
      "effectiveSurfaceArea": 8.762042012749001,
      "floorNumber": 9,
      "totalArea": 1.284659006116532
    }
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_AssetJson_

createVehicleAssetUsingPOST

Code samples

POST /api/v1/assets/{assetId}/vehicle

createVehicleAsset

Create new vehicle type of asset

Body parameter

{
  "vehicleIdentificationCode": "vehicleIdentificationCode",
  "manufacturingYear": 0,
  "registryNumber": "registryNumber",
  "vehicleTypeCode": "vehicleTypeCode",
  "model": "model",
  "manufacturer": "manufacturer"
}

Parameters

Parameter In Type Required Description
assetId path integer(int64) true Reference to abstract asset object
body body CreateVehicleAssetJson true json

Example responses

200 Response

{
  "data": {
    "commercialPledgeAsset": {
      "commercialPledgeId": 3,
      "assetId": 7,
      "pledgeAmount": 2.027123023002322,
      "balanceSheetItem": "balanceSheetItem",
      "description": "description",
      "balanceSheetValue": 9.301444243932576,
      "validityRange": {
        "endDate": "2000-01-23",
        "startDate": "2000-01-23"
      }
    },
    "suretyAsset": {
      "solvency": 7.143538047012306,
      "amount": 3.353193347011243,
      "assetId": 3,
      "description": "description",
      "suretyId": 0
    },
    "evaluations": [
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      },
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      }
    ],
    "insurances": [
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      },
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      }
    ],
    "assetStatusCode": "assetStatusCode",
    "collaterals": [
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      },
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      }
    ],
    "ownerships": [
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      },
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      }
    ],
    "description": "description",
    "depositAsset": {
      "amount": 4.145608029883936,
      "bank": "bank",
      "depositId": 7,
      "description": "description",
      "financialAssetId": 1,
      "accountNumber": "accountNumber",
      "bic": "bic",
      "currencyCode": "currencyCode"
    },
    "securityAsset": {
      "numberOfSecurities": 5,
      "name": "name",
      "description": "description",
      "marketValue": 6.778324963048013,
      "financialAssetId": 2,
      "securityId": 6,
      "currencyCode": "currencyCode",
      "nominalValue": 6.878052220127876
    },
    "assetId": 0,
    "liabilities": [
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      },
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      }
    ],
    "vehicleAsset": {
      "manufacturingYear": 6,
      "registryNumber": "registryNumber",
      "assetId": 7,
      "registrationDate": "2000-01-23",
      "vehicleTypeCode": "vehicleTypeCode",
      "model": "model",
      "vehicleId": 0,
      "factoryIdentification": "factoryIdentification",
      "manufacturer": "manufacturer"
    },
    "assetTypeCode": "assetTypeCode",
    "realEstateAsset": {
      "realEstateId": 3,
      "renovationYear": 6,
      "city": "city",
      "conditionTypeCode": "conditionTypeCode",
      "constructionYear": 6,
      "postalCode": "postalCode",
      "houseNumber": "houseNumber",
      "municipality": "municipality",
      "propertyTypeCode": "propertyTypeCode",
      "description": "description",
      "cityDistrict": "cityDistrict",
      "registryNumber": "registryNumber",
      "assetId": 9,
      "countryCode": "countryCode",
      "street": "street",
      "landPlotArea": 6.438423552598547,
      "effectiveSurfaceArea": 8.762042012749001,
      "floorNumber": 9,
      "totalArea": 1.284659006116532
    }
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_AssetJson_

Schemas

AssetEvaluationJson

{
  "evaluationDate": "2000-01-23",
  "valueTypeCode": "valueTypeCode",
  "currencyCode": "currencyCode",
  "value": 1.0246457001441578
}

Properties

Name Type Required Restrictions Description
currencyCode string false none Currency - EUR, GDP, USD etc
evaluationDate string(date) false none Date of asset evaluation
value number false none Evaluated value of asset
valueTypeCode string false none MARKET_VALUE, REPLACEMENT_VALUE, BALANCE_SHEET_VALUE, FUTURE_VALUE, PURCHASE_PRICE, SALES_PRICE

AssetInsuranceJson

{
  "insuranceDate": "2000-01-23",
  "amount": 1.4894159098541704,
  "currencyCode": "currencyCode",
  "insuranceCompany": "insuranceCompany"
}

Properties

Name Type Required Restrictions Description
amount number false none Insurance amount
currencyCode string false none Currency - EUR, GDP, USD etc
insuranceCompany string false none Insurance company
insuranceDate string(date) false none Date of insurance contract

AssetJson

{
  "commercialPledgeAsset": {
    "commercialPledgeId": 3,
    "assetId": 7,
    "pledgeAmount": 2.027123023002322,
    "balanceSheetItem": "balanceSheetItem",
    "description": "description",
    "balanceSheetValue": 9.301444243932576,
    "validityRange": {
      "endDate": "2000-01-23",
      "startDate": "2000-01-23"
    }
  },
  "suretyAsset": {
    "solvency": 7.143538047012306,
    "amount": 3.353193347011243,
    "assetId": 3,
    "description": "description",
    "suretyId": 0
  },
  "evaluations": [
    {
      "evaluationDate": "2000-01-23",
      "valueTypeCode": "valueTypeCode",
      "currencyCode": "currencyCode",
      "value": 1.0246457001441578
    },
    {
      "evaluationDate": "2000-01-23",
      "valueTypeCode": "valueTypeCode",
      "currencyCode": "currencyCode",
      "value": 1.0246457001441578
    }
  ],
  "insurances": [
    {
      "insuranceDate": "2000-01-23",
      "amount": 1.4894159098541704,
      "currencyCode": "currencyCode",
      "insuranceCompany": "insuranceCompany"
    },
    {
      "insuranceDate": "2000-01-23",
      "amount": 1.4894159098541704,
      "currencyCode": "currencyCode",
      "insuranceCompany": "insuranceCompany"
    }
  ],
  "assetStatusCode": "assetStatusCode",
  "collaterals": [
    {
      "availableAmount": 1.4658129805029452,
      "collateralStatusCode": "collateralStatusCode",
      "assetId": 6,
      "collateralAmount": 5.962133916683182,
      "collateralTypeCode": "collateralTypeCode",
      "personId": 2,
      "collateralId": 5,
      "currencyCode": "currencyCode"
    },
    {
      "availableAmount": 1.4658129805029452,
      "collateralStatusCode": "collateralStatusCode",
      "assetId": 6,
      "collateralAmount": 5.962133916683182,
      "collateralTypeCode": "collateralTypeCode",
      "personId": 2,
      "collateralId": 5,
      "currencyCode": "currencyCode"
    }
  ],
  "ownerships": [
    {
      "assetOwnershipId": 4,
      "assetId": 1,
      "ownershipSize": 5.025004791520295,
      "ownershipTypeCode": "ownershipTypeCode",
      "personId": 9
    },
    {
      "assetOwnershipId": 4,
      "assetId": 1,
      "ownershipSize": 5.025004791520295,
      "ownershipTypeCode": "ownershipTypeCode",
      "personId": 9
    }
  ],
  "description": "description",
  "depositAsset": {
    "amount": 4.145608029883936,
    "bank": "bank",
    "depositId": 7,
    "description": "description",
    "financialAssetId": 1,
    "accountNumber": "accountNumber",
    "bic": "bic",
    "currencyCode": "currencyCode"
  },
  "securityAsset": {
    "numberOfSecurities": 5,
    "name": "name",
    "description": "description",
    "marketValue": 6.778324963048013,
    "financialAssetId": 2,
    "securityId": 6,
    "currencyCode": "currencyCode",
    "nominalValue": 6.878052220127876
  },
  "assetId": 0,
  "liabilities": [
    {
      "pledgeAmount": 6.84685269835264,
      "rank": 7,
      "currencyCode": "currencyCode",
      "pledgee": "pledgee"
    },
    {
      "pledgeAmount": 6.84685269835264,
      "rank": 7,
      "currencyCode": "currencyCode",
      "pledgee": "pledgee"
    }
  ],
  "vehicleAsset": {
    "manufacturingYear": 6,
    "registryNumber": "registryNumber",
    "assetId": 7,
    "registrationDate": "2000-01-23",
    "vehicleTypeCode": "vehicleTypeCode",
    "model": "model",
    "vehicleId": 0,
    "factoryIdentification": "factoryIdentification",
    "manufacturer": "manufacturer"
  },
  "assetTypeCode": "assetTypeCode",
  "realEstateAsset": {
    "realEstateId": 3,
    "renovationYear": 6,
    "city": "city",
    "conditionTypeCode": "conditionTypeCode",
    "constructionYear": 6,
    "postalCode": "postalCode",
    "houseNumber": "houseNumber",
    "municipality": "municipality",
    "propertyTypeCode": "propertyTypeCode",
    "description": "description",
    "cityDistrict": "cityDistrict",
    "registryNumber": "registryNumber",
    "assetId": 9,
    "countryCode": "countryCode",
    "street": "street",
    "landPlotArea": 6.438423552598547,
    "effectiveSurfaceArea": 8.762042012749001,
    "floorNumber": 9,
    "totalArea": 1.284659006116532
  }
}

Properties

Name Type Required Restrictions Description
assetId integer(int64) false none Asset unique reference
assetStatusCode string false none NEW, WAITING_FOR_INSURANCE, WAITING_FOR_EVALUATION, ACTIVE, NOT_VALID
assetTypeCode string false none VEHICLE, FINANCIAL_ASSET, SURETY, COMMERCIAL_PLEDGE, BANK_GUARANTEE, REAL_ESTATE
collaterals [CollateralJson] false none none
commercialPledgeAsset CommercialPledgeAssetJson false none none
depositAsset DepositAssetJson false none none
description string false none Description about collateral
evaluations [AssetEvaluationJson] false none none
insurances [AssetInsuranceJson] false none none
liabilities [AssetLiabilityJson] false none [Evaluation describing the known liabilities set against asset]
ownerships [AssetOwnershipJson] false none none
realEstateAsset RealEstateAssetJson false none none
securityAsset SecurityAssetJson false none none
suretyAsset SuretyAssetJson false none none
vehicleAsset VehicleAssetJson false none none

AssetLiabilityJson

{
  "pledgeAmount": 6.84685269835264,
  "rank": 7,
  "currencyCode": "currencyCode",
  "pledgee": "pledgee"
}

Evaluation describing the known liabilities set against asset

Properties

Name Type Required Restrictions Description
currencyCode string false none Currency - EUR, GDP, USD etc
pledgeAmount number false none Pledge amount
pledgee string false none Person having the claim against asset
rank integer(int32) false none Priority of pledge

AssetOwnershipJson

{
  "assetOwnershipId": 4,
  "assetId": 1,
  "ownershipSize": 5.025004791520295,
  "ownershipTypeCode": "ownershipTypeCode",
  "personId": 9
}

Properties

Name Type Required Restrictions Description
assetId integer(int64) false none Reference to asset
assetOwnershipId integer(int64) false none Ownership entry identifier
ownershipSize number false none Size of ownership in percentage
ownershipTypeCode string false none OWNER, CO_OWNER, REPRESENTATIVE
personId integer(int64) false none Reference to ownership object

AssetTypeJson

{
  "insuranceNeeded": true,
  "assetTypeCode": "assetTypeCode",
  "notaryNeeded": true
}

Properties

Name Type Required Restrictions Description
assetTypeCode string false none VEHICLE, FINANCIAL_ASSET, SURETY, COMMERCIAL_PLEDGE, BANK_GUARANTEE, REAL_ESTATE
insuranceNeeded boolean false none Boolean describing if assets needs an active insurance
notaryNeeded boolean false none Boolean describing if asset needs a notary contract to transfer ownership or set pledge against

CollateralAgreementJson

{
  "notary": true,
  "signingDate": "2000-01-23",
  "collateralAgreementId": 0,
  "notaryOffice": "notaryOffice",
  "agreementNumber": "agreementNumber",
  "fileId": 6,
  "statusCode": "statusCode"
}

Properties

Name Type Required Restrictions Description
agreementNumber string false none Contract number
collateralAgreementId integer(int64) false none Reference to agreement object
fileId integer(int64) false none Reference to contracts document if that exists
notary boolean false none Describes if was approved by notary
notaryOffice string false none Name of the notary office
signingDate string(date) false none Date of signing
statusCode string false none CREATED, WAITING_FOR_SIGNING, SIGNED, ACTIVE

CollateralJson

{
  "availableAmount": 1.4658129805029452,
  "collateralStatusCode": "collateralStatusCode",
  "assetId": 6,
  "collateralAmount": 5.962133916683182,
  "collateralTypeCode": "collateralTypeCode",
  "personId": 2,
  "collateralId": 5,
  "currencyCode": "currencyCode"
}

Properties

Name Type Required Restrictions Description
assetId integer(int64) false none Reference to asset used for collateral contract
availableAmount number false none Amount available for usage
collateralAmount number false none Total value of collateral
collateralId integer(int64) false none Collateral identifier
collateralStatusCode string false none NEW, ACTIVE, RELEASED
collateralTypeCode string false none REGULAR, JOIN, SOLIDARITY
currencyCode string false none Currency - EUR, GDP, USD etc
personId integer(int64) false none Reference to customer

CollateralUsageJson

{
  "assetId": 0,
  "pledgeAmount": 5.962133916683182,
  "contractId": 1,
  "rank": 5,
  "main": true,
  "collateralId": 6,
  "collateral": {
    "availableAmount": 1.4658129805029452,
    "collateralStatusCode": "collateralStatusCode",
    "assetId": 6,
    "collateralAmount": 5.962133916683182,
    "collateralTypeCode": "collateralTypeCode",
    "personId": 2,
    "collateralId": 5,
    "currencyCode": "currencyCode"
  },
  "currencyCode": "currencyCode"
}

Properties

Name Type Required Restrictions Description
assetId integer(int64) false none Reference to asset
collateral CollateralJson false none none
collateralId integer(int64) false none Reference to collateral
contractId integer(int64) false none Reference to contract
currencyCode string false none Currency - EUR, GDP, USD etc
main boolean false none Boolean describing if it is the main pledge
pledgeAmount number false none Pledge amount
rank integer(int32) false none Pledge rank

CommercialPledgeAssetJson

{
  "commercialPledgeId": 3,
  "assetId": 7,
  "pledgeAmount": 2.027123023002322,
  "balanceSheetItem": "balanceSheetItem",
  "description": "description",
  "balanceSheetValue": 9.301444243932576,
  "validityRange": {
    "endDate": "2000-01-23",
    "startDate": "2000-01-23"
  }
}

Properties

Name Type Required Restrictions Description
assetId integer(int64) false none Reference to asset
balanceSheetItem string false none Name of the balance sheet item used as an asset
balanceSheetValue number false none Assets value in balance sheet
commercialPledgeId integer(int64) false none Unique identifier
description string false none Description
pledgeAmount number false none Pledge amount
validityRange DateRange false none none

CreateAssetEvaluationJson

{
  "evaluationDate": "2000-01-23",
  "valueTypeCode": "valueTypeCode",
  "currencyCode": "currencyCode",
  "evaluatorId": 0,
  "value": 6.027456183070403
}

Properties

Name Type Required Restrictions Description
currencyCode string false none Currency - EUR, GDP, USD etc
evaluationDate string(date) false none Date when evaluation was done
evaluatorId integer(int64) false none Reference to registered evaluator
value number false none Value
valueTypeCode string false none MARKET_VALUE, REPLACEMENT_VALUE, BALANCE_SHEET_VALUE, FUTURE_VALUE, PURCHASE_PRICE, SALES_PRICE

CreateAssetInsuranceJson

{
  "insuranceDate": "2000-01-23",
  "amount": 0.8008281904610115,
  "description": "description",
  "agreementNumber": "agreementNumber",
  "currencyCode": "currencyCode",
  "insuranceCompany": "insuranceCompany"
}

Properties

Name Type Required Restrictions Description
agreementNumber string false none Contract number
amount number false none Insurance total amount
currencyCode string false none Currency - EUR, GDP, USD etc
description string false none none
insuranceCompany string false none Company issuing insurance
insuranceDate string(date) false none Date of insurance

CreateAssetJson

{
  "description": "description",
  "assetTypeCode": "assetTypeCode"
}

Properties

Name Type Required Restrictions Description
assetTypeCode string false none VEHICLE, FINANCIAL_ASSET, SURETY, COMMERCIAL_PLEDGE, BANK_GUARANTEE, REAL_ESTATE
description string false none none

CreateAssetLiabilityJson

{
  "liabilities": [
    {
      "pledgeAmount": 6.027456183070403,
      "description": "description",
      "rank": 1,
      "currencyCode": "currencyCode",
      "loanAmount": 0.8008281904610115,
      "loanTypeCode": "loanTypeCode",
      "pledgee": "pledgee"
    },
    {
      "pledgeAmount": 6.027456183070403,
      "description": "description",
      "rank": 1,
      "currencyCode": "currencyCode",
      "loanAmount": 0.8008281904610115,
      "loanTypeCode": "loanTypeCode",
      "pledgee": "pledgee"
    }
  ]
}

Properties

Name Type Required Restrictions Description
liabilities [Liability] false none none

CreateAssetOwnershipJson

{
  "ownershipSize": 0.8008281904610115,
  "ownershipTypeCode": "ownershipTypeCode",
  "personId": 6
}

Properties

Name Type Required Restrictions Description
ownershipSize number false none Ownership size in percentage
ownershipTypeCode string false none OWNER, CO_OWNER, REPRESENTATIVE
personId integer(int64) false none Reference to person having the ownership

CreateAssetOwnershipsJson

{
  "ownerships": [
    {
      "ownershipSize": 0.8008281904610115,
      "ownershipTypeCode": "ownershipTypeCode",
      "personId": 6
    },
    {
      "ownershipSize": 0.8008281904610115,
      "ownershipTypeCode": "ownershipTypeCode",
      "personId": 6
    }
  ]
}

Properties

Name Type Required Restrictions Description
ownerships [CreateAssetOwnershipJson] false none none

CreateCollateralJson

{
  "assetId": 0,
  "collateralAgreementId": 6,
  "collateralTypeCode": "collateralTypeCode",
  "expirationDate": "2000-01-23"
}

Properties

Name Type Required Restrictions Description
assetId integer(int64) false none Reference to asset
collateralAgreementId integer(int64) false none Reference to agreement
collateralTypeCode string false none REGULAR, JOIN, SOLIDARITY
expirationDate string(date) false none Date when collateral expires

CreateCollateralRightJson

{
  "personId": 0,
  "loanTypeCode": "loanTypeCode"
}

Properties

Name Type Required Restrictions Description
loanTypeCode string false none none
personId integer(int64) false none Reference to customer

CreateCollateralRightsJson

{
  "rights": [
    {
      "personId": 0,
      "loanTypeCode": "loanTypeCode"
    },
    {
      "personId": 0,
      "loanTypeCode": "loanTypeCode"
    }
  ]
}

Properties

Name Type Required Restrictions Description
rights [CreateCollateralRightJson] false none none

CreateCollateralUsageJson

{
  "contractId": 0,
  "usages": [
    {
      "pledgeAmount": 1.4658129805029452,
      "description": "description",
      "main": true,
      "collateralId": 6
    },
    {
      "pledgeAmount": 1.4658129805029452,
      "description": "description",
      "main": true,
      "collateralId": 6
    }
  ]
}

Properties

Name Type Required Restrictions Description
contractId integer(int64) false none Reference to contract
usages [UsageJson] false none none

CreateCommercialPledgeAssetJson

{
  "pledgeAmount": 6.027456183070403,
  "balanceSheetItem": "balanceSheetItem",
  "description": "description",
  "balanceSheetValue": 0.8008281904610115
}

Properties

Name Type Required Restrictions Description
balanceSheetItem string false none Name of balance sheet item used as asset
balanceSheetValue number false none Asset value in balance sheet
description string false none none
pledgeAmount number false none Value of pledge

CreateDepositAssetJson

{
  "amount": 0.8008281904610115,
  "bank": "bank",
  "description": "description",
  "accountNumber": "accountNumber",
  "bic": "bic",
  "currencyCode": "currencyCode"
}

Properties

Name Type Required Restrictions Description
accountNumber string false none Account IBAN
amount number false none Amount of deposit used as pledge
bank string false none Bank reference
bic string false none none
currencyCode string false none Currency - EUR, GDP, USD etc
description string false none none

CreateFinancialAssetJson

{
  "security": {
    "numberOfSecurities": 5,
    "name": "name",
    "description": "description",
    "marketValue": 6.027456183070403,
    "currencyCode": "currencyCode",
    "nominalValue": 1.4658129805029452
  },
  "deposit": {
    "amount": 0.8008281904610115,
    "bank": "bank",
    "description": "description",
    "accountNumber": "accountNumber",
    "bic": "bic",
    "currencyCode": "currencyCode"
  },
  "financialAssetTypeCode": "financialAssetTypeCode"
}

Properties

Name Type Required Restrictions Description
deposit CreateDepositAssetJson false none none
financialAssetTypeCode string false none none
security CreateSecurityAssetJson false none none

CreateRealEstateAssetJson

{
  "renovationYear": 5,
  "city": "city",
  "conditionTypeCode": "conditionTypeCode",
  "constructionYear": 0,
  "postalCode": "postalCode",
  "houseNumber": "houseNumber",
  "municipality": "municipality",
  "propertyTypeCode": "propertyTypeCode",
  "description": "description",
  "cityDistrict": "cityDistrict",
  "registryNumber": "registryNumber",
  "countryCode": "countryCode",
  "street": "street",
  "landPlotArea": 5.962133916683182,
  "effectiveSurfaceArea": 6.027456183070403,
  "floorNumber": 1,
  "totalArea": 2.3021358869347655
}

Properties

Name Type Required Restrictions Description
city string false none none
cityDistrict string false none none
conditionTypeCode string false none NEW, RENOVATED, NEEDS_SMALL_RENOVATION, NEEDS_BIG_RENOVATION
constructionYear integer(int32) false none none
countryCode string false none none
description string false none none
effectiveSurfaceArea number false none none
floorNumber integer(int32) false none none
houseNumber string false none none
landPlotArea number false none none
municipality string false none none
postalCode string false none none
propertyTypeCode string false none COMMERCIAL_PURPOSE_PLOT, RESIDUAL_PLOT, PRIVATE_HOUSE, HOTEL, INDUSTRIAL_PROPERTY, OFFICE, TERRACED_HOUSE
registryNumber string false none none
renovationYear integer(int32) false none none
street string false none none
totalArea number false none none

CreateSecurityAssetJson

{
  "numberOfSecurities": 5,
  "name": "name",
  "description": "description",
  "marketValue": 6.027456183070403,
  "currencyCode": "currencyCode",
  "nominalValue": 1.4658129805029452
}

Properties

Name Type Required Restrictions Description
currencyCode string false none none
description string false none none
marketValue number false none none
name string false none none
nominalValue number false none none
numberOfSecurities integer(int32) false none none

CreateSuretyAssetJson

{
  "solvency": 6.027456183070403,
  "amount": 0.8008281904610115,
  "description": "description"
}

Properties

Name Type Required Restrictions Description
amount number false none none
description string false none none
solvency number false none none

CreateVehicleAssetJson

{
  "vehicleIdentificationCode": "vehicleIdentificationCode",
  "manufacturingYear": 0,
  "registryNumber": "registryNumber",
  "vehicleTypeCode": "vehicleTypeCode",
  "model": "model",
  "manufacturer": "manufacturer"
}

Properties

Name Type Required Restrictions Description
manufacturer string false none none
manufacturingYear integer(int32) false none none
model string false none none
registryNumber string false none none
vehicleIdentificationCode string false none none
vehicleTypeCode string false none CAR, LORRY, BUS, BOAT, SHIP, PLANE

DateRange

{
  "endDate": "2000-01-23",
  "startDate": "2000-01-23"
}

Properties

Name Type Required Restrictions Description
endDate string(date) false none none
startDate string(date) false none none

DepositAssetJson

{
  "amount": 4.145608029883936,
  "bank": "bank",
  "depositId": 7,
  "description": "description",
  "financialAssetId": 1,
  "accountNumber": "accountNumber",
  "bic": "bic",
  "currencyCode": "currencyCode"
}

Properties

Name Type Required Restrictions Description
accountNumber string false none none
amount number false none none
bank string false none none
bic string false none none
currencyCode string false none none
depositId integer(int64) false none none
description string false none none
financialAssetId integer(int64) false none Reference to financial asset object

Liability

{
  "pledgeAmount": 6.027456183070403,
  "description": "description",
  "rank": 1,
  "currencyCode": "currencyCode",
  "loanAmount": 0.8008281904610115,
  "loanTypeCode": "loanTypeCode",
  "pledgee": "pledgee"
}

Properties

Name Type Required Restrictions Description
currencyCode string false none none
description string false none none
loanAmount number false none none
loanTypeCode string false none none
pledgeAmount number false none none
pledgee string false none none
rank integer(int32) false none none

PostingDateChangeJson

{
  "newPostingDate": "2000-01-23"
}

Properties

Name Type Required Restrictions Description
newPostingDate string(date) false none none

RealEstateAssetJson

{
  "realEstateId": 3,
  "renovationYear": 6,
  "city": "city",
  "conditionTypeCode": "conditionTypeCode",
  "constructionYear": 6,
  "postalCode": "postalCode",
  "houseNumber": "houseNumber",
  "municipality": "municipality",
  "propertyTypeCode": "propertyTypeCode",
  "description": "description",
  "cityDistrict": "cityDistrict",
  "registryNumber": "registryNumber",
  "assetId": 9,
  "countryCode": "countryCode",
  "street": "street",
  "landPlotArea": 6.438423552598547,
  "effectiveSurfaceArea": 8.762042012749001,
  "floorNumber": 9,
  "totalArea": 1.284659006116532
}

Properties

Name Type Required Restrictions Description
assetId integer(int64) false none none
city string false none none
cityDistrict string false none none
conditionTypeCode string false none none
constructionYear integer(int32) false none none
countryCode string false none none
description string false none none
effectiveSurfaceArea number false none none
floorNumber integer(int32) false none none
houseNumber string false none none
landPlotArea number false none none
municipality string false none none
postalCode string false none none
propertyTypeCode string false none none
realEstateId integer(int64) false none none
registryNumber string false none none
renovationYear integer(int32) false none none
street string false none none
totalArea number false none none

SecurityAssetJson

{
  "numberOfSecurities": 5,
  "name": "name",
  "description": "description",
  "marketValue": 6.778324963048013,
  "financialAssetId": 2,
  "securityId": 6,
  "currencyCode": "currencyCode",
  "nominalValue": 6.878052220127876
}

Properties

Name Type Required Restrictions Description
currencyCode string false none none
description string false none none
financialAssetId integer(int64) false none none
marketValue number false none none
name string false none none
nominalValue number false none none
numberOfSecurities integer(int32) false none none
securityId integer(int64) false none none

SignCollateralAgreementJson

{
  "signingDate": "2000-01-23",
  "notaryOffice": "notaryOffice",
  "fileId": 0
}

Properties

Name Type Required Restrictions Description
fileId integer(int64) false none none
notaryOffice string false none none
signingDate string(date) false none none

SuretyAssetJson

{
  "solvency": 7.143538047012306,
  "amount": 3.353193347011243,
  "assetId": 3,
  "description": "description",
  "suretyId": 0
}

Properties

Name Type Required Restrictions Description
amount number false none none
assetId integer(int64) false none none
description string false none none
solvency number false none none
suretyId integer(int64) false none none

UsageJson

{
  "pledgeAmount": 1.4658129805029452,
  "description": "description",
  "main": true,
  "collateralId": 6
}

Properties

Name Type Required Restrictions Description
collateralId integer(int64) false none none
description string false none none
main boolean false none none
pledgeAmount number false none none

VehicleAssetJson

{
  "manufacturingYear": 6,
  "registryNumber": "registryNumber",
  "assetId": 7,
  "registrationDate": "2000-01-23",
  "vehicleTypeCode": "vehicleTypeCode",
  "model": "model",
  "vehicleId": 0,
  "factoryIdentification": "factoryIdentification",
  "manufacturer": "manufacturer"
}

Properties

Name Type Required Restrictions Description
assetId integer(int64) false none none
factoryIdentification string false none none
manufacturer string false none none
manufacturingYear integer(int32) false none none
model string false none none
registrationDate string(date) false none none
registryNumber string false none none
vehicleId integer(int64) false none none
vehicleTypeCode string false none none

ResponseJson_AssetJson_

{
  "data": {
    "commercialPledgeAsset": {
      "commercialPledgeId": 3,
      "assetId": 7,
      "pledgeAmount": 2.027123023002322,
      "balanceSheetItem": "balanceSheetItem",
      "description": "description",
      "balanceSheetValue": 9.301444243932576,
      "validityRange": {
        "endDate": "2000-01-23",
        "startDate": "2000-01-23"
      }
    },
    "suretyAsset": {
      "solvency": 7.143538047012306,
      "amount": 3.353193347011243,
      "assetId": 3,
      "description": "description",
      "suretyId": 0
    },
    "evaluations": [
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      },
      {
        "evaluationDate": "2000-01-23",
        "valueTypeCode": "valueTypeCode",
        "currencyCode": "currencyCode",
        "value": 1.0246457001441578
      }
    ],
    "insurances": [
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      },
      {
        "insuranceDate": "2000-01-23",
        "amount": 1.4894159098541704,
        "currencyCode": "currencyCode",
        "insuranceCompany": "insuranceCompany"
      }
    ],
    "assetStatusCode": "assetStatusCode",
    "collaterals": [
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      },
      {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      }
    ],
    "ownerships": [
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      },
      {
        "assetOwnershipId": 4,
        "assetId": 1,
        "ownershipSize": 5.025004791520295,
        "ownershipTypeCode": "ownershipTypeCode",
        "personId": 9
      }
    ],
    "description": "description",
    "depositAsset": {
      "amount": 4.145608029883936,
      "bank": "bank",
      "depositId": 7,
      "description": "description",
      "financialAssetId": 1,
      "accountNumber": "accountNumber",
      "bic": "bic",
      "currencyCode": "currencyCode"
    },
    "securityAsset": {
      "numberOfSecurities": 5,
      "name": "name",
      "description": "description",
      "marketValue": 6.778324963048013,
      "financialAssetId": 2,
      "securityId": 6,
      "currencyCode": "currencyCode",
      "nominalValue": 6.878052220127876
    },
    "assetId": 0,
    "liabilities": [
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      },
      {
        "pledgeAmount": 6.84685269835264,
        "rank": 7,
        "currencyCode": "currencyCode",
        "pledgee": "pledgee"
      }
    ],
    "vehicleAsset": {
      "manufacturingYear": 6,
      "registryNumber": "registryNumber",
      "assetId": 7,
      "registrationDate": "2000-01-23",
      "vehicleTypeCode": "vehicleTypeCode",
      "model": "model",
      "vehicleId": 0,
      "factoryIdentification": "factoryIdentification",
      "manufacturer": "manufacturer"
    },
    "assetTypeCode": "assetTypeCode",
    "realEstateAsset": {
      "realEstateId": 3,
      "renovationYear": 6,
      "city": "city",
      "conditionTypeCode": "conditionTypeCode",
      "constructionYear": 6,
      "postalCode": "postalCode",
      "houseNumber": "houseNumber",
      "municipality": "municipality",
      "propertyTypeCode": "propertyTypeCode",
      "description": "description",
      "cityDistrict": "cityDistrict",
      "registryNumber": "registryNumber",
      "assetId": 9,
      "countryCode": "countryCode",
      "street": "street",
      "landPlotArea": 6.438423552598547,
      "effectiveSurfaceArea": 8.762042012749001,
      "floorNumber": 9,
      "totalArea": 1.284659006116532
    }
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data AssetJson false none none
errors [string] false none none

ResponseJson_AssetTypeJson_

{
  "data": {
    "insuranceNeeded": true,
    "assetTypeCode": "assetTypeCode",
    "notaryNeeded": true
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data AssetTypeJson false none none
errors [string] false none none

ResponseJson_CollateralAgreementJson_

{
  "data": {
    "notary": true,
    "signingDate": "2000-01-23",
    "collateralAgreementId": 0,
    "notaryOffice": "notaryOffice",
    "agreementNumber": "agreementNumber",
    "fileId": 6,
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data CollateralAgreementJson false none none
errors [string] false none none

ResponseJson_CollateralJson_

{
  "data": {
    "availableAmount": 1.4658129805029452,
    "collateralStatusCode": "collateralStatusCode",
    "assetId": 6,
    "collateralAmount": 5.962133916683182,
    "collateralTypeCode": "collateralTypeCode",
    "personId": 2,
    "collateralId": 5,
    "currencyCode": "currencyCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data CollateralJson false none none
errors [string] false none none

ResponseJson_List_AssetTypeJson_

{
  "data": [
    {
      "insuranceNeeded": true,
      "assetTypeCode": "assetTypeCode",
      "notaryNeeded": true
    },
    {
      "insuranceNeeded": true,
      "assetTypeCode": "assetTypeCode",
      "notaryNeeded": true
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data [AssetTypeJson] false none none
errors [string] false none none

ResponseJson_List_CollateralJson_

{
  "data": [
    {
      "availableAmount": 1.4658129805029452,
      "collateralStatusCode": "collateralStatusCode",
      "assetId": 6,
      "collateralAmount": 5.962133916683182,
      "collateralTypeCode": "collateralTypeCode",
      "personId": 2,
      "collateralId": 5,
      "currencyCode": "currencyCode"
    },
    {
      "availableAmount": 1.4658129805029452,
      "collateralStatusCode": "collateralStatusCode",
      "assetId": 6,
      "collateralAmount": 5.962133916683182,
      "collateralTypeCode": "collateralTypeCode",
      "personId": 2,
      "collateralId": 5,
      "currencyCode": "currencyCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data [CollateralJson] false none none
errors [string] false none none

ResponseJson_List_CollateralUsageJson_

{
  "data": [
    {
      "assetId": 0,
      "pledgeAmount": 5.962133916683182,
      "contractId": 1,
      "rank": 5,
      "main": true,
      "collateralId": 6,
      "collateral": {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      },
      "currencyCode": "currencyCode"
    },
    {
      "assetId": 0,
      "pledgeAmount": 5.962133916683182,
      "contractId": 1,
      "rank": 5,
      "main": true,
      "collateralId": 6,
      "collateral": {
        "availableAmount": 1.4658129805029452,
        "collateralStatusCode": "collateralStatusCode",
        "assetId": 6,
        "collateralAmount": 5.962133916683182,
        "collateralTypeCode": "collateralTypeCode",
        "personId": 2,
        "collateralId": 5,
        "currencyCode": "currencyCode"
      },
      "currencyCode": "currencyCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data [CollateralUsageJson] false none none
errors [string] false none none

ResponseJson_Void_

{
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
errors [string] false none none