As part of the Canadian implementation, information on taxes and tax amounts can be transmitted to the RetailForce system in various ways.

• Information within each position
• Information in a tax position

Information within each position

This is the standard procedure, which applies to all countries.

Values are transmitted for the properties

• "VatIdentification",
• "VatPercent" + "VatPercent2", and
• "TaxValue" + "TaxValue2"

are transmitted for each line item.

Automatic calculation of values

As in other countries, the function for automatically calculating individual values ("AutomaticVatCalculation") can also be used in Canada.

Calculation of gross amount

For Canada, we recommend using “GrossValueCalculation” for this purpose, i.e. the automatic calculation of the following values:

• "GrossValue" (amount including tax)
• "TaxValue" + "TaxValue2"

based on the net amount (amount excluding tax).

To use this function, the "AutomaticVatCalculation" property must be set to "GrossValueCalculation".

For each individual line item, only the net amount and the applicable tax rates ("VatIdentification", "VatPercent", "VatPercent2") need to be specified:

...
	"AutomaticVatCalculation": "GrossValueCalculation",
	"Positions": [
		{
			...
			"VatIdentification": 1,
			"VatPercent": 5,
			"VatPercent2": 9.975,
			"NetValue": 100.00,
			...
		}
	]

Calculating the net amount

If you wish to have the net amount calculated based on the gross amount, use "NetValueCalculation".

In this case, you must specify the "GrossValue" properties in each line item instead of "NetValue". The net amount and the tax amounts are automatically calculated from the gross amount.

Information in a tax position

As an alternative to specifying amounts and tax rates within all line items, tax positions – "TaxPositions" – can also be passed in the payload with the corresponding document totals.

In "TaxPositions", the individual tax amounts for the entire document are totalled.

In Canada, "TaxPositions" objects can be specified in this way for the two standard tax rates as well as zero tax.

Example:

"taxPositions": [
	{
		"vatIdentification": 1,
		"vatLabel": "GST and PST rates province Quebec",
		"vatPercent1": 5,
		"vatPercent2": 9.975,
		"vatAmount": 0.44,
		"vatAmount2": 0.87,
		"netAmount": 8.70,
		"grossAmount": 10.01
	},
	{
		"vatIdentification": 4,
		"vatLabel": "No Tax/other Tax 0%",
		"vatPercent1": 0,
		"vatPercent2": 0,
		"vatAmount": 0.0,
		"vatAmount2": 0.0,
		"netAmount": 10.00,
		"grossAmount": 10.00
	}
],

To use this function, specify

• either the net amount ("NetValue") or the gross amount ("GrossValue") for each line item, and
• "GrossValueCalculation" or "NetValueCalculation" respectively as the value for the "AutomaticVatCalculation" property.