GuidesAPI ReferenceChangelog
Log In

Pay Schedule Events

API Endpoint

GET /v1/companies/:company_id/pay_schedules/:pay_schedule_id

Event types

  • pay_schedule.created
  • pay_schedule.updated


Resource: "Company"
Entity: "PaySchedule"


Please note that the primary use case for this event is to get Pay Periods. There are no events for Pay Periods because they are virtual and computed every time. You can use this event to in turn query our public API endpoint for a list of Pay Periods that you need for a given date range. If the Pay Schedule does not change, then the Pay Periods can be safely assumed to remain constant.

It is not advised to try and compute the Pay Schedules on your own instead of querying our API. For a monthly pay schedule alone we have 4 different ways of computing it depending on legacy logic and different needs unique to each company. Using our public API allows for the logic to remain constant across services.

You can read more about the Pay Period endpoint in our Gusto API.

Example payload

    "event_type": "pay_schedule.updated",
    "resource_type": "Company",
    "resource_id": 7757616923994151,
    "resource_uuid": "9cf96c42-15f7-40db-ac7e-43ee6c7d8749",
    "entity_type": "PaySchedule",
    "entity_id": 7757518389593568,
    "entity_uuid": "974e7f49-c385-47db-a8e1-69ec675497ef",
    "timestamp": 1629760205,