POST api/letter

Add Letter Details.

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/letter. 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

Letter batch details.

LetterBatchDto

Name	Description	Type
CustomerID	Customer Id	integer
CUAccountID		integer
UserID	User Id	integer
TerminalID	Terminal Id	integer
CustomerName	Customer Name	string
CustomerNumber	Customer Number	string
IsAccountLetterAdded	Is Account letter Added	boolean
LetterBatch	Collection of Letter (Customer Letter and Account Letter)	Collection of LetterDto
IsTransferLetters	Indicates whether letters are saved from transfer account portfolio screen or not.	boolean
LetterID	LetterID for portfolio transfer screen.	integer
LetterDescription	Letter Description for portfolio transfer screen.	string

Request Formats

application/json, text/json

Sample:

{
  "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:

<LetterBatchDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.CU">
  <CUAccountID>1</CUAccountID>
  <CustomerID>1</CustomerID>
  <CustomerName>sample string 1</CustomerName>
  <CustomerNumber>sample string 2</CustomerNumber>
  <IsAccountLetterAdded>true</IsAccountLetterAdded>
  <IsTransferLetters>true</IsTransferLetters>
  <LetterBatch>
    <LetterDto>
      <CUAccountID>1</CUAccountID>
      <CUSessionID>1</CUSessionID>
      <CustomerID>1</CustomerID>
      <DocumentID>1</DocumentID>
      <FailedCount>1</FailedCount>
      <FeeCharged>sample string 3</FeeCharged>
      <FromPortfolioID>1</FromPortfolioID>
      <LetterBatchID>1</LetterBatchID>
      <LetterDescription>sample string 1</LetterDescription>
      <LetterID>1</LetterID>
      <LetterType>1</LetterType>
      <LettersCount>1</LettersCount>
      <PostedCount>1</PostedCount>
      <TerminalName>sample string 5</TerminalName>
      <ToPortfolioID>1</ToPortfolioID>
      <TotalFailed>1</TotalFailed>
      <TotalFees>1</TotalFees>
      <TotalPosted>1</TotalPosted>
      <UserName>sample string 4</UserName>
      <ValueDate>sample string 2</ValueDate>
    </LetterDto>
    <LetterDto>
      <CUAccountID>1</CUAccountID>
      <CUSessionID>1</CUSessionID>
      <CustomerID>1</CustomerID>
      <DocumentID>1</DocumentID>
      <FailedCount>1</FailedCount>
      <FeeCharged>sample string 3</FeeCharged>
      <FromPortfolioID>1</FromPortfolioID>
      <LetterBatchID>1</LetterBatchID>
      <LetterDescription>sample string 1</LetterDescription>
      <LetterID>1</LetterID>
      <LetterType>1</LetterType>
      <LettersCount>1</LettersCount>
      <PostedCount>1</PostedCount>
      <TerminalName>sample string 5</TerminalName>
      <ToPortfolioID>1</ToPortfolioID>
      <TotalFailed>1</TotalFailed>
      <TotalFees>1</TotalFees>
      <TotalPosted>1</TotalPosted>
      <UserName>sample string 4</UserName>
      <ValueDate>sample string 2</ValueDate>
    </LetterDto>
  </LetterBatch>
  <LetterDescription>sample string 3</LetterDescription>
  <LetterID>1</LetterID>
  <TerminalID>1</TerminalID>
  <UserID>1</UserID>
</LetterBatchDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response Codes

Success Status:

Created (201), please see resource description below.

Failed Status(es):

Resource Description

Return addeds letters.

LetterBatchDto

Name	Description	Type
CustomerID	Customer Id	integer
CUAccountID		integer
UserID	User Id	integer
TerminalID	Terminal Id	integer
CustomerName	Customer Name	string
CustomerNumber	Customer Number	string
IsAccountLetterAdded	Is Account letter Added	boolean
LetterBatch	Collection of Letter (Customer Letter and Account Letter)	Collection of LetterDto
IsTransferLetters	Indicates whether letters are saved from transfer account portfolio screen or not.	boolean
LetterID	LetterID for portfolio transfer screen.	integer
LetterDescription	Letter Description for portfolio transfer screen.	string

Response Formats

application/json, text/json

Sample:

{
  "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:

<LetterBatchDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.CU">
  <CUAccountID>1</CUAccountID>
  <CustomerID>1</CustomerID>
  <CustomerName>sample string 1</CustomerName>
  <CustomerNumber>sample string 2</CustomerNumber>
  <IsAccountLetterAdded>true</IsAccountLetterAdded>
  <IsTransferLetters>true</IsTransferLetters>
  <LetterBatch>
    <LetterDto>
      <CUAccountID>1</CUAccountID>
      <CUSessionID>1</CUSessionID>
      <CustomerID>1</CustomerID>
      <DocumentID>1</DocumentID>
      <FailedCount>1</FailedCount>
      <FeeCharged>sample string 3</FeeCharged>
      <FromPortfolioID>1</FromPortfolioID>
      <LetterBatchID>1</LetterBatchID>
      <LetterDescription>sample string 1</LetterDescription>
      <LetterID>1</LetterID>
      <LetterType>1</LetterType>
      <LettersCount>1</LettersCount>
      <PostedCount>1</PostedCount>
      <TerminalName>sample string 5</TerminalName>
      <ToPortfolioID>1</ToPortfolioID>
      <TotalFailed>1</TotalFailed>
      <TotalFees>1</TotalFees>
      <TotalPosted>1</TotalPosted>
      <UserName>sample string 4</UserName>
      <ValueDate>sample string 2</ValueDate>
    </LetterDto>
    <LetterDto>
      <CUAccountID>1</CUAccountID>
      <CUSessionID>1</CUSessionID>
      <CustomerID>1</CustomerID>
      <DocumentID>1</DocumentID>
      <FailedCount>1</FailedCount>
      <FeeCharged>sample string 3</FeeCharged>
      <FromPortfolioID>1</FromPortfolioID>
      <LetterBatchID>1</LetterBatchID>
      <LetterDescription>sample string 1</LetterDescription>
      <LetterID>1</LetterID>
      <LetterType>1</LetterType>
      <LettersCount>1</LettersCount>
      <PostedCount>1</PostedCount>
      <TerminalName>sample string 5</TerminalName>
      <ToPortfolioID>1</ToPortfolioID>
      <TotalFailed>1</TotalFailed>
      <TotalFees>1</TotalFees>
      <TotalPosted>1</TotalPosted>
      <UserName>sample string 4</UserName>
      <ValueDate>sample string 2</ValueDate>
    </LetterDto>
  </LetterBatch>
  <LetterDescription>sample string 3</LetterDescription>
  <LetterID>1</LetterID>
  <TerminalID>1</TerminalID>
  <UserID>1</UserID>
</LetterBatchDto>