docs.unidigital.global Open in urlscan Pro
34.227.189.194  Public Scan

Form analysis
0 forms found in the DOM

Text Content

Public


Documentation Settings

ENVIRONMENT
DI - Core Environment

LAYOUT
Single Column

LANGUAGE
cURL - cURL



DI - Core Documentacion
Introduction
Inicio de sesion y seguridad
Crear documentos
Números de control
Visualizar documentos
Búsquedas
Operaciones Básicas
Anular documentos
Otras operaciones
Preguntas Frecuentes


DI - CORE DOCUMENTACION

En esta documentación se describe la REST API de Facturación Digital, que
permite a los desarrolladores interactuar con la creación, anulación, busqueda y
distribución de documentos fiscales. Aquí encontrarás información detallada
sobre los recursos disponibles, los métodos admitidos, los parámetros de
solicitud y respuesta, y más.


INFORMACIÓN DE CONTACTO Y METADATOS

   

 * Empresa: Corporación Unidigital 1220 C.A

   

 * Propietario de la API: Corporación Unidigital 1220 C.A

   

 * Página web: https://www.unidigital.global

   

 * Soporte del API: api@unidigital.global

   

 * URL API - Ambiente de producción:
   https://www.unidigital.global/digitalinvoice-core

   

 * Sitio Web - Ambiente de producción:
   https://www.unidigital.global/digitalinvoice-portal/

   

 * URL API - Ambiente de pruebas:
   https://qa.unidigital.global/digitalinvoice-core

   

 * Sitio Web - Ambiente de pruebas:
   https://qa.unidigital.global/digitalinvoice-portal

   


ASPECTOS TÉCNICOS

¿POR QUÉ UN REST API?

En Unidigital, Imprenta Digital autorizada por el SENIAT hemos decidido ofrecer
nuestros servicios a través de un REST API que permita a todos nuestros clientes
construir experiencias basadas en tecnologías interconectadas donde los
diferentes Sistemas se puedan comunicar de manera transparente y eficiente.

Este documento te ayudará a interactuar con nuestra REST API para que puedas
conectar tu ERP, tu Sitio Web o Aplicación Móvil y así ofrecerle a tu cliente
una mejor experiencia al administrar sus documentos fiscales.

En la construcción de nuestra REST API valoramos mucho las sugerencias de los
desarrolladores que la utilizan, si tienes alguna puedes escribirnos a
api@unidigital.global

SOLICITUD DE ACCESO A EMPRESA SANDBOX

Lo primero que necesitas para usar el REST API es tener unas credenciales
asociadas a la Empresa SandBox, si no tienes credenciales puedes solicitarla
enviando un correo a api@unidigital.global indicando tu nombre, apellido, numero
de cedula, y los datos fiscales de la empresa que representas. Una vez validada
la información recibirás en tu correo las credenciales.

CODIGOS HTTP DE RESPUESTA

Las respuestas del API estan asociados a los estados HTTP

   

 * 200 OK: El servidor ha procesado la solicitud correctamente y ha retornado
   una respuesta exitosa.

   

 * 400 Bad Request: La solicitud no se pudo entender o estaba incompleta. Esta
   respuesta generalmente se asocia con un error en los datos enviados al
   servidor, algún campo requerido que no fue especificado o el incumplimiento
   de alguna regla de negocio como puede ser enviar un numero de documento
   repetido.

   

 * 401 Unauthorized: La solicitud requiere autenticación, pero el cliente no ha
   proporcionado credenciales válidas. Generalmente se debe a que el token no ha
   sido especificado en el header de la solicitud o simplemente que el token
   esta vencido.

   

 * 402 Not Found: La entidad buscada por el request no fue encontrada.

   

 * 500 Internal Server Error: Se ha producido un error en el servidor mientras
   procesaba la solicitud. Estos errores son los menos comunes, es importante
   que del lado del cliente sean logeados y notificados al equipo de Unidigital
   para su evaluación y correción inmediata.

   

Notas: para las respuestas con HTTP Status Code 400 el json de respuesta siempre
tendra la siguiente estructura

View More
javascript


{
    "result": null,
    "errors": [
        {
            "code": "0000",
            "message": "Mensaje explicativo del error",
            "extra": null
        }
    ],
    "success": [],
    "information": [],
    "haserrors": true
}

El campo errors es un arreglo que contiene una lista de todos los errores que
fueron detectados durante el procesamiento de la solicitud, se recomienda que
estos errores siempre sean logeados del lado del consumidor del API.

ENTIDADES PRINCIPALES DEL API

DOCUMENTO (DOCUMENT)

Representa un Documento generado por el Sistema Corporativo del Contribuyente,
por ejemplo una Factura, Nota de Crédito o Nota de Débito. Todo documento
siempre formará parte de un ciclo. Si el documento es creado bajo el concepto de
"Facturación en Linea" entonces se creará un ciclo por cada documento
transmitido al API, por el contrario si el documento es creado bajo el concepto
de "Facturación por Lotes" entonces se creará un ciclo que podra almacenar N
cantidad de documentos.

CICLO O LOTE (BATCH)

El Ciclo o Lote representa un elemento que permite agrupar uno o muchos
documentos y contiene información valiosa como puede ser el CurrentStatus
(Estatus actual), fecha de creación, fecha de asignación de documentos, etc.

Tabla de Estaus

Estatus Valor Comentario Open 1 Abierto, puede agregar documentos Closed 2
Cerrado, no puede recibir documentos Approved 3 Aprobado, en espera de
asignación de números de control Assigned 4 Asignado, ya los documentos le
fueron asignados los numeros de control y quedan como documentos fiscales
Canceled 5 Cancelado, los documentos del Ciclo seran eliminados, nunca seran
documentos fiscales


ASPECTOS GENERALES

DOCUMENTOS FISCALES SOPORTADOS (TIPOS DE DOCUMENTO)

Actualmente el Sistema soporta solo Facturas, Notas de Credito, Notas de Debito
y Guias de Despacho, estamos planeando agregar nuevos tipos de documentos.

NUMEROS DE DOCUMENTO

Cada documento emitido por la Empresa debe tener una numeración unica por tipo
de documento asi tenemos que por ejemplo si emitimos 3 facturas, 2 notas de
credito y 1 notas de debito, todos por primera vez las numeraciones quedarian de
la siguiente forma:

Tipo Fecha Numero Factura 01/01/2023 1 Factura 01/01/2023 2 Factura 01/01/2023 3
Nota de Crédito 01/01/2023 1 Nota de Crédito 01/01/2023 2 Nota de Débito
01/01/2023 1

Como verán en la tabla anterior cada tipo de documento tiene su propia
numeración, es decir su propio correlativo que en la medida que se emite el
documento debe incrementarse el número.

Esta responsabilidad de manejar la numeración del documento por ahora queda de
parte de la Empresa y no de la Imprenta Digital.

NUMEROS DE CONTROL

El número de control es un entero generado por la Imprenta Digital y asignado a
cada Documento fiscal emitido por la Empresa que contrata los servicios de
facturación digital. Este número es unico e irrepetible independientemente del
tipo de documento emitido.

Continuando con el ejemplo de Numeros de documento

Tipo Fecha Numero Numero de Control Factura 01/01/2023 1 1 Factura 01/01/2023 2
2 Factura 01/01/2023 3 3 Nota de Crédito 01/01/2023 1 4 Nota de Crédito
01/01/2023 2 5 Nota de Débito 01/01/2023 1 6

Como verán el numero de control es un correlativo independiente del número de
documento.

NOTA: La asignación de los números de control no son de manera inmediata, pueden
tardar en un intervalo de 1-5 minutos, asi está la asignación de números de
control ahorita pero, estamos mejorando cada día más para que los números de
control se asignen de forma inmediata.

TALONARIOS DIGITALES

La imprenta para gestionar los números de control utiliza la figura de
talonarios digitales, los cuales agrupan una cantidad de numeros de control que
sirven generalmente para cubrir el consumo de un mes de facturación.

Los talonarios digitales son la representación digital de los talonarios de
formas libres que comunmente se utilizan con las imprentas tradicionales. Todo
talonario tiene una fecha de creación, un rango de numeros de control y una
serie asociada.

Los talonarios estan asociados a una serie, como veremos mas adelante toda
Empresa tiene al menos una serie asociada que llamaremos serie en blanco o serie
0 (cero) las cuales representan un nivel de agrupación para los numeros de
documentos.

SERIES DE FACTURACIÓN

Cuando una empresa tiene varios sistemas, o varias lineas de negocio, surge la
necesidad de crear series de facturación. Las series de facturación permiten
asociar una cantidad de numeros de control con una serie, por defecto al
registrar la empresa dentro de la plataforma una serie en blanco es asociada
automaticamente, de manera que todos los numeros de control creados se haran
bajo esa serie.

Si la empresa necesita tener mas de una serie, entonces la nueva serie se
iniciara con la letra A.

Para la creación de series debe plantear su caso al departamento Legal de
Unidigital y luego de la aprobación sera creada la serie dentro del sistema.

Continuando con el ejemplo para una Empresa que tiene la serie por defecto
quedaria asi

Tipo Fecha Numero Numero de Control Serie Factura 01/01/2023 1 1 0 Factura
01/01/2023 2 2 0 Factura 01/01/2023 3 3 0 Nota de Crédito 01/01/2023 1 4 0 Nota
de Crédito 01/01/2023 2 5 0 Nota de Débito 01/01/2023 1 6 0

Como verán todos los documentos pertenecen a la Serie 0 (Cero) como le llamamos
en Unidigital. La Serie 0 es la serie por defecto que se crea para todas las
Empresas.

En la sección de talonarios digitales comentamos que todo talonario esta
asociado a una serie, esto quiere decir que si la Empresa tiene mas de una serie
entonces un talonario digital al ser creado debera especificarse para que serie
se necesita.

Supongamos que tenemos dos talonarios digitales, cada uno de 10 numeros de
control, uno asociado para la serie 0 y otro para la serie A. Los talonarios se
verian asi:

Serie Numero de Control Desde Numero de Control Hasta 0 1 10 A 11 20

Estos talonarios pueden ser usados en paralelo, y la creación de la serie
permite que tengamos nuevos consecutivos para los tipos de documentos. Usemos un
ejemplo para entender.

Ahora que tenemos dos talonarios una para la serie 0 y otro para la serie A,
queremos crear 3 facturas para la serie 0, 2 notas de debito para la serie 0, 5
facturas para la serie A y 5 notas de credito para la serie A, ¿Como quedarian
los numeros de documentos y numeros de control? Observemos:

View More

Tipo Fecha Numero de Documento Numero de Control Serie Factura 01/01/2023 1 1 0
Factura 01/01/2023 2 2 0 Factura 01/01/2023 3 3 0 Nota de Débito 01/01/2023 1 4
0 Nota de Débito 01/01/2023 2 5 0 Factura 01/01/2023 1 11 A Factura 01/01/2023 2
12 A Factura 01/01/2023 3 13 A Factura 01/01/2023 4 14 A Factura 01/01/2023 5 15
A Nota de Crédito 01/01/2023 1 16 A Nota de Crédito 01/01/2023 2 17 A Nota de
Crédito 01/01/2023 3 18 A Nota de Crédito 01/01/2023 4 19 A Nota de Crédito
01/01/2023 5 20 A

Si observan con detalle, la numeración de los documentos por serie y por tipo de
documento es independiente pudiendo entonces tener una factura con numero 1 para
la serie 0 y tambien en la serie A. Adicionalmente los numeros de control se van
usando en la medida que son requeridos por la serie, sin embargo estos nunca se
repiten.

NOTAS

   
 * En la mayoria de los casos una Serie sera suficiente para cubrir las
   necesidades de las empresas.