PIpismo
Due date

Update program due date

Update a program due date.

patch/statements-v2/v1/programs/{programId}/due-dates/{programDueDateId}

Request

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

Path parameters

programIdinteger required
Example:1122

Program ID

programDueDateIdinteger required
Example:2

Program due date ID

Request body

activeboolean required

Is program due date active?

<b>Note:</b> If you set active from true to false, this just means that you are no longer able to assign the program due date to an account. Accounts that are already using the program due date continue to use it.

grace_period_daysinteger

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

You can change the grace period days for a statement any time before its due date.

Example request

{
  "active": true,
  "grace_period_days": 5
}

Response

OK - Indicates that the server accepted the request and created the resource.

transaction_statement_shift_idinteger

ID of the shift operation performed

desired_cycle_datestring date

The desired cycle date. This is only present if the shift for the transaction is based on the cycle date. Format is yyyy-mm-dd.

tracking_idstring

Tracking identifier. Must consist of the characters [a-z,A-Z,0-9,-,:] with a range from 1 to 128. If a client clicks the button more than once when sending the command to shift transactions, the Pismo platform could create duplicate requests. The tracking identifier enables the platform to identify duplicates and ignore them.

Example response

{
  "transaction_statement_shift_id": 211452,
  "desired_cycle_date": "2023-12-25",
  "tracking_id": "3ea22692-a209-11eb-89a2-f73e179dcbc2",
  "shifts": [
    {
      "tracking_id": "3ea22692-a209-11eb-89a2-f73e179dcbc2,",
      "shifts": [
        {
          "transaction_id": 10,
          "new_statement_id": 5
        },
        {
          "transaction_id": 11,
          "desired_cycle_date": "2023-12-25"
        }
      ]
    }
  ]
}

Changes

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