ResourceChangedNotification

  • deliveryId
    Type: string
    min length:  
    1
    max length:  
    200
    required

    Stable delivery ID used to detect duplicates. Retries use the same value.

  • employerId
    Type: string
    min length:  
    1
    max length:  
    200
    required

    PayrollKit ID of the Employer that owns the changed resource.

  • eventType
    const:  
    resource.changed
    required

    Type of notification.

  • occurredAt
    Type: stringFormat: date-time
    required

    When PayrollKit recorded the resource change. This does not indicate when the notification was delivered.

  • resourceId
    Type: string
    min length:  
    1
    max length:  
    200
    required

    PayrollKit ID of the changed resource.

  • resourceType
    Type: stringenum
    required

    Kind of setup, payroll or output resource to retrieve. Changes to nested Employment setup are reported as an Employment change.

    values
    employerpaye_schemeemploymentpay_runcalculationfilingpayslippayslip_deliveryaccounting_exportpension_exportpayment_instruction_file
  • resourceUrl
    Type: stringFormat: uri
    required

    Absolute PayrollKit API URL used to retrieve the current resource with a Partner access token.