# 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 Credit Notes API
  version: 1.0.0
extends: openapi/merge-subpackage-creditnotes-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/credit-notes'].get
  update:
    x-apievangelist-phrasing:
      intent: List credit notes
      effect: read
      questions:
      - Can I pull all credit notes issued to customers from a connected accounting system?
      - Which credit notes fall within a given transaction date range?
      instructions:
      - text: List credit notes for company {company_id}.
        slots:
          company_id: query.company_id
      - text: Get credit notes dated between {transaction_date_after} and {transaction_date_before}.
        slots:
          transaction_date_after: query.transaction_date_after
          transaction_date_before: query.transaction_date_before
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/credit-notes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a credit note
      effect: write
      questions:
      - How do I issue a new credit note in a customer's accounting software?
      - Can I create a credit note asynchronously and check on it later?
      instructions:
      - text: Create credit note {model} in linked account {account_token}.
        slots:
          model: requestBody.model
          account_token: header.X-Account-Token
      - text: Issue a customer credit note with details {model}.
        slots:
          model: requestBody.model
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/credit-notes/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a credit note
      effect: read
      questions:
      - What's the remaining credit and status on a specific credit note?
      - Can I expand the line items and contact on a single credit note?
      instructions:
      - text: Get credit note {id}.
        slots:
          id: path.id
      - text: Fetch credit note {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/credit-notes/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a credit note
      effect: write
      questions:
      - Can I edit an existing credit note after it's been created?
      - Which credit note fields can be changed through a PATCH?
      instructions:
      - text: Update credit note {id} with {model}.
        slots:
          id: path.id
          model: requestBody.model
      - text: Change the details of existing credit note {id} to {model}.
        slots:
          id: path.id
          model: requestBody.model
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/credit-notes/{id}/application'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a credit note to an invoice
      effect: write
      questions:
      - Can I use a customer's credit note to pay down an open invoice?
      - Do I need to say how much of the credit note to apply and when?
      instructions:
      - text: Apply {applied_amount} from credit note {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: Offset invoice {invoice} using credit note {id}.
        slots:
          invoice: requestBody.invoice
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/credit-notes/meta/patch/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get editable fields for a credit note
      effect: read
      questions:
      - Which fields on an existing credit note does the integration let me edit?
      - What can I change before sending a credit note update?
      instructions:
      - text: Show PATCH metadata for credit note {id}.
        slots:
          id: path.id
      - text: List the updatable fields of credit note {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/credit-notes/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: Get fields for creating credit notes
      effect: read
      questions:
      - Which fields are required to create a credit note in a given integration?
      - What does the accounting system accept for a new credit note?
      instructions:
      - text: Show credit note POST metadata for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Describe the create fields for new credit notes.
      method: generated
      generated: '2026-09-26'