https://github.com/gewebe/syliusvatplugin

Sylius EU-VAT number plugin, validate European VAT numbers real time with VIES, add a predefined set of standard VAT rates for EU countries.
https://github.com/gewebe/syliusvatplugin

eu-vat-number eu-vat-rates sylius

Last synced: 11 months ago
JSON representation

Sylius EU-VAT number plugin, validate European VAT numbers real time with VIES, add a predefined set of standard VAT rates for EU countries.

Host: GitHub
URL: https://github.com/gewebe/syliusvatplugin
Owner: gewebe
License: mit
Created: 2020-01-06T22:35:41.000Z (over 6 years ago)
Default Branch: 1.4
Last Pushed: 2025-04-07T21:24:39.000Z (about 1 year ago)
Last Synced: 2025-04-07T21:38:49.936Z (about 1 year ago)
Topics: eu-vat-number, eu-vat-rates, sylius
Language: PHP
Homepage:
Size: 268 KB
Stars: 5
Watchers: 2
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# Sylius VAT number and rates plugin

[![Latest Version on Packagist][ico-version]][link-packagist]

[![Software License][ico-license]](LICENSE)

[![Build][ico-build]][link-build]

[![Quality Score][ico-code-quality]][link-code-quality]

## Features

 * Installer for EU VAT rates with countries and zones

 * New fields for VAT number at `Address` and `ShopBillingData` entity

 * Configure VAT number field requirement:

    * Optional / Required

    * Required if customer filled “Company” field

    * Required in selected countries

 * Validate VAT number:

    * Format for selected country

    * Country is same as selected country

    * Validity using [VIES API](http://ec.europa.eu/taxation_customs/vies/) for EU VAT number

 * Revalidate customers VAT numbers after a given time

 * Placing an order without VAT in the EU, if

    * VAT number validation was successful

    * Customers taxation country is different from shop billing country

## Installation

### Download the plugin via composer

```bash

composer require gewebe/sylius-vat-plugin

```

### Enable the plugin in bundles.php

```php

# config/bundles.php

return [

    # ...

    

    Gewebe\SyliusVATPlugin\GewebeSyliusVATPlugin::class => ['all' => true],

];

```

### Import the plugin configurations

```yaml

# config/packages/_sylius.yaml

imports:

    # ...

       

    - { resource: '@GewebeSyliusVATPlugin/config/app/config.yml'}

```

### Configure taxation address

For EU VAT, the address for taxation should be set to the shipping address in the Sylius configuration.

```yaml

# config/packages/_sylius.yaml

sylius_core:

    shipping_address_based_taxation: true

```

### Copy templates

Copy customized templates to your templates directory (e.g `templates/bundles/`):

```bash

mkdir -p templates/bundles/SyliusAdminBundle/

cp -R vendor/gewebe/sylius-vat-plugin/templates/SyliusAdminBundle/* templates/bundles/SyliusAdminBundle/

mkdir -p templates/bundles/SyliusShopBundle/

cp -R vendor/gewebe/sylius-vat-plugin/templates/SyliusShopBundle/* templates/bundles/SyliusShopBundle/

```

### Extend `Address` entity

```php

# src/Entity/Addressing/Address.php

namespace App\Entity\Addressing;

use Doctrine\ORM\Mapping as ORM;

use Gewebe\SyliusVATPlugin\Entity\VatNumberAddressInterface;

use Gewebe\SyliusVATPlugin\Entity\VatNumberAwareTrait;

use Sylius\Component\Core\Model\Address as BaseAddress;

/**

 * @ORM\Entity

 * @ORM\Table(name="sylius_address")

 */

#[ORM\Entity]

#[ORM\Table(name: 'sylius_address')]

class Address extends BaseAddress implements VatNumberAddressInterface

{

    use VatNumberAwareTrait;

```

If you use `yaml` mapping add also:

```yaml

# config/doctrine/Address.orm.yaml

App\Entity\Addressing\Address:

    type: entity

    table: sylius_address

    fields:

        vatNumber:

            type: string

            column: vat_number

            nullable: true

        vatValid:

            type: boolean

            column: vat_valid

        vatValidatedAt:

            type: datetime

            column: vat_validated_at

            nullable: true

```

### Add or Extend `ShopBillingData` entity

```php

# src/Entity/Channel/ShopBillingData.php

namespace App\Entity\Channel;

use Doctrine\ORM\Mapping as ORM;

use Gewebe\SyliusVATPlugin\Entity\ShopBillingDataVatNumberAwareTrait;

use Gewebe\SyliusVATPlugin\Entity\ShopBillingDataVatNumberInterface;

use Sylius\Component\Core\Model\ShopBillingData as BaseShopBillingData;

/**

 * @ORM\Entity

 * @ORM\Table(name="sylius_shop_billing_data")

 */

#[ORM\Entity]

#[ORM\Table(name: 'sylius_shop_billing_data')]

class ShopBillingData extends BaseShopBillingData implements ShopBillingDataVatNumberInterface

{

    use ShopBillingDataVatNumberAwareTrait;

```

If you use `yaml` mapping add also:

```yaml

# config/doctrine/ShopBillingData.orm.yaml

App\Entity\Channel\ShopBillingData:

    type: entity

    table: sylius_shop_billing_data

    fields:

        vatNumber:

            type: string

            column: vat_number

            nullable: true

```

Override the resource for `shop_billing_data` in your sylius config:

```yaml

# config/packages/_sylius.yaml

sylius_core:

    resources:

        shop_billing_data:

            classes:

                model: App\Entity\Channel\ShopBillingData

```

### Update your database schema

```bash

bin/console doctrine:migrations:diff

bin/console doctrine:migrations:migrate

```

## Usage

### Install EU countries and VAT rates

```bash

# EU VAT on digital services (MOSS scheme)

bin/console vat:install:eu

# EU with French VAT (cross-border)

bin/console vat:install:eu FR

# EU with French VAT and passed threshold in Spain and Portugal (cross-border)

bin/console vat:install:eu FR -t ES,PT

# EU with French VAT included in price

bin/console vat:install:eu FR -i

# EU with German standard and reduced VAT categories

bin/console vat:install:eu DE -c standard,reduced

```

### Validate customers VAT number

##### 1. Create new order with VAT number at shipping address

![Screenshot checkout address with vat number](docs/images/checkout_address.png)

##### 2. Show VAT number and validation status at admin orders

![Screenshot order shipping address with vat number](docs/images/admin_order_address.png)

## Testing

Setup Traditional

```bash

$ composer install

$ cd tests/Application

$ yarn install

$ yarn build

$ bin/console assets:install public -e test

$ bin/console doctrine:schema:create -e test

$ export APP_ENV=test

$ symfony server:start --port=8080 --dir=public

```

Setup Docker

```bash

$ docker compose up -d

$ docker compose exec app make init

```

Run Tests

```bash

$ vendor/bin/behat

$ vendor/bin/phpspec run

$ vendor/bin/phpstan analyse -c phpstan.neon -l max src/

```

Coding Standard

```bash

$ vendor/bin/ecs check

```

[ico-version]: https://img.shields.io/packagist/v/gewebe/sylius-vat-plugin.svg?style=flat-square

[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square

[ico-code-quality]: https://img.shields.io/scrutinizer/g/gewebe/SyliusVATPlugin.svg?style=flat-square

[ico-build]: https://github.com/gewebe/SyliusVATPlugin/actions/workflows/build.yml/badge.svg

[link-packagist]: https://packagist.org/packages/gewebe/sylius-vat-plugin

[link-code-quality]: https://scrutinizer-ci.com/g/gewebe/SyliusVATPlugin

[link-build]: https://github.com/gewebe/SyliusVATPlugin/actions/workflows/build.yml

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/gewebe/syliusvatplugin

Awesome Lists containing this project

README