Proposals/Confirmed Bookings

Fetch a proposal alternative

Returns one alternative on a proposal, with the IDs of the packages in it. GET /api/v1/events/{event_id}?include=proposal_alternatives lists every alternative on a proposal.

sub_total, tax_amount, final_total and deposit_amount_due price this alternative on its own, the way the client sees it on the proposal. They are null without assigned_event_read_pricing or unassigned_event_read_pricing.

Use the include query parameter to sideload related resources (comma-separated). Available: event_bookings, event_adjustments. event_adjustments lists the adjustments, such as travel fees and discounts, that apply to this alternative.

Required permission: assigned_event_read or unassigned_event_read

get/api/v1/events/{event_id}/proposal_alternatives/{id}

Request

  • Base URL: https://api.checkcherry.com
  • URL: https://api.checkcherry.com/api/v1/events/{event_id}/proposal_alternatives/{id}
  • Auth: none declared. Required headers: Api-Key

Path parameters

event_idinteger required

Event ID

idinteger required

Proposal Alternative ID

Query parameters

includestring

Related resources to sideload, comma-separated. The description lists what is available.

Headers

Api-Keystring required

Your Integration Key

Response

alternative found

Changes

No recorded changes to this operation across all 2 revisions of this API.