Detailed Settlement Report

The Detailed Settlement report offers an in-depth overview of settlements.

To access it, open the Dashboard and click the country you wan to report on and click the Detailed settlement report tab.

After you have chosen you filters, click Schedule report to run it:

Detailed Settlement report

Detailed Settlement report

Filters

The following filters are available. Mandatory filters are denoted by an asterisk:

FilterDescription
Report Period Length*Set the filter for the length of the time period that is reported on.
Report Period*Set the filter for a specific period.
Product Classes*Filter for a specific product class, such as digital or physical.
FX Date TypeThis filters for a specific date type. This can be either Order date, Day before order date or Last from the selected range.
FX Refund Date TypeThis filters for a specific date type for refunds. This can be either Order date, Day before order date or Last from the selected range.
Apply rounding to fx converted amounts?If selected this checkbox means that amounts that are subject to currency conversion will be rounded to 2 decimal places.
Apply Refund ToFilter for refunds by the transaction's order date or the refund date.
Report TypeThis is always Default.
Informative LinesBy default, no informative lines are included. You can choose to include them or you can include only informative transactions, excluding the non-informative.
Tax NameThis is a free text filter that allows you to filter for a specified tax by name.
Send report to user mailSelect this checkbox to send the report to your user's email.

Country Specific Filters

The following table lists some country specific filters:

FilterDescription
StatesFilter for specific States in the United States of America (USA).

Output Fields

The following are the fields that can be found in the Detailed settlement report.

Report Field NameDetailsDescription
Transaction typen/a. This is generated by the service and returned in the response so it is not transformed.This is the type of transaction a sale or a refund.
Exchange rate

API Field: additional_currencies.invoice.fx_rate

API Data Type: float

Report Date Type: String

The exchange rate that was used in the transaction, if any.
Exchange rate date

API Field: additional_currencies.invoice.fx_date

API Data Type: String

Report Date Type: String

The date on which the used exchange rate was retrieved.
F/X source

API Field: fx_source

API Data Type: String

Report Date Type: String

The source, such as the ECB, that provided the exchange rate.
Currency code

API Field:transaction.currency_code

API Data Type: String

Report Date Type: String

The currency used for the transaction.
Target currency code

API Field:additional_currencies.invoice.currency_code

API Data Type: String

Report Date Type: String

The currency used by this report.
Key

API Field:transaction.key

API Data Type: String

Report Date Type: String

Unique transaction key generated by the service initially and use to identify the transaction later.
Country code

API Field:transaction.tax_country_code

API Data Type: String

Report Date Type: String

Country code of the country where liability resides.
Tax country name

API Field:transaction.country_name

API Data Type: String

Report Date Type: String

Full name of the country where liability resides.
Tax deducted

API Field:transaction.tax_deducted

API Data Type: Boolean

Report Date Type: Boolean

Indicates whether tax was deducted.
Amount

API Field:transaction.amount

API Data Type: Float

Report Date Type: String

This the tax exclusive amount.
FX converted amountn/a. This field is calculated when the report is run so it is not transformed.The tax exclusive amount in the report currency.
Tax amount

API Field:transaction.transaction_lines.tax_amount

API Data Type: Float

Report Date Type: String

The amount of tax applied to a transaction line.
FX converted tax amountn/a. This field is calculated when the report is run so it is not transformed.Tax amount of the transaction in the tax reporting currency.
Tax rate

API Field:transaction.transaction_lines.tax_rate

API Data Type: Float

Report Date Type: String

Tax rate that was used for the transaction.
Total amount

API Field:transaction.total_amount

API Data Type: Float

Report Date Type: String

Amount plus the tax amount equals to the total amount.
FX converted total amount

API Field:additional_currencies.invoice.tax_amount

API Data Type: Float

Report Date Type: String

Amount plus the tax amount equals to the total amount in the tax reporting currency.
Product type

API Field:transaction.transaction_line.product_type

API Data Type: String

Report Date Type: String

The service's reference for the type of good that is being sold.
Custom id

API Field:transaction.transaction_line.custom_id

API Data Type: String

Report Date Type: String

This is an unique ID that you can include in the transaction line.
Order date

API Field:transaction.order_date

API Data Type: String

Report Date Type: String

This is the date that the transaction was confirmed. This is the date used for the report period that you choose in the filter.
Refund date

API Field:refunds.refund_timestamp

API Data Type: String

Report Date Type: String

The date the refund was issued.
Invoice number

API Field:transaction.invoice_number

API Data Type: String

Report Date Type: String

Number of the invoice for the sale.
Postal code

API Field:transaction.invoice_address.postal_code

API Data Type: String

Report Date Type: String

The postal or ZIP code of the customer.
Region

API Field:transaction.invoice_address.region

API Data Type: String

Report Date Type: String

The region or state of the customer.
Sub account id

API Field:transaction.merchant_id

API Data Type: Integer

Report Date Type: Integer

For Taxamo Assure users, this is a unique ID referring to your business.
External unique id

API Field:transaction.external_unique_id

API Data Type: String

Report Date Type: String

A unique ID reference to your business.
Product class

API Field:transaction.transaction_line.product_classes

API Data Type: String

Report Date Type: String

This is the type of product that you are selling either digital or physical.
Line Invoice number

API Field:transaction.transaction_line.transaction_id

API Data Type: Integer

Report Date Type: Integer

Invoice line item, this is in the case where you could be selling 2 different products and they could have different tax rates/treatment and Vertex could issue multi-invoices.
Line Tax Country namen/a. This field is present if 2 countries are liable for the tax in the transaction. In such a case, this field contains the information about the second country.Tax country for the line item, this is in the case where you could be selling 2 different products and they could have different tax rates/treatment.

US Fields

The following fields are provided for the USA:

FieldAPI FieldDescription
Tax component tax name

API Field:transaction.transaction_line.tax_name

API Data Type: String

Report Date Type: String

Type of sales tax, it can be STATE SALES TAX, COUNTY SALES TAX, DISTRICT TAX, CITY SALES TAX ,SPECIAL LOCAL - CAPITAL PROJECTS or SPECIAL LOCAL - EDUCATION CAPITAL IMPROVEMENT.
Tax component tax amount

API Field:transaction.transaction_line.tax_amount

API Data Type: String

Report Date Type: String

Amount of sales tax on the transaction.
Tax component tax rate

API Field:transaction.transaction_line.tax_rate

API Data Type: String

Report Date Type: String

The rate of sales tax.
Tax component jurisdiction coden/a. This field is generated by the Tax Engine so is not transformed.Code of the taxing jurisdiction.
Tax component tax authority IDn/a. This field is generated by the Tax Engine so is not transformed.Tax authority ID.
Tax component tax authority namen/a. This field is generated by the Tax Engine so is not transformed.Tax authority name.
Product code

API Field:transaction.transaction_line.product_code

API Data Type: String

Report Date Type: String

The reference code used to identify products for US-based transactions.

API Integration

The following requests are provided so you can use the API to retrieve the results if you prefer: