# 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 Order Line Vats API
  version: 1.0.0
extends: openapi/optimizely-order-line-vats-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/OrderLineVats'].get
  update:
    x-apievangelist-phrasing:
      intent: List VAT entries on order lines
      effect: read
      questions:
      - What VAT has been charged across my order lines?
      - Can I filter order line VAT records by VAT code or order line?
      instructions:
      - text: List all order line VAT entries.
      - text: Find order line VAT records matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderLineVats'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a VAT entry to an order line
      effect: write
      questions:
      - How do I record VAT against a specific order line?
      - Can I set the VAT rate and amount when I add VAT to an order line?
      instructions:
      - text: Add VAT code {vatCodeId} at rate {vatRate} to order line {orderLineId}.
        slots:
          vatCodeId: requestBody.vatCodeId
          vatRate: requestBody.vatRate
          orderLineId: requestBody.orderLineId
      - text: Record a VAT amount of {vatAmount} on order line {orderLineId}.
        slots:
          vatAmount: requestBody.vatAmount
          orderLineId: requestBody.orderLineId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderLineVats({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order line VAT entry by ID
      effect: read
      questions:
      - What rate and amount does one order line VAT record hold?
      - Can I look up a single order line VAT entry by its ID?
      instructions:
      - text: Get order line VAT entry {id}.
        slots:
          id: path.id
      - text: Show the VAT rate and amount of order line VAT record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderLineVats({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an order line VAT entry
      effect: write
      questions:
      - Can I overwrite an entire order line VAT record at once?
      - What happens to omitted fields on a full replace of an order line VAT entry?
      instructions:
      - text: Replace order line VAT {id} with code {vatCodeId}, rate {vatRate} and amount {vatAmount}.
        slots:
          id: path.id
          vatCodeId: requestBody.vatCodeId
          vatRate: requestBody.vatRate
          vatAmount: requestBody.vatAmount
      - text: Overwrite the whole order line VAT record {id} using a full PUT.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderLineVats({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an order line VAT entry by ID
      effect: destructive
      questions:
      - How do I remove a VAT entry from an order line?
      - Does deleting an order line VAT record accept an If-Match ETag?
      instructions:
      - text: Delete order line VAT entry {id}.
        slots:
          id: path.id
      - text: Delete order line VAT {id} only if its ETag matches {ifMatch}.
        slots:
          id: path.id
          ifMatch: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderLineVats({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an order line VAT entry
      effect: write
      questions:
      - How do I correct the VAT amount on an existing order line VAT entry?
      - Can I mark an order line VAT entry as not taxable?
      instructions:
      - text: Change the VAT amount of order line VAT {id} to {vatAmount}.
        slots:
          id: path.id
          vatAmount: requestBody.vatAmount
      - text: Set taxable to {taxable} on order line VAT entry {id}.
        slots:
          taxable: requestBody.taxable
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderLineVats/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a default order line VAT template
      effect: read
      questions:
      - What default values does a new order line VAT entry start with?
      - Is there a blank order line VAT template to fetch first?
      instructions:
      - text: Fetch the default order line VAT template.
      - text: Show me the default values for a new order line VAT entry.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/orderlinevats/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete order line VAT entries
      effect: destructive
      questions:
      - How do I delete several order line VAT records at once?
      - Can I pass a list of IDs to remove many order line VAT entries?
      instructions:
      - text: Bulk delete the order line VAT entries with IDs {ids}.
        slots:
          ids: query.ids
      - text: 'Remove all of these order line VAT records in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/orderlinevats({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on an order line VAT entry
      effect: read
      questions:
      - Where do I read a custom property stored on an order line VAT record?
      - Can I fetch one extra property value from an order line VAT entry?
      instructions:
      - text: Get custom property {custompropertyKey} on order line VAT {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show the custom property {custompropertyKey} of order line VAT entry {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'