# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin API V1 Invoice History Taxes API
  version: 1.0.0
extends: openapi/optimizely-invoice-history-taxes-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: 9
- target: $.paths['/api/v1/admin/InvoiceHistoryTaxes'].get
  update:
    x-apievangelist-phrasing:
      intent: List invoice tax lines
      effect: read
      questions:
      - What tax lines are recorded against historical invoices in Optimizely Configured Commerce?
      - Can I filter invoice tax lines to a single invoice?
      instructions:
      - text: List all invoice history tax lines.
      - text: List invoice tax lines matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/InvoiceHistoryTaxes'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a tax line to an invoice
      effect: write
      questions:
      - How do I record a tax line with its code, rate and amount on an invoice?
      - Can I set the display order of a new invoice tax line?
      instructions:
      - text: Add tax {taxCode} ({taxDescription}) to invoice {invoiceHistoryId}.
        slots:
          taxCode: requestBody.taxCode
          taxDescription: requestBody.taxDescription
          invoiceHistoryId: requestBody.invoiceHistoryId
      - text: Record tax line {taxCode} described as {taxDescription} at rate {taxRate} for amount {taxAmount}.
        slots:
          taxCode: requestBody.taxCode
          taxDescription: requestBody.taxDescription
          taxRate: requestBody.taxRate
          taxAmount: requestBody.taxAmount
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/InvoiceHistoryTaxes({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an invoice tax line
      effect: read
      questions:
      - What rate and amount were charged on a specific invoice tax line?
      - How do I fetch one invoice history tax record by id?
      instructions:
      - text: Get invoice tax line {id}.
        slots:
          id: path.id
      - text: Show the rate and amount on invoice tax line {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/InvoiceHistoryTaxes({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an invoice tax line
      effect: write
      questions:
      - How do I overwrite an entire invoice tax line record?
      - Can I replace a tax line's code and description together?
      instructions:
      - text: Replace invoice tax line {id} with code {taxCode} and description {taxDescription}.
        slots:
          id: path.id
          taxCode: requestBody.taxCode
          taxDescription: requestBody.taxDescription
      - text: Fully overwrite invoice tax record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/InvoiceHistoryTaxes({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an invoice tax line
      effect: destructive
      questions:
      - How do I remove a tax line recorded on an invoice?
      - Can I delete an invoice tax line only if its ETag still matches?
      instructions:
      - text: Delete invoice tax line {id}.
        slots:
          id: path.id
      - text: Delete invoice tax line {id} if the ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/InvoiceHistoryTaxes({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Correct an invoice tax line
      effect: write
      questions:
      - How do I fix the tax amount on an existing invoice tax line?
      - Can I change only the tax rate of an invoice tax record?
      instructions:
      - text: Set the tax amount on invoice tax line {id} to {taxAmount}.
        slots:
          id: path.id
          taxAmount: requestBody.taxAmount
      - text: Change invoice tax line {id}'s rate to {taxRate}.
        slots:
          id: path.id
          taxRate: requestBody.taxRate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/InvoiceHistoryTaxes/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank default invoice tax line
      effect: read
      questions:
      - What does an empty invoice tax line object look like?
      - Is there a template for a new invoice history tax?
      instructions:
      - text: Get the default template for a new invoice tax line.
      - text: Show the blank invoice history tax object.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/invoicehistorytaxes/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several invoice tax lines
      effect: destructive
      questions:
      - Can I delete many invoice tax lines at once?
      - How do I bulk-remove invoice tax records by id?
      instructions:
      - text: Delete invoice tax lines {ids}.
        slots:
          ids: query.ids
      - text: Bulk-remove invoice history taxes with ids {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/invoicehistorytaxes({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an invoice tax line custom property
      effect: read
      questions:
      - How do I read a custom property on an invoice tax line?
      - Can invoice tax records store custom properties?
      instructions:
      - text: Get custom property {custompropertyKey} of invoice tax line {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show invoice tax line {key}'s custom property {custompropertyKey}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'