Skip to main content

VAT Groups

EntityDatastoreDatastore.VatGroup

VAT groups define the tax rates applied to products and product lines. Each VAT group has a percentage and can be linked to a country.

Use the Datastore_VatGroup endpoint to query available VAT groups.

Endpoints

List VAT Groups

GET/v1/odata/Datastore_VatGroup

Single VAT Group

GET/v1/odata/Datastore_VatGroup({id})

Fields

Datastore Fields (inherited)

FieldTypeDescription
NameStringDisplay name (e.g., "NL - 21%")
CodeStringUnique code identifier
LocalizedNameStringLocalized display name
IsDefaultBooleanWhether this is the default VAT group

VAT Group Fields

FieldTypeDescription
PercentageDoubleVAT percentage (e.g., 21.0)

Relationships

RelationshipTarget EntityCardinalityDescription
CountryDatastore_CountryN:1Country this VAT group applies to
ProductProduct1:NProducts using this VAT group
ProductLineProductLine1:NProduct lines using this VAT group

Expanding Relationships

GET/v1/odata/Datastore_VatGroup({id})?$expand=Country
GET/v1/odata/Datastore_VatGroup({id})/Country

Filtering Examples

GET/v1/odata/Datastore_VatGroup?$filter=Name eq '{Name}'&$top={top}
GET/v1/odata/Datastore_VatGroup?$filter=Percentage eq {Percentage}&$top={top}
GET/v1/odata/Datastore_VatGroup?$filter=Percentage eq {Percentage}&$top={top}
GET/v1/odata/Datastore_VatGroup?$filter=IsDefault eq {IsDefault}&$top={top}
GET/v1/odata/Datastore_VatGroup?$filter=contains(Name, '{Name}')&$top={top}