POST api/transaction/adjustment

Adjust the loan transactions in a particular receipt.

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/transaction/adjustment. 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

Receipt transaction data.

ReceiptAdjustmentDto

Name	Description	Type	Additional information
Password	Password to authorize the transaction if required.	string	Optional. - If 'Require user password for reversals and adjustments?' is disabled
AdjustmentReceiptNumber	The receipt number that need to be adjusted.	integer	Required for reversal and adjustments not for other transactions.
CUAccountID	Unique identifier of an account. Either CUAccountID or AccountNumber id required for receipt adjustment.	integer	Required. If it is not available, account number is required.
AccountNumber	Account number represent customer's account. Either CUAccountID or AccountNumber id required for receipt adjustment.	string	Required. If it is not available, CUAccountID is required.
Amount	Transaction amount. Amount is not required for receipt adjustment.	decimal number	Required.
Notes	Transaction notes which will be added as a reference.	string	Optional. It will be mandtory for adjustments as per system settings.
TransactionOverrides	Transaction Override details.	Collection of TransactionOverrideDto	Read-Only.
ReceiptNo	Unique identifier of a receipt.	integer	Required for reversal and adjustments not for other transactions.
ExternalRefNo	Transaction refernce number for identify external transactions.	string	Optional.It contains null for all internal transactions
OverrideUserName	User's name who authorize the transaction if the transaction requires override authorization.	string	Required if there is an override. Optional otherwise.
OverridePassword	Password of the user who authorize the transaction if the transaction requires override authorization.	string	Required if there is an override. Optional otherwise.

Request Formats

application/json, text/json

Sample:

{
  "password": "sample string 1",
  "adjustmentReceiptNumber": 1,
  "cuAccountID": 1,
  "accountNumber": "sample string 2",
  "amount": 1.0,
  "notes": "sample string 3",
  "transactionOverrides": [
    {
      "cuTransactionOverrideID": 1,
      "receiptNo": 1,
      "cuAccountID": 1,
      "overrideType": 64,
      "userId": 1,
      "terminalID": 1,
      "accountInfo": "sample string 1",
      "currencyID": 1,
      "amount": 1.0,
      "description": "sample string 2",
      "splitHeaderID": 1,
      "message": "sample string 3",
      "overrideTypeText": "sample string 4",
      "userName": "sample string 5",
      "terminalName": "sample string 6",
      "password": "sample string 7",
      "checked": true,
      "authorised": true
    },
    {
      "cuTransactionOverrideID": 1,
      "receiptNo": 1,
      "cuAccountID": 1,
      "overrideType": 64,
      "userId": 1,
      "terminalID": 1,
      "accountInfo": "sample string 1",
      "currencyID": 1,
      "amount": 1.0,
      "description": "sample string 2",
      "splitHeaderID": 1,
      "message": "sample string 3",
      "overrideTypeText": "sample string 4",
      "userName": "sample string 5",
      "terminalName": "sample string 6",
      "password": "sample string 7",
      "checked": true,
      "authorised": true
    }
  ],
  "receiptNo": 1,
  "hasOverride": true,
  "externalRefNo": "sample string 4",
  "overrideUserName": "sample string 5",
  "overridePassword": "sample string 6"
}

application/xml, text/xml

Sample:

<ReceiptAdjustmentDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto">
  <AccountNumber>sample string 2</AccountNumber>
  <Amount>1</Amount>
  <CUAccountID>1</CUAccountID>
  <ExternalRefNo>sample string 4</ExternalRefNo>
  <Notes>sample string 3</Notes>
  <OverridePassword>sample string 6</OverridePassword>
  <OverrideUserName>sample string 5</OverrideUserName>
  <ReceiptNo>1</ReceiptNo>
  <TransactionOverrides>
    <TransactionOverrideDto>
      <AccountInfo>sample string 1</AccountInfo>
      <Amount>1</Amount>
      <Authorised>true</Authorised>
      <CUAccountID>1</CUAccountID>
      <CUTransactionOverrideID>1</CUTransactionOverrideID>
      <Checked>true</Checked>
      <CurrencyID>1</CurrencyID>
      <Description>sample string 2</Description>
      <Message>sample string 3</Message>
      <OverrideType>64</OverrideType>
      <OverrideTypeText>sample string 4</OverrideTypeText>
      <Password>sample string 7</Password>
      <ReceiptNo>1</ReceiptNo>
      <SplitHeaderID>1</SplitHeaderID>
      <TerminalID>1</TerminalID>
      <TerminalName>sample string 6</TerminalName>
      <UserId>1</UserId>
      <UserName>sample string 5</UserName>
    </TransactionOverrideDto>
    <TransactionOverrideDto>
      <AccountInfo>sample string 1</AccountInfo>
      <Amount>1</Amount>
      <Authorised>true</Authorised>
      <CUAccountID>1</CUAccountID>
      <CUTransactionOverrideID>1</CUTransactionOverrideID>
      <Checked>true</Checked>
      <CurrencyID>1</CurrencyID>
      <Description>sample string 2</Description>
      <Message>sample string 3</Message>
      <OverrideType>64</OverrideType>
      <OverrideTypeText>sample string 4</OverrideTypeText>
      <Password>sample string 7</Password>
      <ReceiptNo>1</ReceiptNo>
      <SplitHeaderID>1</SplitHeaderID>
      <TerminalID>1</TerminalID>
      <TerminalName>sample string 6</TerminalName>
      <UserId>1</UserId>
      <UserName>sample string 5</UserName>
    </TransactionOverrideDto>
  </TransactionOverrides>
  <AdjustmentReceiptNumber>1</AdjustmentReceiptNumber>
  <Password>sample string 1</Password>
</ReceiptAdjustmentDto>

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

Returns created receipt.

ReceiptAdjustmentDto

Name	Description	Type	Additional information
Password	Password to authorize the transaction if required.	string	Optional. - If 'Require user password for reversals and adjustments?' is disabled
AdjustmentReceiptNumber	The receipt number that need to be adjusted.	integer	Required for reversal and adjustments not for other transactions.
CUAccountID	Unique identifier of an account. Either CUAccountID or AccountNumber id required for receipt adjustment.	integer	Required. If it is not available, account number is required.
AccountNumber	Account number represent customer's account. Either CUAccountID or AccountNumber id required for receipt adjustment.	string	Required. If it is not available, CUAccountID is required.
Amount	Transaction amount. Amount is not required for receipt adjustment.	decimal number	Required.
Notes	Transaction notes which will be added as a reference.	string	Optional. It will be mandtory for adjustments as per system settings.
TransactionOverrides	Transaction Override details.	Collection of TransactionOverrideDto	Read-Only.
ReceiptNo	Unique identifier of a receipt.	integer	Required for reversal and adjustments not for other transactions.
HasOverride	Whether receipt is failed due to override required.	boolean	Read-Only. If it is true find the override info using TransactionOverrides property.
ExternalRefNo	Transaction refernce number for identify external transactions.	string	Optional.It contains null for all internal transactions
OverrideUserName	User's name who authorize the transaction if the transaction requires override authorization.	string	Required if there is an override. Optional otherwise.
OverridePassword	Password of the user who authorize the transaction if the transaction requires override authorization.	string	Required if there is an override. Optional otherwise.

Response Formats

application/json, text/json

Sample:

{
  "password": "sample string 1",
  "adjustmentReceiptNumber": 1,
  "cuAccountID": 1,
  "accountNumber": "sample string 2",
  "amount": 1.0,
  "notes": "sample string 3",
  "transactionOverrides": [
    {
      "cuTransactionOverrideID": 1,
      "receiptNo": 1,
      "cuAccountID": 1,
      "overrideType": 64,
      "userId": 1,
      "terminalID": 1,
      "accountInfo": "sample string 1",
      "currencyID": 1,
      "amount": 1.0,
      "description": "sample string 2",
      "splitHeaderID": 1,
      "message": "sample string 3",
      "overrideTypeText": "sample string 4",
      "userName": "sample string 5",
      "terminalName": "sample string 6",
      "password": "sample string 7",
      "checked": true,
      "authorised": true
    },
    {
      "cuTransactionOverrideID": 1,
      "receiptNo": 1,
      "cuAccountID": 1,
      "overrideType": 64,
      "userId": 1,
      "terminalID": 1,
      "accountInfo": "sample string 1",
      "currencyID": 1,
      "amount": 1.0,
      "description": "sample string 2",
      "splitHeaderID": 1,
      "message": "sample string 3",
      "overrideTypeText": "sample string 4",
      "userName": "sample string 5",
      "terminalName": "sample string 6",
      "password": "sample string 7",
      "checked": true,
      "authorised": true
    }
  ],
  "receiptNo": 1,
  "hasOverride": true,
  "externalRefNo": "sample string 4",
  "overrideUserName": "sample string 5",
  "overridePassword": "sample string 6"
}

application/xml, text/xml

Sample:

<ReceiptAdjustmentDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto">
  <AccountNumber>sample string 2</AccountNumber>
  <Amount>1</Amount>
  <CUAccountID>1</CUAccountID>
  <ExternalRefNo>sample string 4</ExternalRefNo>
  <Notes>sample string 3</Notes>
  <OverridePassword>sample string 6</OverridePassword>
  <OverrideUserName>sample string 5</OverrideUserName>
  <ReceiptNo>1</ReceiptNo>
  <TransactionOverrides>
    <TransactionOverrideDto>
      <AccountInfo>sample string 1</AccountInfo>
      <Amount>1</Amount>
      <Authorised>true</Authorised>
      <CUAccountID>1</CUAccountID>
      <CUTransactionOverrideID>1</CUTransactionOverrideID>
      <Checked>true</Checked>
      <CurrencyID>1</CurrencyID>
      <Description>sample string 2</Description>
      <Message>sample string 3</Message>
      <OverrideType>64</OverrideType>
      <OverrideTypeText>sample string 4</OverrideTypeText>
      <Password>sample string 7</Password>
      <ReceiptNo>1</ReceiptNo>
      <SplitHeaderID>1</SplitHeaderID>
      <TerminalID>1</TerminalID>
      <TerminalName>sample string 6</TerminalName>
      <UserId>1</UserId>
      <UserName>sample string 5</UserName>
    </TransactionOverrideDto>
    <TransactionOverrideDto>
      <AccountInfo>sample string 1</AccountInfo>
      <Amount>1</Amount>
      <Authorised>true</Authorised>
      <CUAccountID>1</CUAccountID>
      <CUTransactionOverrideID>1</CUTransactionOverrideID>
      <Checked>true</Checked>
      <CurrencyID>1</CurrencyID>
      <Description>sample string 2</Description>
      <Message>sample string 3</Message>
      <OverrideType>64</OverrideType>
      <OverrideTypeText>sample string 4</OverrideTypeText>
      <Password>sample string 7</Password>
      <ReceiptNo>1</ReceiptNo>
      <SplitHeaderID>1</SplitHeaderID>
      <TerminalID>1</TerminalID>
      <TerminalName>sample string 6</TerminalName>
      <UserId>1</UserId>
      <UserName>sample string 5</UserName>
    </TransactionOverrideDto>
  </TransactionOverrides>
  <AdjustmentReceiptNumber>1</AdjustmentReceiptNumber>
  <Password>sample string 1</Password>
</ReceiptAdjustmentDto>