Fx Data in data source exports
This article explains how to include FX data in data source exports. You can export transaction amounts converted into your home currency and other specified currencies.
You must have the Currency Conversion feature enabled on your tenant to use this feature. Fx data objects/records are soft deleted, enabling you to retain deleted records within the Zuora system for reporting.
The Fx data feature is in Limited Availability. If you wish to have access to the feature, submit a request to Zuora Global Support.
Data source objects that support FX data conversion
You can export FX data for the following data source objects:
- CreditBalanceAdjustment
- CreditMemoApplication
- CreditMemoApplicationItem
- CreditMemo
- CreditMemoItem
- CreditMemoPart
- CreditMemoPartItem
- CreditTaxationItem
- DebitMemo
- DebitMemoItem
- DebitTaxationItem
- InvoiceAdjustment
- Invoice
- InvoiceItemAdjustment
- InvoiceItem
- InvoicePayment
- Payment
- PaymentApplication
- PaymentApplicationItem
- PaymentPart
- PaymentPartItem
- Refund
- RefundApplication
- RefundApplicationItem
- RefundPart
- RefundPartItem
- RefundInvoicePayment
- RevenueScheduleItem
- RevenueScheduleItemInvoiceItem
- RevenueScheduleItemInvoiceItemAdjustment
- RevenueScheduleItemCreditMemoItem
- RevenueScheduleItemDebitMemoItem
- TaxationItem
You can include FX data only for the base object of a data source export, not its joined objects. For example, if you want to export foreign currency conversion data for the Invoice Item object, you must perform a data source export on the Invoice Item data source.
Standard and associated special fields of the FX data objects
Zuora Object |
Related Zuora FX Object |
Amount Fields |
Associated foreign currency conversion fields on FX Data object |
---|---|---|---|
Credit Balance Adjustment FX Data |
Credit Balance Adjustment > Credit Balance Adjustment FX Data > Amount |
|
|
Credit Memo Application FX Data |
Credit Memo Application > Credit Memo Application FX Data > Amount |
|
|
Credit Memo Application Item FX Data |
Credit Memo Application Item > Credit Memo Application Item FX Data > Amount |
|
|
Credit Memo Item FX Data |
Credit Memo Item > Credit Memo Item FX Data > Amount Without Tax |
|
|
Credit Memo Part FX Data |
Credit Memo Part > Credit Memo Part FX Data > Amount |
|
|
Credit Memo Part Item FX Data |
Credit Memo Part Item > Credit Memo Part Item FX Data > Amount |
|
|
Debit Memo Item FX Data |
Debit Memo Item > Debit Memo Item FX Data > Amount Without Tax |
|
|
Invoice Adjustment FX Data |
Invoice Adjustment > Invoice Adjustment FX Data > Amount |
|
|
Invoice FX Data |
Invoice > Invoice FX Data > Amount |
|
|
Invoice Item Adjustment FX Data |
Invoice Item Adjustment > Invoice Item Adjustment FX Data > Amount |
|
|
Invoice Item FX Data |
Invoice Item > Invoice Item FX Data > Amount |
|
|
Invoice Payment FX Data |
Invoice Payment > Invoice Payment FX Data > Amount |
|
|
Payment FX Data |
Payment > Payment FX Data > Amount |
|
|
Payment Application FX Data |
Payment Application > Payment Application FX Data > Amount |
|
|
Payment Part FX Data |
Payment Part > Payment Part FX Data > Amount |
|
|
Refund FX Data |
Refund > Refund FX Data > Amount |
|
|
Refund Application FX Data |
Refund Application > Refund Application FX Data > Amount |
|
|
Refund Part FX Data |
Refund Part > Refund Part FX Data > Amount |
|
|
Refund Invoice Payment FX Data |
Refund Invoice Part > Refund Invoice Part FX Data > Amount |
|
|
Revenue Schedule Item FX Data |
Refund Schedule Item > Refund Scehdule Item FX Data > Amount |
|
|
Revenue Schedule Item Credit Memo Item FX Data |
Refund Schedule Item Credit Memo Item> Refund Scehdule Item Credit Memo Item FX Data > Amount |
|
|
Revenu Schedule Item Debit Memo Item FX Data |
Refund Schedule Item Debit Memo Item> Refund Scehdule Item Debit Memo Item FX Data > Amount |
|
|
Revenue Schedule Item Invoice Item Adjustment FX Data |
Refund Schedule Item Invoice Item Adjustment > Refund Scehdule Item Invoice Item Adjustment FX Data > Amount |
|
|
Revenue Schedule Item Invoice Item FX Data |
Refund Schedule Item Invoice Item> Refund Scehdule Item Invoice Item FX Data > Amount |
|
Convert Transaction Amounts Into Your Home Currency and Reporting Currency
You can use the Zuora UI to create data source exports that include transaction amounts converted into your home currency/reporting currency.
Prerequisites
In Finance Settings > Manage Currency Conversion, ensure that you have:
-
configured your home currency and reporting currency(if applicable).
See Configure Foreign Currency Conversion for detailed steps.
Currency Fields In FX Data
The following table describes the currency conversion fields that are automatically added to your data source export.
Field Name |
Example |
Description |
---|---|---|
<Object>.<Amount field> |
Invoice.Total Amount |
The transaction amount converted into the specified currency. Note that this field has a different name depending on the object. |
<Object>.AmountCurrencyRounding |
Invoice.AmountCurrencyRounding |
Rounding difference in the amount.
|
<Object>.Home Currency Rate |
Invoice.HomeCurrencyRate |
The exchange rate used to convert the transaction currency into the specified currency. |
<Object>.Home Currency Rate Date |
Invoice.Home Currency Rate Date |
The date used to determine the exchange rate. |
<Object>.Reporting Currency Rate |
Invoice.Reporting Currency Rate |
The exchange rate used to convert the transaction currency into the specified currency. |
<Object>.Reporting Currency Rate Date |
Invoice.Reporting Currency Rate Date |
The date used to determine the exchange rate. |
<Object>.Reporting Currency Amount Rounding |
Invoice.Reporting Currency Amount Rounding |
Rounding difference in the amount. |
<Object>.Reporting Currency Amount Without Tax Rounding |
Invoice.Reporting Currency Amount Without Tax Rounding |
Rounding difference in the amount. |
Values for the Foreign Currency Conversion Fields
The following table shows where Zuora gets the values for the transaction amount that is being converted, the exchange rate date, and the transaction currency for each transaction. Apply this logic for all the objects.
Zuora Object |
Related Zuora FX Object |
Amount |
Exchange Rate Date |
---|---|---|---|
Credit Balance Adjustment FX Data |
Credit Balance Adjustment > Credit Balance Adjustment FX Data > Home Currency Amount Credit Balance Adjustment > Credit Balance Adjustment FX Data > Home Currency Amount Rounding |
The earlier of:
|
|
The earlier of:
|
Notes
You can enable the Automatically include additional Currency Conversion information in data source exports option, along with the Fx data feature.
When you enable the Automatically include additional Currency Conversion information in data source exports along with FX Data permission, through the Zuora UI, the following message appears:
We detected that you are enabling both Currency conversion FX Data and ‘Include currency conversion information in datasource exports’ simultaneously. Please note that in the event your exchange rate provider is updated in the future, FX Rates may be inconsistent between Zuora Revenue and Zuora Billing , this would require you to revisit your API integration. For more information, please refer to Zuora Knowledge Center.”