Irene Solutions SL
Adelante

Quickstart: Empieza con DeCA


Genera y almacena documentos electrónicos de control administrativo mediante una sencilla llamada a nuestra API REST.

  1. Envía los datos del documento
    Utiliza el endpoint de guardado para crear un nuevo DeCA o una nueva versión de un documento existente.
  2. Valida tu integración
    Comprueba las peticiones y respuestas en este entorno antes de utilizar el servicio en producción.

Entorno de Pruebas


Realiza todas las pruebas necesarias en un entorno seguro.

  • Los documentos generados en este entorno no tienen validez legal.
  • Las fechas de los ejemplos se actualizan automáticamente al momento actual.


Soporte y Sugerencias


Para cualquier consulta escríbenos a info@irenesolutions.com.

Gracias por confiar en DeCA.


1. Guardado de un documento DeCA


El mismo endpoint permite crear un documento nuevo o guardar una nueva versión de un documento existente.

El Endpoint para guardar un documento es:

https://facturae.irenesolutions.com:8050/Kivu/Transport/DeCA/Documents/Save

Método:

POST

Body JSON ( No requerido encabezado Authorization, ServiceKey en body):

Pruebalo tu mismo

Datos de acceso
Seleccione el Endpoint a probar, pulse 'Ejecutar' y vea el resultado de la llamada POST

Puede editar el JSON de entrada para ver los distintos resultados:

Ejecutar
Descargar

Documentos


Esta sección se habilitará cuando estén disponibles los endpoints de consulta, carga de versiones y descarga de documentos.

Modelo de datos


El endpoint Documents.Save recibe las propiedades de un objeto Document junto con la propiedad ServiceKey. La colección Document.Parties contiene los interlocutores, establecimientos y lugares que intervienen en el transporte.

Leyenda

Obligatoria Automática Solo lectura Opcional No incluida en JSON

Document

Representa un Documento Electrónico de Control Administrativo para el transporte público de mercancías por carretera.

Propiedad Tipo Uso Descripción
OwnerPartyIDstringObligatoriaIdentificador del interlocutor que representa a la empresa propietaria del documento en el sistema de origen.
DeCAIDstringAutomáticaIdentificador único del documento electrónico de control. En una creación debe omitirse; para modificar un documento existente debe enviarse el identificador ya asignado.
DocumentNumberstringOpcionalNúmero o referencia visible del documento. Si no se informa, el sistema utiliza el mismo valor que DeCAID.
VersionintAutomática en modificaciónNúmero de versión del documento. No puede ser negativo. En las modificaciones se calcula a partir de las versiones ya almacenadas.
StatusstringAutomáticaIdentificador del estado del documento. Al guardar se establece como DEFINITIVO.
CreationDateTimeDateTime?AutomáticaFecha y hora de creación. En una modificación se conserva la fecha de creación de la primera versión.
ModificationDateTimeDateTime?AutomáticaFecha y hora de la última modificación del documento.
IssueDateTimeDateTime?ObligatoriaFecha y hora de emisión definitiva. Debe ser anterior al inicio efectivo del transporte y determina el ejercicio de almacenamiento y numeración.
IssueYearstringSolo lecturaAño obtenido de IssueDateTime.
TransportDateDateTimeDato del documentoFecha prevista o efectiva del transporte.
TransportStartDateTimeDateTime?OpcionalFecha y hora de inicio efectivo del transporte.
TransportEndDateTimeDateTime?OpcionalFecha y hora de finalización del transporte.
PartiesList<Party>ObligatoriaColección de interlocutores de negocio, establecimientos y lugares. Debe contener una única aparición de los roles obligatorios CC, TE, OR y DE.
GoodsDescriptionstringObligatoriaDescripción general de la naturaleza de la mercancía.
GoodsQuantitydecimalOpcionalCantidad total de la mercancía.
GoodsQuantityUnitCodestringOpcionalCódigo de unidad de medida de la cantidad de mercancía. Ejemplos: KGM, TNE, LTR o MTQ.
GrossWeightdecimal?ObligatoriaPeso bruto total expresado en kilogramos. Debe ser mayor que cero.
IsDangerousGoodsboolDato del documentoIndica si la mercancía está sometida a la normativa ADR.
TractorRegistrationNumberstringOpcionalMatrícula del vehículo tractor.
TrailerRegistrationNumberstringOpcionalMatrícula del remolque o semirremolque.
SecondTrailerRegistrationNumberstringOpcionalMatrícula de un segundo remolque, cuando corresponda.
SpecialCirculationAuthorizationNumberstringOpcionalNúmero de la autorización especial de circulación, cuando resulte necesaria.
RemarksstringOpcionalObservaciones, reservas o indicaciones adicionales.
ModificationReasonstringModificaciónMotivo de la última modificación del documento.
PreviousDeCAIDstringOpcionalIdentificador del documento anterior cuando el documento constituye una nueva versión o sustitución.
FileNamestringAutomáticaNombre del fichero PDF generado.
FileSizelong?AutomáticaTamaño del fichero PDF definitivo en bytes.
FileHashstringAutomáticaHash SHA-256 calculado sobre los bytes del fichero PDF definitivo.
DownloadURLstringAutomáticaURL HTTPS única que permite descargar directamente el PDF. Debe omitirse en la entrada porque la asigna el servidor.
QRCodeValuestringAutomáticaContenido incorporado al código QR. Normalmente coincide con DownloadURL.
DownloadAvailableFromDateTimeDateTime?AutomáticaFecha y hora desde la que el documento está disponible mediante la URL de descarga.
DownloadAvailableUntilDateTimeDateTime?AutomáticaFecha y hora hasta la que el documento estará disponible mediante la URL de descarga.
SourceSystemstringOpcionalNombre o identificador del sistema de origen. Ejemplos: SAP, Wefinz o integración API.
SourceDocumentIDstringOpcionalIdentificador de la expedición, entrega o transporte en el sistema de origen.
CreatedBystringOpcionalUsuario o proceso que creó el documento.
ModifiedBystringOpcionalUsuario o proceso que realizó la última modificación.
SourcePdfTemplatebyte[]No incluida en JSONDatos binarios de una plantilla PDF alternativa utilizada por la librería .NET para generar el PDF definitivo.
SourcePdfFileNamestringNo incluida en JSONNombre del archivo de la plantilla PDF alternativa utilizada para generar el documento.
QRCodebyte[]No incluida en JSONImagen binaria del código QR generada por la librería. En la respuesta del endpoint de guardado se expone mediante Return.QRCode.

Party

Representa un interlocutor de negocio, establecimiento o lugar relacionado con el transporte. Su función se identifica mediante PartyRole.

Propiedad Tipo Uso Descripción
PartyRolestringObligatoriaCódigo que identifica la función del interlocutor, establecimiento o lugar dentro del transporte.
PartyIDstringOpcionalIdentificador del interlocutor de negocio en el sistema de origen.
FullNamestringOpcionalNombre, razón social o denominación asignada al interlocutor o lugar.
TaxIDstringOpcionalCódigo de identificación fiscal.
AddressstringOpcionalDirección postal o descripción de la ubicación.
CitystringOpcionalPoblación.
PostalCodestringOpcionalCódigo postal.
RegionstringOpcionalCódigo o denominación de la región; por ejemplo, la provincia.
CountryIDstringOpcionalCódigo de país ISO-3166; por ejemplo, ES.
MailstringOpcionalDirección principal de correo electrónico.
MobilestringOpcionalNúmero de teléfono móvil.
PhonestringOpcionalNúmero de teléfono fijo.
StatusstringOpcionalIdentificador del estado interno del interlocutor.

PartyRole

Valores admitidos en la propiedad Party.PartyRole. Los roles CC, TE, OR y DE son obligatorios y solo pueden aparecer una vez en la colección Parties.

Código Rol Uso Descripción
CCCargador contractualObligatorio · únicoEmpresa o persona que contrata el transporte.
TETransportista efectivoObligatorio · únicoEmpresa que realiza materialmente el transporte.
EXExpedidor o cargador efectivoOpcionalInterlocutor o establecimiento que entrega físicamente la mercancía para su transporte.
DSDestinatario de la mercancíaOpcionalEmpresa o persona destinataria de la mercancía.
OROrigenObligatorio · únicoLugar, establecimiento o interlocutor de origen del transporte.
DEDestinoObligatorio · únicoLugar, establecimiento o interlocutor de destino del transporte.
OTOtrosOpcionalOtros interlocutores relacionados con el transporte que no encajan en los roles anteriores.

EX y DS representan intervinientes, mientras que OR y DE representan el origen y el destino. Aunque puedan coincidir en un transporte concreto, se mantienen como conceptos independientes.

DeCA