API Change Log - 03 Mar 2026

Reports-Core V2

API Endpoint: {api_url} /v1/reports/collections/flat_file
Scenario: This API retrieves the collections details in the organization during selected date range.
API method: POST
Earlier behavior: The collections report response excluded card surcharge tax details, reporting only base tax, tips, SSG, ESF, and other existing totals.
New behavior: The collections report response includes tax_on_surcharge and total_tax_including_surcharge, enabling accurate reporting of payment surcharge taxes.

API Endpoint: {api_url} /v1/reports/aveda_benchmark_summary
Scenario: This API retrieves the details for Aveda benchmark report.
API method: POST
Earlier behavior: The API returned guest service KPIs without distinguishing between appointments booked with requests and without requests.
New behavior: The API returns separate guest KPIs for with-request and without-request services, and includes the RetailPerRetailTransaction metric.

API Endpoint: {{baseUrl}}/v1/giftcards/templates/custom
Scenario: This API creates a custom package template for gift cards based on the selected services and the provided criteria, including support for member pricing. If the member pricing option is enabled and the guest has an active membership, the template should be generated using the member-specific pricing.
API method: POST
Earlier behavior: The create template API did not apply member pricing for services, even when the guest had an active membership.
New behavior: The create template API applies member pricing for services when the guest has an active membership.

API Endpoint: {api_url}/v1/guests/aveda_membership?search_value={membership_or_email}
Scenario: This API checks if a guest can be linked to an Aveda membership, by validating a provided membership ID or email address. It returns either a membership ID (on success) or an error code (on failure).
API method: GET
Earlier behavior: New API. No earlier behavior.
New behavior: The API validates an Aveda membership ID or email, returning a linkable membership ID or error code.

API Endpoint: v1/zenscribe/employee_associations/list
Scenario: This API fetches the employee associations for the AI scribe license-based feature.
API method: POST
Earlier behavior: New API. No earlier behavior.
New behavior: The API returns employee association records filtered by centers, jobs, view status, search text, and paging.

API Endpoint: POST {base_url}/v1/emr/migrations/ai_mappings
Scenario: This API endpoint receives AI-generated field mappings from an external Lambda service after AI processing of EMR (Electronic Medical Records) form fields.
API method: POST
Earlier behavior: New API. No earlier behavior.
New behavior: The API accepts Lambda-generated mappings, validates custom header and HMAC signature, resolves entities, saves mappings, and notifies clients via SignalR.

API Endpoint: POST {base_url}/v1/emr/migrations/ai_mappings
Scenario: This API receives AI-generated EMR field mappings from Lambda, validates them, saves resolved mappings, and updates the UI in real time.
API method: POST
Earlier behavior: New API. No earlier behavior.
New behavior: The API validates the custom header and HMAC signature, resolves entities, saves mappings, and pushes updates via SignalR.

API Endpoint: {api_url}/v1/forms
Scenario: This API updates form associations.
API method: PUT
Earlier behavior: New API. No earlier behavior.
New behavior: You can now associate one or more forms to an appointment on the fly using PUT /v1/forms with is_on_fly=true (and optionally expand=form).

API Endpoint: {{api_url}}/v1/classes/instructors/sessions
Scenario: This API retrieves the list of all class sessions.
API method: GET
Earlier behavior: Training schedules and instructor sessions loaded slowly, impacting roster, webstore, and class-related flows.
New behavior: Training schedules load faster through optimized stored procedures, without changing booking, membership, or fee outcomes.