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 Serializers are provided.

from aeat.rest_framework import serializers as aeat_serializers

serializer = aeat_serializers.ENSPresentationSerializer(data=payload)
serializer.is_valid(raise_exception=True)
result = serializer.save()

# aeat.Result object is returned
assert result.valid
assert result.data is not None
assert result.error is None
assert result.raw_request is not None
assert result.raw_response is not None

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.0.0rc6.tar.gz (57.7 kB view details)

Uploaded Source

Built Distribution

aeat_web_services-1.0.0rc6-py2.py3-none-any.whl (14.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file aeat-web-services-1.0.0rc6.tar.gz.

File metadata

File hashes

Hashes for aeat-web-services-1.0.0rc6.tar.gz
Algorithm Hash digest
SHA256 0e134814576f29afb9e5b7848cf4b0a3e77eee9b04e412f0318b8180dae28c9d
MD5 5877a4965e7ed2112ba4d46f273e03bc
BLAKE2b-256 de29636be018be055f2551dd91c22b71ea2167d7b2a84ef063a85510cf713398

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for aeat_web_services-1.0.0rc6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 48c202184b3b6bad59eff825b0cde29c5fa3d6a085f22450cb740f792c2110b9
MD5 b2b9e135df7171b90a11d574576b5dc9
BLAKE2b-256 eaead74b0f7a8e709e69953b42fc4a274cd0e653c434db3f82618ef8994e650f

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