Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Billing Management Payment Terms API

8 actions 8 updates phrasing extends openapi/conga-payment-terms-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 8

$.info
$.paths['/payment-terms'].get
$.paths['/payment-terms'].post
$.paths['/payment-terms'].patch
$.paths['/payment-terms/activate'].patch
$.paths['/payment-terms/{id}'].get
$.paths['/payment-terms/{id}/default'].put
$.paths['/payment-terms/{paymentTermId}/activate'].patch

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 Billing Management Payment Terms API
  version: 1.0.0
extends: openapi/conga-payment-terms-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: 7
- target: $.paths['/payment-terms'].get
  update:
    x-apievangelist-phrasing:
      intent: List payment terms
      effect: read
      questions:
      - Which payment terms are configured?
      - Can I filter payment terms such as Net 30?
      instructions:
      - text: List all payment terms.
      - text: List payment terms matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/payment-terms'].post
  update:
    x-apievangelist-phrasing:
      intent: Create payment terms
      effect: write
      questions:
      - How do I add a new payment term?
      - Can I create several payment terms at once?
      instructions:
      - text: Create new payment term records.
      - text: Add a batch of payment terms.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/payment-terms'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update payment terms
      effect: write
      questions:
      - Can I edit several payment terms in one request?
      - How do I bulk-update payment terms?
      instructions:
      - text: Bulk update the selected payment terms.
      - text: Edit many payment term records at once.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/payment-terms/activate'].patch
  update:
    x-apievangelist-phrasing:
      intent: Activate or deactivate payment terms in bulk
      effect: write
      questions:
      - Can I switch several payment terms on or off at once?
      - How do I deactivate a list of payment terms?
      instructions:
      - text: Activate or deactivate the listed payment terms.
      - text: Toggle the active state of several payment terms.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/payment-terms/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a payment term
      effect: read
      questions:
      - Where can I see one payment term?
      - What does a specific payment term define?
      instructions:
      - text: Get payment term {id}.
        slots:
          id: path.id
      - text: Show payment term record {id} including {includes}.
        slots:
          id: path.id
          includes: query.includes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/payment-terms/{id}/default'].put
  update:
    x-apievangelist-phrasing:
      intent: Make a payment term the default
      effect: write
      questions:
      - How do I set the default payment term?
      - Can I change which payment term is default?
      instructions:
      - text: Make payment term {id} the default.
        slots:
          id: path.id
      - text: Set {id} as our default payment term.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/payment-terms/{paymentTermId}/activate'].patch
  update:
    x-apievangelist-phrasing:
      intent: Activate or deactivate one payment term
      effect: write
      questions:
      - Can I deactivate a single payment term?
      - How do I turn one payment term back on?
      instructions:
      - text: Set payment term {id} active to {active}.
        slots:
          id: path.paymentTermId
          active: query.active
      - text: Deactivate only payment term {id}.
        slots:
          id: path.paymentTermId
      method: generated
      generated: '2026-10-01'