Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Accounting Subpackage Company Info API

3 actions 3 updates phrasing extends openapi/merge-subpackage-companyinfo-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/company-info'].get

$.paths['/accounting/v1/company-info/{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 Company Info API
  version: 1.0.0
extends: openapi/merge-subpackage-companyinfo-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/company-info'].get
  update:
    x-apievangelist-phrasing:
      intent: List company info from the accounting system
      effect: read
      questions:
      - How do I get the legal company profile stored in a customer's accounting software?
      - Can I find a company info record by name in a multi-entity setup?
      instructions:
      - text: List company info records named {name}.
        slots:
          name: query.name
      - text: Show company info for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/company-info/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one company info record
      effect: read
      questions:
      - Can I read the fiscal year and currency details for one company?
      - What does a single company info record include?
      instructions:
      - text: Get company info {id}.
        slots:
          id: path.id
      - text: Fetch company info {id} with {relations} expanded.
        slots:
          id: path.id
          relations: query.expand
      method: generated
      generated: '2026-09-26'