---
title: "Get interest accrual summary"
method: GET
path: "/statements-v2/v3/accounts/{accountId}/interest-accruals/summarization"
tags: ["Accruals"]
---

# Get interest accrual summary

`GET /statements-v2/v3/accounts/{accountId}/interest-accruals/summarization`

## Request

- Base URL: `https://sandbox.pismolabs.io`
- URL: `https://sandbox.pismolabs.io/statements-v2/v3/accounts/{accountId}/interest-accruals/summarization`
- Auth: HTTP bearer

Get an account interest accrual summary with filter options.

Using the `beginDate` and `endDate` query parameters, you can specify a time period of up to 60 days. However, for the period between 31 and 60 days, the `interest_accruals_ids` field is omitted in the response. This is done because the list of IDs can get very large for a 60-day period. If you specify a period greater than 60 days, the endpoint returns an error.

**Note:** This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message.

## Path parameters

- `accountId` integer, required

## Query parameters

- `beginDate` string, date, required
- `endDate` string, date, required
- `omitId` 'true' | 'false'
- `accrualType` 'OVERDUE' | 'REFINANCING' | 'IOF' | 'FINE'
- `status` 'PENDING' | 'PROCESSED' | 'STOP_ACCRUAL' | 'SETTLED', required
- `page` integer
- `perPage` integer

## Response `200`

Ok

- InterestAccrualSummarizationListResponse
  - `current_page` integer: Current page
  - `per_page` integer: Items per page
  - `total_items` integer: Number of items found
  - `items_on_page` integer: Number of items on this page
  - `pages` integer: Number of pages
  - `is_last_page` boolean: Is this the last page?
  - `items` object[]
    - `accrual_type` 'OVERDUE' | 'REFINANCING' | 'IOF' | 'FINE': Interest accrual type. Possible values: * `OVERDUE`: A daily charge applied to an unpaid balance if the minimum amount due (MAD) has not been paid. * `REFINANCING`: A daily charge applied to an unpaid balance if the MAD has been paid, but the total amount due has not. * `IOF`: A Brazilian tax * `FINE`: A one-time charge that's applied on the day an account becomes overdue.
    - `status` 'PENDING' | 'PROCESSED' | 'STOP_ACCRUAL' | 'SETTLED': Interest accrual status. * `PENDING`: Accrual has been calculated but has not yet generated a transaction. * `PROCESSED`: Accrual has been processed and a transaction has been generated. * `STOP_ACCRUAL`: Due to a program parameter, the accrual has reached the maximum number of days to be posted as a transaction. For more information, refer to [Limiting the number of days accruals can be charged](doc:limiting-the-number-of-days-accruals-can-be-charged). * `SETTLED`: Accrual transaction has been settled.
    - `accrued_value` number, float: Accrued value
    - `interest_accrual_ids` integer[]: All ID's that are included in the summed interest accrual amount

## Other responses

- `400`: Bad Request
- `500`: Internal Server Error

---

[API](https://skmtc.dev/pismo/apis/revolving-credit-statements.md) - [All operations](https://skmtc.dev/pismo/apis/revolving-credit-statements/llms.txt) - [OpenAPI document](https://skmtc.dev/pismo/apis/revolving-credit-statements/revisions/09f552b0f850?raw)