GET api/culoancollateraltype

Get all LoanCollateralTypes.

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/culoancollateraltype. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Response Codes

Success Status:

OK (200), please see resource description below.

Failed Status(es):

Resource Description

Collection of CULoanCollateralTypeDto

Name	Description	Type
CULoanCollateralTypeID	Unique ID.	integer
Code	Code.	string
Description	Description.	string
CollectionPercentage	Percentage collected from collateral.	decimal number
CollectionCost	Fixed cost of collection.	decimal number
CanOverrideCollectionData	Net value can be modified.	boolean
AllProducts	If it applies to all loan products.	boolean
LoanProductIDs	Products that this collateral type can be used with.	string
DefaultItem	Default item in the list.	boolean
AllowLinkToAccount	Can be linked to an account.	boolean
LinkedAccounts	Loans with Linked accounts exist for this Collateral type.	integer
IsAccountWithholding	Withholds an amount from an account.	boolean

Response Formats

application/json, text/json

Sample:

[
  {
    "cuLoanCollateralTypeID": 1,
    "code": "sample string 1",
    "description": "sample string 2",
    "collectionPercentage": 1.0,
    "collectionCost": 1.0,
    "canOverrideCollectionData": true,
    "allProducts": true,
    "loanProductIDs": "sample string 3",
    "defaultItem": true,
    "allowLinkToAccount": true,
    "linkedAccounts": 1,
    "isAccountWithholding": true
  },
  {
    "cuLoanCollateralTypeID": 1,
    "code": "sample string 1",
    "description": "sample string 2",
    "collectionPercentage": 1.0,
    "collectionCost": 1.0,
    "canOverrideCollectionData": true,
    "allProducts": true,
    "loanProductIDs": "sample string 3",
    "defaultItem": true,
    "allowLinkToAccount": true,
    "linkedAccounts": 1,
    "isAccountWithholding": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfCULoanCollateralTypeDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto">
  <CULoanCollateralTypeDto>
    <AllProducts>true</AllProducts>
    <AllowLinkToAccount>true</AllowLinkToAccount>
    <CanOverrideCollectionData>true</CanOverrideCollectionData>
    <Code>sample string 1</Code>
    <CollectionCost>1</CollectionCost>
    <CollectionPercentage>1</CollectionPercentage>
    <DefaultItem>true</DefaultItem>
    <Description>sample string 2</Description>
    <IsAccountWithholding>true</IsAccountWithholding>
    <LinkedAccounts>1</LinkedAccounts>
    <LoanProductIDs>sample string 3</LoanProductIDs>
  </CULoanCollateralTypeDto>
  <CULoanCollateralTypeDto>
    <AllProducts>true</AllProducts>
    <AllowLinkToAccount>true</AllowLinkToAccount>
    <CanOverrideCollectionData>true</CanOverrideCollectionData>
    <Code>sample string 1</Code>
    <CollectionCost>1</CollectionCost>
    <CollectionPercentage>1</CollectionPercentage>
    <DefaultItem>true</DefaultItem>
    <Description>sample string 2</Description>
    <IsAccountWithholding>true</IsAccountWithholding>
    <LinkedAccounts>1</LinkedAccounts>
    <LoanProductIDs>sample string 3</LoanProductIDs>
  </CULoanCollateralTypeDto>
</ArrayOfCULoanCollateralTypeDto>