Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Accounting Subpackage Income Statements API

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

$.info
$.paths['/accounting/v1/income-statements'].get
$.paths['/accounting/v1/income-statements/{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 Income Statements API
  version: 1.0.0
extends: openapi/merge-subpackage-incomestatements-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: 2
- target: $.paths['/accounting/v1/income-statements'].get
  update:
    x-apievangelist-phrasing:
      intent: List income statements
      effect: read
      questions:
      - Can I pull profit and loss reports from a customer's accounting system?
      - Which income statements exist for one company?
      instructions:
      - text: List income statements for company {company_id}.
        slots:
          company_id: query.company_id
      - text: Get P&L reports modified after {modified_after}.
        slots:
          modified_after: query.modified_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/income-statements/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an income statement
      effect: read
      questions:
      - What income, cost of sales and expenses are on a specific P&L report?
      - Can I expand the company on a single income statement?
      instructions:
      - text: Get income statement {id}.
        slots:
          id: path.id
      - text: Fetch income statement {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'