POST api/accountportfolio/savetransferportfolioletter

Save handover letters.

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/accountportfolio/savetransferportfolioletter. 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

Account portfolio transfer data.

TransferAccountPortfolioDto

Name	Description	Type
FromPortfolioID	Unique identifier of portfolio to which the fetched accounts belong.	integer
CityID	Unique udentifier of city.	integer
AreaID	Unique udentifier of area.	integer
SuburbID	Unique udentifier of suburb.	integer
LoanProductID	Unique udentifier of loan product.	integer
LoanOfficerID	Unique udentifier of user who is set as loan officer.	integer
SupervisorID	Unique udentifier of user who is set as loan supervisor.	integer
BranchID	Unique udentifier of branch.	integer
LoanTypeID	Unique udentifier loan type.	integer
ToPortfolioID	Unique identifier of portfolio to which the fetched accounts are being transferred.	integer
VillageBankID	Unique identifier of village bank.	integer
SavingsProductID	Unique identifier of savings product .	integer
CUAccountID	Unique identifier of the customer account.	integer
ArrearDaysFrom	Arrear days range (from value).	integer
ArrearDaysTo	Arrear days range (to value).	integer
LetterID	Handover letter ID.	integer
TransferAccountPortfolioList	Collection of fetched account details.	Collection of TransferAccountPortfolioListDto
LetterBatchDto	Collection of transfer account portfolio letter data.	LetterBatchDto

Request Formats

application/json, text/json

Sample:

{
  "fromPortfolioID": 1,
  "cityID": 1,
  "areaID": 1,
  "suburbID": 1,
  "loanProductID": 1,
  "loanOfficerID": 1,
  "supervisorID": 1,
  "branchID": 1,
  "loanTypeID": 1,
  "toPortfolioID": 1,
  "villageBankID": 1,
  "savingsProductID": 1,
  "cuAccountID": 1,
  "arrearDaysFrom": 1,
  "arrearDaysTo": 1,
  "letterID": 1,
  "transferAccountPortfolioList": [
    {
      "fromPortfolioID": 1,
      "toPortfolioID": 1,
      "transferCustomers": true,
      "villageBankID": 1,
      "name": "sample string 1",
      "customerID": 1,
      "loanOfficer": "sample string 2",
      "loanSupervisor": "sample string 3",
      "city": "sample string 4",
      "area": "sample string 5",
      "suburb": "sample string 6",
      "userName": "sample string 7",
      "transferedDate": "sample string 8",
      "cuAccountID": 1,
      "toPortfolio": "sample string 9",
      "currentPortfolio": "sample string 10",
      "address1": "sample string 11",
      "address2": "sample string 12",
      "address3": "sample string 13",
      "account": "sample string 14",
      "amount": 1.0,
      "productType": "sample string 15",
      "isChecked": true,
      "amountString": "sample string 16",
      "phoneNumber": "sample string 17",
      "postalCode": "sample string 18",
      "country": "sample string 19"
    },
    {
      "fromPortfolioID": 1,
      "toPortfolioID": 1,
      "transferCustomers": true,
      "villageBankID": 1,
      "name": "sample string 1",
      "customerID": 1,
      "loanOfficer": "sample string 2",
      "loanSupervisor": "sample string 3",
      "city": "sample string 4",
      "area": "sample string 5",
      "suburb": "sample string 6",
      "userName": "sample string 7",
      "transferedDate": "sample string 8",
      "cuAccountID": 1,
      "toPortfolio": "sample string 9",
      "currentPortfolio": "sample string 10",
      "address1": "sample string 11",
      "address2": "sample string 12",
      "address3": "sample string 13",
      "account": "sample string 14",
      "amount": 1.0,
      "productType": "sample string 15",
      "isChecked": true,
      "amountString": "sample string 16",
      "phoneNumber": "sample string 17",
      "postalCode": "sample string 18",
      "country": "sample string 19"
    }
  ],
  "letterBatchDto": {
    "customerID": 1,
    "cuAccountID": 1,
    "userID": 1,
    "terminalID": 1,
    "customerName": "sample string 1",
    "customerNumber": "sample string 2",
    "isAccountLetterAdded": true,
    "letterBatch": [
      {
        "letterBatchID": 1,
        "letterID": 1,
        "cuAccountID": 1,
        "customerID": 1,
        "letterDescription": "sample string 1",
        "valueDate": "sample string 2",
        "documentID": 1,
        "feeCharged": "sample string 3",
        "cuSessionID": 1,
        "lettersCount": 1,
        "totalFees": 1.0,
        "postedCount": 1,
        "totalPosted": 1.0,
        "failedCount": 1,
        "totalFailed": 1.0,
        "userName": "sample string 4",
        "terminalName": "sample string 5",
        "letterType": 1,
        "fromPortfolioID": 1,
        "toPortfolioID": 1
      },
      {
        "letterBatchID": 1,
        "letterID": 1,
        "cuAccountID": 1,
        "customerID": 1,
        "letterDescription": "sample string 1",
        "valueDate": "sample string 2",
        "documentID": 1,
        "feeCharged": "sample string 3",
        "cuSessionID": 1,
        "lettersCount": 1,
        "totalFees": 1.0,
        "postedCount": 1,
        "totalPosted": 1.0,
        "failedCount": 1,
        "totalFailed": 1.0,
        "userName": "sample string 4",
        "terminalName": "sample string 5",
        "letterType": 1,
        "fromPortfolioID": 1,
        "toPortfolioID": 1
      }
    ],
    "isTransferLetters": true,
    "letterID": 1,
    "letterDescription": "sample string 3"
  }
}

application/xml, text/xml

Sample:

<TransferAccountPortfolioDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.CU.Accounts">
  <AreaID>1</AreaID>
  <ArrearDaysFrom>1</ArrearDaysFrom>
  <ArrearDaysTo>1</ArrearDaysTo>
  <BranchID>1</BranchID>
  <CUAccountID>1</CUAccountID>
  <CityID>1</CityID>
  <FromPortfolioID>1</FromPortfolioID>
  <LetterBatchDto xmlns:d2p1="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.CU">
    <d2p1:CUAccountID>1</d2p1:CUAccountID>
    <d2p1:CustomerID>1</d2p1:CustomerID>
    <d2p1:CustomerName>sample string 1</d2p1:CustomerName>
    <d2p1:CustomerNumber>sample string 2</d2p1:CustomerNumber>
    <d2p1:IsAccountLetterAdded>true</d2p1:IsAccountLetterAdded>
    <d2p1:IsTransferLetters>true</d2p1:IsTransferLetters>
    <d2p1:LetterBatch>
      <d2p1:LetterDto>
        <d2p1:CUAccountID>1</d2p1:CUAccountID>
        <d2p1:CUSessionID>1</d2p1:CUSessionID>
        <d2p1:CustomerID>1</d2p1:CustomerID>
        <d2p1:DocumentID>1</d2p1:DocumentID>
        <d2p1:FailedCount>1</d2p1:FailedCount>
        <d2p1:FeeCharged>sample string 3</d2p1:FeeCharged>
        <d2p1:FromPortfolioID>1</d2p1:FromPortfolioID>
        <d2p1:LetterBatchID>1</d2p1:LetterBatchID>
        <d2p1:LetterDescription>sample string 1</d2p1:LetterDescription>
        <d2p1:LetterID>1</d2p1:LetterID>
        <d2p1:LetterType>1</d2p1:LetterType>
        <d2p1:LettersCount>1</d2p1:LettersCount>
        <d2p1:PostedCount>1</d2p1:PostedCount>
        <d2p1:TerminalName>sample string 5</d2p1:TerminalName>
        <d2p1:ToPortfolioID>1</d2p1:ToPortfolioID>
        <d2p1:TotalFailed>1</d2p1:TotalFailed>
        <d2p1:TotalFees>1</d2p1:TotalFees>
        <d2p1:TotalPosted>1</d2p1:TotalPosted>
        <d2p1:UserName>sample string 4</d2p1:UserName>
        <d2p1:ValueDate>sample string 2</d2p1:ValueDate>
      </d2p1:LetterDto>
      <d2p1:LetterDto>
        <d2p1:CUAccountID>1</d2p1:CUAccountID>
        <d2p1:CUSessionID>1</d2p1:CUSessionID>
        <d2p1:CustomerID>1</d2p1:CustomerID>
        <d2p1:DocumentID>1</d2p1:DocumentID>
        <d2p1:FailedCount>1</d2p1:FailedCount>
        <d2p1:FeeCharged>sample string 3</d2p1:FeeCharged>
        <d2p1:FromPortfolioID>1</d2p1:FromPortfolioID>
        <d2p1:LetterBatchID>1</d2p1:LetterBatchID>
        <d2p1:LetterDescription>sample string 1</d2p1:LetterDescription>
        <d2p1:LetterID>1</d2p1:LetterID>
        <d2p1:LetterType>1</d2p1:LetterType>
        <d2p1:LettersCount>1</d2p1:LettersCount>
        <d2p1:PostedCount>1</d2p1:PostedCount>
        <d2p1:TerminalName>sample string 5</d2p1:TerminalName>
        <d2p1:ToPortfolioID>1</d2p1:ToPortfolioID>
        <d2p1:TotalFailed>1</d2p1:TotalFailed>
        <d2p1:TotalFees>1</d2p1:TotalFees>
        <d2p1:TotalPosted>1</d2p1:TotalPosted>
        <d2p1:UserName>sample string 4</d2p1:UserName>
        <d2p1:ValueDate>sample string 2</d2p1:ValueDate>
      </d2p1:LetterDto>
    </d2p1:LetterBatch>
    <d2p1:LetterDescription>sample string 3</d2p1:LetterDescription>
    <d2p1:LetterID>1</d2p1:LetterID>
    <d2p1:TerminalID>1</d2p1:TerminalID>
    <d2p1:UserID>1</d2p1:UserID>
  </LetterBatchDto>
  <LetterID>1</LetterID>
  <LoanOfficerID>1</LoanOfficerID>
  <LoanProductID>1</LoanProductID>
  <LoanTypeID>1</LoanTypeID>
  <SavingsProductID>1</SavingsProductID>
  <SuburbID>1</SuburbID>
  <SupervisorID>1</SupervisorID>
  <ToPortfolioID>1</ToPortfolioID>
  <TransferAccountPortfolioList>
    <TransferAccountPortfolioListDto>
      <Account>sample string 14</Account>
      <Address1>sample string 11</Address1>
      <Address2>sample string 12</Address2>
      <Address3>sample string 13</Address3>
      <Amount>1</Amount>
      <AmountString>sample string 16</AmountString>
      <Area>sample string 5</Area>
      <CUAccountID>1</CUAccountID>
      <City>sample string 4</City>
      <Country>sample string 19</Country>
      <CurrentPortfolio>sample string 10</CurrentPortfolio>
      <CustomerID>1</CustomerID>
      <FromPortfolioID>1</FromPortfolioID>
      <IsChecked>true</IsChecked>
      <Name>sample string 1</Name>
      <PhoneNumber>sample string 17</PhoneNumber>
      <PostalCode>sample string 18</PostalCode>
      <ProductType>sample string 15</ProductType>
      <Suburb>sample string 6</Suburb>
      <ToPortfolio>sample string 9</ToPortfolio>
      <ToPortfolioID>1</ToPortfolioID>
      <TransferCustomers>true</TransferCustomers>
      <TransferedDate>sample string 8</TransferedDate>
      <VillageBankID>1</VillageBankID>
      <loanOfficer>sample string 2</loanOfficer>
      <loanSupervisor>sample string 3</loanSupervisor>
      <userName>sample string 7</userName>
    </TransferAccountPortfolioListDto>
    <TransferAccountPortfolioListDto>
      <Account>sample string 14</Account>
      <Address1>sample string 11</Address1>
      <Address2>sample string 12</Address2>
      <Address3>sample string 13</Address3>
      <Amount>1</Amount>
      <AmountString>sample string 16</AmountString>
      <Area>sample string 5</Area>
      <CUAccountID>1</CUAccountID>
      <City>sample string 4</City>
      <Country>sample string 19</Country>
      <CurrentPortfolio>sample string 10</CurrentPortfolio>
      <CustomerID>1</CustomerID>
      <FromPortfolioID>1</FromPortfolioID>
      <IsChecked>true</IsChecked>
      <Name>sample string 1</Name>
      <PhoneNumber>sample string 17</PhoneNumber>
      <PostalCode>sample string 18</PostalCode>
      <ProductType>sample string 15</ProductType>
      <Suburb>sample string 6</Suburb>
      <ToPortfolio>sample string 9</ToPortfolio>
      <ToPortfolioID>1</ToPortfolioID>
      <TransferCustomers>true</TransferCustomers>
      <TransferedDate>sample string 8</TransferedDate>
      <VillageBankID>1</VillageBankID>
      <loanOfficer>sample string 2</loanOfficer>
      <loanSupervisor>sample string 3</loanSupervisor>
      <userName>sample string 7</userName>
    </TransferAccountPortfolioListDto>
  </TransferAccountPortfolioList>
  <VillageBankID>1</VillageBankID>
</TransferAccountPortfolioDto>

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.