ZenotiHelp

Package agreement form data retrieval

ZTZenoti Docs Team Updated August 5, 2026 5 min readGuide

When a guest purchases a package, Zenoti can capture a signed HTML agreement form at the point of sale. This article explains how the system retrieves that submitted form data so it can be rendered — for example, when building dispute evidence for a payment chargeback.

Audience: Administrators and integration developers who need to understand how package agreement form submissions are accessed and rendered in Zenoti.


On this page


Before you begin

  • The package must have an HTML agreement form assigned to it. Forms are assigned during package setup.
  • The guest must have completed and submitted the agreement form at the time of the package sale. The retrieval mechanism only returns data for forms where submission is confirmed.
  • The package sale must be associated with an invoice item. The invoice item identifier is required to locate the correct form submission.
  • You need access to the package details in the guest profile to verify that a form was submitted.

Permission: You need the Packages security role permission to view package details and associated form data in the guest profile.


How package agreement form data retrieval works

When a guest purchases a package that has an HTML agreement form assigned, Zenoti stores the submitted form data against the invoice item created for that sale. The retrieval process locates the correct submission by matching three criteria:

  • The specific form assigned to the package (identified by the form ID)
  • The invoice item created when the package was sold (identified by the invoice item ID)
  • A confirmed submission status — only forms the guest has actually submitted are returned

The retrieved data includes:

  • Data — The full HTML form content as submitted by the guest
  • GuestDataJson — Guest-specific data captured in the form
  • IsFormSubmitted — A flag confirming the form was submitted

This retrieval pattern mirrors how membership agreement forms are fetched, which means package HTML agreement forms render consistently with membership agreement forms in contexts such as the dispute-evidence agreement flow.

Note: Only the most recent submitted form matching the form ID and invoice item is returned. If a guest submitted the form multiple times (for example, after a correction), only the latest valid submission is used.


Steps

Verify that a package agreement form was submitted

  1. Navigate to the guest profile for the guest whose package you want to review.

  2. Select the Packages tab.

  3. Locate the package sale in the guest's package list and open the package details.

  4. Confirm that an agreement form is listed under the package and that its status shows as submitted.

    Note: If no form appears, or if the form status does not show as submitted, the retrieval process will return no data. The guest must have completed and submitted the form at the time of sale.

Confirm the invoice item for the package sale

  1. From the guest profile, navigate to the Payments tab or open the invoice associated with the package sale.
  2. Locate the invoice item corresponding to the package purchase.
  3. Note the invoice details — this is the record the system uses to match the form submission to the correct sale.

Retrieve the form data for rendering or dispute evidence

  1. When the form data is needed — for example, when generating dispute evidence for a payment chargeback — the system uses the form ID assigned to the package and the invoice item ID from the package sale to locate the submitted form.
  2. The system returns the submitted HTML form content, the guest data captured in the form, and a confirmation that the form was submitted.
  3. The retrieved form renders in the same format as a membership agreement form, ensuring visual consistency across agreement form types.

Worked example: A guest purchased a series package called "Wellness 10-Pack" on 14 March. The package has an HTML agreement form (Form ID: 4821) assigned to it. The guest signed and submitted the form at checkout. The invoice item ID for this sale is 990234. When a payment dispute is raised on this invoice, the system retrieves the form submission by matching Form ID 4821 to invoice item 990234, confirms the form was submitted, and returns the signed HTML content for inclusion in the dispute evidence package.


Tips

  • Assign agreement forms before selling packages. Form data can only be retrieved for submissions made at the time of sale. If a form is added to a package after the package has already been sold to a guest, earlier sales will not have associated form data.
  • Use the same form type for consistency. Package HTML agreement forms (form type 7) are retrieved and rendered using the same pattern as membership agreement forms (form type 6). Keeping your agreement form design consistent across both package and membership forms ensures a uniform appearance in dispute evidence and other rendered contexts.
  • Confirm submission status before escalating a dispute. Before including a package agreement form in dispute evidence, verify in the guest profile that the form status is submitted. A form that was opened but not completed will not be retrievable.
  • One form per package. A package can have only one HTML agreement form assigned to it. If you attempt to assign a second form of the same type, the system will display the message: "You can only have one {0} form for a package."

Troubleshooting

The form data is not returned even though the guest purchased the package.

The retrieval process only returns data when all three conditions are met: the form ID matches the form assigned to the package, the invoice item ID matches the package sale, and the form submission status is confirmed. Check the guest profile Packages tab to verify that the form shows as submitted. If the form was never submitted — for example, if the guest closed the form without completing it — no data will be returned.

The form appears in the guest profile but the content is blank when rendered.

This can occur if the form was submitted without any data entered, or if the form data was stored in an unexpected format. Verify that the guest completed the form fields before submitting. If the issue persists, contact your Zenoti administrator to review the form configuration.

The retrieved form does not match the current version of the agreement form.

The system retrieves the form data as it was submitted at the time of the package sale. If the agreement form template was updated after the guest submitted their form, the retrieved content will reflect the version the guest signed, not the current template. This is expected behavior — the submitted record is preserved as the guest completed it.


Was this article helpful?
Your feedback helps us improve our documentation.