# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Accounting Subpackage Payments API
  version: 1.0.0
extends: openapi/merge-subpackage-payments-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: 8
- target: $.paths['/accounting/v1/payments'].get
  update:
    x-apievangelist-phrasing:
      intent: List payments
      effect: read
      questions:
      - Which payments were recorded against a given account last month?
      - Can I list payments made by a specific contact?
      instructions:
      - text: List payments for contact {contact_id}.
        slots:
          contact_id: query.contact_id
      - text: Show payments dated between {transaction_date_after} and {transaction_date_before}.
        slots:
          transaction_date_after: query.transaction_date_after
          transaction_date_before: query.transaction_date_before
      - text: List payments posted to account {account_id}.
        slots:
          account_id: query.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/payments'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a payment
      effect: write
      questions:
      - How do I record a payment in a customer's accounting software?
      - Can I log a payment asynchronously?
      instructions:
      - text: Record a payment with {model}.
        slots:
          model: requestBody.model
      - text: Create payment {model} as an async task.
        slots:
          model: requestBody.model
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/payments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a payment
      effect: read
      questions:
      - What invoices did a specific payment apply to?
      - Can I fetch one payment with related objects expanded?
      instructions:
      - text: Get payment {id}.
        slots:
          id: path.id
      - text: Fetch payment {id} expanding {expand}.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/payments/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an existing payment
      effect: write
      questions:
      - How do I modify a payment that was already recorded?
      - Can I change the amount or date on an existing payment?
      instructions:
      - text: Update payment {id} with {model}.
        slots:
          id: path.id
          model: requestBody.model
      - text: Patch recorded payment {id} using {model} asynchronously.
        slots:
          id: path.id
          model: requestBody.model
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/payments/line-items/remote-field-classes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field definitions for payment line items
      effect: read
      questions:
      - What custom fields appear on payment line items?
      - Which payment line item fields are integration-specific?
      instructions:
      - text: List payment line item remote field classes where custom is {is_custom}.
        slots:
          is_custom: query.is_custom
      - text: Show payment line-item field definitions for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/payments/meta/patch/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: See which payment fields can be updated
      effect: read
      questions:
      - Which fields can I change on a recorded payment?
      - What does the integration allow when editing a payment?
      instructions:
      - text: Get the update metadata for payment {id}.
        slots:
          id: path.id
      - text: Show editable fields on payment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/payments/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: See which fields recording a payment needs
      effect: read
      questions:
      - What fields are required to record a new payment?
      - Can I check the accepted payment fields before posting one?
      instructions:
      - text: Get payment creation metadata for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show the fields needed to record a payment.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/payments/remote-field-classes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field definitions for payments
      effect: read
      questions:
      - What custom payment-level fields exist in the accounting system?
      - Can I list only the common-model payment field classes?
      instructions:
      - text: List payment remote field classes where common-model field is {is_common_model_field}.
        slots:
          is_common_model_field: query.is_common_model_field
      - text: Show payment field definitions for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'