Reporting API v1 - currencies within the invoices

Introduction

This article explains how currencies are handled within invoices in the Reporting API v1. Understanding currency fields will help you accurately interpret invoice data when dealing with multiple currencies across different levels of your sales channel.

In this article:

• Currency options in the Platform
• Invoice API endpoints
• Understanding currency fields
• Preferred currency fields

Currency options in the platform

The Platform can generate Invoices based on different currencies:

• Seller portal currency: Can be different than the currency between Distributor and vendor
• End Customer currency (preferred currency): Can be different than the currency of the Distributor's or Seller's portals

For details on changing preferred currency, see: How do I change my preferred currency?

Invoice API endpoints

Partners use the following endpoints to retrieve Invoice information:

• invoice-rows/
• invoice-rows/{requesterId}/preview/

Understanding currency fields

The standard currency fields in the API response include:

1. Quantity: Number of Licenses

2. Unit price (unitPrice): Price of one License

3. Total price (totalPrice): Quantity × Unit Price

4. Currency: Currency of the unit Price and total Price mentioned above. These fields show the currency between provider (vendor, Distributor, or Seller) and consumer of that Invoice data (Distributor, Seller, or Customer).

Preferred currency fields

Since December 2023, additional preferred currency fields have been introduced:

5. Preferred Currency Id (preferredCurrencyId): Internal Platform ID of the preferred currency for the End Customer

6. Preferred Unit price (preferredUnitPrice): Price of one License in preferred currency = Price of one License × exchange rate

7. Preferred Total price (preferredTotalPrice): Quantity × Preferred Unit Price

All prices and preferred prices fields are applicable to general and detailed invoice line items.s. If preferred currency has not been specified, preferred fields return null values.

Summary

The Platform generates Invoices using either the Seller portal currency or End Customer preferred currency through the invoice-rows API endpoints. Standard currency fields include Quantity, unitPrice, totalPrice, and currency, representing transactions between providers and consumers. Since December 2023, additional preferred currency fields (preferredCurrencyId, preferredUnitPrice, preferredTotalPrice) allow End Customers to view Invoice amounts in their preferred currency using exchange rates. If no preferred currency is specified, these fields return null values. All price fields apply to both general and Detailed Invoice Line Items.