Due date

List available due dates

List available due dates with filtering options.

**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/v1/accounts/{accountId}/available-due-dates

Request

Base URL
https://sandbox.pismolabs.io
URL
https://sandbox.pismolabs.io/statements/v1/accounts/{accountId}/available-due-dates
Auth
HTTP bearer

Path parameters

accountIdinteger required

Example:101

Account ID

Query parameters

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.

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

Example response

{
  "available_due_dates": [
    {
      "day": 1,
      "program_due_date_id": 3812,
      "due_date": "2021-05-24",
      "cycle_closing_date": "2021-05-14",
      "best_transaction_day": 1,
      "grace_period_days": 5
    }
  ]
}

Changes

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