# 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 Vendor Credits API
  version: 1.0.0
extends: openapi/merge-subpackage-vendorcredits-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: 7
- target: $.paths['/accounting/v1/vendor-credits'].get
  update:
    x-apievangelist-phrasing:
      intent: List vendor credits
      effect: read
      questions:
      - Can I see all credits my suppliers have issued in a connected accounting system?
      - Which vendor credits were recorded in a specific transaction date window?
      instructions:
      - text: List vendor credits for company {company_id}.
        slots:
          company_id: query.company_id
      - text: Get vendor credits with transaction dates after {transaction_date_after}.
        slots:
          transaction_date_after: query.transaction_date_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/vendor-credits'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a vendor credit
      effect: write
      questions:
      - How do I record a credit from a supplier in a customer's books?
      - Can a vendor credit be created as an async task?
      instructions:
      - text: Create vendor credit {model} in linked account {account_token}.
        slots:
          model: requestBody.model
          account_token: header.X-Account-Token
      - text: Record a supplier credit with details {model}.
        slots:
          model: requestBody.model
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/vendor-credits/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a vendor credit
      effect: read
      questions:
      - What's the total and vendor on a specific vendor credit?
      - Can I expand the lines on a single supplier credit?
      instructions:
      - text: Get vendor credit {id}.
        slots:
          id: path.id
      - text: Fetch vendor credit {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/vendor-credits/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a vendor credit
      effect: write
      questions:
      - Can I edit a vendor credit that's already in the books?
      - Which supplier credit fields can be changed with a PATCH?
      instructions:
      - text: Update vendor credit {id} with {model}.
        slots:
          id: path.id
          model: requestBody.model
      - text: Change existing supplier credit {id} to {model}.
        slots:
          id: path.id
          model: requestBody.model
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/vendor-credits/{id}/application'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a vendor credit to an invoice
      effect: write
      questions:
      - Can I use a supplier's credit to reduce a bill I owe them?
      - Do I have to specify the amount and date when applying a vendor credit?
      instructions:
      - text: Apply {applied_amount} of vendor credit {id} to invoice {invoice} on {applied_date}.
        slots:
          applied_amount: requestBody.applied_amount
          id: path.id
          invoice: requestBody.invoice
          applied_date: requestBody.applied_date
      - text: Use supplier credit {id} against bill {invoice}.
        slots:
          id: path.id
          invoice: requestBody.invoice
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/vendor-credits/meta/patch/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get editable fields for a vendor credit
      effect: read
      questions:
      - Which fields of an existing vendor credit can the integration update?
      - What am I allowed to change on a supplier credit?
      instructions:
      - text: Show PATCH metadata for vendor credit {id}.
        slots:
          id: path.id
      - text: List the updatable fields of supplier credit {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/vendor-credits/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: Get fields for creating vendor credits
      effect: read
      questions:
      - Which fields are required to create a vendor credit in an integration?
      - What does the accounting system accept for a new supplier credit?
      instructions:
      - text: Show vendor credit POST metadata for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Describe the create fields for new vendor credits.
      method: generated
      generated: '2026-09-26'