Avionté API updates: December

In December, we’ve introduced several updates across the Back Office and Front Office APIs. In the Back Office API, seven new endpoints and two events have been added. Enhancements now allow the use of the FrontOfficeTenantId header and include a new backOfficeUuid field in key entity responses. In the Front Office API, the Create Timesheet endpoint now includes all OT plans in its lookup, regardless of their hidden status. See the rest of the article for more details.

Back Office

This section covers new endpoints, events, and enhancements introduced to the Back Office API.

New Endpoints

• Get Partner Export Batch Talent Benefit Payroll Deductions
  Retrieves a paginated set of batch items for a specified partner export batch ID.
• Get Benefit Partner Transaction Types
  Retrieves a list of talent benefit enrollment transaction types for the requesting authorized partner.
• Get Talent Benefit Enrollment
  Returns the requesting authorized partner talent benefit enrollment details for the specified talent.
• Add Talent Benefit Enrollment
  Adds a talent benefit enrollment.
• Update Talent Benefit Enrolment
  Updates a talent benefit enrollment for a given talent.
• Query Multiple Talent by TalentGuids
  Retrieves details about the specified talent records.
• Query Job Summary for Multiple Talent
  Retrieves job summary details for talent records, with year-to-date totals calculated based on paycheck data from the specified year. Defaults to the current year if no year is specified.

Enhancements

• Back Office API endpoints now accept FrontOfficeTenantId in the header. Either FrontOfficeTenantId or Tenant is required.
• The Get Entity Reference by ID endpoint now includes a new backOfficeUuid field, which represents the entity's primary key when the key value is a GUID. For entities such as Talent, Employer, Company, Company Department, Job, or Placement, the backOfficeUuid property is now populated with the respective primary key.

New Events

• PayrollBenefitExportReadyEvent
  This event is sent after a payroll batch has been posted, notifying that talent benefit payroll deduction items are ready for download.
• TalentBenefitEligibleEvent
  This event is sent to notify the partner that a talent is eligible for benefits enrollment in the partner system.

Front Office

This section outlines the latest update to the Front Office API.

Enhancements

• Updated the Create Timesheet endpoint to include all OT plans in the lookup, regardless of their hidden status.