# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Accounting Subpackage Sales Orders API
  version: 1.0.0
extends: openapi/merge-subpackage-salesorders-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: 8
- target: $.paths['/accounting/v1/sales-orders'].get
  update:
    x-apievangelist-phrasing:
      intent: List sales orders
      effect: read
      questions:
      - Can I pull every sales order from a customer's accounting system?
      - Which sales orders were issued in a given date range?
      instructions:
      - text: List sales orders issued after {issue_date_after}.
        slots:
          issue_date_after: query.issue_date_after
      - text: Show sales orders for company {company_id}.
        slots:
          company_id: query.company_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/sales-orders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a sales order
      effect: write
      questions:
      - How do I record a new sales order in a customer's accounting platform?
      - Can a sales order write run asynchronously against the ledger?
      instructions:
      - text: Create a sales order {sales_order}.
        slots:
          sales_order: requestBody.model
      - text: Record sales order {sales_order} asynchronously {run_async}.
        slots:
          sales_order: requestBody.model
          run_async: query.run_async
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/sales-orders/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sales order
      effect: read
      questions:
      - Can I look up one sales order by its ID?
      - What details come back for a single sales order?
      instructions:
      - text: Get sales order {id}.
        slots:
          id: path.id
      - text: Show me sales order {id} and its details.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/sales-orders/lines/remote-field-classes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field definitions on sales order lines
      effect: read
      questions:
      - What custom fields exist on sales order line items?
      - Can I see which sales order line fields are custom versus common model fields?
      instructions:
      - text: List sales order line field classes where custom is {is_custom}.
        slots:
          is_custom: query.is_custom
      - text: Show line-item field classes that are common model fields {is_common_model_field}.
        slots:
          is_common_model_field: query.is_common_model_field
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/sales-orders/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: Get fields required to create a sales order
      effect: read
      questions:
      - Which fields must I send to create a sales order?
      - What does the accounting integration accept when posting a sales order?
      instructions:
      - text: Show sales order creation fields for account token {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Get the create metadata for sales orders.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/sales-orders/remote-field-classes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field definitions on sales orders
      effect: read
      questions:
      - What custom header-level fields does the ledger define on sales orders?
      - Can I list the remote field classes for sales orders themselves?
      instructions:
      - text: List only the custom header-level sales order field classes, custom = {is_custom}.
        slots:
          is_custom: query.is_custom
      - text: Show sales order field classes that map to common model fields {is_common_model_field}.
        slots:
          is_common_model_field: query.is_common_model_field
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/sales-orders/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Create many sales orders in one batch
      effect: write
      questions:
      - Can I create a batch of sales orders in one request?
      - How do I bulk-load sales orders asynchronously?
      instructions:
      - text: Bulk create these sales orders {batch_items}.
        slots:
          batch_items: requestBody.batch_items
      - text: Submit a sales order batch {batch_items} for async creation.
        slots:
          batch_items: requestBody.batch_items
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/sales-orders/bulk/{batch_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a sales order bulk batch
      effect: read
      questions:
      - Did my bulk sales order batch finish, and what were the results?
      - Can I see which sales orders in a batch failed?
      instructions:
      - text: Get the status of sales order batch {batch_id}.
        slots:
          batch_id: path.batch_id
      - text: Show results for bulk batch {batch_id}.
        slots:
          batch_id: path.batch_id
      method: generated
      generated: '2026-09-26'