GET api/culoancollateral/calculate

Calculate loan collateral values.

Requires Authorisation

The api request must supply authenticated token in a custom variable in the request header. The custom variable name is configured in web.config. The default name of the custom variable is “X-Fern-Token”.

Requires Api License and User Access

The api requires license and user permission for API ID, GETapi/culoancollateral/calculate. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.

Request Information

URI Parameters

Name	Description	Type	Additional information
CULoanCollateralID	Primary key of CULoanCollateral table.	integer
CULoanID	CULoanID - Id of loan that this collateral is held against.	integer
Reference	Reference - user defined information.	string
Description	Description of the collateral.	string
CULoanCollateralTypeID	The type of this collateral.	integer
CustomerID	CustomerID of person holding collateral for this loan.	integer
CUAccountID	Account that has funds held as collateral.	integer
OriginalGrossValue	Gross value initially placed on this collateral.	decimal number	Edits to this field will not be written after the first add.
GrossValue	The current gross collateral value.	decimal number
RealisedValue	Value after CollectionPercentage has been applied.	decimal number
FixedCost	Fixed cost of collecting the collateral.	decimal number
NetValue	RealisedValue - FixedCost	decimal number
ValueDate	ValueDate.	string
ExpiryDate	Collateral expires on this date.	string
ValuerID	Whether the valuer was internal or external.	byte	The value must exist in the MiscellaneousLists table in database.
ValuerName	Name of Valuer.	string
WithholdingRate	If the Collateral Type has "withhold a percentage of balance", this is the % of balance to withhold in the account.	decimal number
GrossValueChanged	Indicates gross value is changed or not.	boolean
FixedValueChanged	Indicates fixed value is changed or not.	boolean
RealisedValueChanged	Indicates realised value is changed or not.	boolean
CollateralTypeChanged	Indicates collateral type is changed or not.	boolean
AccountChanged	Indicates account is changed or not.	boolean
WithholdingRateChanged	Indicates withholding rate is changed or not.	boolean
ValuerChanged	Indicates valuer is changed or not.	boolean
Surveys	Surveys of customer.	Collection of SurveyDto
CollateralActive	Indicates whether collateral is active or not.	boolean

Body Parameters

None.

Response Information

Response Codes

Success Status:

OK (200), please see resource description below.

Failed Status(es):

Resource Description

Calculated loan collateral.

CULoanCollateralDto

Name	Description	Type	Additional information
CULoanCollateralID	Primary key of CULoanCollateral table.	integer
CULoanID	CULoanID - Id of loan that this collateral is held against.	integer
Reference	Reference - user defined information.	string
Description	Description of the collateral.	string
CULoanCollateralTypeID	The type of this collateral.	integer
CustomerID	CustomerID of person holding collateral for this loan.	integer
CUAccountID	Account that has funds held as collateral.	integer
OriginalGrossValue	Gross value initially placed on this collateral.	decimal number	Edits to this field will not be written after the first add.
GrossValue	The current gross collateral value.	decimal number
RealisedValue	Value after CollectionPercentage has been applied.	decimal number
FixedCost	Fixed cost of collecting the collateral.	decimal number
NetValue	RealisedValue - FixedCost	decimal number
ValueDate	ValueDate.	string
ExpiryDate	Collateral expires on this date.	string
ValuerID	Whether the valuer was internal or external.	byte	The value must exist in the MiscellaneousLists table in database.
ValuerName	Name of Valuer.	string
WithholdingRate	If the Collateral Type has "withhold a percentage of balance", this is the % of balance to withhold in the account.	decimal number
GrossValueChanged	Indicates gross value is changed or not.	boolean
FixedValueChanged	Indicates fixed value is changed or not.	boolean
RealisedValueChanged	Indicates realised value is changed or not.	boolean
CollateralTypeChanged	Indicates collateral type is changed or not.	boolean
AccountChanged	Indicates account is changed or not.	boolean
WithholdingRateChanged	Indicates withholding rate is changed or not.	boolean
ValuerChanged	Indicates valuer is changed or not.	boolean
Surveys	Surveys of customer.	Collection of SurveyDto
CollateralActive	Indicates whether collateral is active or not.	boolean

Response Formats

application/json, text/json

Sample:

{
  "cuLoanCollateralID": 1,
  "cuLoanID": 1,
  "reference": "sample string 1",
  "description": "sample string 2",
  "cuLoanCollateralTypeID": 1,
  "customerID": 1,
  "cuAccountID": 1,
  "originalGrossValue": 1.0,
  "grossValue": 1.0,
  "realisedValue": 1.0,
  "fixedCost": 1.0,
  "netValue": 1.0,
  "valueDate": "sample string 3",
  "expiryDate": "sample string 4",
  "valuerID": 64,
  "valuerName": "sample string 5",
  "withholdingRate": 1.1,
  "grossValueChanged": true,
  "fixedValueChanged": true,
  "realisedValueChanged": true,
  "collateralTypeChanged": true,
  "accountChanged": true,
  "withholdingRateChanged": true,
  "valuerChanged": true,
  "surveys": [
    {
      "surveyID": 1,
      "userDefinedFieldGroupID": 1,
      "date": "sample string 1",
      "totalScore": 1.0,
      "udfLinks": [
        {
          "udfLinkID": 1,
          "surveyID": 1,
          "customerID": 1,
          "cuAccountID": 1,
          "productID": 1,
          "cuInsurancePolicyID": 1,
          "receiptNo": 1,
          "branchID": 1,
          "interactionID": 1,
          "cuLoanReviewID": 1,
          "udfFieldID": 1,
          "value": "sample string 1",
          "userDefinedFieldListID": 1,
          "order": 1,
          "mask": "sample string 2",
          "mandatory": true,
          "uniqueField": true,
          "validateActiveUDF": true,
          "udfType": 64,
          "fieldName": "sample string 3",
          "fieldCurrency": 1,
          "dateValue": "sample string 4",
          "customerTypes": 1
        },
        {
          "udfLinkID": 1,
          "surveyID": 1,
          "customerID": 1,
          "cuAccountID": 1,
          "productID": 1,
          "cuInsurancePolicyID": 1,
          "receiptNo": 1,
          "branchID": 1,
          "interactionID": 1,
          "cuLoanReviewID": 1,
          "udfFieldID": 1,
          "value": "sample string 1",
          "userDefinedFieldListID": 1,
          "order": 1,
          "mask": "sample string 2",
          "mandatory": true,
          "uniqueField": true,
          "validateActiveUDF": true,
          "udfType": 64,
          "fieldName": "sample string 3",
          "fieldCurrency": 1,
          "dateValue": "sample string 4",
          "customerTypes": 1
        }
      ]
    },
    {
      "surveyID": 1,
      "userDefinedFieldGroupID": 1,
      "date": "sample string 1",
      "totalScore": 1.0,
      "udfLinks": [
        {
          "udfLinkID": 1,
          "surveyID": 1,
          "customerID": 1,
          "cuAccountID": 1,
          "productID": 1,
          "cuInsurancePolicyID": 1,
          "receiptNo": 1,
          "branchID": 1,
          "interactionID": 1,
          "cuLoanReviewID": 1,
          "udfFieldID": 1,
          "value": "sample string 1",
          "userDefinedFieldListID": 1,
          "order": 1,
          "mask": "sample string 2",
          "mandatory": true,
          "uniqueField": true,
          "validateActiveUDF": true,
          "udfType": 64,
          "fieldName": "sample string 3",
          "fieldCurrency": 1,
          "dateValue": "sample string 4",
          "customerTypes": 1
        },
        {
          "udfLinkID": 1,
          "surveyID": 1,
          "customerID": 1,
          "cuAccountID": 1,
          "productID": 1,
          "cuInsurancePolicyID": 1,
          "receiptNo": 1,
          "branchID": 1,
          "interactionID": 1,
          "cuLoanReviewID": 1,
          "udfFieldID": 1,
          "value": "sample string 1",
          "userDefinedFieldListID": 1,
          "order": 1,
          "mask": "sample string 2",
          "mandatory": true,
          "uniqueField": true,
          "validateActiveUDF": true,
          "udfType": 64,
          "fieldName": "sample string 3",
          "fieldCurrency": 1,
          "dateValue": "sample string 4",
          "customerTypes": 1
        }
      ]
    }
  ],
  "collateralActive": true
}

application/xml, text/xml

Sample:

<CULoanCollateralDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto">
  <AccountChanged>true</AccountChanged>
  <CUAccountID>1</CUAccountID>
  <CULoanCollateralID>1</CULoanCollateralID>
  <CULoanCollateralTypeID>1</CULoanCollateralTypeID>
  <CULoanID>1</CULoanID>
  <CollateralActive>true</CollateralActive>
  <CollateralTypeChanged>true</CollateralTypeChanged>
  <CustomerID>1</CustomerID>
  <Description>sample string 2</Description>
  <ExpiryDate>sample string 4</ExpiryDate>
  <FixedCost>1</FixedCost>
  <FixedValueChanged>true</FixedValueChanged>
  <GrossValue>1</GrossValue>
  <GrossValueChanged>true</GrossValueChanged>
  <NetValue>1</NetValue>
  <OriginalGrossValue>1</OriginalGrossValue>
  <RealisedValue>1</RealisedValue>
  <RealisedValueChanged>true</RealisedValueChanged>
  <Reference>sample string 1</Reference>
  <Surveys>
    <SurveyDto>
      <Date>sample string 1</Date>
      <SurveyID>1</SurveyID>
      <TotalScore>1</TotalScore>
      <UDFLinks xmlns:d4p1="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.UserDefinedFields">
        <d4p1:UserDefinedFieldLinkDto>
          <d4p1:BranchID>1</d4p1:BranchID>
          <d4p1:CUAccountID>1</d4p1:CUAccountID>
          <d4p1:CUInsurancePolicyID>1</d4p1:CUInsurancePolicyID>
          <d4p1:CULoanReviewID>1</d4p1:CULoanReviewID>
          <d4p1:CustomerID>1</d4p1:CustomerID>
          <d4p1:CustomerTypes>1</d4p1:CustomerTypes>
          <d4p1:DateValue>sample string 4</d4p1:DateValue>
          <d4p1:FieldCurrency>1</d4p1:FieldCurrency>
          <d4p1:FieldName>sample string 3</d4p1:FieldName>
          <d4p1:InteractionID>1</d4p1:InteractionID>
          <d4p1:Mandatory>true</d4p1:Mandatory>
          <d4p1:Mask>sample string 2</d4p1:Mask>
          <d4p1:Order>1</d4p1:Order>
          <d4p1:ProductID>1</d4p1:ProductID>
          <d4p1:ReceiptNo>1</d4p1:ReceiptNo>
          <d4p1:SurveyID>1</d4p1:SurveyID>
          <d4p1:UDFFieldID>1</d4p1:UDFFieldID>
          <d4p1:UDFLinkID>1</d4p1:UDFLinkID>
          <d4p1:UDFType>64</d4p1:UDFType>
          <d4p1:UniqueField>true</d4p1:UniqueField>
          <d4p1:UserDefinedFieldListID>1</d4p1:UserDefinedFieldListID>
          <d4p1:ValidateActiveUDF>true</d4p1:ValidateActiveUDF>
          <d4p1:Value>sample string 1</d4p1:Value>
        </d4p1:UserDefinedFieldLinkDto>
        <d4p1:UserDefinedFieldLinkDto>
          <d4p1:BranchID>1</d4p1:BranchID>
          <d4p1:CUAccountID>1</d4p1:CUAccountID>
          <d4p1:CUInsurancePolicyID>1</d4p1:CUInsurancePolicyID>
          <d4p1:CULoanReviewID>1</d4p1:CULoanReviewID>
          <d4p1:CustomerID>1</d4p1:CustomerID>
          <d4p1:CustomerTypes>1</d4p1:CustomerTypes>
          <d4p1:DateValue>sample string 4</d4p1:DateValue>
          <d4p1:FieldCurrency>1</d4p1:FieldCurrency>
          <d4p1:FieldName>sample string 3</d4p1:FieldName>
          <d4p1:InteractionID>1</d4p1:InteractionID>
          <d4p1:Mandatory>true</d4p1:Mandatory>
          <d4p1:Mask>sample string 2</d4p1:Mask>
          <d4p1:Order>1</d4p1:Order>
          <d4p1:ProductID>1</d4p1:ProductID>
          <d4p1:ReceiptNo>1</d4p1:ReceiptNo>
          <d4p1:SurveyID>1</d4p1:SurveyID>
          <d4p1:UDFFieldID>1</d4p1:UDFFieldID>
          <d4p1:UDFLinkID>1</d4p1:UDFLinkID>
          <d4p1:UDFType>64</d4p1:UDFType>
          <d4p1:UniqueField>true</d4p1:UniqueField>
          <d4p1:UserDefinedFieldListID>1</d4p1:UserDefinedFieldListID>
          <d4p1:ValidateActiveUDF>true</d4p1:ValidateActiveUDF>
          <d4p1:Value>sample string 1</d4p1:Value>
        </d4p1:UserDefinedFieldLinkDto>
      </UDFLinks>
      <UserDefinedFieldGroupID>1</UserDefinedFieldGroupID>
    </SurveyDto>
    <SurveyDto>
      <Date>sample string 1</Date>
      <SurveyID>1</SurveyID>
      <TotalScore>1</TotalScore>
      <UDFLinks xmlns:d4p1="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.UserDefinedFields">
        <d4p1:UserDefinedFieldLinkDto>
          <d4p1:BranchID>1</d4p1:BranchID>
          <d4p1:CUAccountID>1</d4p1:CUAccountID>
          <d4p1:CUInsurancePolicyID>1</d4p1:CUInsurancePolicyID>
          <d4p1:CULoanReviewID>1</d4p1:CULoanReviewID>
          <d4p1:CustomerID>1</d4p1:CustomerID>
          <d4p1:CustomerTypes>1</d4p1:CustomerTypes>
          <d4p1:DateValue>sample string 4</d4p1:DateValue>
          <d4p1:FieldCurrency>1</d4p1:FieldCurrency>
          <d4p1:FieldName>sample string 3</d4p1:FieldName>
          <d4p1:InteractionID>1</d4p1:InteractionID>
          <d4p1:Mandatory>true</d4p1:Mandatory>
          <d4p1:Mask>sample string 2</d4p1:Mask>
          <d4p1:Order>1</d4p1:Order>
          <d4p1:ProductID>1</d4p1:ProductID>
          <d4p1:ReceiptNo>1</d4p1:ReceiptNo>
          <d4p1:SurveyID>1</d4p1:SurveyID>
          <d4p1:UDFFieldID>1</d4p1:UDFFieldID>
          <d4p1:UDFLinkID>1</d4p1:UDFLinkID>
          <d4p1:UDFType>64</d4p1:UDFType>
          <d4p1:UniqueField>true</d4p1:UniqueField>
          <d4p1:UserDefinedFieldListID>1</d4p1:UserDefinedFieldListID>
          <d4p1:ValidateActiveUDF>true</d4p1:ValidateActiveUDF>
          <d4p1:Value>sample string 1</d4p1:Value>
        </d4p1:UserDefinedFieldLinkDto>
        <d4p1:UserDefinedFieldLinkDto>
          <d4p1:BranchID>1</d4p1:BranchID>
          <d4p1:CUAccountID>1</d4p1:CUAccountID>
          <d4p1:CUInsurancePolicyID>1</d4p1:CUInsurancePolicyID>
          <d4p1:CULoanReviewID>1</d4p1:CULoanReviewID>
          <d4p1:CustomerID>1</d4p1:CustomerID>
          <d4p1:CustomerTypes>1</d4p1:CustomerTypes>
          <d4p1:DateValue>sample string 4</d4p1:DateValue>
          <d4p1:FieldCurrency>1</d4p1:FieldCurrency>
          <d4p1:FieldName>sample string 3</d4p1:FieldName>
          <d4p1:InteractionID>1</d4p1:InteractionID>
          <d4p1:Mandatory>true</d4p1:Mandatory>
          <d4p1:Mask>sample string 2</d4p1:Mask>
          <d4p1:Order>1</d4p1:Order>
          <d4p1:ProductID>1</d4p1:ProductID>
          <d4p1:ReceiptNo>1</d4p1:ReceiptNo>
          <d4p1:SurveyID>1</d4p1:SurveyID>
          <d4p1:UDFFieldID>1</d4p1:UDFFieldID>
          <d4p1:UDFLinkID>1</d4p1:UDFLinkID>
          <d4p1:UDFType>64</d4p1:UDFType>
          <d4p1:UniqueField>true</d4p1:UniqueField>
          <d4p1:UserDefinedFieldListID>1</d4p1:UserDefinedFieldListID>
          <d4p1:ValidateActiveUDF>true</d4p1:ValidateActiveUDF>
          <d4p1:Value>sample string 1</d4p1:Value>
        </d4p1:UserDefinedFieldLinkDto>
      </UDFLinks>
      <UserDefinedFieldGroupID>1</UserDefinedFieldGroupID>
    </SurveyDto>
  </Surveys>
  <ValueDate>sample string 3</ValueDate>
  <ValuerChanged>true</ValuerChanged>
  <ValuerID>64</ValuerID>
  <ValuerName>sample string 5</ValuerName>
  <WithholdingRate>1.1</WithholdingRate>
  <WithholdingRateChanged>true</WithholdingRateChanged>
</CULoanCollateralDto>