# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Remote Payroll and Billing Billing Documents API
  version: 1.0.0
extends: openapi/remote-com-billing-documents-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: 4
- target: $.paths['/billing_documents'].get
  update:
    x-apievangelist-phrasing:
      intent: List billing documents
      effect: read
      questions:
      - What invoices and billing documents has Remote issued to my company?
      - Can I filter billing documents by period or payment status?
      instructions:
      - text: List billing documents for period {period}.
        slots:
          period: query.period
      - text: Show billing documents with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billing_documents/{billing_document_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a billing document
      effect: read
      questions:
      - How do I see the totals and details of one billing document?
      - Where can I check the status of a specific Remote invoice?
      instructions:
      - text: Show billing document {billing_document_id}.
        slots:
          billing_document_id: path.billing_document_id
      - text: Get the summary of invoice {billing_document_id}.
        slots:
          billing_document_id: path.billing_document_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billing_documents/{billing_document_id}/breakdown'].get
  update:
    x-apievangelist-phrasing:
      intent: Break down a billing document by line item
      effect: read
      questions:
      - What exactly am I being charged for on a billing document, line by line?
      - Can I see per-employee costs that make up an invoice total?
      instructions:
      - text: Break down the charges on billing document {billing_document_id}.
        slots:
          billing_document_id: path.billing_document_id
      - text: Show the itemized cost breakdown for invoice {billing_document_id}.
        slots:
          billing_document_id: path.billing_document_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billing_documents/{billing_document_id}/pdf'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a billing document as PDF
      effect: read
      questions:
      - How do I get a PDF copy of a Remote invoice for my accounting team?
      - Is there a way to download a billing document as a file?
      instructions:
      - text: Download the PDF of billing document {billing_document_id}.
        slots:
          billing_document_id: path.billing_document_id
      - text: Save invoice {billing_document_id} as a PDF.
        slots:
          billing_document_id: path.billing_document_id
      method: generated
      generated: '2026-09-26'