# 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-registration-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 line items were recorded across every event in my account last quarter?
      - Can I pull account-wide event budget items for a date window?
      instructions:
      - text: List budget items across all events between {after} and {before}.
        slots:
          after: query.after
          before: query.before
      - text: Pull account-wide budget items changed after {after} and before {before}, filtered by {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 vendors are configured in the account's budget admin settings?
      - Does the vendor list include event-scoped or supplier network vendors?
      instructions:
      - text: List the account-level budget vendors.
      - text: Show budget vendors matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cards'].get
  update:
    x-apievangelist-phrasing:
      intent: List the account's payment cards
      effect: read
      questions:
      - What payment cards are on file for our Cvent account?
      - Can I filter the list of corporate cards used for event spend?
      instructions:
      - text: List the payment cards on the 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 charges have been made on our event payment cards?
      - Can I see card transactions from a specific date range?
      instructions:
      - text: List card transactions since {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 new 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 purchase?
      instructions:
      - text: Record a card transaction of {transactionAmount} at {transactionMerchant} for event {eventId}.
        slots:
          transactionAmount: requestBody.transactionAmount
          transactionMerchant: requestBody.transactionMerchant
          eventId: requestBody.eventId
      - text: Log a {transactionCurrency} card charge of {transactionAmount} dated {transactionDate}.
        slots:
          transactionCurrency: requestBody.transactionCurrency
          transactionAmount: requestBody.transactionAmount
          transactionDate: requestBody.transactionDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cards/transactions/{transactionId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Correct an existing card transaction
      effect: write
      questions:
      - Can I fix the amount on a card transaction I already recorded?
      - Is it possible to move a logged card charge to a different event?
      instructions:
      - text: Change the amount on card transaction {transactionId} to {transactionAmount}.
        slots:
          transactionId: path.transactionId
          transactionAmount: requestBody.transactionAmount
      - text: Reassign existing card transaction {transactionId} to event {eventId}.
        slots:
          transactionId: path.transactionId
          eventId: requestBody.eventId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cards/transactions/{transactionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a card transaction record
      effect: destructive
      questions:
      - How do I remove a card transaction that was logged 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 record {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 set for euros in my account?
      - Which conversion rates were active for a currency during a given period?
      instructions:
      - text: List the conversion rates for currency {currency}.
        slots:
          currency: path.currency
      - text: Show {currency} conversion rates modified 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 currency conversion rate
      effect: write
      questions:
      - How do I set a new exchange rate for a currency used in event 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} exchange rate {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 conversion rate
      effect: write
      questions:
      - Can I correct an exchange rate that's already defined?
      - How do I extend the end date of an existing currency rate?
      instructions:
      - text: Change existing {currency} rate {conversionRateId} to {conversionRate}.
        slots:
          currency: path.currency
          conversionRateId: path.conversionRateId
          conversionRate: requestBody.conversionRate
      - text: Set the end date of {currency} conversion 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:
      - Can I remove a conversion rate that shouldn't be used anymore?
      - What's the way to delete a wrong exchange rate?
      instructions:
      - text: Delete {currency} conversion rate {conversionRateId}.
        slots:
          currency: path.currency
          conversionRateId: path.conversionRateId
      - text: Remove exchange rate {conversionRateId} defined for {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 budget items for one event
      effect: read
      questions:
      - What's in the budget for a single event?
      - Can I list one event's budget line items changed since a date?
      instructions:
      - text: List the budget items for event {id}.
        slots:
          id: path.id
      - text: Show event {id} budget items modified after {after}.
        slots:
          id: path.id
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/budget-items'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a budget item to an event
      effect: write
      questions:
      - How do I add a new cost line to an event budget?
      - Can I attach a vendor and GL code when creating a budget item?
      instructions:
      - text: Create a budget item {name} in category {category} for event {id}.
        slots:
          name: requestBody.name
          category: requestBody.category
          id: path.id
      - text: Add a {costType} budget item {name} in {currency} with vendor {vendor} to event {id}.
        slots:
          costType: requestBody.costType
          name: requestBody.name
          currency: requestBody.currency
          vendor: requestBody.vendor
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/budget-items/allocations'].get
  update:
    x-apievangelist-phrasing:
      intent: List budget allocations in an event
      effect: read
      questions:
      - How are an event's budget costs allocated across items?
      - Can I see all budget allocations for every budget item in an event?
      instructions:
      - text: List budget allocations for event {id}.
        slots:
          id: path.id
      - text: Show how costs are allocated across budget items in event {id}.
        slots:
          id: path.id
      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 or category of a budget line after it's created?
      - Is it possible to edit an existing budget item's vendor or internal note?
      instructions:
      - text: Set the status of budget item {budgetItemId} in event {id} to {status}.
        slots:
          budgetItemId: path.budgetItemId
          id: path.id
          status: requestBody.status
      - text: Rename existing budget item {budgetItemId} in event {id} to {name}.
        slots:
          budgetItemId: path.budgetItemId
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/budget-items/{budgetItemId}/allocations'].put
  update:
    x-apievangelist-phrasing:
      intent: Set allocations for a budget item
      effect: write
      questions:
      - How do I split one budget item's cost across allocations?
      - Will updating allocations overwrite the ones a budget item already has?
      instructions:
      - text: Allocate budget item {budgetItemId} in event {id} by {allocateBy} with {allocations}.
        slots:
          budgetItemId: path.budgetItemId
          id: path.id
          allocateBy: requestBody.allocateBy
          allocations: requestBody.allocations
      - text: Bulk update the allocations of budget item {budgetItemId} for event {id} to {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: Clear all allocations on a budget item
      effect: destructive
      questions:
      - Can I wipe every allocation from a budget item at once?
      - What happens to allocations when I clear them on a budget item?
      instructions:
      - text: Delete all allocations on budget item {budgetItemId} in event {id}.
        slots:
          budgetItemId: path.budgetItemId
          id: path.id
      - text: Clear the cost allocations from budget item {budgetItemId} for 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 on a budget item
      effect: write
      questions:
      - How do I log a payment made against an event budget item?
      - Can I add a reference number to a budget payment?
      instructions:
      - text: Record a payment of {amount} {currency} on budget item {budgetItemId} in event {id}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          budgetItemId: path.budgetItemId
          id: path.id
      - text: Add payment {name} dated {date} with reference {referenceNumber} to budget item {budgetItemId}, event {id}.
        slots:
          name: requestBody.name
          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 item payment
      effect: write
      questions:
      - Can I correct the amount of a budget payment already recorded?
      - Is it possible to change the date on an existing budget payment?
      instructions:
      - text: Change payment {paymentId} on budget item {budgetItemId} in event {id} to {amount}.
        slots:
          paymentId: path.paymentId
          budgetItemId: path.budgetItemId
          id: path.id
          amount: requestBody.amount
      - text: Update the date of existing budget payment {paymentId} for item {budgetItemId}, event {id}, to {date}.
        slots:
          paymentId: path.paymentId
          budgetItemId: path.budgetItemId
          id: path.id
          date: requestBody.date
      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 item payment
      effect: destructive
      questions:
      - How do I remove a payment logged against the wrong budget item?
      - Can a 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 record {paymentId} on item {budgetItemId} for 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:
      - Can I fill in a custom field on an event budget item?
      - What format do budget custom field answers need?
      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} with {value} for item {budgetItemId}, event {id}.
        slots:
          customFieldId: path.customFieldId
          value: requestBody.value
          budgetItemId: path.budgetItemId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/budget-payments'].get
  update:
    x-apievangelist-phrasing:
      intent: List budget payments in an event
      effect: read
      questions:
      - What payments have been made against an event's budget?
      - Can I list budget payments for an event made after a certain date?
      instructions:
      - text: List budget payments for event {id}.
        slots:
          id: path.id
      - text: Show event {id} budget payments modified 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 budget payment
      effect: write
      questions:
      - How do I attach a vendor invoice to a budget payment?
      - Does the invoice need to be uploaded as a file before I link it to a payment?
      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} for 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 budget totals for an event
      effect: read
      questions:
      - What's the total budgeted versus actual spend for my event?
      - Can I get rolled-up budget totals for one event?
      instructions:
      - text: Show budget totals for event {id}.
        slots:
          id: path.id
      - text: Get the rolled-up budget totals for event {id} filtered by {filter}.
        slots:
          id: path.id
          filter: query.filter
      method: generated
      generated: '2026-09-26'