Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Accounting Subpackage Journal Entries API

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

$.info

$.paths['/accounting/v1/journal-entries'].get

$.paths['/accounting/v1/journal-entries'].post

$.paths['/accounting/v1/journal-entries/{id}'].get

$.paths['/accounting/v1/journal-entries/lines/remote-field-classes'].get

$.paths['/accounting/v1/journal-entries/meta/post'].get

$.paths['/accounting/v1/journal-entries/remote-field-classes'].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 Journal Entries API
  version: 1.0.0
extends: openapi/merge-subpackage-journalentries-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: 6
- target: $.paths['/accounting/v1/journal-entries'].get
  update:
    x-apievangelist-phrasing:
      intent: List journal entries
      effect: read
      questions:
      - How do I pull manual journal entries from a customer's general ledger?
      - Can I list journal entries within a transaction date window?
      - Which journal entries belong to one subsidiary company?
      instructions:
      - text: List journal entries dated 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 journal entries for company {company_id}.
        slots:
          company_id: query.company_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/journal-entries'].post
  update:
    x-apievangelist-phrasing:
      intent: Post a journal entry
      effect: write
      questions:
      - Can I write a new journal entry into the linked accounting platform?
      - What do I need to send to post a journal entry?
      instructions:
      - text: Create a journal entry from {journal_entry}.
        slots:
          journal_entry: requestBody.model
      - text: 'Post this adjusting entry to the ledger: {journal_entry}.'
        slots:
          journal_entry: requestBody.model
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/journal-entries/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one journal entry
      effect: read
      questions:
      - How do I read a single journal entry and its debit and credit lines?
      - Can I include custom remote fields on one journal entry?
      instructions:
      - text: Get journal entry {id}.
        slots:
          id: path.id
      - text: Fetch journal entry {id} with {relations} expanded.
        slots:
          id: path.id
          relations: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/journal-entries/lines/remote-field-classes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field definitions for journal lines
      effect: read
      questions:
      - What custom fields exist on individual journal entry lines?
      - Can I list only custom field classes on journal lines?
      instructions:
      - text: List remote field classes for journal lines on {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show custom fields defined on journal entry line items.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/journal-entries/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: See which fields posting a journal entry takes
      effect: read
      questions:
      - Which fields are required to post a journal entry to this ledger?
      - Can I check the journal entry create schema first?
      instructions:
      - text: Show journal entry creation fields for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Get the journal entry create metadata.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/journal-entries/remote-field-classes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field definitions for journal entries
      effect: read
      questions:
      - Which custom fields are defined at the journal entry header level?
      - Can I tell common-model journal entry fields from custom ones?
      instructions:
      - text: List journal entry remote field classes for {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show only custom field classes on journal entry records.
      method: generated
      generated: '2026-09-26'