Skip to content
pCon.configurator onlineDocumentation
Esc
↑↓navigate↵open⌘Jpreview
On this page

getTaxScheme

Synopsis

TaxScheme getTaxScheme(SessionId sessionId,
    boolean active,
    string schemeId)
throws BasketServiceFault;

See also: TaxScheme, SessionId, BasketServiceFault

getTaxScheme returns detailed information about the tax scheme specified by the schemeId parameter.

In addition to the short information returned by listTaxSchemes, this operation returns the currency required by the tax scheme (or an empty string if the tax scheme does not require a particular currency), the tax types (like VAT), and, for each type, the tax categories (like standard_rate in case of VAT) and the tax rate.

The value of attribute rateUnit of complex type taxType is either % in case of relative taxes, or <cy>/<uom>, where <cy> is a currency code and <uom> is an UNECE unit of measure. With the current implementation of pricing procedures, both weight and volume units are meaningful.

The parameter active is used to select between the default set of tax schemes (false), as available after a new project has been created, or the set of tax schemes available in the current project true. The latter set consists of the first one plus the tax scheme loaded as part of the project file. If the default set of tax schemes contains a scheme with the same identifier as the project tax scheme, this scheme is hidden by the project tax scheme.