Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Invoice Management Invoice Configurations API

8 actions 8 updates phrasing extends openapi/conga-invoice-configurations-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['/configure-requests'].post
$.paths['/configure-requests'].patch
$.paths['/configure-requests/estimate'].post
$.paths['/configure-requests/{id}'].get
$.paths['/configure-requests/{id}/clone'].post
$.paths['/configure-requests/{id}/estimate'].get
$.paths['/configure-requests/{id}/request-results'].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 Invoice Configurations API
  version: 1.0.0
extends: openapi/conga-invoice-configurations-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['/configure-requests'].post
  update:
    x-apievangelist-phrasing:
      intent: Configure an invoice run
      effect: write
      questions:
      - How do I set up an invoice run?
      - Can an invoice run auto-approve invoices under an amount?
      instructions:
      - text: Create invoice run {name} of type {type}.
        slots:
          name: requestBody.Name
          type: requestBody.RunType
      - text: Configure invoice run {name} processing from {from} to {to}.
        slots:
          name: requestBody.Name
          from: requestBody.ProcessFrom
          to: requestBody.ProcessTo
      method: generated
      generated: '2026-10-01'
- target: $.paths['/configure-requests'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an invoice run configuration
      effect: write
      questions:
      - How do I change the settings of an existing invoice run?
      - Can I change an invoice run's schedule frequency?
      instructions:
      - text: Update invoice run configuration {id} to frequency {freq}.
        slots:
          id: requestBody.Id
          freq: requestBody.Frequency
      - text: Change invoice run {id} to use invoice template {template}.
        slots:
          id: requestBody.Id
          template: requestBody.InvoiceDocumentTemplate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/configure-requests/estimate'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview an invoice run before saving
      effect: read
      questions:
      - Can I preview what an invoice run would bill before creating it?
      - How do I estimate an unsaved invoice run configuration?
      instructions:
      - text: Preview an unsaved invoice run {name} from {from} to {to}.
        slots:
          name: requestBody.Name
          from: requestBody.ProcessFrom
          to: requestBody.ProcessTo
      - text: Estimate a draft run with filter {filter}.
        slots:
          filter: requestBody.FilterCriteria
      method: generated
      generated: '2026-10-01'
- target: $.paths['/configure-requests/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an invoice run configuration
      effect: read
      questions:
      - Where can I see the settings of one invoice run?
      - What filters does a saved invoice run use?
      instructions:
      - text: Get invoice run configuration {id}.
        slots:
          id: path.id
      - text: Show the saved settings of invoice run {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/configure-requests/{id}/clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Clone an invoice run configuration
      effect: write
      questions:
      - Can I copy an existing invoice run as a new one?
      - How do I duplicate an invoice configuration?
      instructions:
      - text: Clone invoice run configuration {id}.
        slots:
          id: path.id
      - text: Make a copy of invoice run {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/configure-requests/{id}/estimate'].get
  update:
    x-apievangelist-phrasing:
      intent: Preview a saved invoice run
      effect: read
      questions:
      - What would a saved invoice run produce if it ran now?
      - Can I see the billing schedules a saved run would include?
      instructions:
      - text: Preview the saved invoice run {id}.
        slots:
          id: path.id
      - text: Estimate invoices for configuration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/configure-requests/{id}/request-results'].get
  update:
    x-apievangelist-phrasing:
      intent: Get results of an invoice run configuration
      effect: read
      questions:
      - What happened when an invoice run executed?
      - Can I see the results of a configured invoice run?
      instructions:
      - text: Get the request results of invoice run {id}.
        slots:
          id: path.id
      - text: Show outcomes of configuration {id} including {includes}.
        slots:
          id: path.id
          includes: query.includes
      method: generated
      generated: '2026-10-01'