Retrieve open invoices

This API searches invoices by invoice number or guest user ID, or retrieves all open invoices for a given date.

TodaysInvoicesResponse

Json PropertyData TypeDescription
todays_invoicesListContains the list of invoices for the given date (existing behavior).
invoicesListContains the list of invoices returned when searching by Invoice Number or User ID. This field is returned only when search_type is provided.

TodaysInvoicesDetails

Json PropertyData TypeDescription
invoice_nostringThe invoice number associated with the transaction.
namestringName of the guest associated with the invoice.
itemsstringDescription or list of services/products included in the invoice.
sale_dateDateTime?Date when the invoice was created or the sale was completed. Nullable.
appointment_dateDateTimeDate of the appointment associated with the invoice.
start_timestringStart time of the appointment.
pricedecimalTotal price of services or products before discounts and taxes.
discountdecimalTotal discount applied to the invoice.
redemptionsdecimalAmount redeemed through memberships, packages, or gift cards.
final_pricedecimalFinal invoice price after discounts and redemptions but before taxes.
final_price_taxdecimalFinal invoice amount including taxes.
taxesdecimalTotal tax applied to the invoice.
rounding_adjustmentdecimalAny rounding adjustments applied to the final amount.
mobile_phonestringGuest’s mobile phone number associated with the invoice.
emailstringGuest’s email address associated with the invoice.
invoice_idGuidUnique identifier of the invoice.
receive_emailboolIndicates whether the guest opted to receive invoice emails.
SSG_amountdecimalAmount related to SSG (specific organization-defined amount).
unassigned_tipdecimalTip amount that has not yet been assigned to a specific employee.
app_group_idGuidIdentifier of the appointment group linked to the invoice.
user_idGuidUnique identifier of the guest associated with the invoice.
therapist_namestringName of the therapist assigned to the appointment.
end_timestringEnd time of the appointment.
preferred_pronounstringGuest’s preferred pronoun.

SearchInvoiceForGroupingType (Enum)

Json PropertyData TypeDescription
InvoiceNumberint (0)Indicates invoices should be searched using the invoice number.
UserIdint (1)Indicates invoices should be searched using the guest user ID.
Language
Credentials
Header
Response
Click Try It! to start a request and see the response here!