PIpismo
Accruals

List account accruals v2

List account accruals with filtering options.

<b>Note:</b> 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/accounts/{accountId}/interest-accruals

Request

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

Path parameters

accountIdinteger required
Example:101

Account ID

Query parameters

status'PENDING' | 'PROCESSED' | 'STOP_ACCRUAL'
Example:STOP_ACCRUAL

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.
accrualType'REFINANCING' | 'OVERDUE'
Example:REFINANCING

Interest accrual type.

  • REFINANCING: When payment is greater than the minimum and less than the total balance amount.
  • OVERDUE: When a payment is received that is less than the minimum amount required, the account enters overdue state, and refinancing of that type is calculated.
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:30300

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

beginDatestring date
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
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.

perPageinteger
Example:10

Items per page. Default is 10.

pageinteger
Example:1

Page number

Headers

Authorizationstring required

Account token, not a regular access token. Account tokens are encoded with an account ID. Tokens can expire quickly, which can result in an Unauthorized message.

Response

Ok

pagesinteger

Number of pages

current_pageinteger

Current page

per_pageinteger

Items per page

total_itemsinteger

Number of items found

Example response

{
  "pages": 4,
  "current_page": 2,
  "per_page": 50,
  "total_items": 100,
  "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": "REFINANCING",
      "interest_rate": 0.1,
      "accrued_amount": 1.95,
      "iof_amount": 1.35,
      "fixed_iof_amount": 1.15,
      "status": "PENDING",
      "additional_info": {
        "account_financial_classification": 2
      }
    }
  ]
}

Changes

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