Get Customer Account History

To retrieve the customer account history report, send a GET request to the following endpoint:

GET /api/Report/v1/RequestCustomerAccountHistoryReport The request must include the necessary customer identification details in the request query to specify the customer account for which the history report is requested. This process streamlines the retrieval of customer account history reports and effectively manages customer account-related information.

Headers

Name	Value
Content-Type*	application/json
Authorization*	Bearer <token>
Request-Reference	{unique-reference}

Query Parameter

Name	Data Type (length)	Description
accountNumber	string	The account number associated with the transaction
postingReferenceNumber	string	The unique reference number for the posting
instrumentNumber	string	The instrument number related to the transaction
entryCode	string	The code representing the type of financial entry
batchCode	string	The batch code for grouping transactions
financialDateFrom	date	The starting date for the financial activity
financialDateTo	date	The ending date for the financial activity
startDate	date	The start date of the transaction period
endDate	date	The end date of the transaction period
pageNumber	integer	The page number for pagination
pageSize	integer	The number of results per page
sortColumn	string	The column by which the results are sorted
direction	string	The direction of sorting, either Asc (ascending) or Desc

Here is an example request and response with a sample payload sent to the endpoint in Curl format.

Sample Request

curl --location -g '{{baseurl}}/api/Report/v1/RequestCustomerAccountHistoryReport?AccountNumber=1000002992&PostingReferenceNumber=4945858&InstrumentNumber=0002&EntryCode=100&BatchCode=001&FinancialDateFrom=2022-01-01&FinancialDateTo=2022-03-09&StartDate=2022-01-01&EndDate=2022-03-09&PageNumber=1&PageSize=10&SortColumn=StartDate&Direction=Asc' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json' \
--data ''

Respose: 200

{
  "status": true,
  "message": "string",
  "data": {
    "data": [
      {
        "financialDate": "string",
        "transactionDate": "2023-01-29T15:13:21.626Z",
        "accountNumber": "string",
        "accountName": "string",
        "branch": "string",
        "postedBy": "string",
        "approvedBy": "string",
        "postingReferenceNumber": "string",
        "debit": "string",
        "credit": "string",
        "narration": "string",
        "entryCode": "string",
        "instrumentNumber": "string",
        "balance": "string",
        "accessLevel": 0
      }
    ],
    "recordCount": 0
  }
}