GET api/creditcontrolprocess/search?StartDate={StartDate}&CalculationDate={CalculationDate}&LiveLoans={LiveLoans}&ResultsLimit={ResultsLimit}

Search credit control processes based on search parameters.

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/creditcontrolprocess/search. 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
StartDate	Last Run Date of Credit Control Process.	string
CalculationDate	Date at which the Credit Control Process Action is run.	string
LiveLoans	If LiveLoans , process only the LiveLoans/Charged off loans , else process written off loans.	boolean
ResultsLimit	Limit the number of results found.	integer	If no value is passed then it will return all the results. If 0 is passed, then no results will be returned.

Body Parameters

None.

Response Information

Response Codes

Success Status:

OK (200), please see resource description below.

Failed Status(es):

Resource Description

Returns accounts with their respective process that matches the search paramenters.

CreditControlDto

Name	Description	Type
CreditControlProcessResultsList	Credit control process list data.	Collection of CreditControlProcessResultsDto
LoanCreditControlProcessList		Collection of LoanCreditControlProcessList
LoanCreditControlProcessExceptionsList		Collection of LoanCreditControlProcessExceptionsList
LettersList		Collection of LetterList

Response Formats

application/json, text/json

Sample:

{
  "creditControlProcessResultsList": [
    {
      "timesProcessed": 1,
      "process": true,
      "display": true,
      "customerID": 1,
      "cuAccountID": 1,
      "cuLoanID": 1,
      "creditControlID": 1,
      "productID": 1,
      "name": "sample string 1",
      "smsConsentGiven": true,
      "accountNumber": "sample string 2",
      "arrearsBalance": 1.0,
      "arrearsPeriods": 1,
      "balanceDate": "sample string 3",
      "paymentPeriodID": 64,
      "paymentPeriodNum": 1,
      "issueDate": "sample string 4",
      "lsRatio": 1.0,
      "itemOrder": 1,
      "colour": 64,
      "cuLoanCreditControlProcessID": 1,
      "creditControlProcessID": 1,
      "processDate": "sample string 5",
      "activityName": "sample string 6",
      "activityType": 1,
      "status": 1,
      "statusString": "sample string 7",
      "arrearsMessage": "sample string 8",
      "balance": 1.0,
      "itemOrderSummaryList": [
        {
          "itemOrderCount": 1,
          "itemOrderDescription": "sample string 2",
          "itemOrderID": 3,
          "creditControlActivityList": [
            {
              "activityCount": 1,
              "activityDescription": "sample string 2",
              "itemOrderID": 3
            },
            {
              "activityCount": 1,
              "activityDescription": "sample string 2",
              "itemOrderID": 3
            }
          ]
        },
        {
          "itemOrderCount": 1,
          "itemOrderDescription": "sample string 2",
          "itemOrderID": 3,
          "creditControlActivityList": [
            {
              "activityCount": 1,
              "activityDescription": "sample string 2",
              "itemOrderID": 3
            },
            {
              "activityCount": 1,
              "activityDescription": "sample string 2",
              "itemOrderID": 3
            }
          ]
        }
      ],
      "processCreditControlID": 1,
      "arrearsString": "sample string 9"
    },
    {
      "timesProcessed": 1,
      "process": true,
      "display": true,
      "customerID": 1,
      "cuAccountID": 1,
      "cuLoanID": 1,
      "creditControlID": 1,
      "productID": 1,
      "name": "sample string 1",
      "smsConsentGiven": true,
      "accountNumber": "sample string 2",
      "arrearsBalance": 1.0,
      "arrearsPeriods": 1,
      "balanceDate": "sample string 3",
      "paymentPeriodID": 64,
      "paymentPeriodNum": 1,
      "issueDate": "sample string 4",
      "lsRatio": 1.0,
      "itemOrder": 1,
      "colour": 64,
      "cuLoanCreditControlProcessID": 1,
      "creditControlProcessID": 1,
      "processDate": "sample string 5",
      "activityName": "sample string 6",
      "activityType": 1,
      "status": 1,
      "statusString": "sample string 7",
      "arrearsMessage": "sample string 8",
      "balance": 1.0,
      "itemOrderSummaryList": [
        {
          "itemOrderCount": 1,
          "itemOrderDescription": "sample string 2",
          "itemOrderID": 3,
          "creditControlActivityList": [
            {
              "activityCount": 1,
              "activityDescription": "sample string 2",
              "itemOrderID": 3
            },
            {
              "activityCount": 1,
              "activityDescription": "sample string 2",
              "itemOrderID": 3
            }
          ]
        },
        {
          "itemOrderCount": 1,
          "itemOrderDescription": "sample string 2",
          "itemOrderID": 3,
          "creditControlActivityList": [
            {
              "activityCount": 1,
              "activityDescription": "sample string 2",
              "itemOrderID": 3
            },
            {
              "activityCount": 1,
              "activityDescription": "sample string 2",
              "itemOrderID": 3
            }
          ]
        }
      ],
      "processCreditControlID": 1,
      "arrearsString": "sample string 9"
    }
  ],
  "loanCreditControlProcessList": [
    {
      "name": "sample string 1",
      "accountNumber": "sample string 2",
      "activityType": 3,
      "activityName": "sample string 4",
      "itemOrder": 64,
      "colour": 64,
      "statusCode": "sample string 7",
      "currencyID": 8,
      "loanPaid": 9.0,
      "intPaid": 10.0,
      "balanceIcon": "QEA=",
      "cuLoanID": 11,
      "creditControlProcessID": 12,
      "cuLoanCreditControlProcessID": 13,
      "customerCRMID": 14,
      "status": 15,
      "balance": 16.0,
      "arrearsAmt": 17.0,
      "arrearsPmts": 18,
      "userID": 19,
      "terminalID": 20,
      "processDate": "2019-06-04T21:07:50.7328425-04:00",
      "serverDate": "2019-06-04T21:07:50.7328425-04:00",
      "timestamp": "QEA=",
      "processing": true,
      "portfolioUserID": 24,
      "completed": true
    },
    {
      "name": "sample string 1",
      "accountNumber": "sample string 2",
      "activityType": 3,
      "activityName": "sample string 4",
      "itemOrder": 64,
      "colour": 64,
      "statusCode": "sample string 7",
      "currencyID": 8,
      "loanPaid": 9.0,
      "intPaid": 10.0,
      "balanceIcon": "QEA=",
      "cuLoanID": 11,
      "creditControlProcessID": 12,
      "cuLoanCreditControlProcessID": 13,
      "customerCRMID": 14,
      "status": 15,
      "balance": 16.0,
      "arrearsAmt": 17.0,
      "arrearsPmts": 18,
      "userID": 19,
      "terminalID": 20,
      "processDate": "2019-06-04T21:07:50.7328425-04:00",
      "serverDate": "2019-06-04T21:07:50.7328425-04:00",
      "timestamp": "QEA=",
      "processing": true,
      "portfolioUserID": 24,
      "completed": true
    }
  ],
  "loanCreditControlProcessExceptionsList": [
    {
      "name": "sample string 1",
      "accountNumber": "sample string 2",
      "activityName": "sample string 3",
      "customerID": 4,
      "cuAccountID": 5,
      "exceptionMessage": "sample string 6"
    },
    {
      "name": "sample string 1",
      "accountNumber": "sample string 2",
      "activityName": "sample string 3",
      "customerID": 4,
      "cuAccountID": 5,
      "exceptionMessage": "sample string 6"
    }
  ],
  "lettersList": [
    {
      "letterID": 1,
      "description": "sample string 2",
      "customerID": 3,
      "cuAccountID": 4,
      "customerName": "sample string 5",
      "letterTypeID": 6
    },
    {
      "letterID": 1,
      "description": "sample string 2",
      "customerID": 3,
      "cuAccountID": 4,
      "customerName": "sample string 5",
      "letterTypeID": 6
    }
  ]
}

application/xml, text/xml

Sample:

<CreditControlDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.CRM">
  <CreditControlProcessResultsList>
    <CreditControlProcessResultsDto>
      <AccountNumber>sample string 2</AccountNumber>
      <ActivityName>sample string 6</ActivityName>
      <ActivityType>Meeting</ActivityType>
      <ArrearsBalance>1</ArrearsBalance>
      <ArrearsMessage>sample string 8</ArrearsMessage>
      <ArrearsPeriods>1</ArrearsPeriods>
      <ArrearsString>sample string 9</ArrearsString>
      <Balance>1</Balance>
      <BalanceDate>sample string 3</BalanceDate>
      <CUAccountID>1</CUAccountID>
      <CULoanCreditControlProcessID>1</CULoanCreditControlProcessID>
      <CULoanID>1</CULoanID>
      <Colour>64</Colour>
      <CreditControlID>1</CreditControlID>
      <CreditControlProcessID>1</CreditControlProcessID>
      <CustomerID>1</CustomerID>
      <Display>true</Display>
      <IssueDate>sample string 4</IssueDate>
      <ItemOrder>1</ItemOrder>
      <ItemOrderSummaryList xmlns:d4p1="http://schemas.datacontract.org/2004/07/Abacus.BusinessRules.CU.Accounts">
        <d4p1:CreditControlItems>
          <d4p1:CreditControlActivityList>
            <d4p1:CreditControlActivity>
              <d4p1:ActivityCount>1</d4p1:ActivityCount>
              <d4p1:ActivityDescription>sample string 2</d4p1:ActivityDescription>
              <d4p1:ItemOrderID>3</d4p1:ItemOrderID>
            </d4p1:CreditControlActivity>
            <d4p1:CreditControlActivity>
              <d4p1:ActivityCount>1</d4p1:ActivityCount>
              <d4p1:ActivityDescription>sample string 2</d4p1:ActivityDescription>
              <d4p1:ItemOrderID>3</d4p1:ItemOrderID>
            </d4p1:CreditControlActivity>
          </d4p1:CreditControlActivityList>
          <d4p1:ItemOrderCount>1</d4p1:ItemOrderCount>
          <d4p1:ItemOrderDescription>sample string 2</d4p1:ItemOrderDescription>
          <d4p1:ItemOrderID>3</d4p1:ItemOrderID>
        </d4p1:CreditControlItems>
        <d4p1:CreditControlItems>
          <d4p1:CreditControlActivityList>
            <d4p1:CreditControlActivity>
              <d4p1:ActivityCount>1</d4p1:ActivityCount>
              <d4p1:ActivityDescription>sample string 2</d4p1:ActivityDescription>
              <d4p1:ItemOrderID>3</d4p1:ItemOrderID>
            </d4p1:CreditControlActivity>
            <d4p1:CreditControlActivity>
              <d4p1:ActivityCount>1</d4p1:ActivityCount>
              <d4p1:ActivityDescription>sample string 2</d4p1:ActivityDescription>
              <d4p1:ItemOrderID>3</d4p1:ItemOrderID>
            </d4p1:CreditControlActivity>
          </d4p1:CreditControlActivityList>
          <d4p1:ItemOrderCount>1</d4p1:ItemOrderCount>
          <d4p1:ItemOrderDescription>sample string 2</d4p1:ItemOrderDescription>
          <d4p1:ItemOrderID>3</d4p1:ItemOrderID>
        </d4p1:CreditControlItems>
      </ItemOrderSummaryList>
      <LSRatio>1</LSRatio>
      <Name>sample string 1</Name>
      <PaymentPeriodID>64</PaymentPeriodID>
      <PaymentPeriodNum>1</PaymentPeriodNum>
      <Process>true</Process>
      <ProcessCreditControlID>1</ProcessCreditControlID>
      <ProcessDate>sample string 5</ProcessDate>
      <ProductID>1</ProductID>
      <SMSConsentGiven>true</SMSConsentGiven>
      <Status>NotProcessed</Status>
      <StatusString>sample string 7</StatusString>
      <TimesProcessed>1</TimesProcessed>
    </CreditControlProcessResultsDto>
    <CreditControlProcessResultsDto>
      <AccountNumber>sample string 2</AccountNumber>
      <ActivityName>sample string 6</ActivityName>
      <ActivityType>Meeting</ActivityType>
      <ArrearsBalance>1</ArrearsBalance>
      <ArrearsMessage>sample string 8</ArrearsMessage>
      <ArrearsPeriods>1</ArrearsPeriods>
      <ArrearsString>sample string 9</ArrearsString>
      <Balance>1</Balance>
      <BalanceDate>sample string 3</BalanceDate>
      <CUAccountID>1</CUAccountID>
      <CULoanCreditControlProcessID>1</CULoanCreditControlProcessID>
      <CULoanID>1</CULoanID>
      <Colour>64</Colour>
      <CreditControlID>1</CreditControlID>
      <CreditControlProcessID>1</CreditControlProcessID>
      <CustomerID>1</CustomerID>
      <Display>true</Display>
      <IssueDate>sample string 4</IssueDate>
      <ItemOrder>1</ItemOrder>
      <ItemOrderSummaryList xmlns:d4p1="http://schemas.datacontract.org/2004/07/Abacus.BusinessRules.CU.Accounts">
        <d4p1:CreditControlItems>
          <d4p1:CreditControlActivityList>
            <d4p1:CreditControlActivity>
              <d4p1:ActivityCount>1</d4p1:ActivityCount>
              <d4p1:ActivityDescription>sample string 2</d4p1:ActivityDescription>
              <d4p1:ItemOrderID>3</d4p1:ItemOrderID>
            </d4p1:CreditControlActivity>
            <d4p1:CreditControlActivity>
              <d4p1:ActivityCount>1</d4p1:ActivityCount>
              <d4p1:ActivityDescription>sample string 2</d4p1:ActivityDescription>
              <d4p1:ItemOrderID>3</d4p1:ItemOrderID>
            </d4p1:CreditControlActivity>
          </d4p1:CreditControlActivityList>
          <d4p1:ItemOrderCount>1</d4p1:ItemOrderCount>
          <d4p1:ItemOrderDescription>sample string 2</d4p1:ItemOrderDescription>
          <d4p1:ItemOrderID>3</d4p1:ItemOrderID>
        </d4p1:CreditControlItems>
        <d4p1:CreditControlItems>
          <d4p1:CreditControlActivityList>
            <d4p1:CreditControlActivity>
              <d4p1:ActivityCount>1</d4p1:ActivityCount>
              <d4p1:ActivityDescription>sample string 2</d4p1:ActivityDescription>
              <d4p1:ItemOrderID>3</d4p1:ItemOrderID>
            </d4p1:CreditControlActivity>
            <d4p1:CreditControlActivity>
              <d4p1:ActivityCount>1</d4p1:ActivityCount>
              <d4p1:ActivityDescription>sample string 2</d4p1:ActivityDescription>
              <d4p1:ItemOrderID>3</d4p1:ItemOrderID>
            </d4p1:CreditControlActivity>
          </d4p1:CreditControlActivityList>
          <d4p1:ItemOrderCount>1</d4p1:ItemOrderCount>
          <d4p1:ItemOrderDescription>sample string 2</d4p1:ItemOrderDescription>
          <d4p1:ItemOrderID>3</d4p1:ItemOrderID>
        </d4p1:CreditControlItems>
      </ItemOrderSummaryList>
      <LSRatio>1</LSRatio>
      <Name>sample string 1</Name>
      <PaymentPeriodID>64</PaymentPeriodID>
      <PaymentPeriodNum>1</PaymentPeriodNum>
      <Process>true</Process>
      <ProcessCreditControlID>1</ProcessCreditControlID>
      <ProcessDate>sample string 5</ProcessDate>
      <ProductID>1</ProductID>
      <SMSConsentGiven>true</SMSConsentGiven>
      <Status>NotProcessed</Status>
      <StatusString>sample string 7</StatusString>
      <TimesProcessed>1</TimesProcessed>
    </CreditControlProcessResultsDto>
  </CreditControlProcessResultsList>
  <LettersList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Abacus.BusinessRules.CU.Accounts">
    <d2p1:LetterList>
      <d2p1:CUAccountID>4</d2p1:CUAccountID>
      <d2p1:CustomerID>3</d2p1:CustomerID>
      <d2p1:CustomerName>sample string 5</d2p1:CustomerName>
      <d2p1:Description>sample string 2</d2p1:Description>
      <d2p1:LetterID>1</d2p1:LetterID>
      <d2p1:LetterTypeID>6</d2p1:LetterTypeID>
    </d2p1:LetterList>
    <d2p1:LetterList>
      <d2p1:CUAccountID>4</d2p1:CUAccountID>
      <d2p1:CustomerID>3</d2p1:CustomerID>
      <d2p1:CustomerName>sample string 5</d2p1:CustomerName>
      <d2p1:Description>sample string 2</d2p1:Description>
      <d2p1:LetterID>1</d2p1:LetterID>
      <d2p1:LetterTypeID>6</d2p1:LetterTypeID>
    </d2p1:LetterList>
  </LettersList>
  <LoanCreditControlProcessExceptionsList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Abacus.BusinessRules.CU.Accounts">
    <d2p1:LoanCreditControlProcessExceptionsList>
      <d2p1:AccountNumber>sample string 2</d2p1:AccountNumber>
      <d2p1:ActivityName>sample string 3</d2p1:ActivityName>
      <d2p1:CUAccountID>5</d2p1:CUAccountID>
      <d2p1:CustomerID>4</d2p1:CustomerID>
      <d2p1:ExceptionMessage>sample string 6</d2p1:ExceptionMessage>
      <d2p1:Name>sample string 1</d2p1:Name>
    </d2p1:LoanCreditControlProcessExceptionsList>
    <d2p1:LoanCreditControlProcessExceptionsList>
      <d2p1:AccountNumber>sample string 2</d2p1:AccountNumber>
      <d2p1:ActivityName>sample string 3</d2p1:ActivityName>
      <d2p1:CUAccountID>5</d2p1:CUAccountID>
      <d2p1:CustomerID>4</d2p1:CustomerID>
      <d2p1:ExceptionMessage>sample string 6</d2p1:ExceptionMessage>
      <d2p1:Name>sample string 1</d2p1:Name>
    </d2p1:LoanCreditControlProcessExceptionsList>
  </LoanCreditControlProcessExceptionsList>
  <LoanCreditControlProcessList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Abacus.BusinessRules.CU.Accounts">
    <d2p1:LoanCreditControlProcessList>
      <d2p1:AccountNumber>sample string 2</d2p1:AccountNumber>
      <d2p1:ActivityName>sample string 4</d2p1:ActivityName>
      <d2p1:ActivityType>3</d2p1:ActivityType>
      <d2p1:ArrearsAmt>17</d2p1:ArrearsAmt>
      <d2p1:ArrearsPmts>18</d2p1:ArrearsPmts>
      <d2p1:Balance>16</d2p1:Balance>
      <d2p1:BalanceIcon>QEA=</d2p1:BalanceIcon>
      <d2p1:CULoanCreditControlProcessID>13</d2p1:CULoanCreditControlProcessID>
      <d2p1:CULoanID>11</d2p1:CULoanID>
      <d2p1:Colour>64</d2p1:Colour>
      <d2p1:Completed>true</d2p1:Completed>
      <d2p1:CreditControlProcessID>12</d2p1:CreditControlProcessID>
      <d2p1:CurrencyID>8</d2p1:CurrencyID>
      <d2p1:CustomerCRMID>14</d2p1:CustomerCRMID>
      <d2p1:IntPaid>10</d2p1:IntPaid>
      <d2p1:ItemOrder>64</d2p1:ItemOrder>
      <d2p1:LoanPaid>9</d2p1:LoanPaid>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:PortfolioUserID>24</d2p1:PortfolioUserID>
      <d2p1:ProcessDate>2019-06-04T21:07:50.7328425-04:00</d2p1:ProcessDate>
      <d2p1:Processing>true</d2p1:Processing>
      <d2p1:ServerDate>2019-06-04T21:07:50.7328425-04:00</d2p1:ServerDate>
      <d2p1:Status>15</d2p1:Status>
      <d2p1:StatusCode>sample string 7</d2p1:StatusCode>
      <d2p1:TerminalID>20</d2p1:TerminalID>
      <d2p1:Timestamp>QEA=</d2p1:Timestamp>
      <d2p1:UserID>19</d2p1:UserID>
    </d2p1:LoanCreditControlProcessList>
    <d2p1:LoanCreditControlProcessList>
      <d2p1:AccountNumber>sample string 2</d2p1:AccountNumber>
      <d2p1:ActivityName>sample string 4</d2p1:ActivityName>
      <d2p1:ActivityType>3</d2p1:ActivityType>
      <d2p1:ArrearsAmt>17</d2p1:ArrearsAmt>
      <d2p1:ArrearsPmts>18</d2p1:ArrearsPmts>
      <d2p1:Balance>16</d2p1:Balance>
      <d2p1:BalanceIcon>QEA=</d2p1:BalanceIcon>
      <d2p1:CULoanCreditControlProcessID>13</d2p1:CULoanCreditControlProcessID>
      <d2p1:CULoanID>11</d2p1:CULoanID>
      <d2p1:Colour>64</d2p1:Colour>
      <d2p1:Completed>true</d2p1:Completed>
      <d2p1:CreditControlProcessID>12</d2p1:CreditControlProcessID>
      <d2p1:CurrencyID>8</d2p1:CurrencyID>
      <d2p1:CustomerCRMID>14</d2p1:CustomerCRMID>
      <d2p1:IntPaid>10</d2p1:IntPaid>
      <d2p1:ItemOrder>64</d2p1:ItemOrder>
      <d2p1:LoanPaid>9</d2p1:LoanPaid>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:PortfolioUserID>24</d2p1:PortfolioUserID>
      <d2p1:ProcessDate>2019-06-04T21:07:50.7328425-04:00</d2p1:ProcessDate>
      <d2p1:Processing>true</d2p1:Processing>
      <d2p1:ServerDate>2019-06-04T21:07:50.7328425-04:00</d2p1:ServerDate>
      <d2p1:Status>15</d2p1:Status>
      <d2p1:StatusCode>sample string 7</d2p1:StatusCode>
      <d2p1:TerminalID>20</d2p1:TerminalID>
      <d2p1:Timestamp>QEA=</d2p1:Timestamp>
      <d2p1:UserID>19</d2p1:UserID>
    </d2p1:LoanCreditControlProcessList>
  </LoanCreditControlProcessList>
</CreditControlDto>