PIpismo
Accruals

List account accruals v3

List account accruals with filtering options. You must specify the period using beginDate and endDate, and this period must be less than or equal to 30 days. If you specify a period greater than this, the endpoint returns an error.

The period is restricted to 30 days for performance reasons. A larger period could return a very large number of accruals.

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

Request

  • Base URL
    https://sandbox.pismolabs.io
  • URL
    https://sandbox.pismolabs.io/statements-v2/v3/accounts/{accountId}/interest-accruals
  • 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.

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'
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.
interestAccrualIdinteger
Example:10100

Interest accrual ID. Depending on accrualType, endDate, and beginDate, some filters might be ignored. The other filters can be used concurrently.

transactionIdinteger
Example:20200

Transaction ID. When passed, the accrualType, endDate and beginDate filters are canceled. The other filters can be used concurrently.

statementIdinteger
Example:1

Statement ID

pageinteger
Example:1

Page number

perPageinteger
Example:10

Items per page. Default is 10.

includeNegativeboolean
Example:true

If false, request does not return negative generated accruals. If true, both positive and negative generated accruals are returned. A negative accrual occurs when the Pismo platform receives a payment retroactive to the due date and needs to reverse the positive accruals generated. Default setting is false.

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": [
    {
      "interest_accrual_id": 564,
      "created_at": "2021-08-10T00:00:00",
      "transaction_id": 77489,
      "statement_id": 9497889,
      "transaction_balance": 101.99,
      "accrual_date": "2021-01-01",
      "accrual_type": "OVERDUE",
      "accrued_value": 1.95,
      "status": "PENDING",
      "interest_rate": 15.99,
      "additional_info": {
        "account_financial_classification": 2
      }
    }
  ]
}

Changes

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