REST Accounting Vat

Contains all available functionality to get or list VAT configurations of an accounting location. An accounting location can contain several VAT configurations for different countries of delivery and each VAT configuration for a country of delivery can have up to 4 VAT rates. A VAT configuration of a country must be added once the delivery threshold for deliveries from one accounting location to another country is exceeded.

List VAT configurations of an accounting location

Lists the VAT configurations for all countries of one accounting location

/rest/vat/locations/{locationId}

Parameters

Field Type Description
locationId Int The ID of the accounting location
with[] String[] The relations to load with the VAT object. The relations available are location and country.
columns[] String[] The attributes of the VAT configuration

Success 200

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

List VAT configurations for one country of delivery

Lists the VAT configurations for a country of delivery of one accounting location. The ID of the accounting location and the ID of the country of delivery must be specified.

/rest/vat/locations/{locationId}/countries/{countryId}

Parameters

Field Type Description
locationId Int The ID of the accounting location
countryId Int The ID of the country of delivery
with[] String[] The relations to load with the VAT object. The relations available are location or country.
columns[] String[] The attributes of the VAT configuration

Success 200

Field Type Description
id Int The ID of the VAT configuration. A VAT configuration includes 4 VAT rates
countryId Int The ID of the country that the VAT configuration belongs to
taxIdNumber String The tax id number of VAT configuration.
startedAt String|\Carbon The date when the VAT configuration went into effect
invalidFrom String|\Carbon The date when the VAT configuration should not be used any more
locationId Int The ID of the location
marginScheme String Specifies the tax rate that is used, when the margin scheme is applied. Available values: 'none', 'vat1', 'vat2', 'vat3', 'vat4'.
isRestrictedToDigitalItems Bool Flag that indicates if the VAT configuration is used only applied to digital goods or not. True= The VAT set is only applied to digital goods. False = The VAT set is applied to all types of goods.
isStandard Bool Flag that indicates if the VAT configuration is the standard VAT configuration for the location
createdAt String|\Carbon The date at which the VAT configuration was created.
updatedAt String|\Carbon The date that the VAT configuration was last updated.
[{"id":4,"locationId":1,"countryId":1,"marginScheme":"none","isRestrictedToDigitalItems":false,"vatRates":[{"id":0,"name":"standard taxation","vatRate":19},{"id":1,"name":"reduced taxation","vatRate":7},{"id":2,"name":"no taxation","vatRate":0},{"id":3,"name":"no taxation","vatRate":0}]},{"id":3,"locationId":1,"countryId":1,"marginScheme":"none","isRestrictedToDigitalItems":false,"vatRates":[{"id":0,"name":"standard taxation","vatRate":19},{"id":1,"name":"reduced taxation","vatRate":7},{"id":2,"name":"no taxation","vatRate":0},{"id":3,"name":"no taxation","vatRate":0}]}]

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Get a VAT configuration for a country in a location.

Gets the VAT configuration found by matching the given location, delivery country and date of validity.

/rest/vat/locations/{locationId}/countries/{countryId}/date/{date}

Parameters

Field Type Description
locationId Int The ID of the accounting location
countryId Int The ID of the country of delivery
startDate String The date of validity
with[] String[] The relations to load with the VAT object. The relations available are location or country.
columns[] String[] The attributes of the VAT configuration

Success 200

Field Type Description
id Int The ID of the VAT configuration. A VAT configuration includes 4 VAT rates
countryId Int The ID of the country that the VAT configuration belongs to
taxIdNumber String The tax id number of VAT configuration.
startedAt String|\Carbon The date when the VAT configuration went into effect
invalidFrom String|\Carbon The date when the VAT configuration should not be used any more
locationId Int The ID of the location
marginScheme String Specifies the tax rate that is used, when the margin scheme is applied. Available values: 'none', 'vat1', 'vat2', 'vat3', 'vat4'.
isRestrictedToDigitalItems Bool Flag that indicates if the VAT configuration is used only applied to digital goods or not. True= The VAT set is only applied to digital goods. False = The VAT set is applied to all types of goods.
isStandard Bool Flag that indicates if the VAT configuration is the standard VAT configuration for the location
createdAt String|\Carbon The date at which the VAT configuration was created.
updatedAt String|\Carbon The date that the VAT configuration was last updated.

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

List VAT configurations.

Lists the VAT configurations for the given filter. Possible filters are locationId, countryId, taxIdNumber and startedAt.

/rest/vat

Parameters

Field Type Description
page Int The requested page.
itemsPerPage Int The number of items per page.
with String[] The relations to load with the VAT object. The relations available are location or country.
columns String[] The properties to be loaded.

Success 200

Field Type Description
page Int Current page of the response
totalsCount Int The total number of entries in the response
isLastPage Bool Flag that indicates if the page shown is the last page of the response
lastPageNumber Int The last page number
firstOnPage Int The index of the first item of the current page result
lastOnPage Int The index of the last item of the current page result
itemsPerPage Int The requested amount of items per result page
entries Vat[] List of Vat
 id Int The ID of the VAT configuration. A VAT configuration includes 4 VAT rates
 countryId Int The ID of the country that the VAT configuration belongs to
 taxIdNumber String The tax id number of VAT configuration.
 startedAt String|\Carbon The date when the VAT configuration went into effect
 invalidFrom String|\Carbon The date when the VAT configuration should not be used any more
 locationId Int The ID of the location
 marginScheme String Specifies the tax rate that is used, when the margin scheme is applied. Available values: 'none', 'vat1', 'vat2', 'vat3', 'vat4'.
 isRestrictedToDigitalItems Bool Flag that indicates if the VAT configuration is used only applied to digital goods or not. True= The VAT set is only applied to digital goods. False = The VAT set is applied to all types of goods.
 isStandard Bool Flag that indicates if the VAT configuration is the standard VAT configuration for the location
 createdAt String|\Carbon The date at which the VAT configuration was created.
 updatedAt String|\Carbon The date that the VAT configuration was last updated.

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Get a VAT configuration for the standard accounting location of a client

Gets the VAT configuration currently used for the country of the standard accounting location of a client (store). The ID of the client (store) must be specified.

/rest/vat/standard

Parameters

Field Type Description
plentyId Int The plenty ID of the client (store)
startedAt String The date in the W3C format when the vat configuration went into effect

Success 200

Field Type Description
id Int The ID of the VAT configuration. A VAT configuration includes 4 VAT rates
countryId Int The ID of the country that the VAT configuration belongs to
taxIdNumber String The tax id number of VAT configuration.
startedAt String|\Carbon The date when the VAT configuration went into effect
invalidFrom String|\Carbon The date when the VAT configuration should not be used any more
locationId Int The ID of the location
marginScheme String Specifies the tax rate that is used, when the margin scheme is applied. Available values: 'none', 'vat1', 'vat2', 'vat3', 'vat4'.
isRestrictedToDigitalItems Bool Flag that indicates if the VAT configuration is used only applied to digital goods or not. True= The VAT set is only applied to digital goods. False = The VAT set is applied to all types of goods.
isStandard Bool Flag that indicates if the VAT configuration is the standard VAT configuration for the location
createdAt String|\Carbon The date at which the VAT configuration was created.
updatedAt String|\Carbon The date that the VAT configuration was last updated.

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Get a VAT configuration by id

/rest/vat/{vatId}

Success 200

Field Type Description
id Int The ID of the VAT configuration. A VAT configuration includes 4 VAT rates
countryId Int The ID of the country that the VAT configuration belongs to
taxIdNumber String The tax id number of VAT configuration.
startedAt String|\Carbon The date when the VAT configuration went into effect
invalidFrom String|\Carbon The date when the VAT configuration should not be used any more
locationId Int The ID of the location
marginScheme String Specifies the tax rate that is used, when the margin scheme is applied. Available values: 'none', 'vat1', 'vat2', 'vat3', 'vat4'.
isRestrictedToDigitalItems Bool Flag that indicates if the VAT configuration is used only applied to digital goods or not. True= The VAT set is only applied to digital goods. False = The VAT set is applied to all types of goods.
isStandard Bool Flag that indicates if the VAT configuration is the standard VAT configuration for the location
createdAt String|\Carbon The date at which the VAT configuration was created.
updatedAt String|\Carbon The date that the VAT configuration was last updated.

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Create a VAT configuration

/rest/vat

Request

Field Type Description
countryId Int The ID of the country that the VAT configuration belongs to required
locationId Int The ID of the location required
taxIdNumber String The tax id number of VAT configuration.
startedAt String|\Carbon The date when the VAT configuration went into effect required
invalidFrom String|\Carbon The date when the VAT configuration should not be used any more
isRestrictedToDigitalItems Bool Flag that indicates if the VAT configuration is used only applied to digital goods or not. True= The VAT set is only applied to digital goods. False = The VAT set is applied to all types of goods.
marginScheme String Specifies the tax rate that is used, when the margin scheme is applied. Available values: 'none', 'vat1', 'vat2', 'vat3', 'vat4'. allowed values are none, vat0, vat1, vat2, vat3
vatRates \VatRate[] The VAT rates of a VAT configuration required array
 id Int The ID of the VAT rate required allowed values are 0, 1, 2, 3
 name String The name of a VAT rate
 vatRate Float The percentage of the VAT rate, e.g. 19.00 for 19 % required
null

Success 200

Field Type Description
id Int The ID of the VAT configuration. A VAT configuration includes 4 VAT rates
countryId Int The ID of the country that the VAT configuration belongs to
taxIdNumber String The tax id number of VAT configuration.
startedAt String|\Carbon The date when the VAT configuration went into effect
invalidFrom String|\Carbon The date when the VAT configuration should not be used any more
locationId Int The ID of the location
marginScheme String Specifies the tax rate that is used, when the margin scheme is applied. Available values: 'none', 'vat1', 'vat2', 'vat3', 'vat4'.
isRestrictedToDigitalItems Bool Flag that indicates if the VAT configuration is used only applied to digital goods or not. True= The VAT set is only applied to digital goods. False = The VAT set is applied to all types of goods.
isStandard Bool Flag that indicates if the VAT configuration is the standard VAT configuration for the location
createdAt String|\Carbon The date at which the VAT configuration was created.
updatedAt String|\Carbon The date that the VAT configuration was last updated.

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Update a VAT configuration

/rest/vat/{vatId}

Request

Field Type Description
countryId Int The ID of the country that the VAT configuration belongs to
locationId Int The ID of the location
taxIdNumber String The tax id number of VAT configuration.
startedAt String|\Carbon The date when the VAT configuration went into effect
invalidFrom String|\Carbon The date when the VAT configuration should not be used any more
isRestrictedToDigitalItems Bool Flag that indicates if the VAT configuration is used only applied to digital goods or not. True= The VAT set is only applied to digital goods. False = The VAT set is applied to all types of goods.
marginScheme String Specifies the tax rate that is used, when the margin scheme is applied. Available values: 'none', 'vat1', 'vat2', 'vat3', 'vat4'. allowed values are none, vat0, vat1, vat2, vat3
vatRates \VatRate[] The VAT rates of a VAT configuration optional array
 id Int The ID of the VAT rate required allowed values are 0, 1, 2, 3
 name String The name of a VAT rate
 vatRate Float The percentage of the VAT rate, e.g. 19.00 for 19 %
null

Success 200

Field Type Description
id Int The ID of the VAT configuration. A VAT configuration includes 4 VAT rates
countryId Int The ID of the country that the VAT configuration belongs to
taxIdNumber String The tax id number of VAT configuration.
startedAt String|\Carbon The date when the VAT configuration went into effect
invalidFrom String|\Carbon The date when the VAT configuration should not be used any more
locationId Int The ID of the location
marginScheme String Specifies the tax rate that is used, when the margin scheme is applied. Available values: 'none', 'vat1', 'vat2', 'vat3', 'vat4'.
isRestrictedToDigitalItems Bool Flag that indicates if the VAT configuration is used only applied to digital goods or not. True= The VAT set is only applied to digital goods. False = The VAT set is applied to all types of goods.
isStandard Bool Flag that indicates if the VAT configuration is the standard VAT configuration for the location
createdAt String|\Carbon The date at which the VAT configuration was created.
updatedAt String|\Carbon The date that the VAT configuration was last updated.

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Is this article helpful?

 

Thank you for your Feedback

you can close this field now!