Skip to main content

Spanish Tax Agency Electronic Office (AEAT) Integration

Project description

Master

https://travis-ci.org/initios/aeat-web-services.svg?branch=master https://coveralls.io/repos/github/initios/aeat-web-services/badge.svg?branch=master

Spanish Tax Agency Electronic Office (AEAT) Integration.

Make requests AEAT Web Services and sign your connection and xml using your certificate.


Integración con la Agencia Estatal de Administración Tributaria Española

Realiza peticiones a los Servicios Web de AEAT y firma tu conexión y mensajes XML utilizando tu certificado.

Usage (English)

Example for requesting a list of ENS’s.

Initialize a Config object with the desired preconfigured service and if you want to request AEAT test or production endpoints (test_mode). Finally initialize controller with the config and the desired certificate and make the request with your payload.

If you need more control just build the controller by hand, see build_from_config method for inspiration.

import aeat

config = aeat.Config('ens_query', test_mode=True)
ctrl = aeat.Controller.build_from_config(config, 'cert.pem', 'key.pem')
payload = {'TraModAtBorHEA76': '1', 'ExpDatOfArr': '20110809',  'ConRefNum': '9294408'}
result = ctrl.request(payload)

assert result.valid, f'Error requesting aeat: {result.error}'
assert result.data is not None

Usage (Spanish)

Ejemplo de consulta de ENSs.

Inicializa el objecto Config con el servicio preconfigurado y si quieres usar los endpoints de AEAT de test o de producción (test_mode). Por último inicializa el controlador con la config y el certificado que gustes y realiza la petición pasándole los datos que necesites.

Si necesitas un mayor control simplemente construye el controlador a mano, puedes inspirarte en el método build_from_config.

import aeat

config = aeat.Config('ens_query', test_mode=True)
ctrl = aeat.Controller.build_from_config(config, 'cert.pem', 'key.pem')
payload = {'TraModAtBorHEA76': '1', 'ExpDatOfArr': '20110809',  'ConRefNum': '9294408'}
result = ctrl.request(payload)

assert result.valid, f'Error requesting aeat: {result.error}'
assert result.data is not None

Django Rest Framework

Several AEAT Validators and Serializers are provided.

  • Validators: Validate input data to send to AEAT

  • Serializers: Serialize AEAT request

from aeat.rest_framework import validators

validator = validators.ENSPresentationValidator(data=payload)
assert validator.is_valid(raise_exception=True)

# Send the request to AEAT
import aeat

config = aeat.Config(service_name, test_mode=settings.AEAT_TEST_MODE)
ctrl = aeat.Controller.build_from_config(config, cert_path, key_path)
result = ctrl.request(validator.data)
assert result.valid

# Parse the response
from aeat.rest_framework import serializers

serializer = serializers.get_class_for_aeat_response(data=result.data)
assert serializer.is_valid(raise_exception=False)
assert {'mrn': 'XXXX'} == serializer.data
assert not serializer.is_error

Prerequisites

Install xmlsec prerequisites. Check https://github.com/mehcode/python-xmlsec

Install

$ pip install aeat-web-services

Develop

$ python setup.py develop
$ pip install -r requirements_test.txt

Test

$ pip install tox
$ tox

Releases

https://github.com/initios/aeat-web-services/releases

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aeat-web-services-1.1.1.tar.gz (69.2 kB view details)

Uploaded Source

Built Distribution

aeat_web_services-1.1.1-py2.py3-none-any.whl (17.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file aeat-web-services-1.1.1.tar.gz.

File metadata

File hashes

Hashes for aeat-web-services-1.1.1.tar.gz
Algorithm Hash digest
SHA256 3c84926e9a41d8e70c0ac83ee9fb58db432a4bb4d15dc4fdea95453bb14947a7
MD5 5e740c4c79948e8e9e9142f2a64e4cd3
BLAKE2b-256 db117620c53775660af8085adccfc2b971e298dc5a7a5637c740377158e774db

See more details on using hashes here.

Provenance

File details

Details for the file aeat_web_services-1.1.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for aeat_web_services-1.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 85e541920a52bec71d3c8a6976003bd7a6106bfd25ae043129317f92197e62a8
MD5 970ca31e49225e6dbb02a3d7c29d3c38
BLAKE2b-256 1eeca6e7e0c49b1860346368ee03dc4cb41ba51beeb68eab55d3372e6d8fa415

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page