Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
Webhooks

Payroll > PolicyPeriod > Change statuses

Subscription_type: payroll/policy_period/change_status

postWebhookWebhooks > Payroll > PolicyPeriod > Change statuses

Payload

idstring required

Policy period id

namestring

Policy name with start and end date

starts_onstring required

The start date of the policy period

policy_idstring required

The id of the policy associated with the policy period

company_idstring required

The id of the company

ends_onstring required

The start date of the policy period

periodstring required

Period for the policy

statusstring

Policy period status

policy_namestring

Policy name

calculation_started_atstring

The date and time the calculation started

Example payload

{
  "id": "1",
  "name": "Policy name example 20 aug - 13 sep",
  "starts_on": "2020-01-01",
  "policy_id": "1",
  "company_id": "1",
  "ends_on": "2020-01-01",
  "period": "20 aug - 13 sep 2021",
  "status": "preparation",
  "policy_name": "Policy name example",
  "calculation_started_at": "2020-01-01"
}

Response

Return a 200 status to indicate that the data was received successfully