easybill/e-invoice-validator
A small service to validate XML against PEPPOL BIS 3.X, XRechnung 3.X, factur-x 1.0 or EN16931 rules
10K+
easybill/e-invoice-validator repository overview
e-invoice-validator
Introduction
e-invoice-validator is a small service for validating XML against the official
schematron rules of factur-x, Peppol BIS, XRechnung and EN16931. It exposes a validation endpoint which takes the
to be validated XML and returns a JSON payload which contains possible warnings or errors. The HTTP status code indicates if the
provided XML is valid (200) or has issues (400). UBL and CII is supported.
Currently supported validation artifacts:
- EN16931 v1.3.13
- XRechnung v3.2
- Peppol BIS 3.0
- factur-x v1.07.2
- (only the profiles EN16931 and EXTENDED are supported)
Usage
This service was mainly designed with containerization in mind. So general idea is to use the following docker image and make HTTP-Requests from the main application to the service for validation.
- modifying / creating docker-compose.yaml
The service exposes a health endpoint which can be used to check if the service ready to be used at /health
You can find a OpenAPI documentation after you started the service at /swagger
e-invoice-validator:
image: 'easybill/e-invoice-validator:latest'
ports:
- '8081:8080'
environment:
JAVA_TOOL_OPTIONS: -Xmx512m
healthcheck:
test: curl --fail http://localhost:8081/health || exit 0
interval: 10s
retries: 6
- starting docker compose
docker compose up --detach --wait --wait-timeout 30
- Example of using this service (PHP)
<?php
declare(strict_types=1);
final class EN16931Validator
{
public function isValid(string $xml): ?bool
{
$httpClient = new Client();
$response = $httpClient->request('POST', 'http://localhost:8081/validation', [
RequestOptions::HEADERS => [
'Content-Type' => 'application/json',
],
RequestOptions::BODY => $xml,
RequestOptions::TIMEOUT => 10,
RequestOptions::CONNECT_TIMEOUT => 10,
RequestOptions::HTTP_ERRORS => false,
]);
return 200 === $response->getStatusCode();
}
}
- Example response in case the XML is valid
{
"meta": {
"xml_syntax_type": "CII",
"xml_profile_type": "FACTURX_EXTENDED"
},
"errors": [],
"warnings": [],
"is_valid": true
}
- Example response in case the XML is invalid
{
"meta": {
"xml_syntax_type": "CII",
"xml_profile_type": "EN16931"
},
"errors": [
{
"rule_id": "BR-CO-15",
"rule_location": "/*:CrossIndustryInvoice[namespace-uri()='urn:un:unece:uncefact:data:standard:CrossIndustryInvoice:100'][1]",
"rule_severity": "FATAL",
"rule_messages": [
"[BR-CO-15]-Invoice total amount with VAT (BT-112) = Invoice total amount without VAT (BT-109) + Invoice total VAT amount (BT-110)."
]
},
{
"rule_id": "BR-CL-04",
"rule_location": "/*:CrossIndustryInvoice[namespace-uri()='urn:un:unece:uncefact:data:standard:CrossIndustryInvoice:100'][1]/*:SupplyChainTradeTransaction[namespace-uri()='urn:un:unece:uncefact:data:standard:CrossIndustryInvoice:100'][1]/*:ApplicableHeaderTradeSettlement[namespace-uri()='urn:un:unece:uncefact:data:standard:ReusableAggregateBusinessInformationEntity:100'][1]/*:InvoiceCurrencyCode[namespace-uri()='urn:un:unece:uncefact:data:standard:ReusableAggregateBusinessInformationEntity:100'][1]",
"rule_severity": "FATAL",
"rule_messages": [
"[BR-CL-04]-Invoice currency code MUST be coded using ISO code list 4217 alpha-3"
]
}
],
"warnings": [],
"is_valid": false
}
Insights
You may enable bug reporting via Bugsnag by supplying the env-variable BUGSNAG_API_KEY.
e-invoice-validator:
image: 'easybill/e-invoice-validator:latest'
ports:
- '8081:8080'
environment:
JAVA_TOOL_OPTIONS: -Xmx512m
BUGSNAG_API_KEY: <YOUR_API_KEY>
healthcheck:
test: curl --fail http://localhost:8081/health || exit 0
interval: 10s
retries: 6
Issues & Contribution
Feel free to create pull-requests or issues if you have trouble with this service or any related resources.
Roadmap
TBA
Tag summary
Content type
Image
Digest
sha256:e9e18cfd0…
Size
201.6 MB
Last updated
over 1 year ago
docker pull easybill/e-invoice-validator