Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Accounting Subpackage Invoices API

11 actions 11 updates phrasing extends openapi/merge-subpackage-invoices-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 11

$.info
$.paths['/accounting/v1/invoices'].get
$.paths['/accounting/v1/invoices'].post
$.paths['/accounting/v1/invoices/{id}'].get
$.paths['/accounting/v1/invoices/{id}'].patch
$.paths['/accounting/v1/invoices/line-items/remote-field-classes'].get
$.paths['/accounting/v1/invoices/meta/patch/{id}'].get
$.paths['/accounting/v1/invoices/meta/post'].get
$.paths['/accounting/v1/invoices/remote-field-classes'].get
$.paths['/accounting/v1/invoices/bulk'].post
$.paths['/accounting/v1/invoices/bulk/{batch_id}'].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 Invoices API
  version: 1.0.0
extends: openapi/merge-subpackage-invoices-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: 10
- target: $.paths['/accounting/v1/invoices'].get
  update:
    x-apievangelist-phrasing:
      intent: List invoices
      effect: read
      questions:
      - Which invoices are still unpaid in my customer's accounting system?
      - Can I list only accounts payable bills or only receivable invoices?
      - How do I find invoices issued within a date range?
      instructions:
      - text: List invoices with status {status}.
        slots:
          status: query.status
      - text: Show invoices for contact {contact_id} issued after {issue_date_after}.
        slots:
          contact_id: query.contact_id
          issue_date_after: query.issue_date_after
      - text: Find invoice number {number}.
        slots:
          number: query.number
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/invoices'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an invoice
      effect: write
      questions:
      - How do I create an invoice in a connected accounting platform?
      - Can I generate a payable bill from an existing purchase order?
      instructions:
      - text: 'Create an invoice with these details: {model}.'
        slots:
          model: requestBody.model
      - text: Create an invoice {model} and process it asynchronously.
        slots:
          model: requestBody.model
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/invoices/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an invoice
      effect: read
      questions:
      - What line items and totals are on a specific invoice?
      - Can I retrieve one invoice along with its remote fields?
      instructions:
      - text: Get invoice {id}.
        slots:
          id: path.id
      - text: Fetch invoice {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/invoices/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an existing invoice
      effect: write
      questions:
      - How do I change fields on an invoice that's already been created?
      - Can I edit an existing bill's due date or amounts?
      instructions:
      - text: Update invoice {id} with {model}.
        slots:
          id: path.id
          model: requestBody.model
      - text: Patch existing invoice {id} in debug mode with {model}.
        slots:
          id: path.id
          model: requestBody.model
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/invoices/line-items/remote-field-classes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field definitions for invoice line items
      effect: read
      questions:
      - What custom fields can appear on invoice line items?
      - Which line item fields come from the accounting platform rather than the common model?
      instructions:
      - text: List invoice line item remote field classes where custom is {is_custom}.
        slots:
          is_custom: query.is_custom
      - text: Show 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/invoices/meta/patch/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: See which invoice fields can be updated
      effect: read
      questions:
      - Which fields am I allowed to edit on a given invoice?
      - What does the integration accept when updating an invoice?
      instructions:
      - text: Get the update metadata for invoice {id}.
        slots:
          id: path.id
      - text: Show which fields of invoice {id} are editable.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/invoices/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: See which fields creating an invoice needs
      effect: read
      questions:
      - What fields are required to create an invoice for this integration?
      - Before I post a new invoice, how can I check the accepted fields?
      instructions:
      - text: Get invoice creation metadata for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show the fields needed to create a new invoice.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/invoices/remote-field-classes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field definitions for invoices
      effect: read
      questions:
      - What custom invoice-level fields does the accounting system expose?
      - Can I list invoice field classes that are part of the common model?
      instructions:
      - text: List invoice remote field classes where common-model field is {is_common_model_field}.
        slots:
          is_common_model_field: query.is_common_model_field
      - text: Show invoice header field definitions for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/invoices/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Create many invoices in one batch
      effect: write
      questions:
      - Can I create a large set of invoices in a single request?
      - How do I bulk-import invoices asynchronously?
      instructions:
      - text: 'Bulk create these invoices: {batch_items}.'
        slots:
          batch_items: requestBody.batch_items
      - text: Submit an invoice batch of {batch_items} for async creation.
        slots:
          batch_items: requestBody.batch_items
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/invoices/bulk/{batch_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an invoice bulk create batch
      effect: read
      questions:
      - Did my bulk invoice import succeed?
      - Where can I see results for each invoice in a batch?
      instructions:
      - text: Get the status of invoice batch {batch_id}.
        slots:
          batch_id: path.batch_id
      - text: Show results of bulk invoice job {batch_id}.
        slots:
          batch_id: path.batch_id
      method: generated
      generated: '2026-09-26'