Ir al contenido

Overview

fiskaly Logo
API docs by Redocly

fiskaly SIGN ES (1.23.0)

Download OpenAPI specification:

Contacto: info@fiskaly.com URL: https://fiskaly.com

Información Legal: fiskaly.com/impressum
Política de Privacidad: fiskaly.com/datenschutz
Solución: fiskaly.com/signes
Guía para Desarrolladores: developer.fiskaly.com/es/sign-es

Introducción

SIGN ES, la solución de fiskaly, ofrece una RESTful API que asegura el cumplimiento con las normativas fiscales españolas como TicketBAI y Verifactu.

SIGN ES proporciona un entorno de prueba para fines de integración y pruebas, así como un entorno de producción dedicado para realizar el envío de transacciones oficiales (facturas). Para acceder al entorno de producción, contacta con nuestro equipo de ventas.

SIGN ES es una solución independiente de plataforma y puramente software. Dado que esta es una API basada en la nube, lo único que necesitas para integrar SIGN ES es una conexión estable a internet. La API ...

  • tiene URLs orientadas a recursos,
  • acepta cuerpos de solicitud codificados en JSON,
  • devuelve respuestas codificadas en JSON,
  • usa verbos y códigos de estado HTTP estándar, y
  • está diseñada para ser fácilmente integrada en cualquier sistema.

Con la información de cumplimiento proporcionada en los datos de respuesta de la API Facturas SIGN ES, el proceso de cumplimiento fiscal se puede completar utilizando nuestra API Ticket Digital, ecológica y ganadora de varios premios, que permite la creación de un recibo en formato electrónico.

La API Ticket Digital facilita la emisión de recibos para todas las soluciones de fiskaly SIGN. Un ejemplo de integración y el resultado de un ticket para SIGN ES se muestra en la siguiente imagen. Para obtener más información sobre la API Ticket Digital, ponte en contacto con nuestro equipo de ventas.

Sobre TicketBAI y Verifactu

SIGN ES implementa los requisitos legales y las directrices técnicas para cumplir con la fiscalización de los softwares TPV en España.

La API SIGN ES de fiskaly cumple con los requisitos técnicos de las normativas fiscales en España: TicketBAI en la Región del País Vasco, y la Ley Antifraude y regulación Verifactu para el resto de España.

  • Verifactu en España:

    Real Decreto 1007/2023, de 5 de diciembre, por el que se aprueba el reglamento que establece los requisitos que deben adoptar los sistemas y programas informáticos o electrónicos con capacidad de facturación de empresarios y profesionales, así como la estandarización de los formatos de los registros de facturación

    Orden Ministerial HAC/1177/2024, de 17 de octubre, publicada el 28 de octubre, por la que se establecen las especificaciones técnicas, funcionales y de contenido para los Sistemas Informáticos de Facturación.


  • TicketBAI en Álava:

    Decreto Foral 48/2021, del Consejo del Gobierno Foral de 5 de octubre. Aprobar el Reglamento por el que se desarrolla la obligación TicketBAI.

    Orden Foral 802/2021, de la Primera Teniente de Diputado General y Diputada Foral de Hacienda,Finanzas y Presupuestos, de 27 de diciembre. Regulación de las especificaciones técnicas y funcionales del software TicketBAI y de la declaración de alta en el Registro de Software TicketBAI.


  • TicketBAI en Vizcaya:

    Norma Foral 5/2020, de 15 de julio, por la que se establece un sistema integral de control de los rendimientos de las actividades económicas, así como medidas para facilitar el cumplimiento de las obligaciones tributarias, mediante la modificación de la Norma Foral del Impuesto sobre Sociedades, la Norma Foral del Impuesto sobre la Renta de no Residentes, la Norma Foral del Impuesto sobre la Renta de las Personas Físicas, la Norma Foral del Impuesto sobre Patrimonio y la Norma Foral General Tributaria del Territorio Histórico de Bizkaia.

    Orden Foral 1482/2020, de 9 de septiembre, del diputado foral de Hacienda y Finanzas, por la que se regulan las especificaciones normativas y técnicas del software garante y la declaración de alta en el registro de software garante.


  • TicketBAI en Guipúzcoa:

    Decreto Foral 32/2020, de 22 de diciembre, por el que se aprueba el Reglamento por el que se desarrolla la obligación TicketBAI.

    Orden Foral 521/2020, de 23 de diciembre, por la que se regulan las especificaciones técnicas y funcionales del software TicketBAI y la declaración de alta en el Registro de Software TicketBAI.

Territorios

España tiene un sistema fiscal complejo que consta de dos regímenes fiscales diferentes: el ordinario y el foral. Las regiones que pertenecen al régimen foral (País Vasco y Navarra) tienen derecho a desarrollar y aplicar su propia normativa fiscal. Algunos territorios como Canarias, Ceuta y Melilla, siguen un régimen fiscal especial, distinto del resto de la península.

SIGN ES de fiskaly tiene en cuenta los requisitos particulares de los diferentes territorios españoles, anticipándose a posibles cambios entre las diferentes provincias de España, como el envío de registros de facturación a diferentes autoridades tributarias o el envío de información específica en cada provincia. Es por ello que la API SIGN ES se divide acorde a los siguientes territorios:

  • Álava: indica que el contribuyente tiene domicilio fiscal en Álava en el País Vasco, debiendo cumplir los requisitos específicos de TicketBAI para esta provincia.

  • Vizcaya: indica que el contribuyente tiene domicilio fiscal en Vizcaya, en el País Vasco, y debe cumplir los requisitos específicos de TicketBAI y BATUZ para esta provincia.

  • Guipúzcoa: indica que el contribuyente tiene domicilio fiscal en Guipúzcoa, en el País Vasco, y debe cumplir los requisitos específicos de TicketBAI para esta provincia.

  • Navarra: indica que el contribuyente tiene domicilio fiscal en la Comunidad Foral de Navarra y debe cumplir los requisitos específicos de esta provincia.

  • Otros Territorios de España: indica que el contribuyente tiene domicilio fiscal en cualquier otra comunidad autónoma de España y debe cumplir los requisitos específicos de la legislación Verifactu. Se consideran las siguientes provincias: Andalucía, Aragón, Principado de Asturias, Cantabria, Castilla-La Mancha, Castilla y León, Cataluña, Extremadura, Galicia, Baleares, La Rioja, Comunidad de Madrid, Región de Murcia y Comunidad Valenciana.

  • Islas Canarias: indica que el contribuyente tiene domicilio fiscal en las Islas Canarias y debe cumplir los requisitos específicos de esta provincia.

  • Ceuta: indica que el contribuyente tiene domicilio fiscal en la ciudad autónoma de Ceuta y debe cumplir los requisitos legales específicos.

  • Melilla: indica que el contribuyente tiene su domicilio fiscal en la ciudad autónoma de Melilla y debe cumplir los requisitos legales específicos.

Solución

El solución fiskaly SIGN ES proporciona una implementación 100% conforme con TicketBAI y Verifactu, generando firmas digitales para cada operación de facturación. SIGN ES ya es un software garante TicketBAI registrado en las provincias vascas.

Todos los servicios relacionados con SIGN ES son operados por fiskaly a través de la plataforma Google Cloud Platform en el centro de datos situado en Madrid (europe-southwest1).

Guías

Si es la primera vez que implementas una de las soluciones SIGN de fiskaly, te recomendamos que primero eches un vistazo a nuestra guía para nuevos clientes donde encontrarás una explicación de cómo crear organizaciones y claves API, así como una visión general de los endpoints de la API SIGN ES.

Si ya has implementado nuestra API SIGN DE, hemos preparado una guía de integración para clientes de SIGN DE donde te explicamos las similitudes y diferencias entre los distintos endpoints en comparación con SIGN ES.

Cambios

La lista actualizada de cambios está también disponible en formatos de suscripción: RSS, Atom, and JSON.


1.24.1 [2026-04-21] Mejoras internas

  • se ha mejorado el tratamiento de nombres legales largos devueltos por la validación de NIF de la AEAT
  • mejoras internas

1.24.0 [2026-03-26] Reporte SII de facturas emitidas

  • se ha añadido soporte para reportar facturas al primer libro del SII (Libro Registro de Facturas Expedidas - Suministro Inmediato de Información)
  • se ha añadido un nuevo tipo de corrección CORRECTION_AJ para ajuste de márgenes. Solo disponible para clientes de Bizkaia
  • se ha añadido el nuevo campo registered_activity_territory para especificar la ubicación de la actividad económica cuando difiere de la predeterminada. Solo disponible para clientes de Bizkaia
  • mejoras internas

1.23.1 [2026-03-06] Mejoras internas

  • se han actualizado todos los campos de direcciones para admitir todo el conjunto de caracteres UTF-8
  • se ha añadido la funcionalidad de descarga para el tipo de acuerdo OTHER_DOCUMENT
  • se ha actualizado la colección de Postman con ejemplos para la emisión por terceros
  • se han mejorado los mensajes de error de la API para la subida de certificados externos
  • mejoras internas

1.23.0 [2026-02-02] Soporte de Referencia al Original en Correcciones

  • se ha añadido el campo reference_original_id para poder emitir correcciones o enriquecimientos referenciando la factura original o cualquier modificación previa
  • mejoras internas

1.22.2 [2026-01-26] Mejoras internas

  • se ha corregido el campo de respuesta compliance para facturas EXTERNAL en Verifactu
  • mejoras internas

1.22.1 [2026-01-16] Nuevos tipos de acuerdos

  • permitido otros formatos de acuerdo mediante los nuevos tipos: UNVERIFIED, OTHER_DOCUMENT y PROVIDED_EXTERNALLY
  • se ha deprecado el campo registered en los endpoints de contribuyente y de software
  • se ha añadido el nuevo régimen de IVA ENTITY_GROUP
  • se ha añadido compatibilidad con todos los caracteres utf-8 para address_line y postal_code en la identificación del destinatario
  • mejoras internas

1.22.0 [2025-12-19] Funcionalidad Offline en Bizkaia Ampliada

  • se han añadido correcciones, enriquecimientos y resúmenes offline en Bizkaia con la anotación OFFLINE
  • se ha añadido la opción de cambiar a no Veri*factu a través del campo end_of_verifactu_date
  • se ha añadido el régimen PENDING_ACCRUAL
  • se ha añadido soporte para el carácter & para destinatarios internacionales
  • mejoras internas

1.21.2 [2025-12-05] Mejoras internas

  • se ha añadido soporte para el carácter ; en nombres legales y direcciones
  • se han añadido nuevos regímenes de VAT exclusivos de IPSI: INTERNAL_IPSI_EXEMPT, OBJECTIVE_ESTIMATION y CEUTA_SPECIFIC
  • actualización de la asignación de los regímenes de IVA existentes para el sistema IPSI de acuerdo con los cambios de Verifactu
  • se ha añadido nuevo régimen de VAT PROFESSIONAL_FEES
  • se ha añadido soporte para registration_csv y cancellation_csv para facturas emitidas en Bizkaia
  • mejoras internas

1.21.1 [2025-11-18] Mejoras internas

  • se ha añadido soporte para los caracteres äÄ, ëË y öÖ en nombres legales y direcciones
  • se ha modificado la descripción de la factura y de los ítems para admitir todo el conjunto de caracteres UTF-8
  • se ha ampliado la longitud de la descripción de la factura y de los ítems para permitir hasta 500 caracteres en facturas Verifactu
  • se han añadido los nuevos campos opcionales registration_csv y cancellation_csv en la respuesta de la factura, que se completarán en las nuevas facturas tras transmisiones exitosas en territorios Verifactu y también en Gipuzkoa
  • mejoras internas

1.21.0 [2025-11-06] Facturación por terceros

  • se ha añadido la posibilidad de emitir facturas a través de terceros mediante la configuración opcional third_party en territorios Verifactu.
  • se ha añadido soporte para los caracteres Ãã, Õõ y Øø en nombres fiscales, direcciones y descripción de la factura
  • mejoras internas

1.20.2 [2025-10-28] Mejoras internas

  • añadido el régimen OSS_IOSS
  • mejoras en la documentación de la API
  • mejoras internas

1.20.1 [2025-10-17] Mejoras internas

  • se ha corregido el comportamiento interno cuando el campo issued_at no se especifica en enriquecimientos simplificados: por defecto utiliza la hora local de Europe/Madrid en vez de UTC
  • se añadieron las nuevas causas de exención exclusivas de IGIC: TAXABLE_EXEMPT_7 y TAXABLE_EXEMPT_8
  • se añadieron los nuevos regímenes de IVA exclusivos de IGIC: RETAIL_TRADERS, SMALL_PROFESSIONALS e INTERNAL_IGIC_EXEMPT

1.20.0 [2025-10-14] Facturas proforma

  • agrega un nuevo tipo de factura DRAFT para crear proformas de facturas simplificadas y completas
  • agrega un nuevo campo exception_unidentified para admitir facturas sin identificación del destinatario (solo Verifactu)
  • agrega el régimen especial del oro de inversión
  • agrega el régimen especial de facturas con impuesto pendiente de devengo en operaciones de tracto sucesivo
  • mejora la validación del acuerdo de colaboración social

1.19.0 [2025-10-03] Comportamiento de la fecha de emisión

  • se ha corregido el comportamiento interno cuando el campo issued_at no se informa: por defecto utiliza Europe/Madrid hora local, en vez de UTC
  • se ha aclarado la documentación del campo issued_at
  • se ha corregido la asignación de la anotación INCIDENT al fichero XML de Verifactu

1.18.1 [2025-09-16] Mejoras internas

  • añadido el régimen CASH_CRITERIA
  • se ha añadido un formato alternativo de marca de tiempo issued_at con información sobre la zona horaria
  • mejoras internas

1.18.0 [2025-09-10] Facturas Recapitulativas

  • se ha añadido la posibilidad de emitir facturas recapitulativas
  • se ha añadido la posibilidad de emitir facturas rappel
  • se ha solucionado un problema por el que la fecha de la transacción no se asignaba correctamente a las facturas verifactu
  • mejoras internas

1.17.3 [2025-09-02] Mejoras internas

  • añadido el régimen RENT_PREMISES
  • acepta los caracteres adicionales + and € para InvoiceText
  • acepta caracteres especiales al campo del número de dirección
  • mejoras internas

1.17.2 [2025-08-25] Mejoras internas

  • se han solucionado problemas de redondeo poco frecuentes en las facturas de Verifactu
  • mejoras internas

1.17.1 [2025-08-08] Mejoras internas

  • añade la marca registrado (registered) para destinatarios nacionales (NationalIdentification) para indicar si aún no está registrado en AEAT para Verifactu
  • acepta el caracter adicional ' para los campos LegalName, AddressLine y InvoiceText
  • actualiza la colección de Postman para los servicios de validación del NIF en AEAT y VIES
  • mejoras internas

1.17.0 [2025-07-29] Validación de NIF

  • se ha añadido un endpoint de validación de NIF o número de IVA, compatible con los servicios AEAT y VIES
  • se agregaron nuevos tipos de sistema de facturación OTHER_TAX_IVA, OTHER_TAX_IGIC y OTHER_TAX_IPSI para transacciones sujetas a otros territorios
  • se han añadido los caracteres & ß para LegalName
  • se han añadido los caracteres \ & @ \r ß # para InvoiceText
  • se ha actualizado la colección de Postman para el flujo del acuerdo de colaboración social
  • mejoras internas

1.16.1 [2025-07-14] Régimen especial agencias de viaje

  • añadido el régimen TRAVEL_AGENCIES
  • añadido el régimen TRAVEL_AGENCY_MEDIATORS
  • habilitado el flujo de de creación y subida de acuerdos de facturación
  • actualizada la colección de postman
  • mejoras internas en los sistemas de almacenamiento

1.16.0 [2025-06-25] Autofacturas

  • habilitada la opción de emitir autofacturas para contribuyentes bajo la legislación Verifactu
  • habilitado régimen de IVA REBU (ANTIQUES)
  • habilitado régimen de IVA REAGYP (AGRICULTURE)
  • mejoras internas en el almacenamiento y transmisión de facturas

1.15.1 [2025-06-13] Mejoras internas

  • se cambió el límite de artículos a 10000 para las facturas de Verifactu
  • mejoras internas de la transmisión de verifactu

1.15.0 [2025-05-27] Habilitación de Verifactu

  • se habilita la creación de contribuyentes para los siguientes territorios en el entorno LIVE: Spain_Other, Ceuta, Melilla e Canary_Islands.
  • se habilita la transmisión de facturas de Verifactu en el entorno LIVE.
  • se añaden funciones de envío por batch para la transmisión de Verifactu.
  • se incorporan endpoints para el flujo de colaboración social.
  • se incorpora la posibilidad de añadir información de dirección y correo electrónico a un contribuyente.
  • se incrementa el límite máximo de firmantes para contribuyentes de Verifactu a 10.
  • se corrige la asignación de EQUIVALANCE_SURCHARGE en Verifactu.

1.14.0 [2025-04-23] Mejoras API

  • mejorada la descripción de issued_at y transaction_date
  • mejorada la descripción de tax_number si se usa como destinatario internacional
  • añadidos caracteres adicionales para el texto de la factura, razón social y dirección
  • mejoras en la asignación de puntos finales para los territorios fiscales de Ceuta, Melilla y Canarias
  • arreglos de emisión de facturas con el mismo número y serie pero para diferentes años fiscales
  • para firmantes de Verifactu, VerifactuCertificate se devuelve en lugar de TicketbaiDeviceCertificate
  • mejoras internas

1.13.0 [2025-02-20] Envíos Verifactu

  • habilitada la emisión de facturas a los servicios de prueba de la AEAT para los territorios Verifactu
  • habilitados los territorios fiscales Ceuta, Melilla y Canarias
  • añadida funcionalidad de subsanación para Verifactu
  • añadido un punto final para permitir la deshabilitación permanente de un contribuyente
  • mejoras internas en la generación de xml

1.12.1 [2025-02-03] Facturas rectificativas con destinatarios internacionales

  • corrección en la generación del ID para destinatarios internacionales en facturas rectificativas (REMEDY)

1.12.0 [2025-01-20] Mejoras en las facturas de subsanación

  • mejoras en la funcionalidad de subsanacion en Bizkaia:
    • habilitada la cancelación de subsanaciones
    • subsanación de facturas offline a través del uso de facturas EXTERNAL
    • subsanación de subsanaciones fallidas en estado REQUIRES_INSPECTION
  • corrección en la generación de tipos NON_TAXABLE de TicketBAI
  • corrección en la generación de fechas de emisión de facturas de canje ENRICHMENT
  • mejora en el gestionamiento interno de certificados

1.11.1 [2024-12-11] Mejoras internas

  • mejoras en la transmisión de archivos XML de anulación

1.11.0 [2024-12-04] Tipos de Impuesto y Preparación de la API para Verifactu

  • agregado el campo opcional vat_type, que está disponible en el esquema de API InvoiceItem
  • agregado el campo opcional responsibility_declaration, que está disponible en el esquema de API Software
  • mejoras en la generacion de facturas Verifactu
  • mejoras en la documentación de la API en preparación de Verifactu

1.10.0 [2024-11-18] Facturas de subsanación para Vizcaya

  • habilitada la funcionalidad de subsanación para el territorio de Vizcaya
  • mejoras en los validaciones internas y creación de registros XML

1.9.0 [2024-10-25] Facturas de subsanación

  • habilitada la funcionalidad de subsanación para lot territorios Araba y Gipuzkoa
  • mejoras en la creación y transmisión de registros XML

1.8.2 [2024-09-19] Descuentos en líneas de factura

  • mejoras en la creación de archivos Ticketbai XML relacionadas con el valor de descuento por línea de factura

1.8.1 [2024-09-12] Mejoras internas

  • mejoaras en la creación de las URL de validación
  • mejoras en el manejo de facturas de canje
  • mejoras en la creación de clientes

1.8.0 [2024-08-13] Reenvío de facturas

  • habilitada la retransmisión de facturas a través de la funcionalidad REMEDY en Bizkaia, que se puede utilizar en caso de errores de transmisión debido a un certificado no registrado o para actualizar una IndividualAnnotation configurada incorrectamente.
  • corrección en la codificación de las URL de validación que en ciertos casos resultaban en URL inválidas
  • mejoras en la transmisión de XML TicketBAI en escenarios de alta carga

1.7.2 [2024-07-18] Mejoras internas

  • mejoras en el manejo de transmisión interna
  • mejoras en la respuesta del punto final software

1.7.1 [2024-06-25] API and Transmission

  • mejora de la creación y transmisión XML de TicketBAI hacia Bizkaia

1.7.0 [2024-06-04] Verifactu API

  • agrega el campo Coupon al esquema de la API para facturas rectificativas, que se puede emplear para rectificar facturas simplificadas, o facturas completas de tipo CORRECTION_1, en BIZKAIA y los territorios donde aplique Verifactu
  • agrega la anotación Incident, que permite indicar incidentes técnicos durante la emisión de la factura
  • habilita la creación de contribuyentes del territorio SPAIN_OTHER, para permitir la creación de contribuyentes que entran dentro del marco legislativo de Verifactu en los entornos de pruebas
  • habilita la creación de facturas para los contribuyentes dentro del marco legislativo de Verifactu en los entornos de pruebas
  • mejoras en la transmisión del fichero XML de TicketBAI hacia los servidores de la hacienda foral territorial

1.6.0 [2024-04-11] Envío de Batuz para particulares

  • agrega anotaciones Annotations al esquema de la API, permitiendo añadir a una factura información específica de la provincia o legislación aplicable
  • incluye la funcionalidad de transmisión de facturas para personas físicas a través de IndividualAnnotation, que se puede agregar al emitir la factura por primera vez o más tarde a través de PATCH
  • agrega el campo vat_withholding, disponible en el esquema API CompleteInvoice
  • mejora la transmisión del fichero XML de TicketBAI hacia los servidores de la hacienda foral territorial

1.5.6 [2024-03-21] Texto de la factura

  • se ha añadido el caracter dos puntos (:) para el esquema de la API InvoiceText y ExtendedSpecialAlphaNumerical250, que se utiliza en el esquema de la API SimplifiedInvoice, así como en InvoiceItem y que permite expresar textos descriptivos utilizando dos puntos
  • mejora de la transmisión TicketBAI XML a los servidores de las haciendas forales

1.5.5 [2024-02-29] Facturación

  • añadido NON_TAXABLE_4 para el esquema API NotTaxableCause para crear facturas de ventas realizadas por cuenta de terceros

1.5.4 [2024-02-14] Referencia de facturas externas

  • añadido el tipo de factura EXTERNAL para la operación API createInvoice para representar y referenciar facturas en SIGN ES que fueron emitidas fuera de los límites del sistema SIGN ES
  • descripción actualizada de CONCEPT en la documentación de la API

1.5.3 [2024-01-30] Transmisión LROE

  • ha facilitado la integración de los archivos XML TicketBAI en los registros XML del capítulo 1.1 de BATUZ/LROE para el territorio de contribuyentes BIZKAIA
  • la creación y el envío de los registros LROE ya están activados en el entorno de producción TEST
  • la creación y envío de registros LROE se activará automáticamente para el entorno de producción LIVE el 2024-02-01 00:00:00 UTC+1
  • cambio de nombre del esquema API TicketbaiCommunication a InvoiceExportCommunication
  • renombrado el esquema API TicketbaiXML a TransmissionFile
  • actualización de la documentación de la API en español

1.5.2 [2024-01-10] TicketBAI y Contribuyente

  • habilitado el registro de facturas TicketBAI y la creación y envío de archivos XML de cancelación en la versión v1.2.2 en el sistema LIVE de producción
  • se ha mejorado la respuesta de la API Taxpayer, ahora proporciona la información del type (tipo) de contribuyente. Cuyo valor puede ser COMPANY (empresa) o INDIVIDUAL (particular), la distinción esta basada en número de identificación fiscal
  • proporciona un esquema de API tipificado para la petición TaxpayerCreateRequest
  • mejoras en el patrón regex del tipo TaxNumber

1.5.1 [2023-12-30] Firma TicketBAI

  • actualizada la política de firma BIZKAIA a v1.1
  • mejorado el proceso de firma XAdES-EPES y la creación de firmas
  • soporte de caractéres ordinales masculinos en los esquemas API ExtendedAlphaNumerical120, ExtendedAlphaNumerical250 y ExtendedSpecialAlphaNumerical250
  • aumento de la precisión de los decimales hasta 8 dígitos en los esquemas de API InvoiceItemUnitAmount, InvoiceItemFullAmount, InvoiceItemDiscount y InvoiceQuantity

1.5.0 [2023-12-22] TicketBAI v1.2.2

  • proporciona registro, cancelación y transmisión de facturas TicketBAI versión v1.2.2
  • habilita la nueva versión, por ahora solo en el sistema de producción TEST
  • introduce una nueva causa de no sujeción NON_TAXABLE_3

1.4.4 [2023-11-30] Exportaciones en el dashboard

  • proporciona integración con la funcionalidad de exportación en el panel de control de fiskaly
  • mejoras en la transmisión de XML a los servicios de la autoridad tributaria.

1.4.3 [2023-11-24] Localización del producto

  • proporciona traducciones al Español de la especificación de OpenAPI.
  • añade localización dentro de la guía para desarrolladores.
  • mejoras en la transmisión de XML a los servicios de la autoridad tributaria.

1.4.2 [2023-11-17] Facturación y Transmisión

  • actualizado el calculo de desglose de factura para destinatarios internacionales dentro de la operación createInvoice
  • mejoras en la transmisión de XML a los servicios de la autoridad tributaria.

1.4.1 [2023-11-10] Preparación Verifactu

  • proporciona las regiones para Verifactu en el enumerador de territorios Territory
  • proporciona el esquema VerifactuInvoiceCompliance para el esquema de respuesta API SignedInvoice para los territorios donde aplique Verifactu

1.4.0 [2023-10-30] Funcionalidad de exportación

  • proporciona la funcionalidad de creación de recurso de exportaciones de facturas (Exports) para crear exportaciones de forma asíncrona de archivos ZIP que incluyen múltiples facturas
  • habilitadas las operaciones createExport, updateExport, retrieveExport, listExport, y downloadExport
  • actualiza la documentación de tipos de factura en el recurso Invoice
  • añade el esquema InvoiceAdditionalVat y la funcionalidad para expedir facturas con recargo de equivalencia

1.3.2 [2023-10-11] Facturas de canje

  • habilitada la funcionalidad ENRICHMENT que permite realizar cambios sobre facturas ordinarias para incluir datos de destinatario
  • proporciona el esquema API EnrichmentInvoice para la operación createInvoice
  • actualiza la descripción del campo de IVA rate para documentar el uso del tipo InvoicePercentage dentro del esquema InvoiceWithVatCategory
  • proporciona el error de respuesta de API 400 para los esquemas: TaxpayerResponse, SingerResponse, SignersResponse, ClientResponse, ClientsResponse, InvoiceResponse, InvoicesResponse, ExportResponse, y SoftwareResponse.

1.3.1 [2023-09-29] Transmisión de facturas

  • mejoras en la transmisión de facturas Invoices a los servicios de la autoridad tributaria.
  • mejoras de rendimiento en la operación exportInvoice de la API que proporciona el XML de registro.

1.3.0 [2023-09-22] Certificados externos

  • habilitado el soporte de certificados de dispositivo externos en updateSigner
  • actualización del esquema de petición Certificate de la operación updateSigner
  • mejoras en el esquema de respuesta SignedInvoice dentro de las operaciones de API Invoices. Ahora incluyen la información InvoiceSigner e InvoiceClient
  • proporcionadas nuevas secciones en la guía para desarrolladores con información sobre la creación de certificados de dispositivo externos

1.2.1 [2023-09-01] Facturación y paginación

  • cambios en el comportamiento de validación en createInvoice que ahora devuelve directamente los errores de validación de forma inmediata en la respuesta de la API SignedInvoice dentro del campo validations
  • mejoras en el rendimiento de firma dentro de la operación createInvoice
  • mejoras en el patron regex de TicketbaiInvoiceIdentifier para permitir mayor número de caracteres alfa-numéricos y caracteres especiales
  • proporciona la funcionalidad de paginación Pagination para todos los endpoints de listado, permitiendo la visualización en páginas a través de un sistema basado en token de búsqueda

1.2.0 [2023-08-23] Búsqueda y listado de facturas

  • se habilita la funcionalidad de rectificación por diferencias en la operación createInvoice
  • se actualiza la enumeración ValidationError en la documentación de la API junto con los códigos y descripciones
  • se proporciona la operacion searchInvoices en la API para realizar búsquedas de facturas de un contribuyente, con parámetros de consulta opcionales: numero de factura, serie de factura, y rango de tiempo de expedición
  • se mejora el manejo de peticiones sobre el recurso Invoices de forma concurrente
  • cambios en los esquemas de las respuestas de las operaciones listSigners, listClients, and listInvoices. Ahora devuelven una lista de results que contienen esquemas del recurso correspondiente que incluye el content y metadata

1.1.1 [2023-08-04] Validación de facturas y metadatos

  • se proporciona la validación de facturas (Invoices) con error HTTP 422 para peticiones con facturas no válidas. En la respuesta se incluye el esquema ValidationError que incluye el código de error y descripción.
  • se proporcionan errores de transmisión a través de la API en la respuesta SignedInvoice dentro del campo validations del esquema
  • se actualiza la petición createInvoice de la API para permitir de forma opcional el campo issued_at que especifica la fecha de expedición de la factura
  • se actualiza la petición createInvoice de la API para permitir de forma opcional el campo transaction_date que especifica la fecha de operació.
  • se proporciona el régimen de exportación para Invoice junto con las causas de exención
  • mejoras en la funcionalidad del endpoint Invoices y habilitada la funcionalidad de Metadata
  • mejoras en la funcionalidad del endpoint Clients y habilitada la funcionalidad de Metadata
  • mejoras la funcionalidad del endpoint Signers y habilitada la funcionalidad de Metadata
  • mejoras en la funcionalidad del endpoint Taxpayer y habilitada la funcionalidad de Metadata

1.1.0 [2023-06-23] Funcionalidad de factura completa

  • se habilita la funcionalidad del endpoint Invoices para gestionar el esquema de solicitud de la API CompleteInvoice para emitir facturas COMPLETAS (COMPLETE) que contengan información sobre el destinatario y proporcionen sistemas de IVA adicionales, categorías de IVA y el nuevo concepto económico para las operaciones nacionales e internacionales
  • actualización de la funcionalidad del endpoint Invoices para gestionar el esquema de solicitud de la API CorrectionInvoice para realizar la RECTIFICACIÓN (CORRECTION) de facturas COMPLETAS (COMPLETE) a COMPLETAS (COMPLETE), así como la "actualización" de facturas SIMPLIFICADAS (SIMPLIFIED) a facturas COMPLETAS (COMPLETE)
  • mejoras en el endpoint Signers

1.0.1 [2023-06-16] Esquema de factura completa

  • refinado del esquema de solicitud de la API CompleteInvoice con la estructura Recipients para incluir la información del destinatario nacional e internacional de la factura
  • esquema de la API InvoiceItem ampliado con una nueva abstracción opcional de concepto económico (Concept)
  • mejora de la funcionalidad del endpoint Authentication para los tokens de entorno LIVE
  • se ha actualizado la funcionalidad del endpoint Taxpayer para que los cambios de información sólo se permitan cuando no existan recursos HABILITADOS (ENABLED)

1.0.0 [2023-06-14] Entorno de producción habilitado

  • habilitado el entorno de producción live.es.sign.fiskaly.com
  • habilitada la funcionalidad de endpoint Software para la verificación presencial
  • mejoras en la documentación de la API y de las descripciones de los campos

0.15.0 [2023-06-11] Rectificación de facturas

  • habilitado el esquema y la funcionalidad de CORRECTION en createInvoice
  • actualizado el esquema de respuesta de la API de Invoices
  • mejora de la funcionalidad del endpoint Invoices

0.14.0 [2023-06-02] Anulación de facturas

  • habilitada la funcionalidad de la API updateInvoice
  • actualizado el esquema de solicitud de la API updateInvoice
  • actualizado el esquema de respuesta del Invoice
  • mejora de la funcionalidad del endpoint Invoices

0.13.0 [2023-05-29] Entorno de pruebas habilitado

  • habilitado el entorno de pruebas de producción de test.es.sign.fiskaly.com
  • mejora de la funcionalidad de exportación del endpoint Data Exports
  • mejora de la funcionalidad de facturación del endpoint Invoices

0.12.0 [2023-05-26] Exportar facturas

  • habilitada la funcionalidad de exportación del endpoint Data Exports
  • mejora de la funcionalidad de facturación del endpoint Invoices
  • mejora de la funcionalidad de mantenimiento del endpoint Signers

0.11.2 [2023-05-16] Funcionalidad de facturación

  • documentación actualizada del esquema de solicitud de SimplifiedInvoice
  • mejora de la funcionalidad de facturación del endpoint Invoices
  • mejora de las funciones de mantenimiento del endpoint Clients
  • mejora de la funcionalidad de mantenimiento del endpoint Signers

0.11.1 [2023-04-28] Colección Postman

  • integración con Postman para obtener la colección y el entorno de Postman
  • funcionalidad actualizada del endpoint Invoice
  • se ha añadido la sección Guía Rápida a la documentación
  • se ha añadido la sección PREGUNTAS FRECUENTES FAQs a la documentación

0.11.0 [2023-04-23] Factura simplificada

  • habilitada la funcionalidad createInvoice de la API
  • habilitada la funcionalidad retrieveInvoice de la API
  • habilitada la funcionalidad listInvoices de la API
  • actualizado el esquema de solicitud de FACTURA SIMPLIFICADA SimplifiedInvoice
  • actualizado el esquema de respuesta de Invoice
  • mejora de la funcionalidad de mantenimiento del endpoint Signers
  • mejora de la funcionalidad de mantenimiento del endpoint Clients

0.10.0 [2023-04-17] API de Facturación

  • actualizado el esquema de solicitud de SimplifiedInvoice
  • actualizado el esquema de respuesta de Invoice
  • mejora de la funcionalidad de mantenimiento del endpoint Taxpayer
  • mejora de la funcionalidad de mantenimiento del endpoint Signers
  • mejora de la funcionalidad de mantenimiento del endpoint Clients

0.9.0 [2023-04-02] Clientes

  • habilitada la función de mantenimiento del endpoint Clients con asignación de firmantes por defecto
  • se ha actualizado la funcionalidad de mantenimiento del endpoint Signers
  • se ha actualizado la funcionalidad de mantenimiento del endpoint Taxpayer
  • actualizada la funcionalidad del endpoint Authentication
  • actualizado el esquema de respuesta del endpoint Authentication
  • refinado el esquema de respuesta del endpoint Invoices

0.8.0 [2023-03-29] Firmantes

  • respuestas de error del endpoint createSigner refinadas
  • respuestas de error del endpoint updateSigner refinadas
  • respuestas de error del endpoint retrieveSigner refinadas
  • respuestas de error del endpoint listSigner refinadas
  • respuestas de error del endpoint createClient refinadas
  • respuestas de error del endpoint updateClient refinadas
  • respuestas de error del endpoint retrieveClient refinadas
  • respuestas de error del endpoint listClient refinadas
  • actualizado el esquema de la API SigningDevice con un campo de certificate explícito
  • actualización de las funciones de mantenimiento de la información de Taxpayer
  • habilitada la funcionalidad de mantenimiento para Signer con certificados gestionados

0.7.0 [2023-03-22] Actualización de la API

  • los cambios afectan a los endpoints Taxpayer
  • renombrado el campo tax_id del esquema TicketbaiIssuer a tax_number
  • renombrado el campo name del esquema TicketbaiIssuer a legal_name
  • renombrado el esquema TicketbaiVatRegistrationNumber a TicketbaiTaxNumber

0.6.0 [2023-03-20] Actualización de la API

  • actualizado el esquema de solicitud/respuesta de los endpoints Authentication, Taxpayer, y Signer
  • esquema ErrorResponse actualizado
  • se han introducido los esquemas genéricos BadRequestResponse, UnauthorizedAccessResponse, ResourceNotFoundResponse, y InternalServerErrorResponse
  • funcionalidad de servicio Authentication habilitada
  • funcionalidad de servicio Taxpayer habilitada
  • los cambios de producto se integran en la especificación OpenAPI y están disponibles a través de RSS, Atom y un canal genérico basado en JSON

0.5.0 [2023-02-23] Actualización de la API

  • se ha introducido el tipo de esquema de respuesta del endpoint ErrorResponse
  • esquema de respuesta Client actualizado
  • introducción del esquema SignerState
  • provee ciclo de implantación del servicio

0.4.0 [2023-02-07] Reformulación de la API

  • tipos de esquema de respuesta de los endpoints actualizados
  • esquema SigningDevice actualizado
  • esquema SignerState introducido

0.3.0 [2023-01-30] Actualización de la API

  • esquema TicketBaiInvoiceState actualizado
  • cambiado TicketBaiInvoiceTransmission a TicketBaiInvoiceCancellationState
  • documentación actualizada de TicketBaiIssuer
  • documentación actualizada de TicketBaiVatRegistrationNumber
  • patrones regexDecimal3p2 modificados

0.2.0 [2023-01-20] Reformulación de la API

  • descripción actualizada del esquema UniversallyUniqueIdentifierV4
  • cambiada la clave de actualización de AccessToken de token a refresh_token
  • funcionalidad básica del servidor de pruebas

0.1.1 [2023-01-13] Reformulación de la API

  • esquema AccessToken actualizado
  • cambiada la representación de ApiKeyString y ApiSecretString
  • formatos PKCS y PEM proporcionados
  • actualizaciónes del régimen TicketBAI y de los códigos imponibles

0.1.0 [2023-01-05] Versión inicial

  • proporciona el borrador de la especificación OpenAPI de SIGN ES
  • define los esquemas de TicketBAI
  • define los endpoints de SIGN ES

Versionado

fiskaly SIGN ES sigue el esquema de versionado semántico. El número de versión tiene un patrón de MAYOR.MENOR.PARCHE. Se incrementa:

  • la versión MAYOR cuando realizamos un cambio que es incompatible con la versión anterior de la API,
  • la versión MENOR cuando añadimos una funcionalidad compatible con versiones anteriores, y
  • la versión PARCHE cuando reparamos errores compatibles con versiones anteriores.

Recursos

Esta API hace uso de identificadores únicos UUIDv4 para referenciar recursos creados dentro de SIGN ES.

La API de SIGN ES solo soporta UUIDs (pseudo-)aleatorios en versión 4 (UUIDv4).

Los identificadores UUIDv4 asignados a recursos de SIGN ES, como Firmantes, Clientes, Facturas y Exportaciones, deberán ser generados por una biblioteca disponible en su idioma de programación, por ejemplo en JavaScript o en Golang.

Guía Rápida

Para una primera prueba rápida, puedes utilizar Postman. Hemos preparado una colección de Postman que te permite conocer las funciones más importantes de nuestra API.

  1. Descarga la aplicación Postman.

  2. Crea una Clave API (API Key) y un Secreto API (API Secret) a través del dashboard de fiskaly:

  3. Inserta tu Clave API y Secreto API para descargar el entorno de Postman de fiskaly SIGN ES como archivo personalizado de configuración basado en JSON:

    Clave API
    Secreto API

  4. Descarga la colección Postman de fiskaly SIGN ES, el archivo de configuración basado en JSON:


  5. Inicia Postman e importa los archivos del entorno y la colección de Postman que has descargado:

  6. Selecciona el entorno de fiskaly SIGN ES en Postman y ejecuta la colección:

Preguntas frecuentes

Las preguntas frecuentes de SIGN ES se encuentran en la página de soporte de fiskaly.

Autenticación

Las API de fiskaly utiliza un mecanismo de seguridad basado en JWT para autenticar las solicitudes de la API. Las solicitudes de API sin autenticación fallarán con un error HTTP de acceso no autorizado. Las API de fiskaly procesa solo solicitudes basadas en https. Las solicitudes simples basadas en http son redirigidas a https.

JWT

Un JSON Web Token (JWT) utilizado para el control de acceso y la autorización. El JWT se puede obtener a través de una solicitud de API recuperar token de autenticación.

Obtener token de acceso

Para acceder a un API fiskaly necesitas un access_token JWT válido. Este endpoint crea el token con tu clave api_key y secreto api_secret.

Si no tienes una clave, puedes crear una a través del endpoint createApiKey de la API de gestión o a través del dashboard de fiskaly.

El secreto api_secret se generará una vez creada la clave api_key.

El access_token debe enviarse en cada solicitud dentro del encabezado de Authorization utilizando el esquema de autenticación Bearer.

Más detalles aquí.

Request Body schema: application/json
required
required
ApiKeySecretAuthentication (object) or RefreshTokenAuthentication (object)

Responses

Request samples

Content type
application/json
{
  • "content": {
    }
}

Response samples

Content type
application/json
{
  • "content": {
    }
}

Contribuyente

Crear contribuyente

Este endpoint se utiliza para crear la información de un contribuyente (emisor de facturas)

Authorizations:
JWT
Request Body schema: application/json
required
required
object (TaxpayerCreateContent)

Representa la información del contribuyente que se utiliza para emitir facturas para todos los dispositivos de firma dentro del contexto de la organización gestionada, asociada al JWT. Consta de información del emisor issuer de la factura y del territorio territory que representa el domicilio fiscal del contribuyente.

object (Metadata) <= 20 properties

Puede emplear este parámetro para adjuntar datos en formato clave/valor al objeto.
Los metadatos son útiles para almacenar datos estructurados que complementan el objeto.

Se pueden adjuntar metadatos en los métodos de actualización de cada recurso. Si se incluye una clave con un valor vacío, se eliminará esa pareja clave/valor.

Si se adjuntan metadatos a un objeto, estos serán devueltos en las respuestas a peticiones de ese objeto.

Nota: Se pueden especificar hasta 20 claves, cada clave puede contener hasta 40 caracteres, y los valores pueden contener hasta 500 caracteres.

Responses

Request samples

Content type
application/json
{
  • "content": {
    },
  • "metadata": {}
}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "metadata": {}
}

Actualizar contribuyente

Para actualizar el estado de un contribuyente específico, este endpoint permite desactivar un contribuyente de forma permanente y/o actualizar los metadatos del contribuyente.

Authorizations:
JWT
Request Body schema: application/json
required
object (TaxpayerUpdateContent)
object (Metadata) <= 20 properties

Puede emplear este parámetro para adjuntar datos en formato clave/valor al objeto.
Los metadatos son útiles para almacenar datos estructurados que complementan el objeto.

Se pueden adjuntar metadatos en los métodos de actualización de cada recurso. Si se incluye una clave con un valor vacío, se eliminará esa pareja clave/valor.

Si se adjuntan metadatos a un objeto, estos serán devueltos en las respuestas a peticiones de ese objeto.

Nota: Se pueden especificar hasta 20 claves, cada clave puede contener hasta 40 caracteres, y los valores pueden contener hasta 500 caracteres.

Responses

Request samples

Content type
application/json
{
  • "content": {
    },
  • "metadata": {}
}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "metadata": {}
}

Obtener contribuyente

Este endpoint se utiliza para obtener la información del contribuyente (emisor de facturas).

Authorizations:
JWT

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "metadata": {}
}

Generar acuerdo

Genera un borrador para un acuerdo de facturación. Este documento es un requisito para contribuyentes bajo la legislación de Verifactu y permite que fiskaly envíe facturas en su nombre. Es necesario actualizar la información del contribuyente con su dirección.

El documento generado deberá ser firmado digitalmente por el contribuyente y subido a través de esta API. Para contribuyentes autónomos, el documento será firmado por el propio autónomo, mientras que para entidades jurídicas es necesaria la firma por un representante legal de la misma.

Se podrán generar borradores de acuerdos de facturacion sin invalidar acuerdos firmados existentes.

Authorizations:
JWT
Request Body schema: application/json
required
required
object (GenerateAgreementContent)

Responses

Request samples

Content type
application/json
{
  • "content": {
    }
}

Response samples

Content type
application/json
{
  • "content": {
    }
}

Subir acuerdo firmado

Este endpoint permite la subida de acuerdos de facturación firmados, generados previamente a través de esta API.

Acepta acuerdos firmados en formato PAdES. La firma deberá ser válida y pertenecer al representante legal del contribuyente.

En caso de que se suba satisfactoriamente el acuerdo, se invalidarán acuerdos anteriores con el contribuyente.

Mediante la firma y entrega de esta AUTORIZACIÓN, el CONTRIBUYENTE reconoce y asume expresamente su responsabilidad por la veracidad y exactitud de la información contenida en la misma, declarando que dicha información es completa, veraz y exacta a fecha de su firma. Asimismo, el CONTRIBUYENTE reconoce que con ella otorga expresamente y de manera inequívoca a Fiskaly Iberia su representación para proceder a la remisión de los ficheros de facturación generados a través del Sistema de Información de Facturación (SIF) a la Agencia Tributaria.

Authorizations:
JWT
Request Body schema: application/json
required
required
object (TaxpayerAgreementDocument)

Responses

Request samples

Content type
application/json
{
  • "content": {
    }
}

Response samples

Content type
application/json
{}

Obtener acuerdo

Este endpoint permite obtener el acuerdo de facturación más reciente.

Authorizations:
JWT

Responses

Response samples

Content type
application/json
{}

Descargar acuerdo

Este endpoint permite descargar el último convenio de colaborador social cargado por el contribuyente en formato PDF.

Authorizations:
JWT

Responses

Response samples

Content type
application/json
{
  • "content": {
    }
}

Firmantes

Crear dispositivo firmante

Este endpoint se utiliza para crear un dispositivo firmante. SIGN ES gestiona los certificados para Verifactu y TicketBAI.

Debe existir al menos un dispositivo de firma para cada organización gestionada para poder emitir facturas.
Un dispositivo de firma permite utilizar un certificado de dispositivo exclusivo para TicketBAI del tipo "Punto de facturación" y mantiene el encadenamiento de facturas para uno o varios dispositivos de cliente.

Para TicketBAI, el certificado firmante emplea un certificado de tipo "Punto de facturación", para la firma y envio de registros encadenados. Cada dispositivo de firma requiere un certificado de dispositivo. Si no se provee un certificado externo durante la creación del dispositivo, SIGN ES asignara un certificado gestionado por fiskaly GmbH.

Para Verifactu, SIGN ES utilizara por defecto un certificado electronico gestionado por fiskaly GmbH, que se empleara para la firma y envio a la agencia tributaria de registros encadenados.

Esta llamada es idempotente.

Authorizations:
JWT
path Parameters
signer_id
required
string <uuid> (UniversallyUniqueIdentifierV4) [a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab...
Example: 1c81cb86-c2e8-4074-afc3-a0601b2bf063

Identifica un firmante (dispositivo de firma) con un identificador aleatorio en formato UUIDv4.

Request Body schema: application/json
required
object (Signer)

Representa el dispositivo de firma que realiza las operaciones de encadenamiento y firma de facturas.

object (Metadata) <= 20 properties

Puede emplear este parámetro para adjuntar datos en formato clave/valor al objeto.
Los metadatos son útiles para almacenar datos estructurados que complementan el objeto.

Se pueden adjuntar metadatos en los métodos de actualización de cada recurso. Si se incluye una clave con un valor vacío, se eliminará esa pareja clave/valor.

Si se adjuntan metadatos a un objeto, estos serán devueltos en las respuestas a peticiones de ese objeto.

Nota: Se pueden especificar hasta 20 claves, cada clave puede contener hasta 40 caracteres, y los valores pueden contener hasta 500 caracteres.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "metadata": {}
}

Actualizar dispositivo firmante

Para actualizar el estado de un dispositivo firmante específico, este endpoint permite deshabilitar (desactivar) un dispositivo de firma de forma permanente y/o actualizar los metadatos del dispositivo firmante.

Authorizations:
JWT
path Parameters
signer_id
required
string <uuid> (UniversallyUniqueIdentifierV4) [a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab...
Example: 1c81cb86-c2e8-4074-afc3-a0601b2bf063

Identifica un firmante (dispositivo de firma) con un identificador aleatorio en formato UUIDv4.

Request Body schema: application/json
required
object
object (Metadata) <= 20 properties

Puede emplear este parámetro para adjuntar datos en formato clave/valor al objeto.
Los metadatos son útiles para almacenar datos estructurados que complementan el objeto.

Se pueden adjuntar metadatos en los métodos de actualización de cada recurso. Si se incluye una clave con un valor vacío, se eliminará esa pareja clave/valor.

Si se adjuntan metadatos a un objeto, estos serán devueltos en las respuestas a peticiones de ese objeto.

Nota: Se pueden especificar hasta 20 claves, cada clave puede contener hasta 40 caracteres, y los valores pueden contener hasta 500 caracteres.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "metadata": {}
}

Obtener un firmante

Obtiene el dispositivo firmante específico de una organización.

Authorizations:
JWT
path Parameters
signer_id
required
string <uuid> (UniversallyUniqueIdentifierV4) [a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab...
Example: 1c81cb86-c2e8-4074-afc3-a0601b2bf063

Identifica un firmante (dispositivo de firma) con un identificador aleatorio en formato UUIDv4.

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "metadata": {}
}

Listar dispositivos firmantes

Obtiene una lista de dispositivos firmantes de una organización.

Authorizations:
JWT
query Parameters
limit
integer (PaginationLimit) [ 1 .. 100 ]
Default: 10

Representa el límite de resultados por página para un endpoint de listado.

token
string (PaginationToken) <= 1024 characters ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{4}|[A-...

Representa el token de paginación, que se emplea como puntero hacia la siguiente página de resultados.

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "pagination": {
    }
}

Clientes

Crear cliente

Este endpoint se utiliza para crear un dispositivo cliente.

Un dispositivo cliente permite identificar inequívocamente (a través del parámetro de ruta device_id) una terminal, sistema TPV, aplicación o cliente que emite facturas.

Para emitir facturas necesitas un cliente por cada sistema TPV y al menos un dispositivo firmante.

Esta llamada es idempotente.

Authorizations:
JWT
path Parameters
client_id
required
string <uuid> (UniversallyUniqueIdentifierV4) [a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab...
Example: 1c81cb86-c2e8-4074-afc3-a0601b2bf063

Identifica un cliente de forma única con un identificador aleatorio en formato UUIDv4.

Request Body schema: application/json
required
object (Client)

Representa un dispositivo de facturación al que accede una aplicación de facturación, ya sea que acceda o no a un servidor remoto para este propósito. Por ejemplo, en el caso de una aplicación basada en web, el número de serie del dispositivo de facturación será el del dispositivo en el que está instalado el navegador, y no el del servidor remoto al que accede para operar la aplicación.

object (Metadata) <= 20 properties

Puede emplear este parámetro para adjuntar datos en formato clave/valor al objeto.
Los metadatos son útiles para almacenar datos estructurados que complementan el objeto.

Se pueden adjuntar metadatos en los métodos de actualización de cada recurso. Si se incluye una clave con un valor vacío, se eliminará esa pareja clave/valor.

Si se adjuntan metadatos a un objeto, estos serán devueltos en las respuestas a peticiones de ese objeto.

Nota: Se pueden especificar hasta 20 claves, cada clave puede contener hasta 40 caracteres, y los valores pueden contener hasta 500 caracteres.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Actualizar cliente

Para actualizar el estado de un dispositivo cliente específico, este endpoint permite desactivar un dispositivo cliente de forma permanente y/o actualizar los metadatos del dispositivo cliente.

Authorizations:
JWT
path Parameters
client_id
required
string <uuid> (UniversallyUniqueIdentifierV4) [a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab...
Example: 1c81cb86-c2e8-4074-afc3-a0601b2bf063

Identifica un cliente de forma única con un identificador aleatorio en formato UUIDv4.

Request Body schema: application/json
required
object
object (Metadata) <= 20 properties

Puede emplear este parámetro para adjuntar datos en formato clave/valor al objeto.
Los metadatos son útiles para almacenar datos estructurados que complementan el objeto.

Se pueden adjuntar metadatos en los métodos de actualización de cada recurso. Si se incluye una clave con un valor vacío, se eliminará esa pareja clave/valor.

Si se adjuntan metadatos a un objeto, estos serán devueltos en las respuestas a peticiones de ese objeto.

Nota: Se pueden especificar hasta 20 claves, cada clave puede contener hasta 40 caracteres, y los valores pueden contener hasta 500 caracteres.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Obtener un cliente

Obtiene un dispositivo cliente específico de la organización.

Authorizations:
JWT
path Parameters
client_id
required
string <uuid> (UniversallyUniqueIdentifierV4) [a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab...
Example: 1c81cb86-c2e8-4074-afc3-a0601b2bf063

Identifica un cliente de forma única con un identificador aleatorio en formato UUIDv4.

Responses

Response samples

Content type
application/json
{}

Listar clientes

Lista los dispositivos clientes de una organización.

Authorizations:
JWT
query Parameters
limit
integer (PaginationLimit) [ 1 .. 100 ]
Default: 10

Representa el límite de resultados por página para un endpoint de listado.

token
string (PaginationToken) <= 1024 characters ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{4}|[A-...

Representa el token de paginación, que se emplea como puntero hacia la siguiente página de resultados.

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "pagination": {
    }
}

Software

Obtener software

Este endpoint se utiliza para obtener la información del software SIGN ES acorde al registro de software para un contribuyente determinado, la cual es necesaria en caso de una verificación presencial.

Para más detalles, referirse a la sección Registro de Software en la guía para desarrolladores.

Authorizations:
JWT

Responses

Response samples

Content type
application/json
{}

Facturas

La API fiskaly SIGN ES proporciona información de facturas compatibles con TicketBAI y Verifactu en los datos de respuesta de endpoints createInvoice, updateInvoice y retrieveInvoice a continuación. Esta información se debe imprimir en la factura, pero recomendamos implementar nuestra API del Recibo Digital para representar facturas digitalmente.

Crear factura

Este endpoint se utiliza para emitir una factura a través de un dispositivo cliente.

Authorizations:
JWT
path Parameters
client_id
required
string <uuid> (UniversallyUniqueIdentifierV4) [a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab...
Example: 1c81cb86-c2e8-4074-afc3-a0601b2bf063

Identifica un cliente de forma única con un identificador aleatorio en formato UUIDv4.

invoice_id
required
string <uuid> (UniversallyUniqueIdentifierV4) [a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab...
Example: 1c81cb86-c2e8-4074-afc3-a0601b2bf063

Identifica una factura con un identificador aleatorio en formato UUIDv4.

query Parameters
code
string (InvoiceRepresentationCode)
Enum: "QR_CODE" "CENTERED_CODE" "PORTRAIT_CODE" "LANDSCAPE_CODE"

Permite consultar opcionalmente el código de verificación de la factura con una representación específica (ver TicketbaiRepresentationCode). Cuando se omite el parámetro de consulta, se utiliza de forma predeterminada la representación QR_CODE en la respuesta.

Request Body schema: application/json
required
required
any (Invoice)

Una factura puede ser del tipo SIMPLIFIED (SIMPLIFICADA), COMPLETE (ORDINARIA), CORRECTING (RECTIFICATIVA), ENRICHMENT (CANJE), REMEDY (SUBSANAR) o EXTERNAL (EXTERNA).

  • SIMPLIFIED: Se puede emitir para importes de hasta 400 EUR (IVA incluido) o hasta 3.000 EUR (IVA incluido) en varios casos (ventas al por menor, servicios de ambulancias, servicios a domicilio de los clientes, transporte de personas y sus equipajes, servicios de hostelería y restauración, salas de baile, y clubes nocturnos, entre otros). Para obtener más información, visita la página de la autoridad tributaria. También se pueden emitir facturas simplificadas al rectificar una factura y para facturas autorizadas por el departamento de gestión tributaria.

  • COMPLETE: Deberán emitirse en los casos en que no se permita la emisión de una factura simplificada. Incluye datos del destinatario de la factura: Número de identificación fiscal (NIF) o identificación del destinatario de otros países, nombre completo o denominación social y domicilio con código postal. Se indica el desglose a nivel de factura para destinatarios nacionales o a nivel de operación para la prestación de servicios o entrega de bienes cuando el destinatario no es nacional. Una factura completa puede ser recapitulativa, al sustituir múltiples facturas simplificadas, acorde al Art. 13 del Reglamento de Facturación.

  • CORRECTING: Debe emitirse en los casos en que no se cumplan uno o más requisitos de los artículos 6 (contenido de la factura) y 7 (contenido de la factura simplificada) del reglamento de facturación, o cuando la modificación de la base imponible conforme al artículo 80 de la ley 37/1992 ha ocurrido. Para obtener más detalles, consulta la página de información de autoridad tributaria. Una factura rectificativa puede referenciar múltiples facturas simples y/o completas a la vez.

  • ENRICHMENT: Se puede emitir si la factura original no posee un destinatario y el único cambio es añadir uno o más destinatarios a la factura.

  • REMEDY: Se puede emitir para subsanar datos de una factura en aquellos casos donde no se requiere corregir mediante una factura rectificativa, acorde al Reglamento de Facturación.

  • EXTERNAL: Se pueden emplear para crear facturas que ya han sido emitidas, pero no fueron emitidas con SIGN ES. Las facturas externas nunca serán firmadas o registradas con la autoridad tributaria y no podrán ser anuladas. Las facturas externas podrán ser modificadas mediante las facturas CORRECTING y ENRICHMENT.

Array of objects (Annotations) = 1 items unique

A list of unique annotations.

object (Metadata) <= 20 properties

Puede emplear este parámetro para adjuntar datos en formato clave/valor al objeto.
Los metadatos son útiles para almacenar datos estructurados que complementan el objeto.

Se pueden adjuntar metadatos en los métodos de actualización de cada recurso. Si se incluye una clave con un valor vacío, se eliminará esa pareja clave/valor.

Si se adjuntan metadatos a un objeto, estos serán devueltos en las respuestas a peticiones de ese objeto.

Nota: Se pueden especificar hasta 20 claves, cada clave puede contener hasta 40 caracteres, y los valores pueden contener hasta 500 caracteres.

Responses

Request samples

Content type
application/json
{
  • "content": {
    },
  • "annotations": [
    ],
  • "metadata": {}
}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "annotations": [
    ],
  • "metadata": {}
}

Actualizar factura

Este endpoint se utiliza para cancelar una factura ya creada en el sistema SIGN ES, o modificar los metadatos de una factura ya creada. Al anular una factura, el estado de la factura cambia y se inicia una nueva sincronización con la autoridad tributaria para anular una factura previamente registrada.

¿Cuándo puedo anular una factura? En casos donde no se necesita una rectificación. Por ejemplo, cuando la operación no se ha llevado a cabo y la factura no fue entregada al cliente (DGT V0611/ 11-3-2011). Una vez anulada una factura, el mismo número de serie y número de factura no pueden volver a utilizarse.

Authorizations:
JWT
path Parameters
client_id
required
string <uuid> (UniversallyUniqueIdentifierV4) [a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab...
Example: 1c81cb86-c2e8-4074-afc3-a0601b2bf063

Identifica un cliente de forma única con un identificador aleatorio en formato UUIDv4.

invoice_id
required
string <uuid> (UniversallyUniqueIdentifierV4) [a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab...
Example: 1c81cb86-c2e8-4074-afc3-a0601b2bf063

Identifica una factura con un identificador aleatorio en formato UUIDv4.

query Parameters
code
string (InvoiceRepresentationCode)
Enum: "QR_CODE" "CENTERED_CODE" "PORTRAIT_CODE" "LANDSCAPE_CODE"

Permite consultar opcionalmente el código de verificación de la factura con una representación específica (ver TicketbaiRepresentationCode). Cuando se omite el parámetro de consulta, se utiliza de forma predeterminada la representación QR_CODE en la respuesta.

Request Body schema: application/json
required
object
Array of objects (Annotations) = 1 items unique

A list of unique annotations.

object (Metadata) <= 20 properties

Puede emplear este parámetro para adjuntar datos en formato clave/valor al objeto.
Los metadatos son útiles para almacenar datos estructurados que complementan el objeto.

Se pueden adjuntar metadatos en los métodos de actualización de cada recurso. Si se incluye una clave con un valor vacío, se eliminará esa pareja clave/valor.

Si se adjuntan metadatos a un objeto, estos serán devueltos en las respuestas a peticiones de ese objeto.

Nota: Se pueden especificar hasta 20 claves, cada clave puede contener hasta 40 caracteres, y los valores pueden contener hasta 500 caracteres.

Responses

Request samples

Content type
application/json
{
  • "content": {
    },
  • "annotations": [
    ],
  • "metadata": {}
}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "annotations": [
    ],
  • "metadata": {}
}

Obtener una factura

Este endpoint obtiene una factura emitida por un dispositivo cliente.

Authorizations:
JWT
path Parameters
client_id
required
string <uuid> (UniversallyUniqueIdentifierV4) [a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab...
Example: 1c81cb86-c2e8-4074-afc3-a0601b2bf063

Identifica un cliente de forma única con un identificador aleatorio en formato UUIDv4.

invoice_id
required
string <uuid> (UniversallyUniqueIdentifierV4) [a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab...
Example: 1c81cb86-c2e8-4074-afc3-a0601b2bf063

Identifica una factura con un identificador aleatorio en formato UUIDv4.

query Parameters
code
string (InvoiceRepresentationCode)
Enum: "QR_CODE" "CENTERED_CODE" "PORTRAIT_CODE" "LANDSCAPE_CODE"

Permite consultar opcionalmente el código de verificación de la factura con una representación específica (ver TicketbaiRepresentationCode). Cuando se omite el parámetro de consulta, se utiliza de forma predeterminada la representación QR_CODE en la respuesta.

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "annotations": [
    ],
  • "metadata": {}
}

Listar facturas

Este endpoint obtiene una lista de las facturas emitidas desde un dispositivo cliente.

Authorizations:
JWT
path Parameters
client_id
required
string <uuid> (UniversallyUniqueIdentifierV4) [a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab...
Example: 1c81cb86-c2e8-4074-afc3-a0601b2bf063

Identifica un cliente de forma única con un identificador aleatorio en formato UUIDv4.

query Parameters
code
string (InvoiceRepresentationCode)
Enum: "QR_CODE" "CENTERED_CODE" "PORTRAIT_CODE" "LANDSCAPE_CODE"

Permite consultar opcionalmente el código de verificación de la factura con una representación específica (ver TicketbaiRepresentationCode). Cuando se omite el parámetro de consulta, se utiliza de forma predeterminada la representación QR_CODE en la respuesta.

limit
integer (PaginationLimit) [ 1 .. 100 ]
Default: 10

Representa el límite de resultados por página para un endpoint de listado.

token
string (PaginationToken) <= 1024 characters ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{4}|[A-...

Representa el token de paginación, que se emplea como puntero hacia la siguiente página de resultados.

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "pagination": {
    }
}

Buscar facturas

Este endpoint obtiene una lista de las fatcuras emitidas por el contribuyente, opcionalmente filtrando por cualquier combinación de número, serie o fecha de emisión. Las facturas se identifican inequívocamente por su número, número de serie y año de emisión.

Los parámetros issue_date_from y issue_date_to permiten especificar un rango temporal en el cual las facturas fueron emitidas, donde issued_at_from es inclusive y issue_at_to es exclusive.
Por lo tanto, si una factura fue emitida el 10-08-2023 15:04:03 y se especifica issued_at_from como 10-08-2023 15:04:03, la factura estará incluida en la respuesta, y si se especifica issued_at_to como 10-08-2023 15:04:03, entonces no estará incluida.

Authorizations:
JWT
query Parameters
number
string (TicketbaiInvoiceIdentifier) [ 1 .. 20 ] characters ^[0-9A-Z_/\-\.]{1,20}$
Example: number=2022

Identifica el número de una factura en un determinado año.

series
string (TicketbaiInvoiceIdentifier) [ 1 .. 20 ] characters ^[0-9A-Z_/\-\.]{1,20}$
Example: series=2022

Identifica el número de serie de una factura en un determinado año.

issued_at_from
string (TimestampFormat19) = 19 characters ^\d{2}-\d{2}-\d{4} \d{2}:\d{2}:\d{2}$
Example: issued_at_from=24-12-1992 15:35:01

Define la fecha más temprana posible de la factura (inclusive).

issued_at_to
string (TimestampFormat19) = 19 characters ^\d{2}-\d{2}-\d{4} \d{2}:\d{2}:\d{2}$
Example: issued_at_to=24-12-1992 15:35:01

Define la última fecha posible de la factura (exclusive).

client_id
string <uuid> (UniversallyUniqueIdentifierV4) [a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab...
Example: client_id=1c81cb86-c2e8-4074-afc3-a0601b2bf063

Define el identificador del cliente que emite una factura.

limit
integer (PaginationLimit) [ 1 .. 100 ]
Default: 10

Representa el límite de resultados por página para un endpoint de listado.

token
string (PaginationToken) <= 1024 characters ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{4}|[A-...

Representa el token de paginación, que se emplea como puntero hacia la siguiente página de resultados.

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "pagination": {
    }
}

Exportar factura

Este endpoint proporciona la funcionalidad de exportación sincrónica de una única factura y el estado de transmisión del archivo XML de solicitud/respuesta del registro de alta/anulación de TicketBAI.

Se recomienda utilizar este endpoint únicamente para inspeccionar una factura individual. Para exportar e inspeccionar varias facturas, utiliza la funcionalidad de exportación.

Authorizations:
JWT
path Parameters
client_id
required
string <uuid> (UniversallyUniqueIdentifierV4) [a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab...
Example: 1c81cb86-c2e8-4074-afc3-a0601b2bf063

Identifica un cliente de forma única con un identificador aleatorio en formato UUIDv4.

invoice_id
required
string <uuid> (UniversallyUniqueIdentifierV4) [a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab...
Example: 1c81cb86-c2e8-4074-afc3-a0601b2bf063

Identifica una factura con un identificador aleatorio en formato UUIDv4.

Responses

Response samples

Content type
application/json
{
  • "content": {
    }
}

Validación

Validar el NIF

Valida uno o más números de identificación fiscal contra la lista de contribuyentes registrados. El registro de la AEAT admite la validación de múltiples números de identificación fiscal españoles, mientras que el sistema VIES para contribuyentes de la UE no españoles sólo admite la validación de un número de identificación fiscal cada vez. Dado que varios sistemas permiten la validación de distintos tipos de NIF, por ejemplo el IVA o el NIF, estos tipos se resumen como NIF (Número de Identificación Fiscal).

Authorizations:
JWT
Request Body schema: application/json
required
required
any (TinValidationContent)

Según el servicio de validación utilizado, este endpoint requiere diferentes parámetros:

  • AEAT: Lista de entradas, compuesta por el número de identificación fiscal y el nombre legal, donde el nombre legal es opcional para las empresas.
  • VIES: Entrada única, compuesta por el número de identificación fiscal y el código de país.

Dado que el servicio de validación AEAT no tiene un punto final de prueba y el punto final de producción requiere un certificado oficial, este punto final devuelve INVALID para todos los números de identificación fiscal en TEST. Para permitir la prueba de integración, el tipo de validación AEAT devuelve los siguientes valores si se llama con números de identificación fiscal específicos en entornos TEST:

  • T00000001: INVALID_SIMILAR
  • T00000002: VALID
  • T00000003: VALID_REMOVED
  • T00000004: VALID_REVOKED

Responses

Request samples

Content type
application/json
{
  • "content": {
    }
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Exportar datos

Crear exportación

Este endpoint crea una exportación asíncrona de facturas para los criterios aplicados.

Authorizations:
JWT
path Parameters
export_id
required
string <uuid> (UniversallyUniqueIdentifierV4) [a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab...
Example: 1c81cb86-c2e8-4074-afc3-a0601b2bf063

Identifica una exportación con un identificador aleatorio en formato UUIDv4.

query Parameters
series
string (TicketbaiInvoiceIdentifier) [ 1 .. 20 ] characters ^[0-9A-Z_/\-\.]{1,20}$
Example: series=2022

Identifica el número de serie de una factura en un determinado año.

issued_at_from
string (TimestampFormat19) = 19 characters ^\d{2}-\d{2}-\d{4} \d{2}:\d{2}:\d{2}$
Example: issued_at_from=24-12-1992 15:35:01

Define la fecha más temprana posible de la factura (inclusive).

issued_at_to
string (TimestampFormat19) = 19 characters ^\d{2}-\d{2}-\d{4} \d{2}:\d{2}:\d{2}$
Example: issued_at_to=24-12-1992 15:35:01

Define la última fecha posible de la factura (exclusive).

client_id
string <uuid> (UniversallyUniqueIdentifierV4) [a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab...
Example: client_id=1c81cb86-c2e8-4074-afc3-a0601b2bf063

Define el identificador del cliente que emite una factura.

Request Body schema: application/json
required
object (Metadata) <= 20 properties

Puede emplear este parámetro para adjuntar datos en formato clave/valor al objeto.
Los metadatos son útiles para almacenar datos estructurados que complementan el objeto.

Se pueden adjuntar metadatos en los métodos de actualización de cada recurso. Si se incluye una clave con un valor vacío, se eliminará esa pareja clave/valor.

Si se adjuntan metadatos a un objeto, estos serán devueltos en las respuestas a peticiones de ese objeto.

Nota: Se pueden especificar hasta 20 claves, cada clave puede contener hasta 40 caracteres, y los valores pueden contener hasta 500 caracteres.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "metadata": {}
}

Actualizar exportación

Este endpoint permite actualizar los metadatos de una exportación.

Authorizations:
JWT
path Parameters
export_id
required
string <uuid> (UniversallyUniqueIdentifierV4) [a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab...
Example: 1c81cb86-c2e8-4074-afc3-a0601b2bf063

Identifica una exportación con un identificador aleatorio en formato UUIDv4.

Request Body schema: application/json
required
object (Metadata) <= 20 properties

Puede emplear este parámetro para adjuntar datos en formato clave/valor al objeto.
Los metadatos son útiles para almacenar datos estructurados que complementan el objeto.

Se pueden adjuntar metadatos en los métodos de actualización de cada recurso. Si se incluye una clave con un valor vacío, se eliminará esa pareja clave/valor.

Si se adjuntan metadatos a un objeto, estos serán devueltos en las respuestas a peticiones de ese objeto.

Nota: Se pueden especificar hasta 20 claves, cada clave puede contener hasta 40 caracteres, y los valores pueden contener hasta 500 caracteres.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "metadata": {}
}

Obtener una exportación

Este endpoint obtiene un recurso que proporciona el estado de la solicitud de exportación.

Authorizations:
JWT
path Parameters
export_id
required
string <uuid> (UniversallyUniqueIdentifierV4) [a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab...
Example: 1c81cb86-c2e8-4074-afc3-a0601b2bf063

Identifica una exportación con un identificador aleatorio en formato UUIDv4.

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "metadata": {}
}

Listar exportaciones

Este endpoint obtiene una lista de exportaciones solicitadas del contribuyente.

Authorizations:
JWT
query Parameters
limit
integer (PaginationLimit) [ 1 .. 100 ]
Default: 10

Representa el límite de resultados por página para un endpoint de listado.

token
string (PaginationToken) <= 1024 characters ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{4}|[A-...

Representa el token de paginación, que se emplea como puntero hacia la siguiente página de resultados.

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "pagination": {
    }
}

Descargar exportación

Este endpoint obtiene el archivo zip de una exportación.

Authorizations:
JWT
path Parameters
export_id
required
string <uuid> (UniversallyUniqueIdentifierV4) [a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab...
Example: 1c81cb86-c2e8-4074-afc3-a0601b2bf063

Identifica una exportación con un identificador aleatorio en formato UUIDv4.

Responses

Response samples

Content type
application/json
{
  • "content": {
    }
}

Was this page helpful?