PIpismo
Due date

List program due dates

List a program's due dates with filtering options. If a value for the programDueDateId query parameter is provided, the request returns either a list with only one item or no items if there is no program due date with this ID.

get/statements-v2/v1/programs/{programId}/due-dates

Request

  • Base URL
    https://sandbox.pismolabs.io
  • URL
    https://sandbox.pismolabs.io/statements-v2/v1/programs/{programId}/due-dates
  • Auth
    HTTP bearer

Path parameters

programIdinteger required
Example:1122

Program ID

Query parameters

programDueDateIdinteger
Example:2

Program due date ID

dayinteger
Example:2

Due day (day of the month)

gracePeriodDaysinteger
Example:2

Number of grace period days. Maximum value is 20. This value overrides the value of the <b>Number of days before due date to set the closing date of the statement</b> program parameter for the specified account.

hasGracePeriodboolean

If hasGracePeriod is true, the request returns only program due dates that have a custom grace period configured. If false, it returns only those that don't. If hasGracePeriod is not provided, all program due dates are returned.

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": 50,
  "total_items": 100,
  "items_on_page": 5,
  "pages": 4,
  "is_last_page": true,
  "items": [
    {
      "program_due_date_id": 8287,
      "program_id": 3002,
      "day": 1,
      "active": true,
      "grace_period_days": 0,
      "exists_account": true
    },
    {
      "program_due_date_id": 8292,
      "program_id": 3002,
      "day": 2,
      "active": false,
      "grace_period_days": 0,
      "exists_account": false
    }
  ]
}

Changes

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