> For the complete documentation index, see [llms.txt](https://docs.udara360.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.udara360.io/udara360-docs-1/reports/report-api/savings-accrual-report.md).

# Savings Accrual Report

The "Savings Accrual Report" endpoint allows customers to retrieve a history of savings accrual entries for a given account, within a specified date range.

<mark style="color:green;">GET</mark> `/api/Report/v{{version}}/GetSavingsAccrualHistory`

To retrieve the report, you need to provide the query parameters `AccountNumber`, `FinancialDateFrom`, and `FinancialDateTo`, along with `PageNumber` and `PageSize` for pagination.

**Headers**

| Name                                            | Value                |
| ----------------------------------------------- | -------------------- |
| Content-Type<mark style="color:red;">\*</mark>  | `application/json`   |
| Authorization<mark style="color:red;">\*</mark> | `Bearer`             |
| Request-Reference                               | `{unique_reference}` |

**Query Params**

| Name                | Description                                                     |
| ------------------- | --------------------------------------------------------------- |
| `PageNumber`        | The page number to retrieve, for paginated results.             |
| `AccountNumber`     | The account number to retrieve the savings accrual history for. |
| `FinancialDateFrom` | The start of the financial date range to filter results by.     |
| `PageSize`          | The number of records to return per page.                       |
| `FinancialDateTo`   | The end of the financial date range to filter results by.       |

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

<details>

<summary>Sample Request</summary>

```json
curl --location -g '{{baseUrl}}/api/Report/v{{version}}/GetSavingsAccrualHistory?AccountNumber=1301005489&FinancialDateFrom=2023-06-01&FinancialDateTo=2025-06-23&PageNumber=1&PageSize=10'
```

</details>

<details>

<summary>Respose: <code>200</code></summary>

```json
{
  "status": true,
  "message": "string",
  "data": {
    "data": [
      {
        "accountNumber": "string",
        "referenceNumber": "string",
        "productCode": "string",
        "product": "string",
        "branchCode": "string",
        "branch": "string",
        "amount": 0,
        "financialDate": "2025-01-22T23:36:16.938Z"
      }
    ],
    "recordCount": 0
  }
}
```

</details>