API Reference

Creates a company-specific holiday calendar event.

post
https://example.com/wep/companies//calendar-events

Access: System, Admin, and ClientAdmin users only.

This endpoint creates only client-specific records (no master linkage).
Business validation includes date range, holiday type rules, country/state rules, and payroll applicability rules.

If Country is not provided, US is used as default.
Response includes calculated permissions for the new record.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

Company identifier from route.

Body Params

Holiday event payload.

Payload for creating a new company-specific holiday calendar event.

date | null
required

Holiday start date (inclusive).
Data type is validated and must be Number

date | null
required

Holiday end date (inclusive).
Data type is validated and must be Number

string | null
required

Holiday name visible to users.

string | null

Optional holiday note/description.

int32
enum

Holiday type.

Members:

  • 1 - Other ( Other. )
  • 2 - Federal ( Federal holiday (USA). )
  • 3 - State ( State holiday (USA). )
  • 4 - CountryOfficial ( Official country holiday. )

Allowed:
string | null

Two-letter country code (ISO Alpha-2).

string | null

Two-letter US state code.

boolean

Whether holiday applies to payroll.

boolean
required

Whether holiday applies to Time Off.

Headers
string
required
Defaults to 2.0

The requested API version

string
Defaults to 2.0

The requested API version

string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
jwt
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?