Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Accounting Subpackage Balance Sheets API

3 actions 3 updates phrasing extends openapi/merge-subpackage-balancesheets-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/balance-sheets'].get

$.paths['/accounting/v1/balance-sheets/{id}'].get

OpenAPI Overlay

# 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 Balance Sheets API
  version: 1.0.0
extends: openapi/merge-subpackage-balancesheets-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/balance-sheets'].get
  update:
    x-apievangelist-phrasing:
      intent: List balance sheets
      effect: read
      questions:
      - Can I pull balance sheet reports from a customer's accounting system?
      - Which balance sheets exist for one company within a linked account?
      instructions:
      - text: List balance sheets for company {company_id}.
        slots:
          company_id: query.company_id
      - text: Get balance sheets created after {created_after}.
        slots:
          created_after: query.created_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/balance-sheets/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a balance sheet
      effect: read
      questions:
      - What assets, liabilities and equity are on a specific balance sheet report?
      - Can I expand the company on a single balance sheet?
      instructions:
      - text: Get balance sheet {id}.
        slots:
          id: path.id
      - text: Fetch balance sheet {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'