Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Accounting Subpackage Expense Reports API

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

$.info
$.paths['/accounting/v1/expense-reports'].get
$.paths['/accounting/v1/expense-reports'].post
$.paths['/accounting/v1/expense-reports/{expense_report_id}/lines'].get
$.paths['/accounting/v1/expense-reports/{id}'].get
$.paths['/accounting/v1/expense-reports/lines/remote-field-classes'].get
$.paths['/accounting/v1/expense-reports/meta/post'].get
$.paths['/accounting/v1/expense-reports/remote-field-classes'].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 Expense Reports API
  version: 1.0.0
extends: openapi/merge-subpackage-expensereports-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: 7
- target: $.paths['/accounting/v1/expense-reports'].get
  update:
    x-apievangelist-phrasing:
      intent: List expense reports
      effect: read
      questions:
      - Which expense reports have employees submitted in the accounting system?
      - Can I list expense reports for just one company?
      instructions:
      - text: List expense reports for company {company_id}.
        slots:
          company_id: query.company_id
      - text: Show expense reports modified since {modified_after}.
        slots:
          modified_after: query.modified_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/expense-reports'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit an expense report
      effect: write
      questions:
      - How do I create an expense report in a connected accounting platform?
      - Can I push an employee's expenses as a new report?
      instructions:
      - text: Create an expense report with {model}.
        slots:
          model: requestBody.model
      - text: 'Submit a new expense report: {model}.'
        slots:
          model: requestBody.model
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/expense-reports/{expense_report_id}/lines'].get
  update:
    x-apievangelist-phrasing:
      intent: List the lines on an expense report
      effect: read
      questions:
      - What individual expenses make up a given report?
      - Can I page through the line items of one expense report?
      instructions:
      - text: List the lines on expense report {expense_report_id}.
        slots:
          expense_report_id: path.expense_report_id
      - text: Show {page_size} expense lines at a time for report {expense_report_id}.
        slots:
          page_size: query.page_size
          expense_report_id: path.expense_report_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/expense-reports/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an expense report
      effect: read
      questions:
      - How do I pull the header details of one expense report?
      - What status and totals does a specific expense report show?
      instructions:
      - text: Get expense report {id}.
        slots:
          id: path.id
      - text: Fetch expense report {id} expanding {expand}.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/expense-reports/lines/remote-field-classes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field definitions for expense lines
      effect: read
      questions:
      - What custom fields can appear on expense report lines?
      - Which expense line fields are specific to the accounting platform?
      instructions:
      - text: List expense line remote field classes where custom is {is_custom}.
        slots:
          is_custom: query.is_custom
      - text: Show expense-line field definitions for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/expense-reports/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: See which fields an expense report needs
      effect: read
      questions:
      - What fields must I send to create an expense report here?
      - How can I check supported expense report fields before submitting?
      instructions:
      - text: Get expense report creation metadata for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show the fields required for a new expense report.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/expense-reports/remote-field-classes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field definitions for expense reports
      effect: read
      questions:
      - What custom report-level fields exist on expense reports?
      - Can I list only common-model expense report field classes?
      instructions:
      - text: List expense report remote field classes where common-model field is {is_common_model_field}.
        slots:
          is_common_model_field: query.is_common_model_field
      - text: Show expense report header field definitions for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'