PayrollBenefitExportReadyEvent

Overview

The <PartnerKey>PayrollBenefitExportReadyEvent event is sent after a payroll batch has been posted, notifying that talent benefit payroll deduction items are ready for download via the Get Partner Export Batch Talent Benefit Payroll Deductions endpoint in the Back Office API.

Event Parameters

Parameter	Data Type	Description
`SupplierGuid`	UUID	The unique identifier for the supplier associated with the event.
`AccountingPeriodDate`	string	The date representing the accounting period, formatted as YYYY-MM-DD.
`BatchGuid`	UUID	The unique identifier for the batch associated with the event.
`EventName`	string	The name of the specific event. The `<PartnerKey>` prefix in the event name will be replaced with a partner-specific value.
`ExportType`	string	The type of data included in the export. Possible values are: `PayrollBenefitDeductionExport`: Indicates the export contains deduction data. `PayrollBenefitContributionExport`: Indicates the export contains contribution data.
`TenantId`	integer	The identifier for the tenant (client) for which the request is being made.
`CorrelationId`	UUID	A unique identifier for this event.
`BusinessProcessId`	UUID	The identifier for the business process associated with this event.
`TargetBusinessProcessId`	UUID	The identifier for the target business process related to this event.
`PublishedDate`	string	The date and time when the event was published, in ISO 8601 format.
`DeduplicationId`	string	A unique identifier to ensure the same event is not processed multiple times.

Sample Event

{
  "SupplierGuid": "00000000-0000-0000-0000-000000000000",
  "AccountingPeriodDate": "2025-01-05",   
  "BatchGuid": "00000000-0000-0000-0000-000000000000",
  "EventName": "<PartnerKey>PayrollBenefitExportReadyEvent",
  "ExportType": "PayrollBenefitDeductionExport",
  "TenantId": 12345,
  "CorrelationId": "11111111-2222-3333-4444-555555555555",
  "BusinessProcessId": "00000000-0000-0000-0000-000000000000",
  "TargetBusinessProcessId": "00000000-0000-0000-0000-000000000000",
  "PublishedDate": "2025-01-01T00:00:00.0000000+00:00",
  "DeduplicationId": "SSdtIGEgbGl0dGxlIHRlYXBvdCBzaG9ydCBhbmQgc4RvdXQ="
}

Associated Endpoint

To download talent benefit payroll deduction items, check the Get Partner Export Batch Talent Benefit Payroll Deductions endpoint.