PIpismo
Accruals

Get interest accrual summary

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.

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

Path parameters

accountIdinteger required
Example:101

Account ID

Query parameters

beginDatestring date required
Example:2020-06-18

Beginning date filter. Return statements that have opening date after or equal to this date. Default value is account creation date. Format = yyyy-mm-dd.

endDatestring date required
Example:2020-06-18

End date filter. Return statements that have opening date before or equal to this date. Default value is today's date. Format = yyyy-mm-dd.

omitId'true' | 'false'
Example:true

Omit interest accrual IDs in the API response?

If the period specified using the beginDate and endDate query parameters is greater than 30 days, interest accrual IDs are automatically omitted. Setting omitId to true causes the API to omit interest accrual IDs even when the specified period is 30 days or less. Using this parameter is recommended to improve performance.

accrualType'OVERDUE' | 'REFINANCING' | 'IOF' | 'FINE'
Example:OVERDUE

Interest accrual type. Possible values:

  • OVERDUE: Daily charge applied to an unpaid balance if the minimum amount due (MAD) has not been paid.
  • REFINANCING: Daily charge applied to an unpaid balance if the MAD has been paid, but the total amount due has not.
  • IOF: Brazilian tax
  • FINE: One-time charge that's applied on the day an account becomes overdue.
status'PENDING' | 'PROCESSED' | 'STOP_ACCRUAL' | 'SETTLED' required
Example:PENDING

Status interest accrual filter. Possible values:

  • 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.
  • SETTLED: Accrual transaction has been settled.
pageinteger
Example:1

Page number

perPageinteger
Example:10

Items per page. Default is 10.

Response

Ok

current_pageinteger

Current page

per_pageinteger

Items per page

total_itemsinteger

Number of items found

items_on_pageinteger

Number of items on this page

pagesinteger

Number of pages

is_last_pageboolean

Is this the last page?

Example response

{
  "current_page": 2,
  "per_page": 10,
  "total_items": 100,
  "items_on_page": 5,
  "pages": 4,
  "is_last_page": true,
  "items": [
    {
      "accrual_type": "OVERDUE",
      "status": "PENDING",
      "accrued_value": 1.95,
      "interest_accrual_ids": [
        7,
        8,
        9,
        10,
        11
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.