POST api/receipt/override

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/receipt/override. 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

WebReceiptDto

Name	Description	Type	Additional information
Accounts	List of accounts.	Collection of ReceiptLineDto
Fees	Fees due.	Collection of FeeLineDto
IsArrears	Decides whether there is arrears.	boolean
Arrears	Description of arrears for account	string
DaysLate	How many days late the account.	integer
Installment	Number of installments paid vs total	string
DueDate	Due date of next Payment.	string
Payment	Payment amount of the current Installment.	string
AccountRating	Rating of an Account.	string
Due	Amount due including currency code. e.g. "US$500.00"	string
BalanceDate	BalanceDate for savings accounts	string
ClearedFunds	ClearedFunds for savings accounts.	string
Tendered	Amount tendered.	decimal number
Change	Change to give.	decimal number
FieldChanged	Which amount has been changed by the user, e.g. "fees_2_amountPaid" or "tendered"	string
ReceiptType	Type of Receipt, e.g. LoanRepayment	AWReceiptType
Totals	Totals of opening balance paid and closing balance	ReceiptLineDto
ReceiptPrintParameters	Receipt print parameters to print the receipt after successful transaction post.	ReceiptPrintParams	Required for receipt print.
CurrencyID	Currency ID.	integer
ArrearsDays	Arrears days by CUAccountID	Dictionary of integer [key] and integer [value]
WrittenOffInformation	When the account's status is bad debt, show written off information	string
IsTransferAccount		boolean
IsLoanAccount		boolean
Insurance	Insurance line in reversal receipt	InsuranceLineDto
DontSettleLinkedSavings	To exclude linked savings payment	boolean
TempToken	Token for verification of fingerprint on Android.	string
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:

{
  "accounts": [
    {
      "name": "sample string 1",
      "openBalance": 1.0,
      "debitAmount": 1.0,
      "creditAmount": 1.0,
      "amountPaid": 1.0,
      "closingBalance": 1.0,
      "canEditAmount": true,
      "id": "sample string 2"
    },
    {
      "name": "sample string 1",
      "openBalance": 1.0,
      "debitAmount": 1.0,
      "creditAmount": 1.0,
      "amountPaid": 1.0,
      "closingBalance": 1.0,
      "canEditAmount": true,
      "id": "sample string 2"
    }
  ],
  "fees": [
    {
      "cuAccountFeeID": 1,
      "cuFeeID": 1,
      "manuallyAdded": true,
      "canEditAmount": true,
      "adjustFee": true,
      "accountID": 1,
      "paid": true,
      "charged": true,
      "allowAmountChange": true,
      "amount": 1.0,
      "name": "sample string 5",
      "openBalance": 1.0,
      "debitAmount": 1.0,
      "creditAmount": 1.0,
      "amountPaid": 1.0,
      "closingBalance": 1.0,
      "id": "sample string 6"
    },
    {
      "cuAccountFeeID": 1,
      "cuFeeID": 1,
      "manuallyAdded": true,
      "canEditAmount": true,
      "adjustFee": true,
      "accountID": 1,
      "paid": true,
      "charged": true,
      "allowAmountChange": true,
      "amount": 1.0,
      "name": "sample string 5",
      "openBalance": 1.0,
      "debitAmount": 1.0,
      "creditAmount": 1.0,
      "amountPaid": 1.0,
      "closingBalance": 1.0,
      "id": "sample string 6"
    }
  ],
  "isArrears": true,
  "arrears": "sample string 2",
  "daysLate": 1,
  "installment": "sample string 3",
  "dueDate": "sample string 4",
  "payment": "sample string 5",
  "accountRating": "sample string 6",
  "due": "sample string 7",
  "balanceDate": "sample string 8",
  "clearedFunds": "sample string 9",
  "tendered": 1.0,
  "change": 1.0,
  "fieldChanged": "sample string 10",
  "receiptType": 1,
  "totals": {
    "name": "sample string 1",
    "openBalance": 1.0,
    "debitAmount": 1.0,
    "creditAmount": 1.0,
    "amountPaid": 1.0,
    "closingBalance": 1.0,
    "canEditAmount": true,
    "id": "sample string 2"
  },
  "receiptPrintParameters": {
    "receiptNo": 1,
    "branchCode": "sample string 1",
    "hideBalance": true,
    "reprint": true,
    "withCashOutReceipt": true,
    "useDefaultFormat": true,
    "format": "sample string 3",
    "canPrint": true
  },
  "currencyID": 1,
  "arrearsDays": {
    "1": 2,
    "3": 4
  },
  "writtenOffInformation": "sample string 11",
  "fingerPrintURL": null,
  "isTransferAccount": true,
  "isLoanAccount": true,
  "insurance": {
    "cuInsuranceID": 1,
    "insuranceDescription": "sample string 1",
    "isCash": true,
    "insuranceAmount": 1.0,
    "name": "sample string 2",
    "openBalance": 1.0,
    "debitAmount": 1.0,
    "creditAmount": 1.0,
    "amountPaid": 1.0,
    "closingBalance": 1.0,
    "canEditAmount": true,
    "id": "sample string 3"
  },
  "dontSettleLinkedSavings": true,
  "tempToken": "sample string 15",
  "cuAccountID": 1,
  "accountNumber": "sample string 16",
  "amount": 1.0,
  "notes": "sample string 17",
  "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 18",
  "overrideUserName": "sample string 19",
  "overridePassword": "sample string 20"
}

application/xml, text/xml

Sample:

<WebReceiptDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto">
  <AccountNumber>sample string 16</AccountNumber>
  <Amount>1</Amount>
  <CUAccountID>1</CUAccountID>
  <ExternalRefNo>sample string 18</ExternalRefNo>
  <Notes>sample string 17</Notes>
  <OverridePassword>sample string 20</OverridePassword>
  <OverrideUserName>sample string 19</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>
  <AccountRating>sample string 6</AccountRating>
  <Accounts>
    <ReceiptLineDto>
      <AmountPaid>1</AmountPaid>
      <CanEditAmount>true</CanEditAmount>
      <ClosingBalance>1</ClosingBalance>
      <CreditAmount>1</CreditAmount>
      <DebitAmount>1</DebitAmount>
      <Id>sample string 2</Id>
      <Name>sample string 1</Name>
      <OpenBalance>1</OpenBalance>
    </ReceiptLineDto>
    <ReceiptLineDto>
      <AmountPaid>1</AmountPaid>
      <CanEditAmount>true</CanEditAmount>
      <ClosingBalance>1</ClosingBalance>
      <CreditAmount>1</CreditAmount>
      <DebitAmount>1</DebitAmount>
      <Id>sample string 2</Id>
      <Name>sample string 1</Name>
      <OpenBalance>1</OpenBalance>
    </ReceiptLineDto>
  </Accounts>
  <Arrears>sample string 2</Arrears>
  <ArrearsDays xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOflongint>
      <d2p1:Key>1</d2p1:Key>
      <d2p1:Value>2</d2p1:Value>
    </d2p1:KeyValueOflongint>
    <d2p1:KeyValueOflongint>
      <d2p1:Key>3</d2p1:Key>
      <d2p1:Value>4</d2p1:Value>
    </d2p1:KeyValueOflongint>
  </ArrearsDays>
  <BalanceDate>sample string 8</BalanceDate>
  <Change>1</Change>
  <ClearedFunds>sample string 9</ClearedFunds>
  <CurrencyID>1</CurrencyID>
  <DaysLate>1</DaysLate>
  <DontSettleLinkedSavings>true</DontSettleLinkedSavings>
  <Due>sample string 7</Due>
  <DueDate>sample string 4</DueDate>
  <Fees>
    <FeeLineDto>
      <AmountPaid>1</AmountPaid>
      <CanEditAmount i:nil="true" />
      <ClosingBalance>1</ClosingBalance>
      <CreditAmount>1</CreditAmount>
      <DebitAmount>1</DebitAmount>
      <Id>sample string 6</Id>
      <Name>sample string 5</Name>
      <OpenBalance>1</OpenBalance>
      <AccountID>1</AccountID>
      <AdjustFee>true</AdjustFee>
      <AllowAmountChange>true</AllowAmountChange>
      <Amount>1</Amount>
      <CUAccountFeeID>1</CUAccountFeeID>
      <CUFeeID>1</CUFeeID>
      <CanEditAmount>true</CanEditAmount>
      <Charged>true</Charged>
      <ManuallyAdded>true</ManuallyAdded>
      <Paid>true</Paid>
    </FeeLineDto>
    <FeeLineDto>
      <AmountPaid>1</AmountPaid>
      <CanEditAmount i:nil="true" />
      <ClosingBalance>1</ClosingBalance>
      <CreditAmount>1</CreditAmount>
      <DebitAmount>1</DebitAmount>
      <Id>sample string 6</Id>
      <Name>sample string 5</Name>
      <OpenBalance>1</OpenBalance>
      <AccountID>1</AccountID>
      <AdjustFee>true</AdjustFee>
      <AllowAmountChange>true</AllowAmountChange>
      <Amount>1</Amount>
      <CUAccountFeeID>1</CUAccountFeeID>
      <CUFeeID>1</CUFeeID>
      <CanEditAmount>true</CanEditAmount>
      <Charged>true</Charged>
      <ManuallyAdded>true</ManuallyAdded>
      <Paid>true</Paid>
    </FeeLineDto>
  </Fees>
  <FieldChanged>sample string 10</FieldChanged>
  <Installment>sample string 3</Installment>
  <Insurance>
    <AmountPaid>1</AmountPaid>
    <CanEditAmount>true</CanEditAmount>
    <ClosingBalance>1</ClosingBalance>
    <CreditAmount>1</CreditAmount>
    <DebitAmount>1</DebitAmount>
    <Id>sample string 3</Id>
    <Name>sample string 2</Name>
    <OpenBalance>1</OpenBalance>
    <CUInsuranceID>1</CUInsuranceID>
    <InsuranceAmount>1</InsuranceAmount>
    <InsuranceDescription>sample string 1</InsuranceDescription>
    <IsCash>true</IsCash>
  </Insurance>
  <IsArrears>true</IsArrears>
  <IsLoanAccount>true</IsLoanAccount>
  <IsTransferAccount>true</IsTransferAccount>
  <Payment>sample string 5</Payment>
  <ReceiptPrintParameters xmlns:d2p1="http://schemas.datacontract.org/2004/07/Abacus.BusinessRules.Search.Reports">
    <d2p1:BranchCode>sample string 1</d2p1:BranchCode>
    <d2p1:CanPrint>true</d2p1:CanPrint>
    <d2p1:Format>sample string 3</d2p1:Format>
    <d2p1:HideBalance>true</d2p1:HideBalance>
    <d2p1:ReceiptNo>1</d2p1:ReceiptNo>
    <d2p1:Reprint>true</d2p1:Reprint>
    <d2p1:UseDefaultFormat>true</d2p1:UseDefaultFormat>
    <d2p1:WithCashOutReceipt>true</d2p1:WithCashOutReceipt>
  </ReceiptPrintParameters>
  <ReceiptType>SavingsDeposit</ReceiptType>
  <TempToken>sample string 15</TempToken>
  <Tendered>1</Tendered>
  <Totals>
    <AmountPaid>1</AmountPaid>
    <CanEditAmount>true</CanEditAmount>
    <ClosingBalance>1</ClosingBalance>
    <CreditAmount>1</CreditAmount>
    <DebitAmount>1</DebitAmount>
    <Id>sample string 2</Id>
    <Name>sample string 1</Name>
    <OpenBalance>1</OpenBalance>
  </Totals>
  <WrittenOffInformation>sample string 11</WrittenOffInformation>
</WebReceiptDto>

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

Collection of TransactionOverrideDto

Name	Description	Type	Additional information
CUTransactionOverrideID	Unique identifier of transaction override details.	integer
ReceiptNo	Unique identifier of transaction.	integer
CUAccountID	Unique identifier of an account.	integer
OverrideType	Type of override.	byte	Required when user authorize the override.
UserId	Unique identifier of user.	integer
TerminalID	Unique identifier of terminal.	integer
AccountInfo	Information of account : "Account number - Product Name".	string
CurrencyID	Unique identifier of currency.	integer
Amount	Transaction amount.	decimal number	Required when user authorize the override.
Description	Description of override.	string
SplitHeaderID	Represents batch split header ID.	integer
Message	Message which explain the reason to ask override.	string
OverrideTypeText	Description of override.	string
UserName	Username of overriding user.	string	Required when user authorize the override.
TerminalName	Terminal of overriding user.	string
Password	Password for authorising when multiple authorisations are needed.	string	Required when user authorize the override.
Checked	Whether override is selected.	boolean	Required when user authorize the override.
Authorised	Whether override was successfully authorised.	boolean

Response Formats

application/json, text/json

Sample:

[
  {
    "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
  }
]

application/xml, text/xml

Sample:

<ArrayOfTransactionOverrideDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto">
  <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>
</ArrayOfTransactionOverrideDto>