> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Check Cherry

> Check Cherry is a business management platform for photography and event service companies, with tools for leads, bookings, appointments, offerings, payments, and workflows.

![Check Cherry logo](https://mintcdn.com/composio-preview/PudKL42NVsy5O-ND/images/toolkits/check_cherry.svg?fit=max\&auto=format\&n=PudKL42NVsy5O-ND\&q=85\&s=9aba01b407c0692ce638ad1ea37f8e26)

* **Category:** crm
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 25
* **Triggers:** 0
* **Slug:** `CHECK_CHERRY`
* **Version:** 20261101\_00

## Tools

> [accordion] Attach Questionnaire
>
> **Slug:** `CHECK_CHERRY_ATTACH_QUESTIONNAIRE`
>
> Copy a questionnaire template onto a proposal or confirmed booking, preserving its contents and visibility settings at attachment time. Non-admin users can attach only templates with staff viewing enabled.
>
> #### Input Parameters
>
> **event\_id** `integer` *required*
>
> Event resource ID for the proposal or confirmed booking that will receive the questionnaire, from List Events; this is not the related event\_booking ID.
>
> **questionnaire\_template\_id** `integer` *required*
>
> Questionnaire template ID to copy, from List Questionnaire Templates.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Check Event Availability
>
> **Slug:** `CHECK_CHERRY_CHECK_EVENT_AVAILABILITY`
>
> Check whether a package can be booked on one date or across a date range.
>
> #### Input Parameters
>
> **ends\_at** `string`
>
> Last date of the range in YYYY-MM-DD format. Required with starts\_at when event\_date is omitted.
>
> **starts\_at** `string`
>
> First date of the range in YYYY-MM-DD format. Required with ends\_at when event\_date is omitted.
>
> **event\_date** `string`
>
> Single date to check in YYYY-MM-DD format. Use this alone, or omit it and provide both starts\_at and ends\_at.
>
> **package\_id** `integer` *required*
>
> Package ID to check. Check Cherry requires this value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Appointment
>
> **Slug:** `CHECK_CHERRY_CREATE_APPOINTMENT`
>
> Create a staff appointment for a guest at a specific date, time, and duration; this changes the business calendar.
>
> #### Input Parameters
>
> **user\_id** `integer`
>
> Staff user ID; omit to use the authenticated user.
>
> **brand\_id** `integer`
>
> Brand ID; omit to use the primary brand.
>
> **location** `string`
>
> Appointment location or channel, such as Phone or In Person.
>
> **guest\_name** `string` *required*
>
> Guest's full name.
>
> **created\_via** `string ("quick_add" | "widget" | "app")` *required*
>
> Provider channel to record for appointment creation.
>
> **guest\_email** `string` *required*
>
> Guest email address.
>
> **guest\_phone** `string`
>
> Guest phone number.
>
> **private\_notes** `string`
>
> Internal notes not intended for the guest.
>
> **starts\_at\_date** `string` *required*
>
> Appointment date in YYYY-MM-DD format.
>
> **starts\_at\_time** `string` *required*
>
> Appointment start time, such as 2:00 PM.
>
> **length\_in\_minutes** `integer` *required*
>
> Appointment duration in minutes.
>
> **appointment\_calendar\_id** `integer`
>
> Staff appointment calendar ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Expense
>
> **Slug:** `CHECK_CHERRY_CREATE_EXPENSE`
>
> Record a business expense with its payment date, amount, reference, payee, and optional event and category links.
>
> #### Input Parameters
>
> **amount** `number` *required*
>
> Expense amount in the account currency.
>
> **event\_id** `integer`
>
> Event ID to associate with the expense.
>
> **staff\_id** `integer`
>
> Staff member ID; required when payee\_type is staff.
>
> **payee\_name** `string`
>
> Payee name; required when payee\_type is custom.
>
> **payee\_type** `string ("custom" | "staff")`
>
> Whether the payee is a named external payee or a staff member.
>
> **description** `string`
>
> Reason or details for the expense.
>
> **payment\_date** `string` *required*
>
> Payment date in YYYY-MM-DD format.
>
> **payment\_method** `string`
>
> Payment method, such as Cash, Check, or Credit Card.
>
> **reference\_number** `string` *required*
>
> Unique expense reference number.
>
> **expense\_category\_id** `integer`
>
> Expense category ID from List Expense Categories.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Appointment
>
> **Slug:** `CHECK_CHERRY_DELETE_APPOINTMENT`
>
> Soft-delete one appointment so it no longer appears in active business calendar records; Check Cherry retains the deleted record.
>
> #### Input Parameters
>
> **appointment\_id** `integer` *required*
>
> Unique appointment ID to remove from active calendar records.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Expense
>
> **Slug:** `CHECK_CHERRY_DELETE_EXPENSE`
>
> Soft-delete one business expense so it no longer appears in listings; Check Cherry retains the record for record-keeping.
>
> #### Input Parameters
>
> **expense\_id** `integer` *required*
>
> Unique expense ID to remove from expense listings.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Appointment
>
> **Slug:** `CHECK_CHERRY_GET_APPOINTMENT`
>
> Return full guest, scheduling, and assignment details for one appointment.
>
> #### Input Parameters
>
> **appointment\_id** `integer` *required*
>
> Unique appointment ID, available from List Appointments.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Event
>
> **Slug:** `CHECK_CHERRY_GET_EVENT`
>
> Return event details for one proposal or booking by event ID. For proposals with alternatives, the event's balance and deposit totals combine all alternatives and do not represent the price the client pays.
>
> #### Input Parameters
>
> **event\_id** `integer` *required*
>
> Unique event ID, available from List Events.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Lead
>
> **Slug:** `CHECK_CHERRY_GET_LEAD`
>
> Return full details for one lead by ID.
>
> #### Input Parameters
>
> **lead\_id** `integer` *required*
>
> Unique lead ID, available from List Leads.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Questionnaire
>
> **Slug:** `CHECK_CHERRY_GET_QUESTIONNAIRE`
>
> Return one questionnaire with its completion state and, for standard questionnaires, its questions and current answers. External questionnaires instead provide a link to the hosted form.
>
> #### Input Parameters
>
> **questionnaire\_id** `integer` *required*
>
> Unique questionnaire ID, available from List Questionnaires.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Report
>
> **Slug:** `CHECK_CHERRY_GET_REPORT`
>
> Return one time-bucketed Check Cherry business report for bookings, leads, payments, proposals, or projected revenue.
>
> #### Input Parameters
>
> **ends\_at** `string`
>
> End of the report range in YYYY-MM-DD format; defaults to today.
>
> **brand\_id** `integer`
>
> Limit the report to one brand.
>
> **interval** `string ("year" | "quarter" | "month" | "week" | "day")`
>
> Time bucket for report results.
>
> **starts\_at** `string`
>
> Start of the report range in YYYY-MM-DD format; defaults to one year ago.
>
> **date\_basis** `string ("created_on" | "scheduled_on")`
>
> Bucketing date for leads or proposals only. created\_on uses creation date; scheduled\_on uses the requested or proposed event date.
>
> **report\_type** `string ("bookings" | "leads" | "payments" | "proposals" | "revenue_projection")` *required*
>
> Business metric to report.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Appointments
>
> **Slug:** `CHECK_CHERRY_LIST_APPOINTMENTS`
>
> Search staff appointments by date, assignee, brand, cancellation state, time direction, or text, returning one page.
>
> #### Input Parameters
>
> **brand\_id** `integer`
>
> Return appointments for this brand only.
>
> **end\_date** `string`
>
> Latest appointment date in YYYY-MM-DD format.
>
> **per\_page** `integer`
>
> Number of appointments to request in this page.
>
> **staff\_id** `string`
>
> Staff member ID, or 'my' for the authenticated user.
>
> **start\_date** `string`
>
> Earliest appointment date in YYYY-MM-DD format.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call; omit for the first page.
>
> **search\_text** `string`
>
> Text to search across appointment and guest details.
>
> **past\_or\_future** `string ("past" | "future" | "both")`
>
> Return past, future, or both groups of appointments.
>
> **canceled\_status** `string`
>
> Check Cherry cancellation-state filter. The provider does not publish the accepted values for appointments, so use a value confirmed for the connected account.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Appointment Slots
>
> **Slug:** `CHECK_CHERRY_LIST_APPOINTMENT_SLOTS`
>
> Return appointment time slots for one staff member and appointment calendar on a selected date, including each slot's availability status.
>
> #### Input Parameters
>
> **user\_id** `integer` *required*
>
> Staff user ID whose appointment availability to inspect.
>
> **selected\_date** `string` *required*
>
> Date to inspect in YYYY-MM-DD format.
>
> **appointment\_calendar\_id** `integer` *required*
>
> Appointment calendar ID for the selected staff member.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Event Bookings
>
> **Slug:** `CHECK_CHERRY_LIST_EVENT_BOOKINGS`
>
> List package bookings attached to events within an optional event-date range, returning one page and a continuation cursor.
>
> #### Input Parameters
>
> **per\_page** `integer`
>
> Number of bookings to request in this page.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call; omit for the first page.
>
> **event\_date\_end** `string`
>
> Latest event date in YYYY-MM-DD format.
>
> **event\_date\_start** `string`
>
> Earliest event date in YYYY-MM-DD format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Events
>
> **Slug:** `CHECK_CHERRY_LIST_EVENTS`
>
> Search proposals and confirmed bookings with date, status, client, staff, payment, and workflow filters, returning one page; expired proposals are excluded. For proposals with alternatives, event-level balance and deposit amounts aggregate all alternatives rather than the price of one option.
>
> #### Input Parameters
>
> **brand\_id** `integer`
>
> Return events for this brand only.
>
> **past\_due** `boolean`
>
> When true, return only events with a past-due payment.
>
> **per\_page** `integer`
>
> Number of events to request in this page. No provider maximum is verified.
>
> **staff\_id** `integer`
>
> Return events assigned to this staff member.
>
> **client\_id** `integer`
>
> Return events for this client only.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call; omit for the first page.
>
> **search\_text** `string`
>
> Text to search across event and contact details.
>
> **event\_status** `string ("proposal_date_open" | "proposal_date_reserved" | "proposal_awaiting_review" | "awaiting_signature" | "confirmed" | "any_proposal" | "any_confirmed" | "any_unsigned")`
>
> Proposal or confirmed-booking status to return. Cancellation is controlled separately by canceled\_status.
>
> **event\_date\_end** `string`
>
> Latest event date in YYYY-MM-DD format.
>
> **canceled\_status** `string ("hide_canceled" | "show_canceled_only" | "show_all")`
>
> Cancellation filter: hide\_canceled excludes canceled events, show\_canceled\_only returns only canceled events, and show\_all includes both. Omit to use hide\_canceled.
>
> **awaiting\_deposit** `boolean`
>
> When true, return only events with an unpaid deposit.
>
> **event\_date\_start** `string`
>
> Earliest event date in YYYY-MM-DD format.
>
> **postponed\_status** `string ("hide_postponed" | "show_postponed_only" | "show_all")`
>
> Postponement filter: hide\_postponed excludes postponed events, show\_postponed\_only returns only postponed events, and show\_all includes both. Omit to use hide\_postponed.
>
> **no\_staff\_assigned** `boolean`
>
> When true, return only events with no staff assigned.
>
> **unsubmitted\_forms** `boolean`
>
> When true, return only events with an unsubmitted form.
>
> **balance\_outstanding** `boolean`
>
> When true, return only events with a balance owed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Expense Categories
>
> **Slug:** `CHECK_CHERRY_LIST_EXPENSE_CATEGORIES`
>
> Return the expense categories available for classifying business expenses.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Expenses
>
> **Slug:** `CHECK_CHERRY_LIST_EXPENSES`
>
> Search business expenses by event, category, payment date, text, and sort order, returning one page.
>
> #### Input Parameters
>
> **sort\_by** `string ("paid_at_asc" | "paid_at_desc" | "relevance")`
>
> Order returned expenses.
>
> **event\_id** `integer`
>
> Return expenses associated with this event.
>
> **per\_page** `integer`
>
> Number of expenses to request in this page.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call; omit for the first page.
>
> **search\_text** `string`
>
> Search expense reference numbers, payees, and descriptions.
>
> **payment\_date\_end** `string`
>
> Latest payment date in YYYY-MM-DD format.
>
> **payment\_date\_start** `string`
>
> Earliest payment date in YYYY-MM-DD format.
>
> **expense\_category\_id** `integer`
>
> Return expenses in this category.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Leads
>
> **Slug:** `CHECK_CHERRY_LIST_LEADS`
>
> List one page of leads, optionally filtering by exact email or full-text search across lead names, email, phone, venue, and notes.
>
> #### Input Parameters
>
> **email** `string`
>
> Return leads with this exact email address.
>
> **per\_page** `integer`
>
> Number of leads to request in this page. The provider has no verified maximum, so the default is a conservative 25.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous response; omit for the first page.
>
> **search\_text** `string`
>
> Search lead names, emails, phones, venues, and notes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Offerings
>
> **Slug:** `CHECK_CHERRY_LIST_OFFERINGS`
>
> List one Check Cherry catalog resource: active services, publicly visible package groups, packages, or active add-ons.
>
> #### Input Parameters
>
> **resource** `string ("services" | "package_groups" | "packages" | "add_ons")` *required*
>
> Catalog resource to list.
>
> **visibility** `string`
>
> Package visibility filter, such as public\_only. Valid only when resource is packages.
>
> **search\_text** `string`
>
> Search add-ons by name. Valid only when resource is add\_ons.
>
> **category\_ids** `array`
>
> Filter add-ons by category IDs. Valid only when resource is add\_ons.
>
> **widget\_visible\_only** `boolean`
>
> Return only add-ons visible on the booking widget. Valid only when resource is add\_ons.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Payments
>
> **Slug:** `CHECK_CHERRY_LIST_PAYMENTS`
>
> List event payment records, including received payments and refunds, by event or payment date; returns one page with monetary values in Check Cherry's original representations.
>
> #### Input Parameters
>
> **event\_id** `integer`
>
> Return payments for this event only.
>
> **per\_page** `integer`
>
> Number of payments to request in this page. No provider maximum is verified.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous call; omit for the first page.
>
> **payment\_date\_end** `string`
>
> Latest payment date in YYYY-MM-DD format.
>
> **payment\_date\_start** `string`
>
> Earliest payment date in YYYY-MM-DD format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Questionnaires
>
> **Slug:** `CHECK_CHERRY_LIST_QUESTIONNAIRES`
>
> List questionnaires attached to one event booking. Results reflect the authenticated user's visibility permissions and questionnaire display window.
>
> #### Input Parameters
>
> **event\_id** `integer` *required*
>
> Event resource ID for the proposal or confirmed booking whose questionnaires to return, from List Events; do not use the related event\_booking ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Questionnaire Templates
>
> **Slug:** `CHECK_CHERRY_LIST_QUESTIONNAIRE_TEMPLATES`
>
> List the business's questionnaire templates that can be attached to an event booking. Deleted templates are excluded; non-admin users see only templates with staff viewing enabled.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Questionnaire
>
> **Slug:** `CHECK_CHERRY_REMOVE_QUESTIONNAIRE`
>
> Detach one questionnaire from its event booking and delete its collected answers; the source questionnaire template is unchanged. Requires an admin or extended-staff integration-key user in addition to event write permission.
>
> #### Input Parameters
>
> **questionnaire\_id** `integer` *required*
>
> Unique questionnaire ID to detach from the booking with its answers.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Expense
>
> **Slug:** `CHECK_CHERRY_UPDATE_EXPENSE`
>
> Change selected fields on an existing business expense.
>
> #### Input Parameters
>
> **amount** `number`
>
> Replacement expense amount in the account currency.
>
> **event\_id** `integer`
>
> Replacement associated event ID.
>
> **staff\_id** `integer`
>
> Replacement staff payee ID.
>
> **expense\_id** `integer` *required*
>
> Unique expense ID to update.
>
> **payee\_name** `string`
>
> Replacement custom payee name.
>
> **payee\_type** `string ("custom" | "staff")`
>
> Replacement payee type.
>
> **description** `string`
>
> Replacement expense description.
>
> **payment\_date** `string`
>
> Replacement payment date in YYYY-MM-DD format.
>
> **payment\_method** `string`
>
> Replacement payment method.
>
> **reference\_number** `string`
>
> Replacement reference number.
>
> **expense\_category\_id** `integer`
>
> Replacement expense category ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Questionnaire Answers
>
> **Slug:** `CHECK_CHERRY_UPDATE_QUESTIONNAIRE_ANSWERS`
>
> Update answers on a standard questionnaire. By default, answers merge by field UUID, but each supplied UUID replaces that field's complete answer array. Set replace\_all to delete answers for omitted UUIDs as well. The integration-key user must be staff with edit access to the questionnaire.
>
> #### Input Parameters
>
> **replace\_all** `boolean`
>
> Whether answers\_by\_field\_uuid represents the complete questionnaire. False merges by field UUID while replacing each supplied field's full answer array; true also deletes answers for omitted field UUIDs.
>
> **questionnaire\_id** `integer` *required*
>
> Unique questionnaire ID to update.
>
> **answers\_by\_field\_uuid** `object` *required*
>
> Answers keyed by field UUID from Get Questionnaire. Each value is the complete array of entries for that field; entry keys depend on the field type (for example, text\_field uses text and dropdown uses dropdown). Include every element of each supplied entry; an empty array clears the field. Example: \{"field-uuid": \[\{"text": "Answer"}]}.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
