Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GlobalBlueGetEligibilityInformation

Fetch the eligibility information for the current order.

When no BillingAddress is available on the Order, the country of residence has to be provided in the CountryCode field.

If the response TaxFreeAvailble is true, the user can proceed with calling the GlobalBlueStartTaxFree service.

If the response is false, tax free is not available. This can be due to several reasons:

  • CountryEligibility == false: the selected CountryOfResidence is not eligible for TaxFree
  • Amounts.AmountBelowMinimum: the total amount of the order is not enough to qualify for tax free, it should be at least Amounts.MinAmount
  • Amounts.AmountOverMaximum: the total amount of the order is to much to qualify for tax free, it should be lower than Amounts.MaxAmount

Hierarchy

  • GlobalBlueGetEligibilityInformation

Index

Properties

Properties

Optional CountryCode

CountryCode: undefined | string

Country of residence of the customer, overrides billingaddress CountryID Entity type: Country

Optional OrderID

OrderID: undefined | number

Entity type: Order