Efí Pay (Gerencianet) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Efí Pay Pix Reports API

3 actions 3 updates phrasing extends openapi/gerencianet-reports-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Efí Pay (Gerencianet)'s API. It is a proposal applied on top of the contract, not a document Efí Pay (Gerencianet) publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/v2/gn/relatorios/extrato-conciliacao'].post
$.paths['/v2/gn/relatorios/{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 Efí Pay Pix Reports API
  version: 1.0.0
extends: openapi/gerencianet-reports-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: 2
- target: $.paths['/v2/gn/relatorios/extrato-conciliacao'].post
  update:
    x-apievangelist-phrasing:
      intent: Request a reconciliation report
      effect: write
      questions:
      - How do I generate a statement reconciliation report?
      - Can I request a report to reconcile my Pix transactions?
      instructions:
      - text: Create a reconciliation report.
      - text: Request a new statement reconciliation report.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/gn/relatorios/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a reconciliation report
      effect: read
      questions:
      - Is my reconciliation report ready to download?
      - Can I fetch a report I requested earlier?
      instructions:
      - text: Show reconciliation report {id}.
        slots:
          id: path.id
      - text: Get the results of report {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'