Skip to main content

Mapping financial status in Klar

How Klar maps order and payment statuses from each shop system to Net Revenue, Gross Revenue, and Canceled — and how to override the defaults.

Written by Franz May

Klar assigns every order or payment a financial category — Net Revenue, Gross Revenue, or Canceled — based on its status in your shop system. The default mappings for each platform are listed below. If your shop uses non-standard statuses, you can override the defaults using a datasource customization.


How to customise the financial status mapping

  1. Go to Store ConfiguratorData Sources

  2. Click on your store datasource and open the Customizations section

  3. Add a new customization and choose one of the four mapping options:

  • Financial status to paid — map a custom status to Net Revenue (Paid)

  • Financial status to partially refunded — map a custom status to Gross Revenue (Partially Refunded)

  • Financial status to refunded — map a custom status to Gross Revenue (Refunded)

  • Financial status to cancelled — map a custom status to Canceled

Enter the exact status value from your shop system. Klar will treat all orders with that status as if they had the mapped standard status.


Default status mappings by shop system

WooCommerce: Financial Status of Orders

Revenue category

Status in Klar

WooCommerce order statuses

Net Revenue

Paid

completed, delivered

Net Revenue

Pending

processing, pending, on-hold, production, ready_to_pack, or similar

Gross Revenue

Refunded

refunded

Gross Revenue

Partially Refunded

partially_refunded

Canceled

Canceled

failed


SW5: Financial Status of Payment Processes

Revenue category

Status in Klar

Shopware 5 payment statuses

Net Revenue

Paid

completely_paid

Net Revenue

Pending

open, review_necessary, 1st_reminder, AmazonPendingAuthorizationPayment, or similar

Gross Revenue

Refunded

re_crediting

Canceled

Voided

the_process_has_been_cancelled, zahlungsausfall


SW6: Financial Status of Orders and Payments

Revenue category

Status in Klar

Shopware 6 order/payment statuses

Net Revenue

Paid

paid, completed, refund_failed

Net Revenue

Authorized

authorized

Net Revenue

Partially Paid

paid_partially, partially_paid

Net Revenue

Pending

in_progress, open, unconfirmed, pending

Gross Revenue

Refunded

refunded

Gross Revenue

Partially Refunded

refunded_partially, new_return, return_completed

Canceled

Canceled

cancelled

Did this answer your question?