The FxCustomRate object is used in HTML templates to apply custom exchange rates for invoices, credit memos, and debit memos, available when the Custom Exchange Rates Finance feature is enabled.

1. Navigate to Settings > Billing > Manage Billing Document Configuration.
2. Click Add New HTML Template or select an existing one.
3. On the bottom left corner of the screen, select the Show Object Schema icon . This object includes all the exchange rates. You can either upload exchange rates via a file or utilize a third-party custom exchange rate provider.
4. Search for the FxCustomRate object. The fields in the FxCustomRate object are explained in the table. .
5. Click Copy .
6. In the Content tab, drag and drop the HTML component into the HTML template.
7. In the HTML template, click the HTML block. The Content panel is displayed on the right of the template editor.
8. In the HTML section, enter the following HTML code in the HTML editor:

   {{#Invoice}}
       <br> Converted Amount to EUR:
       {{#FxCustomRates|FilterByRef(CurrencyTo,EQ,Invoice.Currency)|FilterByValue(CurrencyFrom,EQ,'EUR')|SortBy(RateDate,DESC)|First(1)}}
         {{Cmd_Assign(EurConversionRate,Rate,True)}}
        <br>
          "Rate:RateDate:RateSetName" 
        <br>
         {{Rate}}:{{RateDate}}:{{RateSetName}}
       {{/FxCustomRates|FilterByRef(CurrencyTo,EQ,Invoice.Currency)|FilterByValue(CurrencyFrom,EQ,'EUR')|SortBy(RateDate,DESC)|First(1)}}
       <br>
       Original Amount: {{Amount|Round(2)|Localise}} {{Invoice.Currency}}
       <br>
       Converted Amount:
   {{#Wp_Eval}}
         {{Amount}} * {{EurConversionRate}} |Round(2)|Localise
       {{/Wp_Eval}} EUR
     {{/Invoice}}

   This code filters the foreign exchange (FX) rate for converting from EUR to the invoice currency, for example, USD, sorts the results by RateDate in descending order to retrieve the most recent rate, and assigns that rate to a temporary variable called EurConversionRate using Cmd_Assign. It then displays the rate details, including the rate value, its date, and the rate set name, followed by the original invoice amount in its billing currency. Finally, it calculates and displays the converted amount by multiplying the original amount by the retrieved FX rate.

   Also, if you're generating an invoice and want to display a custom FX rate for a given CurrencyFrom and RateDate, you can filter it dynamically using invoice fields, like Invoice.Currency and Invoice.InvoiceDate.

   • Retrieve rate based on invoice date:

     {{#FXCustomRates|FilterByRef(CurrencyTo,EQ,Invoice.Currency)|FilterByValue(CurrencyFrom,EQ,GBP)|FilterByValue(RateDate,EQ,Invoice.InvoiceDate)|First(1)}}

   • Retrieve the latest:

     Rate:{{#FxCustomRates|FilterByRef(CurrencyTo,EQ,Invoice.Currency)|FilterByValue(CurrencyFrom,EQ,'EUR')|SortBy(RateDate,DESC)|First(1)}}

9. Click Preview , and select an account and an invoice in the Preview Settings section to preview the corresponding PDF file. If a PDF file has multiple pages due to the conditional page breaks, you can see it in the invoice PDF file displayed.