# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cvent REST Budget API
  version: 1.0.0
extends: openapi/cvent-event-cloud-budget-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 24
- target: $.paths['/budget-items'].get
  update:
    x-apievangelist-phrasing:
      intent: List budget items across all events
      effect: read
      questions:
      - What budget items exist across every event in my Cvent account?
      - Can I pull account-wide event costs for a specific date window?
      instructions:
      - text: List budget items across all my events between {after} and {before}.
        slots:
          after: query.after
          before: query.before
      - text: Export every account-wide budget item modified from {after} to {before} matching {filter}.
        slots:
          after: query.after
          before: query.before
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/budget-vendors'].get
  update:
    x-apievangelist-phrasing:
      intent: List account-level budget vendors
      effect: read
      questions:
      - Which budget vendors are configured at the account level?
      - Are event-scoped vendors included in the account vendor list?
      instructions:
      - text: List the account-level budget vendors.
      - text: Show budget vendors from the account admin list matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cards'].get
  update:
    x-apievangelist-phrasing:
      intent: List payment cards on the account
      effect: read
      questions:
      - What payment cards are linked to my Cvent account?
      - Can I filter the account's payment cards?
      instructions:
      - text: List the payment cards on my account.
      - text: Show payment cards matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cards/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List card transactions
      effect: read
      questions:
      - What card transactions have been recorded on my account?
      - How do I see card charges made within a certain date range?
      instructions:
      - text: List card transactions recorded after {after}.
        slots:
          after: query.after
      - text: Show card transactions between {after} and {before}.
        slots:
          after: query.after
          before: query.before
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cards/transactions'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a card transaction
      effect: write
      questions:
      - How do I log a corporate card charge against an event?
      - Can I record the merchant and currency for a card transaction?
      instructions:
      - text: Record a card transaction of {transactionAmount} {transactionCurrency} at {transactionMerchant} for event {eventId}.
        slots:
          transactionAmount: requestBody.transactionAmount
          transactionCurrency: requestBody.transactionCurrency
          transactionMerchant: requestBody.transactionMerchant
          eventId: requestBody.eventId
      - text: Log a new card charge dated {transactionDate} for {transactionAmount}.
        slots:
          transactionDate: requestBody.transactionDate
          transactionAmount: requestBody.transactionAmount
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cards/transactions/{transactionId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a card transaction record
      effect: write
      questions:
      - Can I correct a card transaction that's already been recorded?
      - What's the call to edit an existing card charge?
      instructions:
      - text: Update card transaction {transactionId}.
        slots:
          transactionId: path.transactionId
      - text: Correct the details of the recorded card charge {transactionId}.
        slots:
          transactionId: path.transactionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cards/transactions/{transactionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a card transaction
      effect: destructive
      questions:
      - How do I remove a card transaction entered by mistake?
      - Can a recorded card charge be deleted?
      instructions:
      - text: Delete card transaction {transactionId}.
        slots:
          transactionId: path.transactionId
      - text: Remove the duplicate card charge {transactionId}.
        slots:
          transactionId: path.transactionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/currencies/{currency}/conversion-rates'].get
  update:
    x-apievangelist-phrasing:
      intent: List conversion rates for a currency
      effect: read
      questions:
      - What exchange rates are defined for a currency in my account?
      - Can I see the conversion rates for euros over a date range?
      instructions:
      - text: List the conversion rates for {currency}.
        slots:
          currency: path.currency
      - text: Show {currency} conversion rates effective after {after}.
        slots:
          currency: path.currency
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/currencies/{currency}/conversion-rates'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a conversion rate for a currency
      effect: write
      questions:
      - How do I define an exchange rate for a currency in Cvent budgets?
      - Can a conversion rate have a start and end date?
      instructions:
      - text: Add a {currency} conversion rate of {conversionRate} starting {startDate}.
        slots:
          currency: path.currency
          conversionRate: requestBody.conversionRate
          startDate: requestBody.startDate
      - text: Create a {currency} rate of {conversionRate} valid from {startDate} to {endDate}.
        slots:
          currency: path.currency
          conversionRate: requestBody.conversionRate
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/currencies/{currency}/conversion-rates/{conversionRateId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an existing currency conversion rate
      effect: write
      questions:
      - Can I change an exchange rate I already set up?
      - What do I send to extend the end date of an existing conversion rate?
      instructions:
      - text: Change existing {currency} conversion rate {conversionRateId} to {conversionRate}.
        slots:
          currency: path.currency
          conversionRateId: path.conversionRateId
          conversionRate: requestBody.conversionRate
      - text: Set the end date of {currency} rate {conversionRateId} to {endDate}.
        slots:
          currency: path.currency
          conversionRateId: path.conversionRateId
          endDate: requestBody.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/currencies/{currency}/conversion-rates/{conversionRateId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a currency conversion rate
      effect: destructive
      questions:
      - How do I remove an exchange rate from a currency?
      - Can I delete a conversion rate that was entered wrong?
      instructions:
      - text: Delete {currency} conversion rate {conversionRateId}.
        slots:
          currency: path.currency
          conversionRateId: path.conversionRateId
      - text: Remove exchange rate {conversionRateId} from currency {currency}.
        slots:
          conversionRateId: path.conversionRateId
          currency: path.currency
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/budget-items'].get
  update:
    x-apievangelist-phrasing:
      intent: List one event's budget items
      effect: read
      questions:
      - What line items are in the budget for a single event?
      - Can I filter one event's budget items by date?
      instructions:
      - text: List the budget items for event {id}.
        slots:
          id: path.id
      - text: Show event {id} budget items matching {filter}.
        slots:
          id: path.id
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/budget-items'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a budget item for an event
      effect: write
      questions:
      - How do I add a new cost line to an event budget?
      - Can I set category, status and currency when adding a budget item?
      instructions:
      - text: Add a budget item {name} in category {category} to event {id}.
        slots:
          name: requestBody.name
          category: requestBody.category
          id: path.id
      - text: Create a {costType} budget line {name} for event {id} in {currency} with status {status}.
        slots:
          costType: requestBody.costType
          name: requestBody.name
          id: path.id
          currency: requestBody.currency
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/budget-items/allocations'].get
  update:
    x-apievangelist-phrasing:
      intent: List budget allocations for an event
      effect: read
      questions:
      - How are costs allocated across the budget items of an event?
      - Where can I see every budget allocation within one event?
      instructions:
      - text: List the budget allocations for event {id}.
        slots:
          id: path.id
      - text: Show all cost allocations across event {id}'s budget items matching {filter}.
        slots:
          id: path.id
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/budget-items/{budgetItemId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an existing budget item
      effect: write
      questions:
      - Can I change the status of a budget item that already exists?
      - What's needed to rename or recategorize an event budget line?
      instructions:
      - text: Set existing budget item {budgetItemId} on event {id} to status {status}.
        slots:
          budgetItemId: path.budgetItemId
          id: path.id
          status: requestBody.status
      - text: Move budget item {budgetItemId} in event {id} to category {category}.
        slots:
          budgetItemId: path.budgetItemId
          id: path.id
          category: requestBody.category
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/budget-items/{budgetItemId}/allocations'].put
  update:
    x-apievangelist-phrasing:
      intent: Add or update a budget item's allocations
      effect: write
      questions:
      - How do I split a budget item's cost across allocations?
      - Will bulk allocation updates overwrite allocations that already exist?
      instructions:
      - text: Allocate budget item {budgetItemId} on event {id} by {allocateBy} using {allocations}.
        slots:
          budgetItemId: path.budgetItemId
          id: path.id
          allocateBy: requestBody.allocateBy
          allocations: requestBody.allocations
      - text: Replace the allocations on budget item {budgetItemId} in event {id} with {allocations}.
        slots:
          budgetItemId: path.budgetItemId
          id: path.id
          allocations: requestBody.allocations
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/budget-items/{budgetItemId}/allocations'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete all allocations for a budget item
      effect: destructive
      questions:
      - Can I clear every allocation from a budget item at once?
      - What removes a budget item's cost split entirely?
      instructions:
      - text: Delete all allocations on budget item {budgetItemId} in event {id}.
        slots:
          budgetItemId: path.budgetItemId
          id: path.id
      - text: Clear the cost split for budget item {budgetItemId} of event {id}.
        slots:
          budgetItemId: path.budgetItemId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/budget-items/{budgetItemId}/budget-payments'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a payment against a budget item
      effect: write
      questions:
      - How do I log a vendor payment against an event budget item?
      - Can I add a reference number when recording a budget payment?
      instructions:
      - text: Record a payment {name} of {amount} {currency} on budget item {budgetItemId} for event {id}.
        slots:
          name: requestBody.name
          amount: requestBody.amount
          currency: requestBody.currency
          budgetItemId: path.budgetItemId
          id: path.id
      - text: Add a new budget payment dated {date} with reference {referenceNumber} to item {budgetItemId} in event {id}.
        slots:
          date: requestBody.date
          referenceNumber: requestBody.referenceNumber
          budgetItemId: path.budgetItemId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/budget-items/{budgetItemId}/budget-payments/{paymentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a budget payment
      effect: write
      questions:
      - Can I fix the amount on a budget payment I already recorded?
      - What changes an existing payment's date or note?
      instructions:
      - text: Change the amount of payment {paymentId} on budget item {budgetItemId}, event {id}, to {amount}.
        slots:
          paymentId: path.paymentId
          budgetItemId: path.budgetItemId
          id: path.id
          amount: requestBody.amount
      - text: Update existing budget payment {paymentId} for item {budgetItemId} in event {id} with note {note}.
        slots:
          paymentId: path.paymentId
          budgetItemId: path.budgetItemId
          id: path.id
          note: requestBody.note
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/budget-items/{budgetItemId}/budget-payments/{paymentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a budget payment
      effect: destructive
      questions:
      - How do I remove a payment from a budget item?
      - Can a recorded budget payment be deleted?
      instructions:
      - text: Delete payment {paymentId} from budget item {budgetItemId} in event {id}.
        slots:
          paymentId: path.paymentId
          budgetItemId: path.budgetItemId
          id: path.id
      - text: Remove budget payment {paymentId} recorded on item {budgetItemId} of event {id}.
        slots:
          paymentId: path.paymentId
          budgetItemId: path.budgetItemId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/budget-items/{budgetItemId}/custom-fields/{customFieldId}/answers'].put
  update:
    x-apievangelist-phrasing:
      intent: Answer a custom field on a budget item
      effect: write
      questions:
      - How do I fill in a custom field on an event budget item?
      - Does a budget custom field answer need to match the field's type?
      instructions:
      - text: Set custom field {customFieldId} on budget item {budgetItemId} in event {id} to {value}.
        slots:
          customFieldId: path.customFieldId
          budgetItemId: path.budgetItemId
          id: path.id
          value: requestBody.value
      - text: Answer budget custom field {customFieldId} for item {budgetItemId}, event {id}, with {value}.
        slots:
          customFieldId: path.customFieldId
          budgetItemId: path.budgetItemId
          id: path.id
          value: requestBody.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/budget-payments'].get
  update:
    x-apievangelist-phrasing:
      intent: List budget payments for an event
      effect: read
      questions:
      - What payments have been made against an event's budget?
      - Can I list budget payments recorded after a given date?
      instructions:
      - text: List the budget payments for event {id}.
        slots:
          id: path.id
      - text: Show event {id} budget payments recorded after {after}.
        slots:
          id: path.id
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/budget-payments/{paymentId}/invoices/{invoiceId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Attach an invoice file to a payment
      effect: write
      questions:
      - How do I attach an uploaded invoice to a budget payment?
      - Can I link an invoice document to a payment record?
      instructions:
      - text: Attach invoice file {invoiceId} to payment {paymentId} in event {id}.
        slots:
          invoiceId: path.invoiceId
          paymentId: path.paymentId
          id: path.id
      - text: Link uploaded invoice {invoiceId} to budget payment {paymentId} of event {id}.
        slots:
          invoiceId: path.invoiceId
          paymentId: path.paymentId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/budget-totals'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an event's budget totals
      effect: read
      questions:
      - What do the budget totals come to for my event?
      - Where do I find the rolled-up budget totals for one event?
      instructions:
      - text: Show the budget totals for event {id}.
        slots:
          id: path.id
      - text: Get event {id}'s rolled-up budget totals matching {filter}.
        slots:
          id: path.id
          filter: query.filter
      method: generated
      generated: '2026-09-26'