API Change Log - 27 Jan 2026

Booking Wizard

API Endpoint: {api_url}/v1/appointments/recurrences/{recurrence_id}
Scenario: This API updates all appointments in a series based on the provided appointment details.
API method: PUT
Earlier behavior: New API. No earlier behavior.
New behavior: This API updates all appointments in a series based on the provided appointment details.

Booking Wizard

API Endpoint: {api_url}/v1/appointments/recurrences
Scenario: This API generates a series of recurring appointments using the specified recurrence details.
API method: POST
Earlier behavior: New API. No earlier behavior.
New behavior: This API generates a series of recurring appointments using the specified recurrence details.

ZMA

API Endpoint: api/Payments/Invoice/RefundInvoice
Scenario: This API processes refunds for selected items and payments, handling online and offline refunds, payment processor integration, inventory restocking, and loyalty point reversals.
API method: POST
Earlier behavior: New API. No earlier behavior.
New behavior: This API processes refunds for selected items and payments, handling online and offline refunds, payment processor integration, inventory restocking, and loyalty point reversals.

ZMA

API Endpoint: {api_url}/v1/Centers/{center_id}/appointment_views
Scenario: This API retrieves center appointment views and has been enhanced to include new parameters (orientation, item IDs, item type, and appointment status) with updated filter logic.
API method: GET
Earlier behavior: New API. No earlier behavior.
New behavior: This API retrieves center appointment views and has been enhanced to include new parameters (orientation, item IDs, item type, and appointment status) with updated filter logic.

Zenoti Mobile iOS

API Endpoint: {api_url}/api/Payments/Invoice/RefundInvoice
Scenario: This API creates a refund invoice for selected items and payments. It supports online and offline refunds, integrates with payment processors, updates inventory, and reverses loyalty points.
API method: POST
Earlier behavior: New API. No earlier behavior.
New behavior: This API helps you process refunds by creating a refund invoice for specific items and payments. It handles online and offline refunds, integrates with payment processors, restocks inventory, and adjusts loyalty points automatically.

Zenoti Mobile iOS

API Endpoint: {api_url}/api/Payments/Invoice/RefundInvoice
Scenario: This API processes and creates a refund invoice for specified items and payments. It supports online and offline refunds, integrates with payment processors, restocks inventory, and reverses loyalty points.
API method: POST
Earlier behavior: New API. No earlier behavior.
New behavior: This API processes refunds by creating a refund invoice for specified items and payments. It handles online and offline refunds, integrates with payment processors, restocks inventory, and reverses loyalty points.

Zenoti Mobile iOS

API Endpoint: {api_url}/v1/invoices/items
Scenario: This API creates a new invoice or adds items to an existing invoice. It mirrors the current web POS functionality and does not perform booking validations, which are handled separately for regular appointment bookings.
API method: POST
Earlier behavior: New API. No earlier behavior.
New behavior: This API allows you to create a new invoice or add items to an existing one. It replicates the behavior of the web POS and does not include booking validations, as those are applied only to standard appointment bookings created through other workflows.

Zenoti Mobile iOS

API Endpoint: {api_url}/{baseurl}/v1/invoices/{invoice_id}/tax
Scenario: This API updates tax on an invoice based on the selected action: Recalculate or Exempt.
API method: PUT
Earlier behavior: New API. No earlier behavior.
New behavior: This API updates the tax applied to an invoice by either recalculating the tax or marking it as exempt, based on the specified action.

Payments

API Endpoint: {api_url/v1/payments/centers/{center_id}/feature_info?feature={feature}&transaction_source={transaction_source}
Scenario: This API retrieves the list of payment features available for a given subscriber and payment processor.
API method: GET
Earlier behavior: New API. No earlier behavior.
New behavior: This API returns details of the payment features supported for a specific subscriber and payment processor.

Zenoti Mobile iOS

API Endpoint: {api_url}/v1/invoices/{invoice_id}/properties
Scenario: This API retrieves essential invoice properties and metadata for a specific invoice, including group invoice details, lock status, invoice status, and center information used for invoice operations and UI state.
API method: GET
Earlier behavior: New API. No earlier behavior.
New behavior: This API returns key properties and metadata for a specific invoice, such as group invoice information, lock status, invoice status, and center details required for invoice processing and UI state management.

Zenoti Mobile iOS

API Endpoint: {api_url}/api/Invoices/SendReceiptMail
Scenario: This API sends a receipt email to the customer for a specified invoice.
API method: POST
Earlier behavior: New API. No earlier behavior.
New behavior: This API sends a receipt email to a customer based on the selected invoice.

Zenoti Mobile iOS

API Endpoint: {api_url}/api/Invoices/{InvoiceId}/Payment/Save/RecurringMembership
Scenario: This API associates a saved payment method (credit card or check) with a recurring membership invoice for future automatic billing.
API method: POST
Earlier behavior: New API. No earlier behavior.
New behavior: This API links a saved payment method, such as a credit card or check, to a recurring membership invoice to support future automatic billing.

Reports - Core V2

API Endpoint: {api_url}//v1/reports/royalty/flat_file
Scenario: This API retrieves royalty details by center for a specified time period.
API method: POST
Earlier behavior: This API returned royalty details without center-wise breakdown or duration filtering.
New behavior: This API returns center-wise royalty details for a selected duration.

Zenoti Mobile iOS

API Endpoint: {api_url/v1/Packages/{package_version_id}/bundle_items
Scenario: This API retrieves the bundle items linked to a package version for a specific center.
API method: GET
Earlier behavior: New API. No earlier behavior.
New behavior: This API returns the bundle items associated with a package version at a given center.

Zenoti Mobile iOS

API Endpoint: {api_url}/api/Centers/CustomPaymentData
Scenario: This API retrieves available custom payment agents. It supports filtering by center, agent assignments, and integration type.
API method: GET
Earlier behavior: New API. No earlier behavior.
New behavior: This API fetches custom payment agents and allows filtering by center availability, agent center assignment, and integration type.

Zenoti Mobile iOS

API Endpoint: {api_url}/v1/invoices/{invoice_id}/invoice_items?
Scenario: This API retrieves item details for an invoice, with support for batch tracking, service bundle day packages, smart cart integration, insurance data, and enhanced invoice and item-level metadata.
API method: GET
Earlier behavior: New API. No earlier behavior.
New behavior: This API returns invoice item details and related invoice metadata, including batch tracking, bundle packages, insurance indicators, redemption details, recurring payments, and enhanced security fields.

Zenoti Mobile iOS

API Endpoint: {api_url}/v1/invoices/{InvoiceId}/environmental_fee
Scenario: The API now supports a new request parameter, include_invoice_details. When this parameter is used, the API validates only the existence of the invoice without fetching full invoice details, and the response does not include updated invoice details after fees are applied.
API method: POST
Earlier behavior: The API retrieved full invoice details for validation, which increased processing time. After fees were applied, the API fetched the invoice details again to update the response.
New behavior: This API supports a new include_invoice_details parameter that skips fetching full invoice details, validates only invoice existence, and does not return updated invoice details in the response.

Zenoti Mobile iOS

API Endpoint: {api_url}/v1/invoices/{InvoiceId}/invoice_items/{InvoiceItemId}
Scenario: This API conditionally includes invoice details in the response based on the include_invoice_details flag. When set to false, invoice details are omitted; when true or not provided, invoice details are returned.
API method: PUT
Earlier behavior: This API always returned invoice details in the response.
New behavior: This API uses the include_invoice_details request parameter to control whether invoice details are included in the response.

Zenoti Mobile iOS

API Endpoint: {api_url}/v1/invoices/{invoice_id}/payments/memberships
Scenario: This API uses the include_invoice_details parameter to control whether updated invoice details are returned after payment or redemption.
API method: POST
Earlier behavior: This API performed the same operations multiple times and always returned updated invoice details in the response.
New behavior: This API does not return updated invoice details when include_invoice_details is set to false.

Zenoti Mobile iOS

API Endpoint: {api_url}/v1/invoices/{invoice_id}/coupons
Scenario: This API applies coupon, voucher, or cashback codes in POS.
API method: PUT
Earlier behavior: New API. No earlier behavior.
New behavior: This API applies coupon, voucher, or cashback codes during POS transactions.

Zenoti Mobile iOS

API Endpoint: {api_url}/v1/invoices/{invoice_id}/due_amount
Scenario: This API retrieves the due amount breakdown for a specific invoice, including invoice amounts, tips, service charges or gratuity (SSG), and other fees with paid and due balances.
API method: GET
Earlier behavior: New API. No earlier behavior.
New behavior: This API returns a detailed breakdown of amounts due for an invoice, covering invoice totals, tips, SSG, other fees, and their corresponding paid and remaining balances.

Zenoti Mobile iOS

API Endpoint: {api_url}/v1/guests/{guest_id}/visit_history
Scenario: This API retrieves visit history from ZMA for printing appointments.
API method: GET
Earlier behavior: New API. No earlier behavior.
New behavior: This API fetches appointment visit history from ZMA to support appointment printing.

Zenoti Mobile iOS

API Endpoint: {api_url} /v1/Centers/{center_id}/appointment_views
Scenario: This API conditionally returns invoice details based on the include_invoice_details query parameter.
API method: GET
Earlier behavior: This API always returned invoice details in the response.
New behavior: This API does not return invoice details when include_invoice_details is set to false, and returns them when the value is true or not provided.

Zenoti Mobile iOS

API Endpoint: {api_url}/api/Payments/Invoice/RefundInvoice
Scenario: This API processes and creates a refund invoice for specified items and payments, supporting online and offline refunds, payment processor integration, inventory restocking, and loyalty point reversals.
API method: POST
Earlier behavior: New API. No earlier behavior.
New behavior: This API creates a refund invoice for selected items and payments and handles online and offline refunds, payment processor integration, inventory restocking, and loyalty point reversals.

API V1, Zenoti Mobile iOS

API Endpoint: {{api_url}}/v1/invoices/payments?invoice_type={invoice_type}&invoice_id={invoice_id}&is_offline_payments_enabled={is_offline_payments_enabled}&include_tip_details={include_tip_details=}
Scenario: This API fetches all payment details for a specific invoice.
API method: GET
Earlier behavior: New API. No earlier behavior.
New behavior: This API retrieves complete payment information associated with an invoice.

Zenoti Mobile iOS

API Endpoint: {api_url}/v1/pos/memberships/list
Scenario: This API returns the memberships that can be sold through the new POS.
API method: GET
Earlier behavior: New API. No earlier behavior.
New behavior: This API retrieves the list of memberships available for sale in the new POS.

API, Zenoti Mobile iOS

API Endpoint: {api_url}/v1/invoices/{invoice_id}/associated_invoices
Scenario: This API retrieves source or child invoices associated with a given invoice ID, including invoices linked through Smart Kart recommendations.
API method: GET
Earlier behavior: New API. No earlier behavior.
New behavior: This API returns invoices related to a given invoice ID, allowing you to fetch either the source invoice or any child invoices created through Smart Kart recommendations.

API, Zenoti Mobile iOS

API Endpoint: {api_url} /v1/guests/{guest_id}/visit_history
Scenario: This API retrieves visit history details and includes credit card prequalification information in the response.
API method: GET
Earlier behavior: This API retrieved only guest visit history details without credit card prequalification information.
New behavior: This API returns visit history for appointments along with optional credit card prequalification details.

API, Zenoti Mobile iOS

API Endpoint: {api_url}/v1/invoices/{invoice_id}/invoice_items?
Scenario: This API retrieves invoice item details along with additional information such as product batch tracking, insurance indicators, and validation of required service custom data.
API method: GET
Earlier behavior: This API retrieved only basic invoice item details.
New behavior: This API returns invoice item details with enhanced invoice- and item-level metadata, including batch tracking, insurance support, and service custom data checks.