Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Merge Subpackage Accounts API

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

$.info
$.paths['/accounting/v1/accounts'].get
$.paths['/accounting/v1/accounts'].post
$.paths['/accounting/v1/accounts/{id}'].get
$.paths['/accounting/v1/accounts/meta/post'].get
$.paths['/crm/v1/accounts'].get
$.paths['/crm/v1/accounts'].post
$.paths['/crm/v1/accounts/{id}'].get
$.paths['/crm/v1/accounts/{id}'].patch
$.paths['/crm/v1/accounts/meta/patch/{id}'].get
$.paths['/crm/v1/accounts/meta/post'].get
$.paths['/crm/v1/accounts/remote-field-classes'].get
$.paths['/ticketing/v1/accounts'].get
$.paths['/ticketing/v1/accounts/{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 Merge Subpackage Accounts API
  version: 1.0.0
extends: openapi/merge-subpackage-accounts-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: 13
- target: $.paths['/accounting/v1/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List the chart of accounts
      effect: read
      questions:
      - How do I pull the chart of accounts from my customer's accounting software?
      - Can I filter ledger accounts by classification, such as only expense or revenue accounts?
      - Which general ledger account has a particular account number?
      instructions:
      - text: List ledger accounts with classification {classification}.
        slots:
          classification: query.classification
      - text: Find the GL account numbered {account_number}.
        slots:
          account_number: query.account_number
      - text: Show active chart-of-accounts entries for company {company_id} with status {status}.
        slots:
          company_id: query.company_id
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a ledger account to the chart of accounts
      effect: write
      questions:
      - Can I create a new general ledger account in a linked accounting system?
      - What does posting a new chart-of-accounts entry require?
      instructions:
      - text: Create a ledger account from {account}.
        slots:
          account: requestBody.model
      - text: Add GL account {account} to the chart of accounts asynchronously.
        slots:
          account: requestBody.model
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/accounts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one ledger account
      effect: read
      questions:
      - How do I read the balance and type of one general ledger account?
      - Can I see which company a single GL account belongs to?
      instructions:
      - text: Get ledger account {id}.
        slots:
          id: path.id
      - text: Fetch GL account {id} with {relations} expanded.
        slots:
          id: path.id
          relations: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/accounts/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: See which fields creating a ledger account takes
      effect: read
      questions:
      - What fields does the accounting platform need to create a GL account?
      - Can I check the ledger account create schema before posting?
      instructions:
      - text: Show ledger account creation fields for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Get the chart-of-accounts create metadata.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List CRM company accounts
      effect: read
      questions:
      - How do I list the companies a sales team tracks in their CRM?
      - Can I find CRM accounts owned by one sales rep?
      - Which CRM account matches a company name?
      instructions:
      - text: List CRM accounts owned by {owner_id}.
        slots:
          owner_id: query.owner_id
      - text: Find the CRM company account named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a company account in the CRM
      effect: write
      questions:
      - Can I add a new customer company to a linked CRM?
      - What do I send to create a CRM account record?
      instructions:
      - text: Create a CRM company account from {account}.
        slots:
          account: requestBody.model
      - text: Add organization {account} to the CRM as a new account.
        slots:
          account: requestBody.model
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/accounts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one CRM account
      effect: read
      questions:
      - How do I read a single company record from the CRM?
      - Can I see the owner of one CRM account?
      instructions:
      - text: Get CRM account {id}.
        slots:
          id: path.id
      - text: Fetch CRM company {id} and expand {relations}.
        slots:
          id: path.id
          relations: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/accounts/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a CRM account
      effect: write
      questions:
      - Can I change the industry or owner on a CRM company record?
      - What is the way to edit only certain fields of a CRM account?
      instructions:
      - text: Update CRM account {id} with {changes}.
        slots:
          id: path.id
          changes: requestBody.model
      - text: Reassign CRM company {id} using {changes}.
        slots:
          id: path.id
          changes: requestBody.model
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/accounts/meta/patch/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: See which CRM account fields can be edited
      effect: read
      questions:
      - Which fields on a CRM company can I patch for this integration?
      - Is there edit metadata I can read for one CRM account?
      instructions:
      - text: Show the editable fields on CRM account {id}.
        slots:
          id: path.id
      - text: Get CRM account patch metadata for {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/accounts/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: See which fields creating a CRM account takes
      effect: read
      questions:
      - What fields are required to create a company in the linked CRM?
      - Can I read the CRM account create schema first?
      instructions:
      - text: Show CRM account creation fields for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Get the create metadata for CRM companies.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/accounts/remote-field-classes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field definitions for CRM accounts
      effect: read
      questions:
      - What custom properties has my customer added to company records in their CRM?
      - Can I list only custom fields on CRM accounts?
      instructions:
      - text: List CRM account remote field classes for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show custom field definitions on CRM companies.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List help desk customer accounts
      effect: read
      questions:
      - How do I get the customer organizations stored in a ticketing system?
      - Can I list ticketing accounts created after a certain date?
      instructions:
      - text: List help desk accounts created after {created_after}.
        slots:
          created_after: query.created_after
      - text: Find the ticketing account with remote id {remote_id}.
        slots:
          remote_id: query.remote_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/accounts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one help desk account
      effect: read
      questions:
      - How do I read one customer organization from the help desk?
      - Can I get a ticketing account along with its raw remote data?
      instructions:
      - text: Get ticketing account {id}.
        slots:
          id: path.id
      - text: Fetch help desk organization {id} with remote data.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'