# 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-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:
      - Which budget items changed across all my events in a date range?
      - Can I pull every event's budget lines for the whole account at once?
      instructions:
      - text: List account-wide budget items modified between {after} and {before}.
        slots:
          after: query.after
          before: query.before
      - text: Pull budget items across all events 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 vendors are set up under Admin > Budget > Vendors in my account?
      - Does the account vendor list include event-scoped vendors?
      instructions:
      - text: List the budget vendors configured at the account level.
      - text: Find account budget vendors 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 registered on my Cvent account?
      - Can I filter the list of company cards used for event spend?
      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:
      - Which card charges were recorded against my account last month?
      - Can I see card transactions within a specific date window?
      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 card transaction
      effect: write
      questions:
      - How do I log a company card charge against an event?
      - Can I record the merchant and currency of a card purchase?
      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: Add a new card charge dated {transactionDate} on card {cardDescription}.
        slots:
          transactionDate: requestBody.transactionDate
          cardDescription: requestBody.cardDescription
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cards/transactions/{transactionId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a recorded card transaction
      effect: write
      questions:
      - Can I correct the amount on a card transaction I already recorded?
      - Is it possible to move an existing card charge to a different event?
      instructions:
      - text: Change the amount of 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
      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 card charge record {transactionId} from the account.
        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 conversion rates are defined for euros in my account?
      - Can I see historical exchange rates set for a currency?
      instructions:
      - text: List the conversion rates for currency {currency}.
        slots:
          currency: path.currency
      - text: Show {currency} exchange rates changed 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 set an exchange rate for a currency starting on a date?
      - Can a conversion rate have an end date?
      instructions:
      - text: Add a conversion rate of {conversionRate} for {currency} starting {startDate}.
        slots:
          conversionRate: requestBody.conversionRate
          currency: path.currency
          startDate: requestBody.startDate
      - text: Create a {currency} 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 currency conversion rate
      effect: write
      questions:
      - Can I correct an exchange rate I entered earlier?
      - Is there a way to change the date range of an existing conversion rate?
      instructions:
      - text: Change conversion rate {conversionRateId} for {currency} to {conversionRate}.
        slots:
          conversionRateId: path.conversionRateId
          currency: path.currency
          conversionRate: requestBody.conversionRate
      - text: Set the end date of existing {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 defined for a currency?
      - Can I delete a conversion rate that's no longer valid?
      instructions:
      - text: Delete conversion rate {conversionRateId} for {currency}.
        slots:
          conversionRateId: path.conversionRateId
          currency: path.currency
      - text: Remove the {currency} exchange rate {conversionRateId}.
        slots:
          currency: path.currency
          conversionRateId: path.conversionRateId
      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 line items are in the budget for my 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}'s 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: Add a budget item to an event
      effect: write
      questions:
      - How do I add a catering cost to my event budget?
      - Can I record tax and gratuity when adding a budget line?
      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 line {name} in {currency} with status {status} to event {id}.
        slots:
          costType: requestBody.costType
          name: requestBody.name
          currency: requestBody.currency
          status: requestBody.status
          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 for an event
      effect: read
      questions:
      - How are my event's budget items allocated?
      - Can I see allocations across every budget item in an event?
      instructions:
      - text: List the budget allocations for event {id}.
        slots:
          id: path.id
      - text: Show how budget items are split for 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 of a budget item I already created?
      - Is it possible to move an existing budget line to another category?
      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} on 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: Add or update a budget item's allocations
      effect: write
      questions:
      - How do I split a budget item's cost across allocations?
      - Will bulk-updating allocations overwrite ones that already exist?
      instructions:
      - text: Allocate budget item {budgetItemId} in event {id} by {allocateBy} using {allocations}.
        slots:
          budgetItemId: path.budgetItemId
          id: path.id
          allocateBy: requestBody.allocateBy
          allocations: requestBody.allocations
      - text: Bulk update the allocations on 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}/allocations'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete all allocations on a budget item
      effect: destructive
      questions:
      - Can I clear every allocation on a budget item at once?
      - How do I reset a budget item so it has no allocations?
      instructions:
      - text: Delete all allocations on budget item {budgetItemId} in event {id}.
        slots:
          budgetItemId: path.budgetItemId
          id: path.id
      - text: Clear the allocation split 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 deposit paid to a vendor against a budget item?
      - Can I add a reference number when recording a budget payment?
      instructions:
      - text: Record a payment {name} of {amount} {currency} on {date} for budget item {budgetItemId} in event {id}.
        slots:
          name: requestBody.name
          amount: requestBody.amount
          currency: requestBody.currency
          date: requestBody.date
          budgetItemId: path.budgetItemId
          id: path.id
      - text: Add a payment with reference {referenceNumber} to budget item {budgetItemId} on event {id}.
        slots:
          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?
      - Is it possible to change the date of an existing vendor payment?
      instructions:
      - text: Change the amount of 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 note on existing payment {paymentId} for budget item {budgetItemId}, event {id}, to {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 logged against the wrong budget item?
      - Can a budget payment be deleted after it's recorded?
      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} 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:
      - How do I fill in a custom field on a budget item?
      - What format does a budget custom field answer need to be in?
      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}.
        slots:
          customFieldId: path.customFieldId
          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 for an event
      effect: read
      questions:
      - What payments have been made against my event's budget?
      - Can I list vendor payments for an event in a date range?
      instructions:
      - text: List the budget payments for event {id}.
        slots:
          id: path.id
      - text: Show event {id} budget payments made 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 payment?
      - Can I link an uploaded invoice file to a budget 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 spent for my event?
      - Where can I see the rolled-up budget totals for one event?
      instructions:
      - text: Get the budget totals for event {id}.
        slots:
          id: path.id
      - text: Show the summed budget figures for event {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'