rechtlogisch / steuer-id
Validates the German Tax-ID (Steuerliche Identifikationsnummer)
Requires
- php: ^8.1
- ext-mbstring: *
Requires (Dev)
- laravel/pint: ^1.18
- pestphp/pest: ^2.36|^3.5
- pestphp/pest-plugin-type-coverage: ^2.8|^3.1
- phpstan/phpstan: ^1.12
README
steuer-id
Validates the German Tax-ID (Steuerliche Identifikationsnummer)
Based on the official ELSTER documentation (chapter: 2; as of 2025-02-24).
Note
This package validates solely the syntax and check digit of the provided input. It does not confirm, that the validated Steuer-ID was assigned to a person. Please contact the Bundeszentralamt für Steuern in case you are unsure about your Steuer-ID.
Installation
You can install the package via composer:
composer require rechtlogisch/steuer-id
Usage
isSteuerIdValid('02476291358'); // => true
or
use Rechtlogisch\SteuerId\SteuerId; (new SteuerId('02476291358')) ->validate() // ValidationResult::class ->isValid(); // => true
Test-Steuer-IDs
Support for test Steuer-IDs (starting with 0
) is enabled by default. Test Steuer-IDs are typically invalid in production. It is recommended to disable them with the following environment variable:
STEUERID_PRODUCTION=true
or in PHP:
putenv('STEUERID_PRODUCTION=true');
Validation errors
You can get a list of errors explaining why the provided input is invalid. The validate()
method returns a DTO with a getErrors()
method.
Note
The keys of getErrors()
hold the stringified reference to the exception class. You can check for a particular error by comparing to the ::class constant. For example: Rechtlogisch\UstId\Exceptions\InvalidUstIdLength::class
.
validateSteuerId('x2476291358')->getErrors(); // [ // 'Rechtlogisch\SteuerId\Exceptions\SteuerIdCanContainOnlyDigits' // => ['Only digits are allowed.'] // ]
or
use Rechtlogisch\SteuerId\SteuerId; (new SteuerId('x2476291358')) ->validate() // ValidationResult::class ->getErrors(); // [ // 'Rechtlogisch\SteuerId\Exceptions\SteuerIdCanContainOnlyDigits' // => ['Only digits are allowed.'] // ]
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
If you discover any security-related issues, please email open-source@rechtlogisch.de instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.