Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Subpackage Accounting Periods API

3 actions 3 updates phrasing extends openapi/merge-subpackage-accountingperiods-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/accounting-periods'].get
$.paths['/accounting/v1/accounting-periods/{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 Subpackage Accounting Periods API
  version: 1.0.0
extends: openapi/merge-subpackage-accountingperiods-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/accounting-periods'].get
  update:
    x-apievangelist-phrasing:
      intent: List accounting periods
      effect: read
      questions:
      - How do I get the fiscal periods defined in a customer's accounting system?
      - Can I page through accounting periods 100 at a time?
      instructions:
      - text: List accounting periods for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show all fiscal periods, including deleted ones.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/accounting-periods/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one accounting period
      effect: read
      questions:
      - Can I check whether a single accounting period is open or closed?
      - What does one fiscal period record contain?
      instructions:
      - text: Get accounting period {id}.
        slots:
          id: path.id
      - text: Fetch fiscal period {id} with its raw remote data.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'