Klarna · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Klarna Settlements Reports API

5 actions 5 updates phrasing extends openapi/klarna-reports-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Klarna's API. It is a proposal applied on top of the contract, not a document Klarna publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/reports/payout-with-transactions'].get

$.paths['/reports/payout'].get

$.paths['/reports/payouts-summary-with-transactions'].get

$.paths['/reports/payouts-summary'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Klarna Settlements Reports API
  version: 1.0.0
extends: openapi/klarna-reports-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['/reports/payout-with-transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: Download one payout's transactions as CSV
      effect: read
      questions:
      - Can I export every transaction in a single payout to a spreadsheet?
      - Where do I get the CSV settlement report for one payout?
      instructions:
      - text: Download the CSV report for payout {payment_reference}.
        slots:
          payment_reference: query.payment_reference
      - text: Export the transactions of payout {payment_reference} as CSV.
        slots:
          payment_reference: query.payment_reference
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reports/payout'].get
  update:
    x-apievangelist-phrasing:
      intent: Download one payout's summary as PDF
      effect: read
      questions:
      - Is there a printable PDF summary of a single settlement?
      - Can I get a PDF of one payout for my accountant?
      instructions:
      - text: Download the PDF summary for payout {payment_reference}.
        slots:
          payment_reference: query.payment_reference
      - text: Get payout {payment_reference} as a PDF.
        slots:
          payment_reference: query.payment_reference
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reports/payouts-summary-with-transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: Export all payout transactions for a period as CSV
      effect: read
      questions:
      - Can I export the transactions of all payouts between two dates as CSV?
      - Which report gives me a CSV of every settlement in a month?
      instructions:
      - text: Download a CSV of all payout transactions from {start_date} to {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      - text: Export the payouts summary with transactions between {start_date} and {end_date} as CSV.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reports/payouts-summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a PDF summary of payouts for a period
      effect: read
      questions:
      - Can I get a PDF covering all payouts between two dates?
      - Is there a PDF report summarizing a quarter's payouts?
      instructions:
      - text: Download the PDF payouts summary from {start_date} to {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      - text: Get a PDF of all payouts between {start_date} and {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-09-26'