Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Invoice Management Credit Memos API

4 actions 4 updates phrasing extends openapi/conga-credit-memos-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Conga's API. It is a proposal applied on top of the contract, not a document Conga publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/creditmemos/approve'].post
$.paths['/creditmemos/cancel'].post
$.paths['/creditmemos/{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 Invoice Management Credit Memos API
  version: 1.0.0
extends: openapi/conga-credit-memos-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/creditmemos/approve'].post
  update:
    x-apievangelist-phrasing:
      intent: Approve credit memos
      effect: write
      questions:
      - How do I approve draft or pending credit memos in bulk?
      - What happens to billing schedules when a credit memo is approved?
      - Can some credit memos approve while others fail validation?
      instructions:
      - text: Approve credit memos {Ids}.
        slots:
          Ids: requestBody.Ids
      - text: Bulk-approve the pending credit memos with IDs {Ids}.
        slots:
          Ids: requestBody.Ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/creditmemos/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel credit memos
      effect: destructive
      questions:
      - How do I cancel approved credit memos that haven't been credited yet?
      - Which credit memos are eligible for cancellation?
      instructions:
      - text: Cancel credit memos {Ids}.
        slots:
          Ids: requestBody.Ids
      - text: Void the approved, uncredited credit memos {Ids}.
        slots:
          Ids: requestBody.Ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/creditmemos/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get credit memo details
      effect: read
      questions:
      - How do I view a credit memo I already created?
      - Can I pull one credit memo's details by its ID?
      instructions:
      - text: Show credit memo {id}.
        slots:
          id: path.id
      - text: Get the details of credit memo {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'