API Evangelist conversational phrasing for Mirakl Invoicing and Accounting API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mirakl Invoicing and Accounting API
  version: 1.0.0
extends: openapi/mirakl-invoicing-and-accounting-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: 11
- target: $.paths['/api/document-request/documents/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download accounting documents
      effect: read
      questions:
      - How do I download invoices or credit notes from a document request?
      - What happens when I download more than one accounting document at once?
      instructions:
      - text: Download document {document_id} from an accounting document request.
        slots:
          document_id: query.document_id
      - text: Download the documents for entity {entity_id} as {document_format}.
        slots:
          entity_id: query.entity_id
          document_format: query.document_format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/invoices'].get
  update:
    x-apievangelist-phrasing:
      intent: List invoices and credit notes
      effect: read
      questions:
      - Which invoices and credit notes were issued in a date range?
      - Can I list unpaid accounting documents for one shop?
      instructions:
      - text: List accounting documents from {start_date} to {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      - text: Show invoices for shop {shop} with payment status {payment_status}.
        slots:
          shop: query.shop
          payment_status: query.payment_status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/seller-billing-cycles'].get
  update:
    x-apievangelist-phrasing:
      intent: List seller billing cycles
      effect: read
      questions:
      - What billing cycles have been run for sellers, and were they paid out?
      - Can I find a seller billing cycle by payment voucher number?
      instructions:
      - text: List seller billing cycles for shop {shop_id}.
        slots:
          shop_id: query.shop_id
      - text: Show billing cycles with payout state {pay_out_state}.
        slots:
          pay_out_state: query.pay_out_state
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/document-request/requests'].get
  update:
    x-apievangelist-phrasing:
      intent: List accounting document requests
      effect: read
      questions:
      - Which accounting document requests are pending issuance?
      - Can I filter document requests by type, state or billing cycle?
      instructions:
      - text: List document requests in state {state}.
        slots:
          state: query.state
      - text: Show document requests for billing cycle {shop_billing_cycle_id}.
        slots:
          shop_billing_cycle_id: query.shop_billing_cycle_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/document-request/{document_request_id}/lines'].get
  update:
    x-apievangelist-phrasing:
      intent: List a document request's lines
      effect: read
      questions:
      - What lines make up a specific accounting document request?
      - Can I see the detail behind one document request before issuing it?
      instructions:
      - text: List the lines of document request {document_request_id}.
        slots:
          document_request_id: path.document_request_id
      - text: Show line details for request {document_request_id}.
        slots:
          document_request_id: path.document_request_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/document-request/documents/upload'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload accounting documents
      effect: write
      questions:
      - How do I upload the invoices I issued for document requests?
      - How many accounting documents can I upload at the same time?
      instructions:
      - text: Upload documents {files} with metadata {documents_input}.
        slots:
          files: requestBody.files
          documents_input: requestBody.documents_input
      - text: Attach issued invoices {files} for shop {shop_id} using {documents_input}.
        slots:
          files: requestBody.files
          shop_id: query.shop_id
          documents_input: requestBody.documents_input
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/invoices/{accounting_document_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download one invoice or credit note
      effect: read
      questions:
      - How do I get the PDF of a specific marketplace invoice?
      - Can I download a single accounting document by its ID?
      instructions:
      - text: Get the single invoice or credit note {accounting_document_id} as a file.
        slots:
          accounting_document_id: path.accounting_document_id
      - text: Get the invoice file {accounting_document_id} for shop {shop_id}.
        slots:
          accounting_document_id: path.accounting_document_id
          shop_id: query.shop_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/sellerpayment/transactions_logs'].get
  update:
    x-apievangelist-phrasing:
      intent: List seller transaction lines
      effect: read
      questions:
      - What transactions make up a seller's payout?
      - Can I list transaction lines for a specific order?
      instructions:
      - text: List transaction lines for billing cycle {seller_billing_cycle_id}.
        slots:
          seller_billing_cycle_id: query.seller_billing_cycle_id
      - text: Show transactions for order {order_id}.
        slots:
          order_id: query.order_id
      - text: List transactions of type {transaction_type}.
        slots:
          transaction_type: query.transaction_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/sellerpayment/transactions_logs/async'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a transaction log export
      effect: read
      questions:
      - How do I export a large volume of transaction lines as a file?
      - Can the transaction log export be chunked by size or item count?
      instructions:
      - text: Start a transaction export for billing cycle {seller_billing_cycle_id}.
        slots:
          seller_billing_cycle_id: requestBody.seller_billing_cycle_id
      - text: Export transactions created from {date_created_from} to {date_created_to}.
        slots:
          date_created_from: requestBody.date_created_from
          date_created_to: requestBody.date_created_to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/sellerpayment/transactions_logs/async/status/{tracking_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a transaction export's status
      effect: read
      questions:
      - Is my transaction log export ready to download?
      - Where do I find the file URLs once a transaction export completes?
      instructions:
      - text: Check transaction export {tracking_id}.
        slots:
          tracking_id: path.tracking_id
      - text: Get the file links for finished transaction export {tracking_id}.
        slots:
          tracking_id: path.tracking_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dynamic-url/The+URL+is+retrieved+from+TL04+output/TL05'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a transaction export file
      effect: read
      questions:
      - How do I fetch each chunk of a completed transaction log export?
      - Can I retrieve a specific transaction export file by name?
      instructions:
      - text: Download file {file} of transaction export {tracking_id}.
        slots:
          file: query.file
          tracking_id: path.tracking_id
      - text: Retrieve transaction log chunk {file} from export {tracking_id}.
        slots:
          file: query.file
          tracking_id: path.tracking_id
      method: generated
      generated: '2026-09-26'