---
title: "Send a group invoice email"
method: POST
path: "/v1/group_invoices/{group_invoice_id}/email"
---

# Send a group invoice email

`POST /v1/group_invoices/{group_invoice_id}/email`

This API helps you to send a group invoice email to a guest.

To send a group invoice email, you must specify the appropriate details for the `group_invoice_id` parameter in the API request.

In the API request body, you must specify the required `guest_details` and `email_type` details. After you provide the necessary details, this API sends a group invoice email.

## Path parameters

- `group_invoice_id` string, required

## Response `200`

200

- object
  - `is_invoice_created` boolean
  - `group_invoice` object
    - `Id` string
    - `name` string
    - `host_id` string
    - `payment_made_by` string
    - `Invoices` object[]
      - `Id` string
      - `InvoiceNumber` string
      - `GroupInvoiceId` string
      - `group_name` string
      - `ReceiptNumber` string
      - `AppointmentGroupId` string
      - `ReservationId` string
      - `IsRebooking` boolean
      - `Notes` string
      - `GuestId` string
      - `Guest` object
        - `Id` string
        - `Code` string
        - `FirstName` string
        - `MiddleName` string
        - `LastName` string
        - `Email` string
        - `MobileNumber` string
        - `MobilePhoneModel` object
          - `CountryId` integer
          - `Number` string
          - `DisplayNumber` string
        - `HomePhone` string
        - `HomePhoneModel` object
          - `CountryId` integer
          - `Number` string
          - `DisplayNumber` string
        - `WorkPhone` string
        - `WorkPhoneModel` object
          - `CountryId` integer
          - `Number` string
          - `DisplayNumber` string
        - `Gender` integer
        - `DateOfBirth` string
        - `AnniversaryDate` string
        - `Address1` string
        - `Address2` string
        - `City` string
        - `PostalCode` string
        - `State` object
          - `Id` integer
          - `Code` string
          - `Name` string
          - `ShortName` string
        - `Country` object
          - `Id` integer
          - `Code` string
          - `Name` string
          - `PhoneCode` integer
          - `Nationality` string
        - `Nationality` object
          - `Id` integer
          - `Code` string
          - `Name` string
          - `PhoneCode` integer
          - `Nationality` string
        - `ReferralSource` object
          - `Id` string
          - `OrgReferralId` string
          - `Name` string
        - `ReferredGuestId` string
        - `ReceiveTransactionalSms` boolean
        - `ReceiveMarketingEmail` boolean
        - `ReceiveTransactionalEmail` boolean
        - `ReceiveMarketingSms` boolean
        - `CreationDate` string
        - `LastUpdated` string
        - `MergeIntoCode` string
        - `MergeIntoGuestId` string
        - `CenterId` string
        - `CenterCode` string
        - `CenterName` string
        - `GuestIndicator` string
        - `IsMember` integer
        - `DOB_IncompleteYear` string
        - `Password` string
        - `UserName` string
        - `FacebookUserId` string
        - `SocialFaceBookUserId` string
        - `SocialGoogleUserId` string
        - `hasZenotiCreds` boolean
        - `OldPassword` string
        - `OptInForLoyaltyProgram` boolean
        - `FormDetails` object[]
          - `AppointmentId` string
          - `FormId` string
          - `ServiceName` string
          - `ServiceDisplayName` string
          - `ServiceId` string
          - `Name` string
          - `Filled` boolean
          - `Submitted` boolean
          - `LastFilledDate` string
          - `FormType` integer
          - `LastFilledBy` string
          - `LatestVersion` string
          - `FormHistory` object[]
            - `VersionDate` string
            - `VersionDateString` string
            - `VersionId` string
            - `CreatedBy` string
            - `FormName` string
            - `FormId` string
          - `Viewonly` boolean
          - `IsFormLocked` boolean
          - `ExpiryDate` string
          - `IsEditable` boolean
          - `IsExpired` boolean
          - `OwnerId` string
          - `DisplayOrder` integer
          - `IsServiceForm` boolean
          - `SourceAppointmentDate` string
          - `Permissions` object
            - `CanView` boolean
            - `CanEdit` boolean
          - `FormFilledStatus` integer
          - `IsActive` boolean
          - `SendLinkInNotifications` boolean
        - `IsMinors` boolean
        - `LpTierInfo` string
        - `GuestIndicatorValue` object
          - `HighSpender` boolean
          - `Member` integer
          - `LowFeedback` boolean
          - `RegularGuest` boolean
          - `FirstTimer` boolean
          - `ReturningCustomer` boolean
          - `NoShow` boolean
          - `HasActivePackages` boolean
          - `HasProfileAlerts` boolean
          - `OtherCenterGuest` boolean
          - `HasCTA` boolean
          - `Dues` boolean
          - `CardOnFile` boolean
          - `AutoPayEnabled` boolean
        - `IsMemberbershipAddOnUser` integer
        - `HasActiveMems` integer
        - `ReceiveLpStmt` boolean
        - `GenderEnumType` integer
        - `ReferralCode` string
        - `EnableAutoPay` boolean
        - `GuestCustomDataFilled` string
      - `Price` object
        - `CurrencyId` integer
        - `Sales` integer
        - `Tax` integer
        - `Final` integer
        - `Final1` integer
        - `Discount` integer
        - `Tip` integer
        - `SSG` integer
        - `RoundingCorrection` integer
        - `DiscountedPrice` integer
        - `environmental_fee` integer
        - `environmental_fee_label` string
        - `can_be_waived` boolean
      - `SaleDate` string
      - `FutureRecurringBillDate` string
      - `guest_checkin_time` string
      - `LinkedInvoiceId` string
      - `Status` integer
      - `InvoiceServices` object[]
        - `AppointmentService` object
          - `AppointmentId` string
          - `InvoiceItemId` string
          - `InvoiceItemAddedTime` string
          - `UIItemIdentifier` string
          - `CartItemId` string
          - `AppointmentSegmentId` string
          - `PackageId` string
          - `Package` object
            - `Id` string
            - `Name` string
            - `Description` string
            - `Code` string
            - `HasBundledProducts` boolean
            - `Duration` integer
            - `BundledProductPriceCheck` integer
            - `BundledProductPricePercentage` integer
            - `PackagePriceWithOutTax` integer
            - `Type` integer
            - `Price` object
              - …
            - `PackageCostIncBundledProducts` boolean
            - `Services` object[]
              - …
            - `Items` object[]
              - …
            - `CanBook` boolean
            - `PackageDisplayName` string
            - `PackageDisplayPrice` string
            - `HTMLDescription` string
            - `CalculateServiceLevelTax` boolean
            - `TermsandConditions` string
            - `ExpirationDate` string
            - `ExpirationDays` integer
            - `ScheduledPaymentFrequency` integer
            - `ScheduledPaymentFrequencyType` integer
            - `RestrictRedemptionToThisCenter` integer
            - `CenterName` string
            - `PackageCategoryName` string
            - `start_validity_at_first_redemption` boolean
          - `Service` object
            - `Id` string
            - `Name` string
            - `DisplayName` string
            - `Price` object
              - …
            - `Duration` integer
            - `CategoryId` string
            - `IsAddOn` boolean
            - `HasAddOns` boolean
            - `AddOnToServiceId` string
            - `Description` string
            - `HTMLDescription` string
            - `CategoryName` string
            - `AddOns` object[]
              - …
            - `IsVariant` boolean
            - `HasVariant` boolean
            - `HasSegments` boolean
            - `ParentServiceId` string
            - `CartItemId` string
            - `SaleAllowedAsPartOfPackageOrMembershipOnly` boolean
            - `BookingWithPartialBalance` integer
            - `ShowInCatalog` integer
            - `IncludesTax` boolean
            - `IsServicePriceScaledForAnyTherapist` boolean
            - `canPerformService` boolean
            - `Membership` object
              - …
            - `PseudoAppliedMembership` integer
            - `ScaledDuration` integer
            - `AppointmentId` string
            - `override_product_consumption` boolean
            - `override_default_product_consumption` boolean
            - `ServiceFinalPrice` integer
            - `Void` boolean
            - `RecoveryTime` integer
            - `Code` string
            - `CampaignInfo` object
              - …
            - `PreRequisites` object[]
              - …
            - `EnforcePreRequisites` boolean
            - `ClubPreRequisites` boolean
            - `ValidityDays` integer
            - `BookingOrder` integer
            - `ValidityDaysAsPreRequisite` integer
            - `tips_enabled` boolean
            - `EnableCatalogServiceFrequency` boolean
            - `CatalogServiceFrequency` integer
          - `ReducedTimeGroupId` string
          - `ServiceFormDetails` object[]
            - `AppointmentId` string
            - `FormId` string
            - `ServiceName` string
            - `ServiceDisplayName` string
            - `ServiceId` string
            - `Name` string
            - `Filled` boolean
            - `Submitted` boolean
            - `LastFilledDate` string
            - `FormType` integer
            - `LastFilledBy` string
            - `LatestVersion` string
            - `FormHistory` object[]
              - …
            - `Viewonly` boolean
            - `IsFormLocked` boolean
            - `ExpiryDate` string
            - `IsEditable` boolean
            - `IsExpired` boolean
            - `OwnerId` string
            - `DisplayOrder` integer
            - `IsServiceForm` boolean
            - `SourceAppointmentDate` string
            - `Permissions` object
              - …
            - `FormFilledStatus` integer
            - `IsActive` boolean
            - `SendLinkInNotifications` boolean
          - `RequestedTherapistGender` integer
          - `StartTime` string
          - `EndTime` string
          - `RequestedDuration` integer
          - `NonReducedDuration` integer
          - `StartTimeInCenter` string
          - `EndTimeInCenter` string
          - `Room` object
            - `Id` string
            - `Name` string
          - `Lock` boolean
          - `Equipment` object
            - `Id` string
            - `Name` string
          - `Status` integer
          - `RequestedTherapist` object
            - `Id` string
            - `ShortName` string
            - `NickName` string
            - `FullName` string
            - `Email` string
            - `PhoneNumber` string
            - `MobilePhoneModel` object
              - …
            - `Gender` integer
            - `FirstName` string
            - `LastName` string
            - `IsAvailable` boolean
            - `WaiveBiometricFlag` boolean
            - `VanityImageUrl` string
            - `ScalingFactor` number
            - `ScaledPrice` integer
            - `ServiceTime` integer
            - `DisplayName` string
            - `IdleTime` integer
            - `OriginalPrice` integer
            - `OriginalTax` integer
            - `Job` object
              - …
            - `BookingInterval` integer
            - `schedule` object[]
              - …
            - `unavailable_times` object[]
              - …
            - `LastDate` string
          - `SaleBy` object
            - `Id` string
            - `ShortName` string
            - `NickName` string
            - `FullName` string
            - `Email` string
            - `PhoneNumber` string
            - `MobilePhoneModel` object
              - …
            - `Gender` integer
            - `FirstName` string
            - `LastName` string
            - `IsAvailable` boolean
            - `WaiveBiometricFlag` boolean
            - `VanityImageUrl` string
            - `ScalingFactor` number
            - `ScaledPrice` integer
            - `ServiceTime` integer
            - `DisplayName` string
            - `IdleTime` integer
            - `OriginalPrice` integer
            - `OriginalTax` integer
            - `Job` object
              - …
            - `BookingInterval` integer
            - `schedule` object[]
              - …
            - `unavailable_times` object[]
              - …
            - `LastDate` string
          - `Quantity` integer
          - `Price` object
            - `CurrencyId` integer
            - `Sales` integer
            - `Tax` integer
            - `Final` integer
            - `Final1` integer
            - `Discount` integer
            - `Tip` integer
            - `SSG` integer
            - `RoundingCorrection` integer
            - `DiscountedPrice` integer
            - `environmental_fee` integer
            - `environmental_fee_label` string
            - `can_be_waived` boolean
          - `SCD` string
          - `ActualStartTime` string
          - `CompletedTime` string
          - `Progress` integer
          - `ParentAppointmentId` string
          - `ServiceCustomData` object
            - `Permission` object
              - …
          - `ItemActions` string
          - `EquivalenceFactor` number
          - `EquivalentName` string
          - `IsMembershipApplied` boolean
          - `IsAddOn` boolean
          - `AddonAppointmentId` string
          - `IsPackageApplied` boolean
          - `IsDiscountApplied` boolean
          - `CanModifyTherapist` boolean
          - `CoupleGroupNo` integer
          - `CoupleGroupId` string
          - `OrderNo` integer
          - `OpenSlots` object[]
            - `StartTimeInCenter` string
            - `EndTimeInCenter` string
            - `Therapists` object[]
              - …
            - `Rooms` object[]
              - …
            - `Equipments` object[]
              - …
          - `Warnings` object[]
            - `Type` integer
            - `Message` string
            - `GuestId` string
            - `TherapistId` string
            - `ServiceId` string
            - `RoomId` string
            - `EquipmentId` string
          - `FillOpenSlots` boolean
          - `AssignDefaultSlot` boolean
          - `AssignedSlotTherapistIds` string[]
          - `AssignedSlotRoomIds` string[]
          - `AssignedSlotRooms` object[]
            - `Id` string
            - `Name` string
          - `AssignedSlotEquipmentIds` string[]
          - `AssignedSlotEquipments` object[]
            - `Id` string
            - `Name` string
          - `ResetIfTherapistCanNotDoService` boolean
          - `Membership` object
            - `Id` string
            - `VersionId` string
            - `SetupMembershipId` string
            - `Name` string
            - `Price` object
              - …
            - `SetupPrice` object
              - …
            - `CanBook` boolean
            - `ShowPrice` boolean
            - `DisplayName` string
            - `DisplayPrice` string
            - `ImagePaths` object
              - …
            - `IsRecurrringMembership` boolean
            - `MembershipType` integer
            - `FirstCollectionAfter` integer
            - `Description` string
            - `HTMLDescription` string
            - `TermsandConditions` string
            - `TermsandConditionsAcceptance` string
            - `enforce_mandatory_fields` boolean
            - `FrequencyText` string
          - `PseudoAppliedMembership` integer
          - `PkgGroupNo` integer
          - `DayPackageService` object
            - `Type` integer
            - `Id` string
            - `Name` string
            - `Quantity` integer
            - `Order` integer
            - `Service` object
              - …
            - `PackageServicePK` integer
          - `ShowInCalendar` integer
          - `FormId` string
          - `hasServiceForm` boolean
          - `PreferredTime` string
          - `AppointmentSource` integer
          - `RemoveBuddyServiceSegments` object[]
            - `Id` string
            - `Name` string
            - `ServiceName` string
          - `AppointmentStatus` integer
          - `ServiceCustomDataEntered` boolean
          - `ProductConsumptionEntered` boolean
          - `disable_tip` boolean
          - `EnableCatalogServiceFrequency` boolean
          - `CatalogServiceFrequency` integer
        - `AppliedMembership` object
          - `MembershipId` string
          - `DiscountAmount` integer
          - `Action` string
          - `InvoiceItemId` string
          - `ShowChangeMembership` boolean
          - `EquivalenceOptions` number[]
        - `AppliedPackage` object
          - `PackageId` string
          - `DiscountAmount` integer
          - `Action` string
          - `InvoiceItemId` string
        - `AppliedDiscount` object
          - `DiscountId` string
          - `CampaignId` string
          - `CouponId` integer
          - `Action` string
          - `Type` integer
          - `DiscountAmount` integer
          - `InvoiceItemId` string
      - `InvoiceProducts` object[]
        - `AppointmentProduct` object
          - `Product` object
            - `Id` string
            - `Name` string
            - `Price` object
              - …
            - `CategoryId` string
            - `IsRetail` boolean
            - `IsConsumable` boolean
            - `Url` string
            - `Description` string
          - `InvoiceItemId` string
          - `InvoiceItemAddedTime` string
          - `Quantity` integer
          - `Price` object
            - `CurrencyId` integer
            - `Sales` integer
            - `Tax` integer
            - `Final` integer
            - `Final1` integer
            - `Discount` integer
            - `Tip` integer
            - `SSG` integer
            - `RoundingCorrection` integer
            - `DiscountedPrice` integer
            - `environmental_fee` integer
            - `environmental_fee_label` string
            - `can_be_waived` boolean
          - `Employee` object
            - `Id` string
            - `ShortName` string
            - `NickName` string
            - `FullName` string
            - `Email` string
            - `PhoneNumber` string
            - `MobilePhoneModel` object
              - …
            - `Gender` integer
            - `FirstName` string
            - `LastName` string
            - `IsAvailable` boolean
            - `WaiveBiometricFlag` boolean
            - `VanityImageUrl` string
            - `ScalingFactor` number
            - `ScaledPrice` integer
            - `ServiceTime` integer
            - `DisplayName` string
            - `IdleTime` integer
            - `OriginalPrice` integer
            - `OriginalTax` integer
            - `Job` object
              - …
            - `BookingInterval` integer
            - `schedule` object[]
              - …
            - `unavailable_times` object[]
              - …
            - `LastDate` string
          - `IsMembershipApplied` boolean
          - `IsPackageApplied` boolean
          - `IsDiscountApplied` boolean
        - `AppliedMembership` object
          - `MembershipId` string
          - `DiscountAmount` integer
          - `Action` string
          - `InvoiceItemId` string
          - `ShowChangeMembership` boolean
          - `EquivalenceOptions` number[]
        - `AppliedPackage` object
          - `PackageId` string
          - `DiscountAmount` integer
          - `Action` string
          - `InvoiceItemId` string
        - `AppliedDiscount` object
          - `DiscountId` string
          - `CampaignId` string
          - `CouponId` integer
          - `Action` string
          - `Type` integer
          - `DiscountAmount` integer
          - `InvoiceItemId` string
      - `InvoiceMemberships` object[]
        - `AppointmentMembership` object
          - `Membership` object
            - `Id` string
            - `VersionId` string
            - `SetupMembershipId` string
            - `Name` string
            - `Price` object
              - …
            - `SetupPrice` object
              - …
            - `CanBook` boolean
            - `ShowPrice` boolean
            - `DisplayName` string
            - `DisplayPrice` string
            - `ImagePaths` object
              - …
            - `IsRecurrringMembership` boolean
            - `MembershipType` integer
            - `FirstCollectionAfter` integer
            - `Description` string
            - `HTMLDescription` string
            - `TermsandConditions` string
            - `TermsandConditionsAcceptance` string
            - `enforce_mandatory_fields` boolean
            - `FrequencyText` string
          - `InvoiceItemId` string
          - `InvoiceItemAddedTime` string
          - `Employee` object
            - `Id` string
            - `ShortName` string
            - `NickName` string
            - `FullName` string
            - `Email` string
            - `PhoneNumber` string
            - `MobilePhoneModel` object
              - …
            - `Gender` integer
            - `FirstName` string
            - `LastName` string
            - `IsAvailable` boolean
            - `WaiveBiometricFlag` boolean
            - `VanityImageUrl` string
            - `ScalingFactor` number
            - `ScaledPrice` integer
            - `ServiceTime` integer
            - `DisplayName` string
            - `IdleTime` integer
            - `OriginalPrice` integer
            - `OriginalTax` integer
            - `Job` object
              - …
            - `BookingInterval` integer
            - `schedule` object[]
              - …
            - `unavailable_times` object[]
              - …
            - `LastDate` string
          - `Quantity` integer
          - `Price` object
            - `CurrencyId` integer
            - `Sales` integer
            - `Tax` integer
            - `Final` integer
            - `Final1` integer
            - `Discount` integer
            - `Tip` integer
            - `SSG` integer
            - `RoundingCorrection` integer
            - `DiscountedPrice` integer
            - `environmental_fee` integer
            - `environmental_fee_label` string
            - `can_be_waived` boolean
          - `IsMembershipApplied` boolean
          - `IsPackageApplied` boolean
          - `IsDiscountApplied` boolean
          - `MembershipBillDate` string
          - `RecurringMembership` object
            - `Days` integer
            - `SaleStartDate` string
            - `SaleEndDate` string
            - `CreditAmount` number
            - `CreditAmountExpiration` boolean
            - `NumGuests` integer
            - `Code` string
            - `BusinessUnitId` string
            - `Months` integer
            - `TermsandConditions` string
            - `Type` integer
            - `CategoryId` string
            - `Description` string
            - `HTMLDescription` string
            - `TermsandConditionsAcceptance` string
            - `Id` string
            - `VersionId` string
            - `SetupMembershipId` string
            - `Name` string
            - `Price` object
              - …
            - `SetupPrice` object
              - …
            - `CanBook` boolean
            - `ShowPrice` boolean
            - `DisplayName` string
            - `DisplayPrice` string
            - `ImagePaths` object
              - …
            - `IsRecurrringMembership` boolean
            - `MembershipType` integer
            - `FirstCollectionAfter` integer
            - `enforce_mandatory_fields` boolean
            - `FrequencyText` string
          - `Signature` string
          - `UserMembershipId` string
          - `AcceptedOn` string
          - `IsTandCAccepted` boolean
          - `PaymentAccountId` string
          - `HasMembershipDigitalForm` boolean
          - `HasFilledMembershipForms` boolean
          - `RecurringPaymentType` integer
        - `AppliedMembership` object
          - `MembershipId` string
          - `DiscountAmount` integer
          - `Action` string
          - `InvoiceItemId` string
          - `ShowChangeMembership` boolean
          - `EquivalenceOptions` number[]
        - `AppliedPackage` object
          - `PackageId` string
          - `DiscountAmount` integer
          - `Action` string
          - `InvoiceItemId` string
        - `AppliedDiscount` object
          - `DiscountId` string
          - `CampaignId` string
          - `CouponId` integer
          - `Action` string
          - `Type` integer
          - `DiscountAmount` integer
          - `InvoiceItemId` string
      - `InvoiceDayPackages` object[]
        - `AppointmentDayPackage` object
          - `Package` object
            - `Id` string
            - `Name` string
            - `Description` string
            - `Code` string
            - `HasBundledProducts` boolean
            - `Duration` integer
            - `BundledProductPriceCheck` integer
            - `BundledProductPricePercentage` integer
            - `PackagePriceWithOutTax` integer
            - `Type` integer
            - `Price` object
              - …
            - `PackageCostIncBundledProducts` boolean
            - `Services` object[]
              - …
            - `Items` object[]
              - …
            - `CanBook` boolean
            - `PackageDisplayName` string
            - `PackageDisplayPrice` string
            - `HTMLDescription` string
            - `CalculateServiceLevelTax` boolean
            - `TermsandConditions` string
            - `ExpirationDate` string
            - `ExpirationDays` integer
            - `ScheduledPaymentFrequency` integer
            - `ScheduledPaymentFrequencyType` integer
            - `RestrictRedemptionToThisCenter` integer
            - `CenterName` string
            - `PackageCategoryName` string
            - `start_validity_at_first_redemption` boolean
          - `InvoiceItemId` string
          - `InvoiceItemAddedTime` string
          - `AppointmentService` object[]
            - `AppointmentId` string
            - `InvoiceItemId` string
            - `InvoiceItemAddedTime` string
            - `UIItemIdentifier` string
            - `CartItemId` string
            - `AppointmentSegmentId` string
            - `PackageId` string
            - `Package` object
              - …
            - `Service` object
              - …
            - `ReducedTimeGroupId` string
            - `ServiceFormDetails` object[]
              - …
            - `RequestedTherapistGender` integer
            - `StartTime` string
            - `EndTime` string
            - `RequestedDuration` integer
            - `NonReducedDuration` integer
            - `StartTimeInCenter` string
            - `EndTimeInCenter` string
            - `Room` object
              - …
            - `Lock` boolean
            - `Equipment` object
              - …
            - `Status` integer
            - `RequestedTherapist` object
              - …
            - `SaleBy` object
              - …
            - `Quantity` integer
            - `Price` object
              - …
            - `SCD` string
            - `ActualStartTime` string
            - `CompletedTime` string
            - `Progress` integer
            - `ParentAppointmentId` string
            - `ServiceCustomData` object
              - …
            - `ItemActions` string
            - `EquivalenceFactor` number
            - `EquivalentName` string
            - `IsMembershipApplied` boolean
            - `IsAddOn` boolean
            - `AddonAppointmentId` string
            - `IsPackageApplied` boolean
            - `IsDiscountApplied` boolean
            - `CanModifyTherapist` boolean
            - `CoupleGroupNo` integer
            - `CoupleGroupId` string
            - `OrderNo` integer
            - `OpenSlots` object[]
              - …
            - `Warnings` object[]
              - …
            - `FillOpenSlots` boolean
            - `AssignDefaultSlot` boolean
            - `AssignedSlotTherapistIds` string[]
            - `AssignedSlotRoomIds` string[]
            - `AssignedSlotRooms` object[]
              - …
            - `AssignedSlotEquipmentIds` string[]
            - `AssignedSlotEquipments` object[]
              - …
            - `ResetIfTherapistCanNotDoService` boolean
            - `Membership` object
              - …
            - `PseudoAppliedMembership` integer
            - `PkgGroupNo` integer
            - `DayPackageService` object
              - …
            - `ShowInCalendar` integer
            - `FormId` string
            - `hasServiceForm` boolean
            - `PreferredTime` string
            - `AppointmentSource` integer
            - `RemoveBuddyServiceSegments` object[]
              - …
            - `AppointmentStatus` integer
            - `ServiceCustomDataEntered` boolean
            - `ProductConsumptionEntered` boolean
            - `disable_tip` boolean
            - `EnableCatalogServiceFrequency` boolean
            - `CatalogServiceFrequency` integer
          - `Quantity` integer
          - `Price` object
            - `CurrencyId` integer
            - `Sales` integer
            - `Tax` integer
            - `Final` integer
            - `Final1` integer
            - `Discount` integer
            - `Tip` integer
            - `SSG` integer
            - `RoundingCorrection` integer
            - `DiscountedPrice` integer
            - `environmental_fee` integer
            - `environmental_fee_label` string
            - `can_be_waived` boolean
          - `IsDiscountApplied` boolean
          - `AppointmentStatus` integer
        - `AppliedDiscount` object
          - `DiscountId` string
          - `CampaignId` string
          - `CouponId` integer
          - `Action` string
          - `Type` integer
          - `DiscountAmount` integer
          - `InvoiceItemId` string
      - `InvoiceSeriesPackages` object[]
        - `AppointmentSeriesPackage` object
          - `Package` object
            - `Id` string
            - `Name` string
            - `Description` string
            - `Code` string
            - `HasBundledProducts` boolean
            - `Duration` integer
            - `BundledProductPriceCheck` integer
            - `BundledProductPricePercentage` integer
            - `PackagePriceWithOutTax` integer
            - `Type` integer
            - `Price` object
              - …
            - `PackageCostIncBundledProducts` boolean
            - `Services` object[]
              - …
            - `Items` object[]
              - …
            - `CanBook` boolean
            - `PackageDisplayName` string
            - `PackageDisplayPrice` string
            - `HTMLDescription` string
            - `CalculateServiceLevelTax` boolean
            - `TermsandConditions` string
            - `ExpirationDate` string
            - `ExpirationDays` integer
            - `ScheduledPaymentFrequency` integer
            - `ScheduledPaymentFrequencyType` integer
            - `RestrictRedemptionToThisCenter` integer
            - `CenterName` string
            - `PackageCategoryName` string
            - `start_validity_at_first_redemption` boolean
          - `InvoiceItemId` string
          - `InvoiceItemAddedTime` string
          - `PackageUserId` string
          - `Employee` object
            - `Id` string
            - `ShortName` string
            - `NickName` string
            - `FullName` string
            - `Email` string
            - `PhoneNumber` string
            - `MobilePhoneModel` object
              - …
            - `Gender` integer
            - `FirstName` string
            - `LastName` string
            - `IsAvailable` boolean
            - `WaiveBiometricFlag` boolean
            - `VanityImageUrl` string
            - `ScalingFactor` number
            - `ScaledPrice` integer
            - `ServiceTime` integer
            - `DisplayName` string
            - `IdleTime` integer
            - `OriginalPrice` integer
            - `OriginalTax` integer
            - `Job` object
              - …
            - `BookingInterval` integer
            - `schedule` object[]
              - …
            - `unavailable_times` object[]
              - …
            - `LastDate` string
          - `Quantity` integer
          - `Price` object
            - `CurrencyId` integer
            - `Sales` integer
            - `Tax` integer
            - `Final` integer
            - `Final1` integer
            - `Discount` integer
            - `Tip` integer
            - `SSG` integer
            - `RoundingCorrection` integer
            - `DiscountedPrice` integer
            - `environmental_fee` integer
            - `environmental_fee_label` string
            - `can_be_waived` boolean
          - `IsMembershipApplied` boolean
          - `IsPackageApplied` boolean
          - `IsDiscountApplied` boolean
          - `packages_product_type_item` object[]
            - `packages_product` object
              - …
            - `quantity` integer
            - `invoice_item_id` string
            - `employee_id` string
            - `price` object
              - …
            - `discount` object
              - …
        - `AppliedMembership` object
          - `MembershipId` string
          - `DiscountAmount` integer
          - `Action` string
          - `InvoiceItemId` string
          - `ShowChangeMembership` boolean
          - `EquivalenceOptions` number[]
        - `AppliedPackage` object
          - `PackageId` string
          - `DiscountAmount` integer
          - `Action` string
          - `InvoiceItemId` string
        - `AppliedDiscount` object
          - `DiscountId` string
          - `CampaignId` string
          - `CouponId` integer
          - `Action` string
          - `Type` integer
          - `DiscountAmount` integer
          - `InvoiceItemId` string
      - `InvoiceGiftCards` object[]
        - `AppointmentGiftCard` object
          - `GiftCard` object
            - `Id` string
            - `Code` string
            - `Value` integer
            - `PurchasePrice` integer
            - `ValidityDays` integer
            - `IsOneTimeUse` boolean
            - `ExpiryDate` string
            - `Notes` string
            - `GiftTypeId` string
            - `SendEmailToRecipient` boolean
            - `Price` object
              - …
            - `Recipient` object
              - …
            - `Services` object
              - …
            - `RestrictRedemptionToSaleCenter` boolean
            - `ConfirmationMessage` string
            - `GiftCardTemplateId` string
            - `SelectedTemplateId` string
            - `gcPackage` object[]
              - …
            - `GiftCardMessage` string
            - `ScheduleDate` string
            - `MessageFromRecipient` string
            - `GcName` string
            - `send_gc_email_to_buyer` boolean
          - `InvoiceItemId` string
          - `InvoiceItemAddedTime` string
          - `Employee` object
            - `Id` string
            - `ShortName` string
            - `NickName` string
            - `FullName` string
            - `Email` string
            - `PhoneNumber` string
            - `MobilePhoneModel` object
              - …
            - `Gender` integer
            - `FirstName` string
            - `LastName` string
            - `IsAvailable` boolean
            - `WaiveBiometricFlag` boolean
            - `VanityImageUrl` string
            - `ScalingFactor` number
            - `ScaledPrice` integer
            - `ServiceTime` integer
            - `DisplayName` string
            - `IdleTime` integer
            - `OriginalPrice` integer
            - `OriginalTax` integer
            - `Job` object
              - …
            - `BookingInterval` integer
            - `schedule` object[]
              - …
            - `unavailable_times` object[]
              - …
            - `LastDate` string
          - `Quantity` integer
          - `Price` object
            - `CurrencyId` integer
            - `Sales` integer
            - `Tax` integer
            - `Final` integer
            - `Final1` integer
            - `Discount` integer
            - `Tip` integer
            - `SSG` integer
            - `RoundingCorrection` integer
            - `DiscountedPrice` integer
            - `environmental_fee` integer
            - `environmental_fee_label` string
            - `can_be_waived` boolean
          - `IsMembershipApplied` boolean
          - `IsPackageApplied` boolean
          - `IsDiscountApplied` boolean
          - `IsBonusGiftCard` boolean
          - `Items` object[]
            - `ItemId` string
            - `ItemName` string
            - `Type` integer
            - `SubItems` object[]
              - …
            - `Quantity` integer
            - `price` number
        - `AppliedMembership` object
          - `MembershipId` string
          - `DiscountAmount` integer
          - `Action` string
          - `InvoiceItemId` string
          - `ShowChangeMembership` boolean
          - `EquivalenceOptions` number[]
        - `AppliedPackage` object
          - `PackageId` string
          - `DiscountAmount` integer
          - `Action` string
          - `InvoiceItemId` string
        - `AppliedDiscount` object
          - `DiscountId` string
          - `CampaignId` string
          - `CouponId` integer
          - `Action` string
          - `Type` integer
          - `DiscountAmount` integer
          - `InvoiceItemId` string
      - `InvoicePrepaidCards` object[]
        - `AppointmentPrepaidCard` object
          - `PrepaidCard` object
            - `Id` string
            - `Code` string
            - `Value` integer
            - `PurchasePrice` integer
            - `ValidityDays` integer
            - `IsOneTimeUse` boolean
            - `ExpiryDate` string
            - `Notes` string
            - `GiftTypeId` string
            - `SendEmailToRecipient` boolean
            - `Price` object
              - …
            - `Recipient` object
              - …
            - `Services` object
              - …
            - `RestrictRedemptionToSaleCenter` boolean
            - `ConfirmationMessage` string
            - `GiftCardTemplateId` string
            - `SelectedTemplateId` string
            - `gcPackage` object[]
              - …
            - `GiftCardMessage` string
            - `ScheduleDate` string
            - `MessageFromRecipient` string
            - `GcName` string
            - `send_gc_email_to_buyer` boolean
          - `InvoiceItemId` string
          - `InvoiceItemAddedTime` string
          - `Employee` object
            - `Id` string
            - `ShortName` string
            - `NickName` string
            - `FullName` string
            - `Email` string
            - `PhoneNumber` string
            - `MobilePhoneModel` object
              - …
            - `Gender` integer
            - `FirstName` string
            - `LastName` string
            - `IsAvailable` boolean
            - `WaiveBiometricFlag` boolean
            - `VanityImageUrl` string
            - `ScalingFactor` number
            - `ScaledPrice` integer
            - `ServiceTime` integer
            - `DisplayName` string
            - `IdleTime` integer
            - `OriginalPrice` integer
            - `OriginalTax` integer
            - `Job` object
              - …
            - `BookingInterval` integer
            - `schedule` object[]
              - …
            - `unavailable_times` object[]
              - …
            - `LastDate` string
          - `Quantity` integer
          - `Price` object
            - `CurrencyId` integer
            - `Sales` integer
            - `Tax` integer
            - `Final` integer
            - `Final1` integer
            - `Discount` integer
            - `Tip` integer
            - `SSG` integer
            - `RoundingCorrection` integer
            - `DiscountedPrice` integer
            - `environmental_fee` integer
            - `environmental_fee_label` string
            - `can_be_waived` boolean
          - `IsMembershipApplied` boolean
          - `IsPackageApplied` boolean
          - `IsDiscountApplied` boolean
        - `AppliedMembership` object
          - `MembershipId` string
          - `DiscountAmount` integer
          - `Action` string
          - `InvoiceItemId` string
          - `ShowChangeMembership` boolean
          - `EquivalenceOptions` number[]
        - `AppliedPackage` object
          - `PackageId` string
          - `DiscountAmount` integer
          - `Action` string
          - `InvoiceItemId` string
        - `AppliedDiscount` object
          - `DiscountId` string
          - `CampaignId` string
          - `CouponId` integer
          - `Action` string
          - `Type` integer
          - `DiscountAmount` integer
          - `InvoiceItemId` string
      - `Payments` object[]
        - `PaymentOption` object
          - `Id` string
          - `PaymentMode` integer
          - `PaymentName` string
          - `CardNumber` string
        - `TotalAmountPaid` integer
        - `AmountPaid` integer
        - `TipAmount` integer
        - `SSGAmount` integer
        - `FeeAmount` integer
        - `CashBackAmount` integer
        - `TransactionId` string
        - `PaymentDate` string
        - `CashRegisterId` string
      - `Redemptions` object[]
        - `Option` object
          - `Id` string
          - `Mode` integer
          - `Name` string
        - `Amount` integer
        - `TransactionId` string
        - `PaymentDate` string
        - `Points` integer
      - `RefundItems` object[]
        - `InvoiceItemId` string
        - `ItemId` string
        - `Quantity` integer
        - `RefundAmount` integer
        - `RefundDate` string
      - `Lock` boolean
      - `CanChangeGuest` boolean
      - `CenterId` string
      - `Center` object
        - `Id` string
        - `Country` object
          - `Id` integer
          - `Code` string
          - `Name` string
          - `PhoneCode` integer
          - `Nationality` string
        - `State` object
          - `Id` integer
          - `Code` string
          - `Name` string
          - `ShortName` string
        - `Name` string
        - `GeoLatitude` number
        - `GeoLongitude` number
        - `Address1` string
        - `Address2` string
        - `City` string
        - `ZipCode` string
        - `Phone1` object
          - `CountryId` integer
          - `Number` string
          - `DisplayNumber` string
        - `Phone2` object
          - `CountryId` integer
          - `Number` string
          - `DisplayNumber` string
        - `Email` string
        - `CenterInfo` string
        - `ServiceTaxNo` string
        - `TIN` string
        - `VAT` string
        - `CST` string
        - `CanBook` boolean
        - `CenterCode` string
        - `TimeZone` object
          - `Id` integer
          - `Name` string
          - `StandardName` string
          - `Symbol` string
        - `CollectFeedback` boolean
        - `working_hours` object[]
          - `day_of_week` string
          - `start_time` string
          - `end_time` string
        - `AreServicesAvailableInCenter` boolean
        - `FeedBackLink` string
        - `FeedBackLabelText` string
        - `isPaymentEnabled` boolean
        - `isCenterVoided` boolean
        - `isServiceSaleEnabled` boolean
        - `isMembershipSaleEnabled` boolean
        - `isGiftCardSaleEnabled` boolean
        - `isSeriesPackageSaleEnabled` boolean
        - `isDealsEnabled` boolean
        - `EnableSelfPay` boolean
        - `EnableSelfCheckIn` boolean
        - `EnableAutoPay` boolean
        - `AllowSelfCheckinBefore` integer
        - `AllowCheckWithinRadius` integer
        - `Zone` object
          - `id` string
          - `name` unknown
      - `CollectFeedback` boolean
      - `IsFeedbackExpired` boolean
      - `BookingWizardAdvancedMode` boolean
      - `BookingWizardBottomPanelMode` boolean
      - `Refunded` boolean
      - `InvoiceAuthStatus` integer
      - `InvoiceAuthorizationStatus` integer
      - `InvTransactionStatusForAutoPay` integer
      - `InvoiceSource` integer
      - `is_created_from_booking_wizard` boolean
      - `RemoveBuddyServiceFinishSegment` boolean
      - `host_id` string
      - `payment_made_by` string
      - `entity_name` string
      - `email_link` string
      - `sms_link` string
      - `appointment_category_id` string
      - `scheduled_payment_frequency` integer
      - `scheduled_payment_installment` integer
      - `scheduled_first_payment` integer
      - `scheduled_payment_frequency_type` integer
    - `Redemptions` object[]
      - `Option` object
        - `Id` string
        - `Mode` integer
        - `Name` string
      - `Amount` integer
      - `TransactionId` string
      - `PaymentDate` string
      - `Points` integer
    - `Payments` object[]
      - `PaymentOption` object
        - `Id` string
        - `PaymentMode` integer
        - `PaymentName` string
        - `CardNumber` string
      - `TotalAmountPaid` integer
      - `AmountPaid` integer
      - `TipAmount` integer
      - `SSGAmount` integer
      - `FeeAmount` integer
      - `CashBackAmount` integer
      - `TransactionId` string
      - `PaymentDate` string
      - `CashRegisterId` string
    - `Price` object
      - `CurrencyId` integer
      - `Sales` integer
      - `Tax` integer
      - `Final` integer
      - `Final1` integer
      - `Discount` integer
      - `Tip` integer
      - `SSG` integer
      - `RoundingCorrection` integer
      - `DiscountedPrice` integer
      - `environmental_fee` integer
      - `environmental_fee_label` string
      - `can_be_waived` boolean
    - `GroupRedemptions` object[]
      - `GroupRedemptionId` string
      - `InvoiceId` string
    - `GroupPayments` object[]
      - `GroupTransactionId` string
      - `TransactionId` string
  - `error` unknown

## Other responses

- `400` — 400

---

[API](https://skmtc.net/zenoti/apis/zenoti-authentication.md) · [All operations](https://skmtc.net/zenoti/apis/zenoti-authentication/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zenoti/zenoti-authentication/revisions/e628f892391a/schema)
