Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Accounting Subpackage Expenses API

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

$.info
$.paths['/accounting/v1/expenses'].get
$.paths['/accounting/v1/expenses'].post
$.paths['/accounting/v1/expenses/{id}'].get
$.paths['/accounting/v1/expenses/lines/remote-field-classes'].get
$.paths['/accounting/v1/expenses/meta/post'].get
$.paths['/accounting/v1/expenses/remote-field-classes'].get
$.paths['/accounting/v1/expenses/bulk'].post
$.paths['/accounting/v1/expenses/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 Expenses API
  version: 1.0.0
extends: openapi/merge-subpackage-expenses-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/accounting/v1/expenses'].get
  update:
    x-apievangelist-phrasing:
      intent: List expenses from the accounting system
      effect: read
      questions:
      - How do I pull recorded expenses from a customer's accounting software?
      - Can I list expenses by transaction date range?
      - Which expenses belong to one company in a multi-entity ledger?
      instructions:
      - text: List expenses with transaction dates between {transaction_date_after} and {transaction_date_before}.
        slots:
          transaction_date_after: query.transaction_date_after
          transaction_date_before: query.transaction_date_before
      - text: Show expenses for company {company_id}.
        slots:
          company_id: query.company_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/expenses'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a single expense
      effect: write
      questions:
      - Can I write one new expense into a linked accounting platform?
      - What does creating an individual expense need?
      instructions:
      - text: Create an expense from {expense}.
        slots:
          expense: requestBody.model
      - text: 'Record this one expense in the ledger: {expense}.'
        slots:
          expense: requestBody.model
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/expenses/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one expense
      effect: read
      questions:
      - How do I read a single expense and its lines?
      - Can I include the accounting system's custom fields on one expense?
      instructions:
      - text: Get expense {id}.
        slots:
          id: path.id
      - text: Fetch expense {id} with {relations} expanded.
        slots:
          id: path.id
          relations: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/expenses/lines/remote-field-classes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field definitions for expense lines
      effect: read
      questions:
      - What custom fields exist on individual expense line items?
      - Can I list only custom field classes for expense lines?
      instructions:
      - text: List remote field classes for expense lines on linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show custom fields defined on expense line items.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/expenses/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: See which fields creating an expense takes
      effect: read
      questions:
      - Which fields does the accounting platform require to create an expense?
      - Can I check the expense create schema before posting one?
      instructions:
      - text: Show expense creation fields for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Get the expense create metadata.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/expenses/remote-field-classes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field definitions for expenses
      effect: read
      questions:
      - What custom fields are defined at the expense header level?
      - Can I tell which expense fields are common-model versus custom?
      instructions:
      - text: List expense remote field classes for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show only custom field classes on expense records.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/expenses/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Create many expenses in one batch
      effect: write
      questions:
      - Can I push a whole batch of expenses at once instead of one by one?
      - What do I send to start an asynchronous bulk creation of new expenses?
      instructions:
      - text: 'Bulk create these expenses: {batch_items}.'
        slots:
          batch_items: requestBody.batch_items
      - text: Submit {batch_items} as an asynchronous expense batch.
        slots:
          batch_items: requestBody.batch_items
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounting/v1/expenses/bulk/{batch_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of an expense bulk batch
      effect: read
      questions:
      - Did my bulk expense upload finish, and which items failed?
      - Where do I see the results of an expense batch I submitted?
      instructions:
      - text: Check the status of expense batch {batch_id}.
        slots:
          batch_id: path.batch_id
      - text: Show the results for expense bulk job {batch_id}.
        slots:
          batch_id: path.batch_id
      method: generated
      generated: '2026-09-26'