PIpismo
Holidays (deprecated)

Create holiday (deprecated)

DEPRECATED. Call the Add holiday endpoint instead.

Create a holiday—a day on which your company's offices are closed for normal business activity though online financial transactions and other business activity could still be occurring.

For more information, refer to <a href="https://developers.pismo.io/pismo-docs/docs/platform-setup-holidays">Platform setup - Holidays and administrative divisions</a>.

post/holidays-core/v1/holiday

Request

  • Base URL
    https://sandbox.pismolabs.io/holidays-core
  • URL
    https://sandbox.pismolabs.io/holidays-core/holidays-core/v1/holiday
  • Auth
    HTTP bearer

Request body

namestring required

Holiday name

holiday_datestring required

Holiday date. Format = yyyy-mm-dd.

working_datestring date required

Next work day following the holiday. Format = yyyy-mm-dd.

administrative_division_idinteger

Administrative division ID.

When passed as a parameter, either this or external_id is REQUIRED.

external_idstring

Existing ID value from another process or application.

When passed as a parameter, either this or administrative_division_id is REQUIRED.

Example request

{
  "name": "New Year's Day",
  "holiday_date": "2023-12-01",
  "working_date": "2023-01-02",
  "administrative_division_id": 100100,
  "external_id": "38400-000"
}

Response

Holidays response

idinteger

Holiday ID

namestring

Holiday name

holiday_datestring

Holiday date. Format = yyyy-mm-dd.

working_datestring date

Next work day following the holiday. Format = yyyy-mm-dd.

administrative_division_idinteger

Administrative division ID.

When passed as a parameter, either this or external_id is REQUIRED.

Example response

{
  "id": 8675309,
  "name": "New Year's Day",
  "holiday_date": "2023-12-01",
  "working_date": "2023-01-02",
  "administrative_division_id": 100100
}

Changes

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