POST api/creditcontrolprocess/add

Create a new credit control process.

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, POSTapi/creditcontrolprocess/add. 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

Credit control process data.

CreditControlProcessDto

Name	Description	Type
StartDate	Last run date of credit control process.	string
StartTime	Appointment Start Time of processed action.	string
CalculationDate	Calculation date of credit control process.	string
LiveLoans	Indicates whether the fetched accounts should be live loans or written off loans.	boolean
CreditControlProcessResultsList	Credit control process list data.	Collection of CreditControlProcessResultsDto

Request Formats

application/json, text/json

Sample:

{
  "startDate": "sample string 1",
  "startTime": "sample string 2",
  "calculationDate": "sample string 3",
  "liveLoans": true,
  "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"
    }
  ]
}

application/xml, text/xml

Sample:

<CreditControlProcessDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.CRM">
  <CalculationDate>sample string 3</CalculationDate>
  <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>
  <LiveLoans>true</LiveLoans>
  <StartDate>sample string 1</StartDate>
  <StartTime>sample string 2</StartTime>
</CreditControlProcessDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response Codes

Success Status:

NoContent (204), the response does not have any content.

Failed Status(es):

Resource Description

None.