Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Accounting Subpackage Purchase Orders API

7 actions 7 updates phrasing extends openapi/merge-subpackage-purchaseorders-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Merge's API. It is a proposal applied on top of the contract, not a document Merge publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/accounting/v1/purchase-orders'].get
$.paths['/accounting/v1/purchase-orders'].post
$.paths['/accounting/v1/purchase-orders/{id}'].get
$.paths['/accounting/v1/purchase-orders/line-items/remote-field-classes'].get
$.paths['/accounting/v1/purchase-orders/meta/post'].get
$.paths['/accounting/v1/purchase-orders/remote-field-classes'].get

OpenAPI Overlay

Raw ↑
# 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 Purchase Orders API
  version: 1.0.0
extends: openapi/merge-subpackage-purchaseorders-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: 6
- target: $.paths['/accounting/v1/purchase-orders'].get
  update:
    x-apievangelist-phrasing:
      intent: List purchase orders
      effect: read
      questions:
      - Which purchase orders were issued last quarter?
      - Can I list purchase orders for one company in the accounting system?
      instructions:
      - text: List purchase orders issued after {issue_date_after}.
        slots:
          issue_date_after: query.issue_date_after
      - text: Show purchase orders for company {company_id}.
        slots:
          company_id: query.company_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/purchase-orders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a purchase order
      effect: write
      questions:
      - How do I raise a new purchase order in a connected accounting platform?
      - Can I create a PO for a vendor through the integration?
      instructions:
      - text: Create a purchase order with {model}.
        slots:
          model: requestBody.model
      - text: 'Raise a new PO: {model}.'
        slots:
          model: requestBody.model
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/purchase-orders/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a purchase order
      effect: read
      questions:
      - What items and vendor are on a specific purchase order?
      - Can I fetch one PO with its remote fields?
      instructions:
      - text: Get purchase order {id}.
        slots:
          id: path.id
      - text: Fetch PO {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/purchase-orders/line-items/remote-field-classes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field definitions for PO line items
      effect: read
      questions:
      - What custom fields exist on purchase order line items?
      - Which PO line fields come from the underlying platform?
      instructions:
      - text: List PO line item remote field classes where custom is {is_custom}.
        slots:
          is_custom: query.is_custom
      - text: Show purchase order line-item field definitions for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/purchase-orders/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: See which fields a purchase order needs
      effect: read
      questions:
      - What fields are required to create a purchase order for this integration?
      - How do I check supported PO fields before creating one?
      instructions:
      - text: Get purchase order creation metadata for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show the fields needed to raise a PO.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/purchase-orders/remote-field-classes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field definitions for purchase orders
      effect: read
      questions:
      - What custom header fields are on purchase orders?
      - Can I list only common-model purchase order field classes?
      instructions:
      - text: List purchase order remote field classes where common-model field is {is_common_model_field}.
        slots:
          is_common_model_field: query.is_common_model_field
      - text: Show PO header field definitions for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'