GET api/letterprocessing/search

Returns a list of customer.

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/letterprocessing/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
LetterId		integer
Letter		Letter
IsChargeFee		boolean
ScheduleId		integer
ProcessType		CRMProcessTypes
BranchId		integer
IsLimitingResults		boolean
CUName1		string
CUName2		string
CUTypes		integer
CUOpenDate1		date
CUOpenDate2		date
CUClosedState		byte
CULoanToSavRatio1		decimal number
CULoanToSavRatio2		decimal number
CUAge1		integer
CUAge2		integer
CUBatchId		integer
CUBatchStartDate1		date
CUBatchStartDate2		date
CULanguage		string
CULanguageId		integer
CUCulture		string
CUGroupIds		string
AccountCurrencyId		integer
AccountNumber1		string
AccountNumber2		string
AccountBalance1		decimal number
AccountBalance2		decimal number
AccountBalanceDate1		date
AccountBalanceDate2		date
AccountProductId		integer
AccountProductType		integer
AccountExcludeNoAcct		boolean
LoanArrearsBalance1		decimal number
LoanArrearsBalance2		decimal number
LoanArrearsNoPayments1		integer
LoanArrearsNoPayments2		integer
LoanArrearsPeriod1		integer
LoanArrearsPeriod2		integer
LoanArrearsPeriod		ReportPeriods
LoanArrearsPeriodsText		string
LoanAge1		integer
LoanAge2		integer
LoanAgePeriod		ReportPeriods
LoanLastPayment1		integer
LoanLastPayment2		integer
LoanLastPaymentPeriod		ReportPeriods
LoanFinalPaymentDate1		date
LoanFinalPaymentDate2		date
LoanChargedOffState		TriState
LoanStatus		integer
LoanIssueDate1		date
LoanIssueDate2		date
LoanNoOfDaysBeforeDue		integer
LoanUseArrearDays		boolean
LetterBatch		string
Session		CUSession
CurrentUser		AbacusUser
Terminal		Terminal
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

Collection of LetterProcessingSearchResultsDto

Name	Description	Type
IsSelected	Returns true if item is selected.	boolean
CustomerId		integer
Name		string
OpenDate		date
CustomerType		string
BirthDate		date
LetterType		string
SMSConsentGiven		boolean
Accounts		Collection of LetterProcessingSearchResultsChildDto

Response Formats

application/json, text/json

Sample:

[
  {
    "isSelected": true,
    "customerId": 2,
    "name": "sample string 3",
    "openDate": "2019-06-04T21:08:29.9473101-04:00",
    "customerType": "sample string 5",
    "birthDate": "2019-06-04T21:08:29.9473101-04:00",
    "letterType": "sample string 7",
    "smsConsentGiven": true,
    "accounts": [
      {
        "accountNo": "sample string 1",
        "branchName": "sample string 2",
        "productName": "sample string 3",
        "balance": 4.0,
        "balanceDate": "2019-06-04T21:08:29.9473101-04:00",
        "status": "sample string 6"
      },
      {
        "accountNo": "sample string 1",
        "branchName": "sample string 2",
        "productName": "sample string 3",
        "balance": 4.0,
        "balanceDate": "2019-06-04T21:08:29.9473101-04:00",
        "status": "sample string 6"
      }
    ]
  },
  {
    "isSelected": true,
    "customerId": 2,
    "name": "sample string 3",
    "openDate": "2019-06-04T21:08:29.9473101-04:00",
    "customerType": "sample string 5",
    "birthDate": "2019-06-04T21:08:29.9473101-04:00",
    "letterType": "sample string 7",
    "smsConsentGiven": true,
    "accounts": [
      {
        "accountNo": "sample string 1",
        "branchName": "sample string 2",
        "productName": "sample string 3",
        "balance": 4.0,
        "balanceDate": "2019-06-04T21:08:29.9473101-04:00",
        "status": "sample string 6"
      },
      {
        "accountNo": "sample string 1",
        "branchName": "sample string 2",
        "productName": "sample string 3",
        "balance": 4.0,
        "balanceDate": "2019-06-04T21:08:29.9473101-04:00",
        "status": "sample string 6"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfLetterProcessingSearchResultsDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.CRM">
  <LetterProcessingSearchResultsDto>
    <Accounts>
      <LetterProcessingSearchResultsChildDto>
        <AccountNo>sample string 1</AccountNo>
        <Balance>4</Balance>
        <BalanceDate>2019-06-04T21:08:29.9473101-04:00</BalanceDate>
        <BranchName>sample string 2</BranchName>
        <ProductName>sample string 3</ProductName>
        <Status>sample string 6</Status>
      </LetterProcessingSearchResultsChildDto>
      <LetterProcessingSearchResultsChildDto>
        <AccountNo>sample string 1</AccountNo>
        <Balance>4</Balance>
        <BalanceDate>2019-06-04T21:08:29.9473101-04:00</BalanceDate>
        <BranchName>sample string 2</BranchName>
        <ProductName>sample string 3</ProductName>
        <Status>sample string 6</Status>
      </LetterProcessingSearchResultsChildDto>
    </Accounts>
    <BirthDate>2019-06-04T21:08:29.9473101-04:00</BirthDate>
    <CustomerId>2</CustomerId>
    <CustomerType>sample string 5</CustomerType>
    <IsSelected>true</IsSelected>
    <LetterType>sample string 7</LetterType>
    <Name>sample string 3</Name>
    <OpenDate>2019-06-04T21:08:29.9473101-04:00</OpenDate>
    <SMSConsentGiven>true</SMSConsentGiven>
  </LetterProcessingSearchResultsDto>
  <LetterProcessingSearchResultsDto>
    <Accounts>
      <LetterProcessingSearchResultsChildDto>
        <AccountNo>sample string 1</AccountNo>
        <Balance>4</Balance>
        <BalanceDate>2019-06-04T21:08:29.9473101-04:00</BalanceDate>
        <BranchName>sample string 2</BranchName>
        <ProductName>sample string 3</ProductName>
        <Status>sample string 6</Status>
      </LetterProcessingSearchResultsChildDto>
      <LetterProcessingSearchResultsChildDto>
        <AccountNo>sample string 1</AccountNo>
        <Balance>4</Balance>
        <BalanceDate>2019-06-04T21:08:29.9473101-04:00</BalanceDate>
        <BranchName>sample string 2</BranchName>
        <ProductName>sample string 3</ProductName>
        <Status>sample string 6</Status>
      </LetterProcessingSearchResultsChildDto>
    </Accounts>
    <BirthDate>2019-06-04T21:08:29.9473101-04:00</BirthDate>
    <CustomerId>2</CustomerId>
    <CustomerType>sample string 5</CustomerType>
    <IsSelected>true</IsSelected>
    <LetterType>sample string 7</LetterType>
    <Name>sample string 3</Name>
    <OpenDate>2019-06-04T21:08:29.9473101-04:00</OpenDate>
    <SMSConsentGiven>true</SMSConsentGiven>
  </LetterProcessingSearchResultsDto>
</ArrayOfLetterProcessingSearchResultsDto>