Bienvenido a la documentación de la API de Datamart. Esta API le dará la posibilidad de conectar sus aplicaciones informáticas a diferentes servicios de Datamart para la sincronización de documentos tributarios, cesiones electrónicas, información de morosidad, comportamiento de pago y riesgo, reportes tributarios, entre otros.
La interacción con el API se realiza sobre conexiones seguras utilizando el protocolo HTTPS. Las solicitudes sobre HTTP no serán aceptadas y la respuesta indicará que se debe volver a realizar la misma solicitud sobre HTTPS. Las peticiones y respuestas se envían con formato JSON de acuerdo a los parámetros de cada método, y estas últimas se devuelven bajo códigos de estado HTTP. De forma general, 200 indica que la solicitud fue satisfactoria, 40X errores controlados y 500 cuando ocurre algún error no controlado. Se recomienda incluir el encabezado Content-Type: application/json en todas las solicitudes que envíen contenido en el cuerpo de la misma.
POST /rtt-sync/v1/subscriptions/1L/2B
Host: https://homo.api.datamart.pe
x-api-key: c40e7d1e28b94bdeb2dd16a736f09b16
Content-Type: application/json
{
"atributo": "valor"
}
GET /sentinel-sync/download/1L/2B
Host: https://homo.api.datamart.pe
x-api-key: c40e7d1e28b94bdeb2dd16a736f09b16
Las respuestas no satisfactorias utilizan códigos de estado HTTP para indicar el tipo de error ocurrido. El cuerpo de respuesta JSON puede contener un código de nivel superior y un mensaje con una descripción detallada del problema. Cada API describe detalladamente los posibles códigos de estado HTTP, el formato JSON de la respuesta, así como los diferentes códigos de nivel superior que puede responder.
Ejemplo error de validación (HTTP 400)
{
"Codigo":"1"
"Mensaje": "Se requiere la numeración de la factura"
}
Ejemplo error ApiKey incorrecta (HTTP 403)
{
"message": "Forbidden"
}
Errores comunes Los siguientes códigos de respuesta HTTP son comunes a todas las APIs.
HTTP Status | Descripción |
---|---|
400 | El cuerpo de la solicitud contiene una sintaxis incorrecta o está incompleta. |
400 | Errores de validación presentes. Vea la lista de errores de nivel superior para más detalles. (Vea abajo) |
403 | ApiKey incorrecta. |
403 | La URL solicitada está incorrecta. |
500 | Se produjo un error no controlado en la API. |
504 | No se pudo obtener respuesta en el tiempo esperado. |
Errores de validación Las respuestas con un código de nivel superior se devuelven cuando es posible corregir un problema específico en la solicitud. La respuesta incluirá un mensaje descriptivo de los problemas detectados y un código para facilitar el tratamiento al problema. La siguiente lista describe códigos de nivel superior comunes que pueden responder todas las APIs. Cada API describe detalladamente los posibles códigos de estado HTTP, el formato JSON de la respuesta, así como los diferentes códigos de nivel superior que puede responder.
Ejemplo de respuesta para una solicitud con credenciales inválidas:
{
"Codigo":"65",
"Mensaje": "Credenciales inválidas"
}
En Datamart disponemos de dos ambientes de trabajo, un ambiente de homologación sobre el que se pueden probar todas las integraciones a los diferentes servicios, y un ambiente que producción que una vez terminado el desarrollo se puede comenzar a consumir análogo al ambiente productivo. De esta forma el desarrollo de nuevas funcionalidades o integraciones no afecta el ambiente de producción.
Todos los servicios están disponibles en el ambiente de homologación y con las mismas funcionalidades. Para realizar solicitudes a las diferentes APIs solo se debe modificar el Host y ApiKey según el ambiente en que se desee operar.
Homologación: https://homo.api.datamart.pe.
Producción: https://api.datamart.pe.
Para identificar y autorizar el acceso a las APIs se utiliza autorización por ApiKey.
Las ApiKeys de acceso pueden ser recuperadas y configuradas desde el Portal de Clientes. Cada ApiKey es configurada para ser utilizada en el ambiente de homologación o producción, para cada ambiente se obtendrá una ApiKey privada para autorizar todas las solicitudes. Debe asegurarse de proteger y nunca compartir los ApiKeys ya que tienen acceso a todos los datos de su cuenta.
La mayoría de los servicios envían notificaciones a los clientes sobre los datos que procesan. Estas notificaciones pueden ocurrir vía correo electrónico o webhook, a través del Portal de Clientes los clientes pueden seleccionar las configuraciones sobre cómo desea que ello ocurra y los métodos de seguridad que emplean.
Datamart Connect es la solución que permite integrar de manera sencilla la interacción que posibilita que un titular de los datos comparta la información solicitada de manera rápida y segura. La aplicación expone un pequeño workflow donde el usuario final navega por las etapas de Identificación, Consentimiento y Obtención de Datos Distintivos.
Para incorporar el botón de Connect a su sitio web en modalidad Button deberá seguir los pasos siguientes:
Etiqueta para agregar el botón: agregue este texto donde desee que se renderice el botón.
<datamart-button>
Código para insertar en su sitio: agregue este código después de la etiqueta body de su sitio.
<script src="https://homo.connect.datamart.co/js/datamart-button.js"></script>
Código para insertar en tu HTML: agregue este código donde desee mostrar el botón
<datamart-button connectid="0*******c"></datamart-button>
Tener en cuenta que connectid="0*******c"
deberá corresponderse con el identificador asignado al botón creado para su uso.
El formato de renderización del botón se encuentra asociado al connectid
, siendo estos los formatos disponibles.
Nota Los scripts de código asociados al botón se generarán automáticamente al finalizar el wizard de configuración.
Atributos generales para configurar el botón
El atributo connectid
es utilizado para identificar de manera única cada conexión asociada al botón de Connect.
El atributo subscribername
se utiliza para identificar a la empresa o la persona que se va a suscribir a la conexión.
El atributo subscriberid
es utilizado para identificar al suscriptor (RUT en Chile/RUC en Perú).
El atributo authorizername
se refiere al nombre del contacto que va a suscribirse a los servicios para los que fue configurada la conexión.
El atributo authorizeremail
es el correo asociado a la persona de contacto.
El atributo authorizermobile
es el número de teléfono asociado a la persona de contacto.
El atributo nodocument
es el identificador personal de un susbcriptor, digase número de DNI o de cédula.
El atributo validatesubscription
se utiliza para verificar el estado del suscriptor. Puede tomar los valores "true" o "false", en caso de que el valor sea "true", verificará el estado de la suscripción y las posibles respuestas son: "suscrito", "no suscrito", "actualizar credenciales" o "aceptar términos".
Los datos relativos al authorizername
, authorizeremail
y authorizermobile
, son requeridos para identificar a la persona que acepta los términos y condiciones.
Atributos opcionales para personalizar el estilo del botón
El botón tomará por defecto el diseño que le haya sido definido al momento de su configuración; sin embargo, admitirá que le sean pasados los siguientes parámetros que cambiarán su forma de renderización.
Al abrir, la app de suscripción se desplegará en una nueva pestaña manteniendo la comunicación con el sitio que lo invocó a través de un socket; mediante el cual ambas aplicaciones podrán comprender la condición en la que se encuentran.
onstatuschange: este evento se ejecuta cuando ocurre alguna acción dentro del widget. Cuando este evento se dispara, se envía un mensaje con el nombre del evento que ha ocurrido.
Aquí tienes una lista de los posibles eventos que pueden ocurrir dentro del widget:
Cuando se dispara alguno de estos eventos, se envía un mensaje con la siguiente estructura: { eventName: 'NOMBRE_DEL_EVENTO' }. El valor de 'NOMBRE_DEL_EVENTO' será el nombre del evento que ha ocurrido.
Puedes utilizar estos eventos y sus respectivos mensajes para realizar acciones específicas dentro de tu aplicación en respuesta a las interacciones del usuario con el widget de suscripción.
const element = document.createElement("datamart-button");
element.addEventListener('onstatuschange', (e) => {
console.log('--------->onstatuschange', e);
});
oninitialized: este evento ocurre cuando comienza el proceso de suscripción. Puede utilizarse para realizar alguna acción específica al inicio del proceso de suscripción.
Puedes utilizar este evento para realizar acciones específicas al inicio del proceso de suscripción, como mostrar un mensaje de bienvenida, realizar alguna validación adicional o cualquier otra acción que desees realizar en ese momento.
El mensaje enviado con este evento tiene la siguiente estructura: { eventName: 'initialized' }.
Aquí tienes un ejemplo de cómo puedes escuchar este evento y realizar una acción específica cuando se dispare:
element.addEventListener('oninitialized', (e) => {
console.log('--------->oninitialized', e);
});
onuserclose: este evento ocurre cuando el usuario cierra el widget sin haber completado completamente el flujo de suscripción. Puede utilizarse para realizar alguna acción específica cuando esto sucede.
Puedes utilizar este evento para realizar acciones específicas cuando el usuario cierra el widget sin completar la suscripción, como mostrar un mensaje de despedida, guardar el progreso realizado hasta el momento o cualquier otra acción que desees realizar en ese momento.
El mensaje enviado con este evento es un valor booleano.
Aquí tienes un ejemplo de cómo puedes escuchar este evento y realizar una acción específica cuando se dispare:
element.addEventListener('onuserclose', (e) => {
console.log('--------->onuserclose', e);
});
onsuccess: este evento se ejecuta cuando el botón verifica la suscripción del subscriberid y como resultado determina que el usuario está suscrito. Este evento puede ocurrir al principio cuando el usuario ya estaba previamente suscrito, o cuando se cierra el widget y el usuario se suscribe correctamente.
Puedes utilizar este evento para realizar acciones específicas cuando se verifica la suscripción del usuario, como mostrar un mensaje de confirmación, redirigir a una página de agradecimiento o cualquier otra acción que desees realizar en ese momento.
El mensaje enviado con este evento es un valor booleano.
Aquí tienes un ejemplo de cómo puedes escuchar este evento y realizar una acción específica cuando se dispare:
element.addEventListener('onsuccess', (e) => {
console.log('--------->onsuccess', e);
});
oninactivity: este evento se ejecuta cuando el usuario se mantiene inactivo por al menos 5 minutos, con la app de suscripción abierta en el navegador.
Puedes utilizar este evento para realizar acciones específicas cuando el usuario se mantiene inactivo por un período de tiempo determinado, como mostrar un mensaje de advertencia, cerrar la app de suscripción o cualquier otra acción que desees realizar en ese momento.
El mensaje enviado con este evento es un valor booleano.
Aquí tienes un ejemplo de cómo puedes escuchar este evento y realizar una acción específica cuando se dispare:
element.addEventListener('oninactivity', (e) => {
console.log('--------->oninactivity', e);
});
onunauthorized: este evento se ejecuta cuando se integra la conexión desde un dominio no autorizado.
Puedes utilizar este evento para realizar acciones específicas cuando la conexión se integra desde un dominio no autorizado, como mostrar un mensaje de error, redirigir a una página de error o cualquier otra acción que desees realizar en ese momento.
El mensaje enviado con este evento es un valor booleano.
Aquí tienes un ejemplo de cómo puedes escuchar este evento y realizar una acción específica cuando se dispare:
element.addEventListener('onunauthorized', (e) => {
console.log('--------->onunauthorized', e);
});
onbadconfiguration: este evento se ejecuta cuando existe algún error en la configuración de la conexión.
Puedes utilizar este evento para realizar acciones específicas cuando se produce un error en la configuración de la conexión, como mostrar un mensaje de error, realizar alguna acción de recuperación o cualquier otra acción que desees realizar en ese momento.
El mensaje enviado con este evento es un valor booleano.
Aquí tienes un ejemplo de cómo puedes escuchar este evento y realizar una acción específica cuando se dispare:
element.addEventListener('onbadconfiguration', (e) => {
console.log('--------->onbadconfiguration', e);
});
onconectionnotready: este evento se ejecuta cuando la conexión se encuentra en proceso de creación, y aún no se encuentra lista para ser utilizada.
Puedes utilizar este evento para realizar acciones específicas cuando la conexión aún no está lista para ser utilizada, como mostrar un mensaje de espera, deshabilitar ciertas funcionalidades o cualquier otra acción que desees realizar en ese momento.
El mensaje enviado con este evento es un valor booleano.
Aquí tienes un ejemplo de cómo puedes escuchar este evento y realizar una acción específica cuando se dispare:
element.addEventListener('onconnectionnotready', (e) => {
console.log('--------->onconnectionnotready', e);
});
oninvalidsuscriberid: este evento se ejecuta cuando el RUT del suscriptor no es válido.
Puedes utilizar este evento para realizar acciones específicas cuando el RUT del suscriptor no es válido, como mostrar un mensaje de error, solicitar al usuario que ingrese un RUT válido o cualquier otra acción que desees realizar en ese momento.
El mensaje enviado con este evento es un valor booleano.
Aquí tienes un ejemplo de cómo puedes escuchar este evento y realizar una acción específica cuando se dispare:
element.addEventListener('oninvalidsubscriberid', (e) => {
console.log('--------->oninvalidsubscriberid', e);
});
oninvalidtoken: este evento se ejecuta cuando se envía un token inválido.
Puedes utilizar este evento para realizar acciones específicas cuando se envía un token inválido, como mostrar un mensaje de error, solicitar al usuario que ingrese un token válido o cualquier otra acción que desees realizar en ese momento.
El mensaje enviado con este evento es un valor booleano.
Aquí tienes un ejemplo de cómo puedes escuchar este evento y realizar una acción específica cuando se dispare:
element.addEventListener('oninvalidtoken', (e) => {
console.log('--------->oninvalidtoken', e);
});
onunknownerror: este evento se ejecuta cuando se desencadena un error desconocido.
Puedes utilizar este evento para realizar acciones específicas cuando se produce un error desconocido, como mostrar un mensaje de error genérico, registrar el error para su posterior análisis o cualquier otra acción que desees realizar en ese momento.
El mensaje enviado con este evento es un valor booleano.
Aquí tienes un ejemplo de cómo puedes escuchar este evento y realizar una acción específica cuando se dispare:
element.addEventListener('onunknownerror', (e) => {
console.log('--------->onunknownerror', e);
});
onvalidationerror: este evento se ejecuta cuando se desencadena un error de validación.
Puedes utilizar este evento para realizar acciones específicas cuando se produce un error de validación, como mostrar un mensaje de error al usuario, resaltar los campos inválidos o cualquier otra acción que desees realizar en ese momento.
El mensaje enviado con este evento es un valor booleano.
Aquí tienes un ejemplo de cómo puedes escuchar este evento y realizar una acción específica cuando se dispare:
element.addEventListener('onvalidationerror', (e) => {
console.log('--------->onvalidationerror', e);
});
onapikeyrequired: esto evento se ejecuta cuando se requiere una clave de API.
Puedes utilizar este evento para realizar acciones específicas cuando se requiere una clave de API, como mostrar un mensaje al usuario solicitando la clave, redirigir a una página de configuración de la clave de API o cualquier otra acción que desees realizar en ese momento.
El mensaje enviado con este evento es un valor booleano.
Aquí tienes un ejemplo de cómo puedes escuchar este evento y realizar una acción específica cuando se dispare:
element.addEventListener('onapikeyrequired', (e) => {
console.log('--------->onapikeyrequired', e);
});
onexceededquota: este evento se ejecuta cuando se excede la cantidad de suscripciones permitidas.
Puedes utilizar este evento para realizar acciones específicas cuando se excede la cantidad de suscripciones permitidas, como mostrar un mensaje de error al usuario, limitar la funcionalidad del botón o cualquier otra acción que desees realizar en ese momento.
El mensaje enviado con este evento es un valor booleano.
Aquí tienes un ejemplo de cómo puedes escuchar este evento y realizar una acción específica cuando se dispare:
element.addEventListener('onexceededquota', (e) => {
console.log('--------->onexceededquota', e);
});
onsuscriberstatuschange: este evento se ejecuta cuando cambia el estado del botón de acuerdo al estado del suscriptor.
Puedes utilizar este evento para realizar acciones específicas cuando cambia el estado del botón de acuerdo al estado del suscriptor, como actualizar la interfaz de usuario para reflejar el nuevo estado, mostrar mensajes informativos al usuario o cualquier otra acción que desees realizar en ese momento.
El mensaje enviado con este evento puede tener diferentes valores, como "Verificando", "NoSuscrito", "ActualizarCredenciales", "ActualizarTerminos" o "Suscrito".
Aquí tienes un ejemplo de cómo puedes escuchar este evento y realizar una acción específica cuando se dispare:
element.addEventListener('onsubscriberstatuschange', (e) => {
console.log('--------->onsubscriberstatuschange', e);
});
onsessionoperations: este evento se ejecuta para mostrar las operaciones que se van realizando durante una sesión.
Puedes utilizar este evento para mostrar las operaciones que se van realizando durante una sesión, como obtener el ID del suscriptor, compartir información de contacto, seleccionar documentos para suscribirse, actualizar términos, completar la sesión, entre otras operaciones.
El mensaje enviado con este evento puede tener diferentes valores, como "started_session", "get_subscriber_id", "shared_contact_info", "selected_documents_to_subscribe", "updated_terms" o "completed_session".
Aquí tienes un ejemplo de cómo puedes escuchar este evento y realizar una acción específica cuando se dispare:
element.addEventListener('onsessionoperations', (e) => {
console.log('--------->onsessionoperations', e);
});
Con el fin de mejorar la experiencia de uso, en caso de que el botón reciba como parámetro el subscriberid, la aplicación validará el estado de la suscripción de los servicios que se encuentran configurados para ese connectid. El proceso de validación sólo se ejecutará en caso de que el botón tenga activada la propiedad de validatesubscription y al invocarlo se envíe un subscriberid válido.
El resultado de este proceso condicionará el despliegue del mensaje del botón de Datamart Connect.
Caso | Estado suscripción | Estado credencial | Aceptación de Términos de uso | Despliegue |
---|---|---|---|---|
1 | Suscrito a todos los servicios | Válida | Aceptados | |
2 | Actualizar credenciales | Inválida | Aceptados | |
3 | Suscrito a todos los servicios | Válida | No aceptados | |
4 | No suscrito a alguno de los servicios | - | - |
En el caso de los clientes que hayan realizado procesos de suscripción a los diferentes servicios configurados en el botón, desde otras vías previas a la implementación de Connect; deberán tener en cuenta que el botón mostrará el estado: acepte los nuevos términos y condiciones. Para estos casos, si el cliente así lo considerase, podría solicitar la generación de una versión de migración de los Términos de uso. Esta versión hará referencia a la aprobación previa de los Términos por parte del cliente a través de otras plataformas; sin necesidad de solicitarles nuevamente su aprobación.
En el caso de que se desee emplear la misma configuración de servicios y finalidades a suscribir, se recomienda que se ocupe un único botón. Cada botón constituye una aplicación, por lo que tiene definidos sus propios Términos de uso. Si se emplean varios botones, los clientes que hayan sido suscritos por un botón, deberán aceptar nuevamente los términos de uso al usar un nuevo botón.
Servicio que permite la suscripción a los servicios de datamart: Sincronización de Comprobante de Pagos Electrónicos(CPESync), Reporte Tributario para Terceros en SUNAT(RTT), Balances Financieros registrados en SUNAT(BalanceSheet), Información sobre Deudas Tributarias sin pagar(CoerciveDebt), Registro Centralizado de Facturas Negociables(Factrack), Descarga de información del Bureau de Crédito Sentinel(Sentinel), Declaraciones y pagos registrados en SUNAT(DecPagos), Información general del contribuyente Ficha RUC(Rucfolder), Información de Administradora de Fondos de Pensiones(AFPSync); así como generar los consentimientos de Políticas de Privacidad y de Términos y Condiciones.
Petición para crear un token de acceso
Tipo required | string |
IdConexion required | string |
Servidor de Homologación
Servidor de Producción
{- "Tipo": "Conexion",
- "IdConexion": "9b7056b0-9136-4e7d-ad37-64603f2fc937"
}
{- "Codigo": "0",
- "Mensaje": "",
- "Data": {
- "TokenId": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJBbG...",
- "TokenAcceso": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJBbG...",
- "TokenRefrescar": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJBbG..."
}
}
Petición para obtener la información asociada a una conexión.
customer-code required | any Ejemplo: DATAMART Código del cliente en Datamart |
connection-id required | any Ejemplo: 9b7056b0-9136-4e7d-ad37-64603f2fc937 Id de la conexión |
Servidor de Homologación
Servidor de Producción
curl --request GET \ --url 'https://homo.api.datamart.pe/v1/customers/{customer-code}/connections/{connection-id}' \ --header 'x-dm-connect-token: {CONNECT-TOKEN}'
{- "Codigo": "0",
- "Mensaje": "",
- "Conexion": {
- "Estado": "Listo",
- "Documentos": [
- {
- "Codigo": "Cpe",
- "Nombre": "Comprobante de Pagos Electrónico",
- "Obligatorio": false
}, - {
- "Codigo": "Rtt",
- "Nombre": "Reporte Tributario para Terceros",
- "Obligatorio": true
}, - {
- "Codigo": "Bsh",
- "Nombre": "Balances Financieros",
- "Obligatorio": false
}, - {
- "Codigo": "DeudaCoactiva",
- "Nombre": "Deuda Coactiva",
- "Obligatorio": false
}, - {
- "Codigo": "Factrack",
- "Nombre": "Factrack",
- "Obligatorio": false
}
], - "FormularioDeContacto": [
- {
- "Id": "Empresa",
- "Descripcion": "Empresa o Personas que tributan en Primera Categoría",
- "Campos": [
- {
- "Llave": "IdSuscriptor",
- "Etiqueta": "Ruc",
- "Ejemplo": "2040045032",
- "Descripcion": "Identificador de empresa",
- "TextoDeAyuda": "Identificador de empresa",
- "Obligatorio": true,
- "Formato": "Ruc"
}, - {
- "Llave": "Nombre",
- "Etiqueta": "Nombre de contacto",
- "Ejemplo": "Jose Perez Perez",
- "Descripcion": "Nombre de contacto",
- "TextoDeAyuda": "En caso de que tengamos una consulta",
- "Obligatorio": true,
- "Formato": "Texto"
}, - {
- "Llave": "Correo",
- "Etiqueta": "Email",
- "Ejemplo": "joseperez@gmail.com",
- "Descripcion": "Correo Electrónico",
- "TextoDeAyuda": "En caso de que debamos contactarnos contigo",
- "Obligatorio": true,
- "Formato": "Correo"
}, - {
- "Llave": "Telefono",
- "Etiqueta": "Teléfono móvil",
- "Ejemplo": "51 9981XXXX",
- "Descripcion": "Teléfono móvil",
- "TextoDeAyuda": "En caso de que debamos contactarnos contigo",
- "Obligatorio": true,
- "Formato": "Telefono"
}
]
}, - {
- "Id": "Persona",
- "Descripcion": "Personas que tributan en Primera Categoría",
- "Campos": [
- {
- "Llave": "IdSuscriptor",
- "Obligatorio": true,
- "Opciones": [
- {
- "Llave": "RUC",
- "Etiqueta": "Ruc",
- "Ejemplo": "2040045032",
- "Descripcion": "Identificador de empresa",
- "TextoDeAyuda": "Identificador de empresa",
- "Formato": "Ruc"
}, - {
- "Llave": "DNI",
- "Etiqueta": "DNI",
- "Ejemplo": "123456789",
- "Descripcion": "Identificador de la persona",
- "TextoDeAyuda": "Identificador de la persona",
- "Formato": "DNI"
}
]
}, - {
- "Llave": "Nombre",
- "Etiqueta": "Nombre de contacto",
- "Ejemplo": "Jose Perez Perez",
- "Descripcion": "Nombre de contacto",
- "TextoDeAyuda": "En caso de que tengamos una consulta",
- "Obligatorio": true,
- "Formato": "Texto"
}, - {
- "Llave": "Correo",
- "Etiqueta": "Email",
- "Ejemplo": "joseperez@gmail.com",
- "Descripcion": "Correo Electrónico",
- "TextoDeAyuda": "En caso de que debamos contactarnos contigo",
- "Obligatorio": true,
- "Formato": "Correo"
}, - {
- "Llave": "Telefono",
- "Etiqueta": "Teléfono móvil",
- "Ejemplo": "51 9981XXXX",
- "Descripcion": "Teléfono móvil",
- "TextoDeAyuda": "En caso de que debamos contactarnos contigo",
- "Obligatorio": true,
- "Formato": "Telefono"
}
]
}
], - "TouTerminos": {
- "Id": "0dc7eb66-210a-4dcc-8785-ec496c552858",
}, - "TouPoliticas": {
- "Id": "d273ed10-6c21-4a47-8d9e-359203829a32",
}
}
}
Petición para obtener una vista previa de la política de privacidad de los datos.
customer-code required | any Ejemplo: DATAMART Código del cliente en Datamart |
connection-id required | any Ejemplo: 9b7056b0-9136-4e7d-ad37-64603f2fc937 Id de la conexión |
no-markup | any Ejemplo: no-markup=true Tipo de salida, si el valor es |
Servidor de Homologación
Servidor de Producción
curl --request GET \ --url 'https://homo.api.datamart.pe/v1/customers/{customer-code}/connections/{connection-id}/privacy-politics-preview' \ --header 'x-dm-connect-token: {CONNECT-TOKEN}'
{- "Codigo": "0",
- "Mensaje": "",
- "VistaPrevia": "\n\t<style type=\"text/css\">\n\t\t@page { size: 21.59cm 27.94cm; margin-left: 3cm; margin-right: 3cm; margin-top: 2.5cm; margin-bottom: 2.5cm }\n\t\tp { margin-bottom: 0.25cm; direction: ltr; line-height: 115%; text-align: left; orphans: 2; widows: 2 }\n\t</style>\n\n<p style=\"margin-bottom: 0cm; line-height: 100%\"><font size=\"4\" style=\"font-size: 14pt\"><b>Datamart\n</b></font>\n</p>\n<br>\n<p style=\"margin-bottom: 0cm; line-height: 106%\">Datamart SpA, con\ndomicilio en Alonso de Monroy 2869, oficina 201 ..."
}
Petición para obtener vista previa de las finalidades de los datos.
customer-code required | any Ejemplo: DATAMART Código del cliente en Datamart |
connection-id required | any Ejemplo: 9b7056b0-9136-4e7d-ad37-64603f2fc937 Id de la conexión |
Servidor de Homologación
Servidor de Producción
curl --request GET \ --url 'https://homo.api.datamart.pe/v1/customers/{customer-code}/connections/{connection-id}/terms-finalities-preview' \ --header 'x-dm-connect-token: {CONNECT-TOKEN}'
{- "Codigo": 200,
- "Finalidades": {
- "Nombre": "DATAMART-CL-DATAMART_360_PUBLIC-9b7056b0-9136-4e7d-ad37-64603f2fc937",
- "Para": "www.datamart.cl",
- "VersionAnterior": "43215a36-7689-987c-9b40-10a6f4213576",
- "TermsConnect": {
- "comunicacion_con_terceros_empresas": [ ],
- "derechos_correo": "derechos@datamart.co",
- "mandato_especial_tipo_negocio": "Factoring",
- "preguntas_correo": "preguntas@datamart.co",
- "propiedad_de_los_datos_finalidad": "estos términos y condiciones de uso"
}
}, - "Mensaje": ""
}
Petición para obtener una vista previa de los términos y condiciones dado una selección de documentos.
customer-code required | any Ejemplo: DATAMART Código del cliente en Datamart |
connection-id required | any Ejemplo: 9b7056b0-9136-4e7d-ad37-64603f2fc937 Id de la conexión |
no-markup | any Ejemplo: no-markup=true Tipo de salida, si el valor es |
documents | any Ejemplo: documents=Cpe,Rtt,Bsh,DeudaCoactiva,Factrack Los códigos de los documentos separados por comas. Si no se especifica entonces se asumen todos los documentos en la vista previa. Los documentos obligatorios siempre se asumen. |
Servidor de Homologación
Servidor de Producción
curl --request GET \ --url 'https://homo.api.datamart.pe/v1/customers/{customer-code}/connections/{connection-id}/terms-preview' \ --header 'x-dm-connect-token: {CONNECT-TOKEN}'
{- "Codigo": "0",
- "Mensaje": "",
- "VistaPrevia": "\n\t<style type=\"text/css\">\n\t\t@page { size: 21.59cm 27.94cm; margin-left: 3cm; margin-right: 3cm; margin-top: 2.5cm; margin-bottom: 2.5cm }\n\t\tp { margin-bottom: 0.25cm; direction: ltr; line-height: 115%; text-align: left; orphans: 2; widows: 2 }\n\t</style>\n\n<p style=\"margin-bottom: 0cm; line-height: 100%\"><font size=\"4\" style=\"font-size: 14pt\"><b>Datamart\n</b></font>\n</p>\n<br>\n<p style=\"margin-bottom: 0cm; line-height: 106%\">Datamart SpA, con\ndomicilio en Alonso de Monroy 2869, oficina 201 ..."
}
Petición para obtener las credenciales requeridas dado una selección de documentos.
customer-code required | any Ejemplo: DATAMART Código del cliente en Datamart |
connection-id required | any Ejemplo: 9b7056b0-9136-4e7d-ad37-64603f2fc937 Id de la conexión |
documents | any Ejemplo: documents=Cpe,Rtt,Bsh,DeudaCoactiva,Factrack Los códigos de los documentos separados por comas |
supportedCredentials | any Ejemplo: supportedCredentials=ClaveSol,ClaveSolDNI Los códigos de las credenciales soportadas separadas por comas |
Servidor de Homologación
Servidor de Producción
curl --request GET \ --url 'https://homo.api.datamart.pe/v1/customers/{customer-code}/connections/{connection-id}/required-credentials' \ --header 'x-dm-connect-token: {CONNECT-TOKEN}'
{- "Codigo": 0,
- "Mensaje": "",
- "ConfiguracionesDeCredencialesSoportadas": [
- {
- "Codigo": "ClaveSol",
- "Nombre": "Clave Sol",
- "Campos": [
- {
- "Llave": "Usuario",
- "Etiqueta": "Usuario",
- "Ejemplo": "jose",
- "Descripcion": "Usuario",
- "TextoDeAyuda": "Usuario",
- "Formato": "Texto",
- "Secreto": false,
- "Cifrado": false
}, - {
- "Llave": "Clave",
- "Etiqueta": "Clave Sol",
- "Ejemplo": "",
- "Descripcion": "",
- "TextoDeAyuda": "",
- "Formato": "TextoExtenso",
- "Secreto": true,
- "Cifrado": true
}
]
}, - {
- "Codigo": "ClaveSolDNI",
- "Nombre": "Clave Sol Dni",
- "Campos": [
- {
- "Llave": "DNI",
- "Etiqueta": "DNI",
- "Ejemplo": "12345678",
- "Descripcion": "DNI",
- "TextoDeAyuda": "DNI",
- "Formato": "Texto",
- "Secreto": false,
- "Cifrado": false
}, - {
- "Llave": "Clave",
- "Etiqueta": "Clave Sol",
- "Ejemplo": "",
- "Descripcion": "",
- "TextoDeAyuda": "",
- "Formato": "TextoExtenso",
- "Secreto": true,
- "Cifrado": true
}
]
}
], - "AlternativasDeCredencialesPorDocumentos": [
- {
- "CodigoDocumento": "Cpe",
- "Alternativas": [
- {
- "Credenciales": [
- "ClaveSol"
]
}
]
}, - {
- "CodigoDocumento": "Rtt",
- "Alternativas": [
- {
- "Credenciales": [
- "ClaveSol"
]
}
]
}, - {
- "CodigoDocumento": "Bsh",
- "Alternativas": [
- {
- "Credenciales": [
- "ClaveSol"
]
}
]
}, - {
- "CodigoDocumento": "DeudaCoactiva",
- "Alternativas": [
- {
- "Credenciales": [
- "ClaveSol"
]
}
]
}, - {
- "CodigoDocumento": "Rucfolder",
- "Alternativas": [
- {
- "Credenciales": [
- "ClaveSol"
]
}
]
}
]
}
Petición para obtener el estado actual de un suscriptor para una conexión.
customer-code required | any Ejemplo: DATAMART Código del cliente en Datamart |
connection-id required | any Ejemplo: 9b7056b0-9136-4e7d-ad37-64603f2fc937 Id de la conexión |
subscriber-id required | any Ejemplo: 2040045032 Id del suscriptor |
Servidor de Homologación
Servidor de Producción
curl --request GET \ --url 'https://homo.api.datamart.pe/v1/customers/{customer-code}/connections/{connection-id}/subscribers/{subscriber-id}' \ --header 'x-dm-connect-token: {CONNECT-TOKEN}'
{- "Codigo": "0",
- "Mensaje": "",
- "EstadoDeSuscriptor": {
- "Documentos": [
- {
- "Codigo": "Cpe",
- "Obligatorio": false,
- "Estado": "Actualizando"
}, - {
- "Codigo": "Rtt",
- "Obligatorio": true,
- "Estado": "Actualizando"
}, - {
- "Codigo": "Bsh",
- "Obligatorio": false,
- "Estado": "Actualizando"
}, - {
- "Codigo": "DeudaCoactiva",
- "Obligatorio": false,
- "Estado": "Actualizando"
}, - {
- "Codigo": "Factrack",
- "Obligatorio": false,
- "Estado": "Actualizando"
}
], - "EstadoDeConsentimiento": {
- "VersionTou": "0dc7eb66-210a-4dcc-8785-ec496c552858",
- "Documentos": [
- "Cpe",
- "Rtt",
- "Bsh",
- "DeudaCoactiva",
- "Factrack"
], - "Consentimiento": {
- "Estado": "Listo",
- "Id": "de47bbb2-c812-428c-92ac-fc395c21eb47",
}
}
}
}
Petición para crear una sesión.
customer-code required | any Ejemplo: DATAMART Código del cliente en Datamart |
connection-id required | any Ejemplo: 9b7056b0-9136-4e7d-ad37-64603f2fc937 Id de la conexión |
subscriber-id required | any Ejemplo: 2040045032 Id del suscriptor |
IpClienteWeb | string <IPV4 | IPV6> |
object Los datos de contacto. | |
Arreglo de objects Códigos de los documentos para actualizar consentimiento o actualizar suscripción. | |
object Un objeto donde las llaves son los códigos de las credenciales y los valores son objetos json con las llaves y valores de los campos requeridos por la credencial. | |
ActualizarSuscriptor | string Enum: "ActualizarConsentimiento" "Actualizar" "Eliminar" ActualizarConsentimiento: Genera el consentimiento. |
Servidor de Homologación
Servidor de Producción
{- "IpClienteWeb": "10.2.3.4",
- "InformacionDeContacto": {
- "IdSuscriptor": "2040045032",
- "Nombre": "Jose Perez Perez",
- "Correo": "joseperez@gmail.com",
- "Telefono": "+5112453256"
}, - "Documentos": [
- {
- "Codigo": "Cpe",
- "ExtrasNotificacion": {
- "Llave1": "Valor2"
}, - "SegmentosDeSuscripcion": [
- "seller-pe"
]
}, - {
- "Codigo": "Cpe"
}, - {
- "Codigo": "Rtt"
}, - {
- "Codigo": "Bsh"
}, - {
- "Codigo": "DeudaCoactiva"
}
], - "ActualizarSuscriptor": "ActualizarConsentimiento"
}
{- "Codigo": "0",
- "Mensaje": "",
- "IdSesion": "476d45ac-9b3b-407f-8bdc-6445ea2fc99b"
}
Petición para obtener el estado de una sesión.
customer-code required | any Ejemplo: DATAMART Código del cliente en Datamart |
connection-id required | any Ejemplo: 9b7056b0-9136-4e7d-ad37-64603f2fc937 Id de la conexión |
subscriber-id required | any Ejemplo: 2040045032 Id del suscriptor |
session-id required | any Ejemplo: 476d45ac-9b3b-407f-8bdc-6445ea2fc99b Id de la sesión |
Servidor de Homologación
Servidor de Producción
curl --request GET \ --url 'https://homo.api.datamart.pe/v1/customers/{customer-code}/connections/{connection-id}/subscribers/{subscriber-id}/sessions/{session-id}' \ --header 'x-dm-connect-token: {CONNECT-TOKEN}'
{- "Codigo": "0",
- "Mensaje": "",
- "Sesion": {
- "Id": "476d45ac-9b3b-407f-8bdc-6445ea2fc99b",
- "IdSuscriptor": "2040045032",
- "Estado": "Completada",
- "Activa": true,
- "FechaDeCreacion": "2021-04-01T17:59:41",
- "IpClienteWeb": "10.2.3.4",
- "CredencialesCompartidas": [
- {
- "Codigo": "ClaveSol",
- "Estado": "Correcta"
}
], - "Documentos": [
- {
- "Codigo": "Cpe",
- "ExtrasNotificacion": {
- "some-key": "some-value",
- "some-key2": [
- "a",
- "b"
]
}, - "SegmentosDeSuscripcion": [
- "abcd-pe",
- "ghij-pe"
], - "RecuperarDatos": true,
- "FormatoEntrega": "JSON"
}, - {
- "Codigo": "Cpe"
}, - {
- "Codigo": "Rtt"
}, - {
- "Codigo": "Bsh"
}, - {
- "Codigo": "DeudaCoactiva"
}
], - "InformacionDeContacto": {
- "Correo": "joseperez@gmail.com",
- "IdSuscriptor": "2040045032",
- "Nombre": "Jose Perez Perez",
- "Telefono": "+5112345678"
}, - "VersionTouPoliticasDePrivacidad": "d273ed10-6c21-4a47-8d9e-359203829a32",
- "VersionTouTerminosYCondiciones": "0dc7eb66-210a-4dcc-8785-ec496c552858",
- "ConsentimientoPoliticasDePrivacidad": {
- "Estado": "Generando",
- "Id": null,
- "Url": null
}, - "ConsentimientoTerminosYCondiciones": {
- "Estado": "Listo",
- "Id": "de47bbb2-c812-428c-92ac-fc395c21eb47",
}, - "RecuperacionDeDocumentos": [
- {
- "Codigo": "Cpe",
- "Estado": "Completado",
- "Datos": null,
- "Documentos": null
}
]
}
}
Petición para actualizar el estado de una sesión.
customer-code required | any Ejemplo: DATAMART Código del cliente en Datamart |
connection-id required | any Ejemplo: 9b7056b0-9136-4e7d-ad37-64603f2fc937 Id de la conexión |
subscriber-id required | any Ejemplo: 2040045032 Id del suscriptor |
session-id required | any Ejemplo: 476d45ac-9b3b-407f-8bdc-6445ea2fc99b Id de la sesión |
IpClienteWeb | string <IPV4 | IPV6> |
object Los datos de contacto. | |
Arreglo de objects Códigos de los documentos para actualizar consentimiento o actualizar suscripción. | |
object Un objeto donde las llaves son los códigos de las credenciales y los valores son objetos json con las llaves y valores de los campos requeridos por la credencial. | |
ActualizarSuscriptor | string Enum: "ActualizarConsentimiento" "Actualizar" "Eliminar" ActualizarConsentimiento: Genera el consentimiento. |
Servidor de Homologación
Servidor de Producción
{- "IpClienteWeb": "10.2.3.4",
- "InformacionDeContacto": {
- "IdSuscriptor": "2040045032",
- "Nombre": "Jose Perez Perez",
- "Correo": "joseperez@gmail.com",
- "Telefono": "+5112453256"
}, - "Documentos": [
- {
- "Codigo": "Cpe",
- "ExtrasNotificacion": {
- "Llave1": "Valor2"
}, - "SegmentosDeSuscripcion": [
- "seller-pe"
]
}, - {
- "Codigo": "Cpe"
}, - {
- "Codigo": "Rtt"
}, - {
- "Codigo": "Bsh"
}, - {
- "Codigo": "DeudaCoactiva"
}
], - "ActualizarSuscriptor": "ActualizarConsentimiento"
}
{- "Codigo": "0",
- "Mensaje": ""
}
Petición para obtener documento recuperado.
customer-code required | any Ejemplo: DATAMART Código del cliente en Datamart |
connection-id required | any Ejemplo: 9b7056b0-9136-4e7d-ad37-64603f2fc937 Id de la conexión |
subscriber-id required | any Ejemplo: 2040045032 Id del suscriptor |
session-id required | any Ejemplo: 476d45ac-9b3b-407f-8bdc-6445ea2fc99b Id de la sesión |
document-code required | any Ejemplo: Cpe Código del documento |
Servidor de Homologación
Servidor de Producción
curl --request GET \ --url 'https://homo.api.datamart.pe/v1/customers/{customer-code}/connections/{connection-id}/subscribers/{subscriber-id}/sessions/{session-id}/documents/{document-code}' \ --header 'x-dm-connect-token: {CONNECT-TOKEN}'
{- "Codigo": "0",
- "Mensaje": "",
- "Estado": "Completado",
- "Datos": null,
- "Documentos": null
}
Servicio de sincronización para las AFP. Para una AFP suscrita al servicio, permite a sus afiliados obtener la información
asociada a sus fondos de pensiones y los certificados que tengan disponibles.
Código de AFPs
Este servicio funciona para las siguientes AFPs, junto con las credenciales necesarias para cada una.
Tipo de AFP | Credenciales | |
---|---|---|
Usuario | Clave | |
Prima | DNI | Clave AFP DNI |
Habitat | DNI | Clave AFP DNI |
Carnet de Extranjería | Clave AFP CE | |
Lib. Adolesc. Trab. | Clave AFP LAT | |
Pasaporte | Clave AFP PAS |
Notificaciones
El servicio permite recibir vía webhook o por correo electrónico notificaciones con la información del afiliado.
El siguiente modelo representa los datos enviados en la notificación.
DNI | string Identificador |
EnlaceJson | string <url> Enlace para descarga del documento en formato JSON |
TipoAfp | string Enum: "Prima" "Habitat" Nombre de la AFP asociada al cliente
|
FechaGeneracion | string <date-time> Indica la fecha en que se obtuvo el documento |
Extras | object Datos adicionales enviados en la notificación |
Servicio | string Código del servicio que envía la notificación |
Notificacion | string Código de la notificación |
{- "DNI": "11111111",
- "TipoAfp": "Prima",
- "FechaGeneracion": "2023-05-24T10:48",
- "Extras": null,
- "Servicio": "AFPService",
- "Notificacion": "AFP_ACTUALIZADA"
}
Permite realizar la subscripción al servicio de AFP Perú.
x-api-key required | text Ejemplo: AbhCM24Zz123Y22aa5TTbnn55Yay700a5Y5Oo00 ApiKey del cliente |
x-dmrt-susbscriber-segment | any Ejemplo: personas Segmento(s) de la subscripción. Un segmento indica, por ejemplo, el área de negocio al que pertenece el subscriptor. |
x-dmrt-customer-id required | any Ejemplo: 1-0 Identificador del cliente |
required | object (CredencialesAFP) |
TipoAfp required | string Enum: "Prima" "Habitat" Nombre de la AFP asociada al cliente
|
SubscriptorId required | string identificador de la subscripción |
VigenciaSubscripcion | string Enum: "Indefinida" "Transitoria" Indica la vigencia de la subscripción.
|
ExtrasNotificacion | object |
Servidor de Homologación
Servidor de Producción
{- "CredencialesAutenticacion": {
- "Usuario": "usuario",
- "Password": "Pas$$w0rd",
- "Tipo": "ClaveAfpDNI"
}, - "TipoAfp": "Prima",
- "SubscriptorId": "1-8",
- "VigenciaSubscripcion": "Indefinida",
- "ExtrasNotificacion": null
}
{- "Codigo": "0",
- "Mensaje": "Empresa subscrita al servicio"
}
Permite actualizar la subscripción al servicio.
x-api-key required | text Ejemplo: AbhCM24Zz123Y22aa5TTbnn55Yay700a5Y5Oo00 ApiKey del cliente |
x-dmrt-susbscriber-segment | any Ejemplo: personas Segmento(s) de la subscripción. Un segmento indica, por ejemplo, el área de negocio al que pertenece el subscriptor. |
x-dmrt-customer-id required | any Ejemplo: 1-0 Identificador del cliente |
required | object (CredencialesAFP) |
TipoAfp required | string Enum: "Prima" "Habitat" Nombre de la AFP asociada al cliente
|
SubscriptorId required | string identificador de la subscripción |
VigenciaSubscripcion | string Enum: "Indefinida" "Transitoria" Indica la vigencia de la subscripción.
|
ExtrasNotificacion | object |
Servidor de Homologación
Servidor de Producción
{- "CredencialesAutenticacion": {
- "Usuario": "usuario",
- "Password": "Pas$$w0rd",
- "Tipo": "ClaveAfpDNI"
}, - "TipoAfp": "Prima",
- "SubscriptorId": "1-8",
- "VigenciaSubscripcion": "Indefinida",
- "ExtrasNotificacion": null
}
{- "Codigo": "0",
- "Mensaje": "Empresa subscrita al servicio"
}
Permite realizar la subscripción al servicio de AFP Perú.
x-api-key required | text Ejemplo: AbhCM24Zz123Y22aa5TTbnn55Yay700a5Y5Oo00 ApiKey del cliente |
x-dmrt-susbscriber-segment | any Ejemplo: personas Segmento(s) de la subscripción. Un segmento indica, por ejemplo, el área de negocio al que pertenece el subscriptor. |
x-dmrt-customer-id required | any Ejemplo: 1-0 Identificador del cliente |
required | object (CredencialesAFP) |
TipoAfp required | string Enum: "Prima" "Habitat" Nombre de la AFP asociada al cliente
|
SubscriptorId required | string identificador de la subscripción |
VigenciaSubscripcion | string Enum: "Indefinida" "Transitoria" Indica la vigencia de la subscripción.
|
ExtrasNotificacion | object |
Servidor de Homologación
Servidor de Producción
{- "CredencialesAutenticacion": {
- "Usuario": "usuario",
- "Password": "Pas$$w0rd",
- "Tipo": "ClaveAfpDNI"
}, - "TipoAfp": "Prima",
- "SubscriptorId": "1-8",
- "VigenciaSubscripcion": "Indefinida",
- "ExtrasNotificacion": null
}
{- "RequestId": "abccc2a1x-i1e5-12a3-a234-u5cof4c98765",
- "Codigo": "0",
- "Mensaje": "Se realizo correctamente la peticion a keyshield para que valide las credenciales"
}
Permite actualizar la subscripción al servicio.
x-api-key required | text Ejemplo: AbhCM24Zz123Y22aa5TTbnn55Yay700a5Y5Oo00 ApiKey del cliente |
x-dmrt-susbscriber-segment | any Ejemplo: personas Segmento(s) de la subscripción. Un segmento indica, por ejemplo, el área de negocio al que pertenece el subscriptor. |
x-dmrt-customer-id required | any Ejemplo: 1-0 Identificador del cliente |
required | object (CredencialesAFP) |
TipoAfp required | string Enum: "Prima" "Habitat" Nombre de la AFP asociada al cliente
|
SubscriptorId required | string identificador de la subscripción |
VigenciaSubscripcion | string Enum: "Indefinida" "Transitoria" Indica la vigencia de la subscripción.
|
ExtrasNotificacion | object |
Servidor de Homologación
Servidor de Producción
{- "CredencialesAutenticacion": {
- "Usuario": "usuario",
- "Password": "Pas$$w0rd",
- "Tipo": "ClaveAfpDNI"
}, - "TipoAfp": "Prima",
- "SubscriptorId": "1-8",
- "VigenciaSubscripcion": "Indefinida",
- "ExtrasNotificacion": null
}
{- "RequestId": "abccc2a1x-i1e5-12a3-a234-u5cof4c98765",
- "Codigo": "0",
- "Mensaje": "Se realizo correctamente la peticion a keyshield para que valide las credenciales"
}
Permite eliminar la subscripción al servicio.
subscriptor-id required | string Ejemplo: 1-8 identificador de la subscripción |
x-api-key required | text Ejemplo: AbhCM24Zz123Y22aa5TTbnn55Yay700a5Y5Oo00 ApiKey del cliente |
x-dmrt-susbscriber-segment | any Ejemplo: personas Segmento(s) de la subscripción. Un segmento indica, por ejemplo, el área de negocio al que pertenece el subscriptor. |
x-dmrt-customer-id required | any Ejemplo: 1-0 Identificador del cliente |
TipoAfp required | string Enum: "Prima" "Habitat" Nombre de la AFP asociada al cliente
|
Servidor de Homologación
Servidor de Producción
{- "TipoAfp": "Prima"
}
Respuesta satisfactoria
{- "Codigo": "0",
- "Mensaje": "Subscripción eliminada"
}
Permite iniciar la ejecución del servicio para actualizar los datos.
subscriptor-id required | string Ejemplo: 1-8 identificador de la subscripción |
tipo-afp | string Ejemplo: tipo-afp=Prima Nombre de la AFP asociada al usuario
|
x-api-key required | text Ejemplo: AbhCM24Zz123Y22aa5TTbnn55Yay700a5Y5Oo00 ApiKey del cliente |
x-dmrt-customer-id required | any Ejemplo: 1-0 Identificador del cliente |
Servidor de Homologación
Servidor de Producción
curl --request GET \ --url 'https://homo.api.datamart.pe/afp/v1/sync/{subscriptor-id}?tipo-afp=SOME_STRING_VALUE' \ --header 'x-api-key: {API_KEY_CLIENTE}'
{- "Codigo": "0",
- "Mensaje": "Sincronización iniciada"
}
Permite descargar la información asociada a la AFP del usuario.
subscriptor-id required | string Ejemplo: 1-8 identificador de la subscripción |
output | string Enum: "file" "inline" Ejemplo: output=inline Indica la salida de los datos, en el cuerpo de la respuesta o un enlace a un
archivo externo. Su valor por defecto es |
generation-date | string Ejemplo: generation-date=20230508041500 Fecha de generación del documento en formato |
tipo-afp | string Ejemplo: tipo-afp=Prima Nombre de la AFP asociada al usuario
|
x-api-key required | text Ejemplo: AbhCM24Zz123Y22aa5TTbnn55Yay700a5Y5Oo00 ApiKey del cliente |
x-dmrt-customer-id required | any Ejemplo: 1-0 Identificador del cliente |
Servidor de Homologación
Servidor de Producción
curl --request GET \ --url 'https://homo.api.datamart.pe/afp/v1/document/{subscriptor-id}?output=SOME_STRING_VALUE&generation-date=SOME_STRING_VALUE&tipo-afp=SOME_STRING_VALUE' \ --header 'x-api-key: {API_KEY_CLIENTE}'
Documento en cuerpo
{- "FileBase64": null,
- "EnlaceJson": null,
- "FechaGeneracion": "2023-05-19T15:23",
- "AfpData": {
- "InformacionPersonal": {
- "IdAfiliado": "",
- "IdAplicante": null,
- "TipoDocumento": "DNI",
- "CodigoDocumento": "00",
- "NumeroDocumento": "01234567",
- "Nombre": "NOMBRE",
- "SegundoNombre": "SEGUNDONOMBRE",
- "ApellidoPadre": "APELLIDO1",
- "ApellidoMadre": "APELLIDO2",
- "Genero": "MALE",
- "EstadoMatrimonio": "MALE",
- "FechaNacimiento": "1992-05-20",
- "Celular": "999999999",
- "TelefonoFijo": null,
- "Correo": "nombre_a@correo.com",
- "Edad": "30",
- "PaisNacimiento": "114",
- "Discapacidad": false,
- "Fallecido": false,
- "EnActualizacion": null,
- "EnActivacion": null,
- "Activo": null,
- "IndMigrado": null,
- "IdSolicitudValidacionReniec": null,
- "IdSolicitudValidacionBiometrica": null,
- "IndConsultaReniec": null,
- "IndReniecValidada": null,
- "Companias": null,
- "FechaEntradaSpp": "dd/mm/yyyy",
- "FechaRegistroPPD": null,
- "Jubilado": "N"
}, - "ResumenFondo": {
- "ContribucionTotal": "48,002.68",
- "JubilacionTotal": "40,689.00",
- "GananciaTotal": "2,578.09",
- "AhorroTotal": "9,891.77",
- "CuotaTotal": "219.2948930",
- "Retenciones": "0",
- "Contribuciones": [
- {
- "CodigoContribucion": "OBL",
- "TipoContribucion": "Obligatorio",
- "TotalContribucion": "47,911.84",
- "TotalCargos": "",
- "TotalJubilacion": "40,689.00",
- "TotalGanancia": "2,580.15",
- "TotalAhorro": "9,802.99",
- "TotalCuota": "217.1501485",
- "TotalSinAfecto": "9,802.93",
- "TotalComision": "1,922.78",
- "TipoFondo": "Fondo de Crecimiento",
- "NumeroTransaccion": null
}, - {
- "CodigoContribucion": "CFP",
- "TipoContribucion": "Con Fin Previsional",
- "TotalContribucion": "0.00",
- "TotalCargos": "0.00",
- "TotalJubilacion": "0.00",
- "TotalGanancia": "0.00",
- "TotalAhorro": "0.00",
- "TotalCuota": "0.0000000",
- "TotalSinAfecto": "",
- "TotalComision": "0.00",
- "TipoFondo": "Fondo de Crecimiento",
- "NumeroTransaccion": null
}
]
}, - "ListaDetallesMovimientoPorContribucion": [
- {
- "CodigoContribucion": "OBL",
- "Detalles": [
- {
- "Periodo": "04/2023",
- "FechaTransaccion": "dd/04/2023",
- "ConceptoTransaccion": "Administración del Fondo",
- "FondoTransaccion": "3",
- "CuotasTransaccion": "-0.17765920",
- "MontoCuotas": "45.28945810",
- "MontoRam": "0.00",
- "MontoComision": "0.00",
- "MontoSeguro": "0.00",
- "MontoTotal": "-7.85",
- "Compania": "",
- "NumeroDocumento": null,
- "DescripcionTransaccion": null,
- "Indicador": null
}, - {
- "Periodo": "03/2023",
- "FechaTransaccion": "dd/03/2023",
- "ConceptoTransaccion": "Aporte a su Fondo",
- "FondoTransaccion": "3",
- "CuotasTransaccion": "64.70706360",
- "MontoCuotas": "44.53408700",
- "MontoRam": "0.00",
- "MontoComision": "0.00",
- "MontoSeguro": "210.24",
- "MontoTotal": "2,881.67",
- "Compania": "BANCO",
- "NumeroDocumento": null,
- "DescripcionTransaccion": null,
- "Indicador": null
}
]
}, - {
- "CodigoContribucion": "CFP",
- "Detalles": [ ]
}, - {
- "CodigoContribucion": "SFP",
- "Detalles": [
- {
- "Periodo": "",
- "FechaTransaccion": "dd/01/2022",
- "ConceptoTransaccion": "Acreditación por Fusión / Partición de Cuentas",
- "FondoTransaccion": "2",
- "CuotasTransaccion": "2.14424390",
- "MontoCuotas": "42.35662700",
- "MontoRam": null,
- "MontoComision": null,
- "MontoSeguro": null,
- "MontoTotal": "90.82",
- "Compania": null,
- "NumeroDocumento": "",
- "DescripcionTransaccion": null,
- "Indicador": "0"
}
]
}, - {
- "CodigoContribucion": "FFLEX",
- "Detalles": [ ]
}
]
}, - "Codigo": "0",
- "Mensaje": null
}
Permite realizar el proceso de descarga del certificado indicado.
subscriptor-id required | string Ejemplo: 1-8 identificador de la subscripción |
x-api-key required | text Ejemplo: AbhCM24Zz123Y22aa5TTbnn55Yay700a5Y5Oo00 ApiKey del cliente |
x-dmrt-customer-id required | any Ejemplo: 1-0 Identificador del cliente |
required | object (CredencialesAFP) |
TipoAfp required | string Enum: "Prima" "Habitat" Nombre de la AFP asociada al cliente
|
TipoCertificado | string Enum: "Afiliacion" "Seguro" "Sunat" Indica el tipo de certificado solicitado
|
Servidor de Homologación
Servidor de Producción
{- "CredencialesAutenticacion": {
- "Usuario": "usuario",
- "Password": "Pas$$w0rd",
- "Tipo": "ClaveAfpDNI"
}, - "TipoAfp": "Prima",
- "TipoCertificado": "Afiliacion"
}
{- "RequestId": "abccc2a1x-i1e5-12a3-a234-u5cof4c98765",
- "Codigo": "0",
- "Mensaje": "Se realizo correctamente la peticion del certificado"
}
Permite obtener el certificado.
subscriptor-id required | string Ejemplo: 1-8 identificador de la subscripción |
RequestId required | string Ejemplo: abccc2a1x-i1e5-12a3-a234-u5cof4c98765 Identificador para las solicitudes |
x-api-key required | text Ejemplo: AbhCM24Zz123Y22aa5TTbnn55Yay700a5Y5Oo00 ApiKey del cliente |
Servidor de Homologación
Servidor de Producción
curl --request GET \ --url 'https://homo.api.datamart.pe/afp/v1/certificate/async/{subscriptor-id}/{RequestId}/status' \ --header 'x-api-key: {API_KEY_CLIENTE}'
{- "Codigo": "0",
- "Mensaje": "",
- "TipoCertificado": "Afiliacion",
- "TipoAfp": "Prima",
- "Estado": "Completado"
}
RequestId required | string Ejemplo: abccc2a1x-i1e5-12a3-a234-u5cof4c98765 Identificador para las solicitudes |
x-api-key required | text Ejemplo: AbhCM24Zz123Y22aa5TTbnn55Yay700a5Y5Oo00 ApiKey del cliente |
Servidor de Homologación
Servidor de Producción
curl --request GET \ --url 'https://homo.api.datamart.pe/afp/v1/subscriptions/async/{RequestId}/status' \ --header 'x-api-key: {API_KEY_CLIENTE}'
{- "Codigo": "0",
- "Mensaje": "",
- "Estado": "Completado"
}
Servicio de sincronización de Comprobante de Pago Electrónicos (CPEs) en formato XML y JSON desde la SUNAT y proveedores de factura electrónica.
Para una empresa subscrita al servicio, periódicamente y de forma automática se notifica vía webhook o por correo
electrónico cuando la empresa subscrita ha emitido o recibido un CPE.
Notificaciones
El servicio permite notificar vía webhook o por correo electrónico notificaciones con los documentos emitidos
y recibidos para una empresa. Se incluye un parámetro type
en la URL del webhook para indicar el tipo de notificación enviada.
type=CPE_SINCRONIZADO
.El campo Version es un indicador sustancial en la notificación. Este campo indica el origen de sincronización del documento, y en base a este origen la información notificada varia en los documentos enviados siendo Json para el caso Version = 0 y Json, XML, PDF para el caso Version = 1. Ademas los campos TipoCPE y TipoCPEDesc también varian de acuerdo al tipo de Version a continuación ambas opciones.
Versión 0 | Versión 1 | ||
---|---|---|---|
TipoCPE | TipoCPEDesc | TipoCPE | TipoCPEDesc |
00 | Otros | 01 | Factura Electrónica |
01 | Factura | 21 | NC - Anulación de operación |
03 | Boleta de Venta | 23 | NC - Descuento global |
04 | Boleta de Compra | 24 | NC - Devolución total |
05 | Boletos de Transporte Aéreo | 25 | NC - Corrección por error en la descripción |
06 | Carta de porte aéreo | 26 | NC - Devolución por ítem |
07 | Nota de Crédito | 27 | NC - Descuento por ítem |
08 | Nota de Débito | 29 | NC - Ajustes montos y/o fechas de pago |
11 | Póliza emitida por la Bolsa de Valores | 41 | ND - Intereses por mora |
12 | Ticket de máquina registradora | 42 | ND - Aumento de valor |
13 | Documento Bajo Control de SBS | 43 | ND - Penalidad |
14 | Recibo de Servicios Públicos Electrónico |
||
15 | Boletos emitidos por servicio de transporte | ||
16 | Boleto de viaje de transporte interprovincial | ||
17 | Documentos emitidos por la Iglesia Católica | ||
18 | Documentos emitidos por las AFP | ||
19 | Boleto por atracciones y espectáculos públicos | ||
21 | Conocimiento de embarque de carga marítima | ||
23 | Pólizas de Adjudicación | ||
24 | Certificado de pago PERUPETRO S.A. | ||
25 | Documento de Atribución | ||
27 | Seguro Complementario de Trabajo de Riesgo | ||
28 | Etiqueta por el pago de la TUUA | ||
29 | Documentos emitidos por la COFOPRI | ||
30 | Documentos emitidos por el Adquiriente | ||
32 | Documentos emitidos garantía red principal | ||
34 | Documento Electrónico Autorizado del Operador | ||
35 | Documento Electrónico Autorizado del Adquirente | ||
36 | Recibo de Distribución de Gas Natural | ||
37 | Documentos emitidos por Serv. de Revisiones Técnicas | ||
42 | Documentos emitidos por TC Propias | ||
43 | Boleto de aviación transporte aéreo no regular | ||
44 | Billetes de lotería, rifas y apuestas | ||
45 | Documentos emitidos por CE y culturales | ||
48 | Comprobantes de Operaciones | ||
49 | Constancia de Depósito - IVAP | ||
50 | DUA/DAM | ||
52 | Despacho Simplificado – Exportación Simplificada | ||
53 | Declaración de Mensajería o Courier | ||
55 | BVME para transporte ferroviario de pasajeros | ||
56 | Comprobante de pago SEAE | ||
64 | Documento emitido por Servicio de transporte aéreo | ||
87 | Nota de Crédito Especial | ||
88 | Nota de Débito Especial | ||
89 | Nota de Ajuste de Operaciones - Ley N° 29972 |
El siguiente modelo representa los datos enviados en la notificación.
RUCEmisor | string <RUC> RUC empresa proveedora del documento |
RazonSocialEmisor | string Razón social empresa proveedora del documento |
TipoCPE | string Tipo de documento |
TipoCPEDesc | string Descripción del tipo de documento |
NroSerie | integer <int64> Número de serie |
Folio | integer <int64> Folio del documento |
RUCReceptor | string <RUC> RUC empresa adquiriente del documento |
RazonSocialReceptor | string Razón social empresa adquiriente del documento |
CodigoMoneda | string <string> Código de la monenda |
CodigoMonedaDesc | string <string> Descripción del tipo de moneda |
MntTotal | integer <int64> Monto total del documento |
ImporteTotal | integer <int64> Monto total del documento |
EnlaceZip | string <url> Enlace para descarga del zip |
EnlaceJson | string <url> Enlace para descarga del documento en formato JSON |
EnlaceXml | string <url> Enlace para descarga del documento en formato XML |
EnlaceXmlCpe | string <url> Enlace para descarga de la CPE en formato XML |
EnlacePdf | string <url> Enlace para descarga del documento en formato PDF |
EmitidoRecibido | string Enum: 1 2 Indica si el documento fue
|
IndAnulado | string Índice anulado |
Origen | string Enum: "SunatCOMPPAGO" "SunatPORTAL" Origen facturador
|
FchEmis | date <yyyy-MM-dd> Fecha emisión |
Extras | object Datos adicionales enviados en la notificación |
Servicio | string Servicio que envía la notificación |
Notificacion | string Código de la notificación |
StrEmitidoRecibido | string Enum: "Emitido" "Recibido" StrEmitidoRecibido
|
Action | string Enum: "Create" "Update" Action
|
CondicionConformidadId | string Enum: "01" "02" "03" "04" Action
|
CondicionConformidadDesc | string Enum: "Sin Datos" "Conformidad Expresa" "Conformidad Presunta" "Disconformidad" Action
|
FechaCondicionConformidad | date <yyyy-MM-ddThh:mm:ss> Fecha Condición Conformidad |
FormaPagoDesc | string Enum: "Contado" "Credito" Forma Pago
|
FormaPagoId | string Enum: "1" "2" Forma Pago
|
DocAfecto | string Documento Afecto |
FechaVencimiento | date <yyyy-MM-ddThh:mm:ss> Fecha de Vencimiento |
Version | integer <int64> Fuente del documento sincronizado
|
{- "RUCEmisor": "1B",
- "RazonSocialEmisor": "Proveedor SA",
- "TipoCPE": "01",
- "TipoCPEDesc": "Factura electrónica",
- "NroSerie": 103,
- "Folio": 103,
- "RUCReceptor": "1-8",
- "RazonSocialReceptor": "Adquiriente SpA",
- "CodigoMoneda": "Soles",
- "CodigoMonedaDesc": "Soles",
- "MntTotal": 10000,
- "ImporteTotal": 10000,
- "EnlaceZip": "string",
- "EmitidoRecibido": "1",
- "IndAnulado": 0,
- "Origen": "SunatPORTAL",
- "FchEmis": "2020-09-20T00:00:00.000Z",
- "Extras": null,
- "Servicio": "CPESync",
- "Notificacion": "CPE_SINCRONIZADO",
- "StrEmitidoRecibido": "Emitido",
- "Action": "Create",
- "CondicionConformidadId": "01",
- "CondicionConformidadDesc": "Sin Datos",
- "FechaCondicionConformidad": "2024-01-03T01:55:13.000Z",
- "FormaPagoDesc": "Contado",
- "FormaPagoId": "1",
- "DocAfecto": "E001-379",
- "FechaVencimiento": "2024-01-03T01:55:13.000Z",
- "Version": 0
}
Permite subscribir una empresa al servicio CPESync
customer-id required | any Ejemplo: 2G Identificador del cliente en Datamart |
subscriber-id required | any Ejemplo: 1I RUC empresa a subscribir al servicio |
required | object (CredencialesAutenticacion) Credenciales de autenticación en la SUNAT |
Recurrencia | string Default: "CadaHora" Enum: "CadaHora" "Diario" "Semanal" "Mensual" "Trimestral" "Semestral" "Anual" Frecuencia con la que se desea sincronizar el documento |
Servidor de Homologación
Servidor de Producción
{- "CredencialesAutenticacion": {
- "Ruc": "2B",
- "Usuario": "usuario",
- "Password": "P4$$w0rd"
}, - "Recurrencia": "CadaHora"
}
{- "Codigo": "0",
- "Mensaje": null
}
Permite actualizar la subscripción de una empresa en el servicio CPESync.
customer-id required | any Ejemplo: 2G Identificador del cliente en Datamart |
subscriber-id required | any Ejemplo: 1I RUC empresa a subscribir al servicio |
required | object (CredencialesAutenticacion) Credenciales de autenticación en la SUNAT |
Recurrencia | string Default: "CadaHora" Enum: "CadaHora" "Diario" "Semanal" "Mensual" "Trimestral" "Semestral" "Anual" Frecuencia con la que se desea sincronizar el documento |
Servidor de Homologación
Servidor de Producción
{- "CredencialesAutenticacion": {
- "Ruc": "2B",
- "Usuario": "usuario",
- "Password": "P4$$w0rd"
}, - "Recurrencia": "CadaHora"
}
{- "Codigo": "0",
- "Mensaje": null
}
Permite eliminar una subscripción existente
customer-id required | any Ejemplo: 2G Identificador del cliente en Datamart |
subscriber-id required | any Ejemplo: 1I RUC empresa a subscribir al servicio |
Servidor de Homologación
Servidor de Producción
curl --request DELETE \ --url 'https://homo.api.datamart.pe/cpe-sync/v1/subscriptions/{customer-id}/{subscriber-id}' \ --header 'x-api-key: {API_KEY_CLIENTE}'
{- "Codigo": "0",
- "Mensaje": null
}
Permite iniciar la ejecución a demanda del servicio
CustomerID required | string |
RUCs required | Arreglo de strings |
Servidor de Homologación
Servidor de Producción
{- "CustomerID": "1L",
- "RUCs": [
- "2B"
]
}
{- "Codigo": "0",
- "Mensaje": null,
- "Estado": {
- "2B": "Estado del servicio para el RUC 2B"
}
}
Permite cambiar las recurrencias con que se sincronizan las subscripciones para un conjunto de estas
customer-id required | any Ejemplo: 2G Identificador del cliente en Datamart |
Recurrencia required | string Default: "CadaHora" Enum: "CadaHora" "Diario" "Semanal" "Mensual" "Trimestral" "Semestral" "Anual" Frecuencia con la que se desea sincronizar el documento |
SubscriptorIds required | Arreglo de strings Listado de RUC de empresas a suscritas al servicio |
Servidor de Homologación
Servidor de Producción
{- "Recurrencia": "CadaHora",
- "SubscriptorIds": [
- "2B"
]
}
{- "Codigo": "0",
- "Mensaje": null,
- "SolicitudId": "16e1af9f-1b32-4c8d-b8bc-d0701b76938b"
}
Permite verificar el estado en que se encuentra el proceso de cambiar la recurrencia
customer-id required | any Ejemplo: 2G Identificador del cliente en Datamart |
solicitud-id required | any Ejemplo: 2G Identificador del proceso de cambiar la recurrencia |
Servidor de Homologación
Servidor de Producción
curl --request GET \ --url 'https://homo.api.datamart.pe/cpe-sync/v1/update-recurrence/{customer-id}/{solicitud-id}/status' \ --header 'x-api-key: {API_KEY_CLIENTE}'
{- "Codigo": "0",
- "Mensaje": null,
- "Estado": "Completado",
}
Servicio de sincronización de metadatos de la actividad registrada en el Registro Centralizado de Facturas Negociables (Factrack) administrado por Cavali.
Periódicamente se verifica la actividad en Factrack para cada empresa subscrita al servicio y se notifican vía Webhook o por correo electrónico los metadatos de las nuevas cesiones encontradas.
Notificaciones
El servicio notifica de manera automática las nuevas cesiones registradas en Factrack. La notificación de nueva cesión incluye metadatos relativos a la cesión, al CPE cedido, datos de identificación del cedente y cesionario.
El siguiente modelo representa los datos enviados en la notificación.
SubscriberId | string RUC Subscriptor |
RUCProveedor | string RUC Proveedor de la factura |
RazonSocialProveedor | string Razón social del RUC Proveedor de la factura |
RUCAdquiriente | string RUC que adquiere la factura |
RazonSocialAdquiriente | string Razón social del RUC que adquiere la factura |
RUCParticipante | string RUC Participante en la factura |
RazonSocialParticipante | string Razón social del RUC Participante en la factura |
IdParticipante | string Id Cavali |
TipoCPE | string Tipo de factura |
TipoCPEDesc | string Descripción del tipo de factura |
Serie | string Número de Serie de la factura |
Folio | string Folio de la factura |
FechaEmisionCPE | string Fecha de emisión de la factura |
Moneda | string Moneda de la factura |
MontoNetoCPE | number <decimal> Monto neto de la factura |
ImporteNetoaPagar | number <decimal> Monto de la cesión |
FechaEntregaFacturaNegociable | string Fecha en la que se negocia la factura |
FechadeAnotacionenCuenta | string Fecha en la que se registra la operación de cesión |
CodigodeValor | string Código entregado por Cavali |
FechadePago | string Fecha en la que se pagará la factura |
Ambiente | string Ambiente de trabajo |
EnlaceXml | string Documento xml de la cesión |
EstadoCavali | string Estado de la operación en Cavali |
FechaEstado | string Fecha en la que se establece el estado |
TipoRegistro | any <string> Tipo de registro dado por Cavali |
IndicadorVenta | any <string> Indicador de la venta |
FechaRegistro | string Fecha de registro de la cesión |
RespuestaCPE | string Respuesta de la factura |
EstadoCPE | string Estado la factura |
EstadoConformidad | string Estado de conformidad de la factura |
TipoConformidad | string Tipo de conformidad de la factura (CPE) |
Condici\u00f3nConformidad | string Condición de conformidad de la factura (CPE) |
CondicionConformidad | string Condición de conformidad de la factura (CPE) |
FechaPago | string Fecha en la que se pagará la factura |
FechaPagoEfectiva | string Fecha efectiva del pago |
FechadeTransferenciaContable | string Fecha en la que la factura se registra |
MotivoRetiro | string Aplica si se retira la cesión |
Obs | string Observaciones |
GlosaDTE | string Descripción de la factura |
Extras | object Datos adicionales enviados en la notificación |
Servicio | string Código del servicio que envía la notificación |
Notificacion | string Código de la notificación |
{- "SubscriberId": "1B",
- "RUCProveedor": "1-8",
- "RazonSocialProveedor": "",
- "RUCAdquiriente": "1-9",
- "RazonSocialAdquiriente": "",
- "RUCParticipante": "1A",
- "RazonSocialParticipante": "",
- "IdParticipante": "000",
- "TipoCPE": "Factura comercial",
- "TipoCPEDesc": "Factura comercial",
- "Serie": "E001",
- "Folio": "0000",
- "FechaEmisionCPE": "2024-09-23T00:00:00",
- "Moneda": "$",
- "MontoNetoCPE": 33089.1,
- "ImporteNetoaPagar": 33089.1,
- "FechaEntregaFacturaNegociable": "2023-04-10T05:00:00+00:00",
- "FechadeAnotacionenCuenta": "2023-04-10T23:31:08+00:00",
- "CodigodeValor": "FN0004436043",
- "FechadePago": "2023-04-28T00:00:00",
- "Ambiente": "Prod/Homo",
- "EstadoCavali": "Redimida / Anotada en Cuenta / Retirada / Registrada / Registro Sin información adicional",
- "FechaEstado": "02/05/2023",
- "TipoRegistro": "Electrónico",
- "IndicadorVenta": "Crédito",
- "FechaRegistro": "28/03/2023",
- "RespuestaCPE": "Autorizada",
- "EstadoCPE": "Aceptado",
- "EstadoConformidad": "Conforme",
- "TipoConformidad": "CPE con conformidad presunta",
- "Condici\u00f3nConformidad": "Conformidad presunta dentro del plazo",
- "CondicionConformidad": "Conformidad presunta dentro del plazo",
- "FechaPago": "28/03/2023",
- "FechaPagoEfectiva": "28/04/2023",
- "FechadeTransferenciaContable": "10/04/2023",
- "MotivoRetiro": "Explicación",
- "Obs": "Observaciones",
- "GlosaDTE": "TARIFA POR HORA DE VUELO [USD/HORA] | OTROS (USD).",
- "Extras": null,
- "Servicio": "FactrackSync",
- "Notificacion": "FACTRACK_SINCRONIZADO"
}
Permite subscribir una empresa al servicio Factrack
customer-id required | any Ejemplo: 2G Identificador del cliente en Datamart |
subscriber-id required | any Ejemplo: 1I RUC empresa a subscribir al servicio |
required | object (CredencialesAutenticacion) Credenciales de autenticación en la SUNAT |
Servidor de Homologación
Servidor de Producción
{- "CredencialesAutenticacion": {
- "Ruc": "2B",
- "Usuario": "usuario",
- "Password": "P4$$w0rd"
}
}
{- "Codigo": "0",
- "Mensaje": null
}
Permite actualizar la subscripción de una empresa en el servicio Factrack
customer-id required | any Ejemplo: 2G Identificador del cliente en Datamart |
subscriber-id required | any Ejemplo: 1I RUC empresa a subscribir al servicio |
required | object (CredencialesAutenticacion) Credenciales de autenticación en la SUNAT |
Servidor de Homologación
Servidor de Producción
{- "CredencialesAutenticacion": {
- "Ruc": "2B",
- "Usuario": "usuario",
- "Password": "P4$$w0rd"
}
}
{- "Codigo": "0",
- "Mensaje": null
}
Permite eliminar una subscripción al servicio Factrack
customer-id required | any Ejemplo: 2G Identificador del cliente en Datamart |
subscriber-id required | any Ejemplo: 1I RUC empresa a subscribir al servicio |
Servidor de Homologación
Servidor de Producción
curl --request DELETE \ --url 'https://homo.api.datamart.pe/factrack-sync/v1/subscriptions/{customer-id}/{subscriber-id}' \ --header 'x-api-key: {API_KEY_CLIENTE}'
{- "Codigo": "0",
- "Mensaje": null
}
Permite iniciar la ejecución del servicio Factrack
customer-id required | any Ejemplo: 2G Identificador del cliente en Datamart |
subscriber-id required | any Ejemplo: 1I RUC empresa a subscribir al servicio |
Servidor de Homologación
Servidor de Producción
curl --request POST \ --url 'https://homo.api.datamart.pe/factrack-sync/v1/synchronize/{customer-id}/{subscriber-id}' \ --header 'x-api-key: {API_KEY_CLIENTE}'
{- "Codigo": "0",
- "Mensaje": null
}
Servicio para la descarga de información de morosidad, comportamiento de pago y riesgo registrada en Buerau de Crédito Sentinel.
Descarga la información de morosidad, comportamiento de pago y riesgo registrada en Buerau de Crédito Sentinel.
customer-id required | any Ejemplo: 2G Identificador del cliente en Datamart |
subscriber-id required | any Ejemplo: 1I RUC empresa a encuestar deuda |
update-data | bool Ejemplo: update-data=false Indica si se deben actualizar los datos de la deuda desde el servicio |
bool Ejemplo: pdf=false Indica si se debe descargar el pdf desde el servicio. |
Servidor de Homologación
Servidor de Producción
curl --request GET \ --url 'https://homo.api.datamart.pe/sentinel/v1/debts/{customer-id}/{subscriber-id}' \ --header 'x-api-key: {API_KEY_CLIENTE}'
{- "Codigo": "0",
- "Mensaje": null,
}
Servicio que permite registrar eventos de conformidad y disconformidad en comprobantes recibidos por una empresa,
cumpliendo con las restricciones establecidas por la SUNAT para este proceso.
Asimismo, ofrece la opción de consultar los eventos registrados para un comprobante.
Permite obtener, de manera síncrona, el historial de eventos registrados para un comprobante en la SUNAT, proporcionando detalles sobre cada evento asociado al comprobante.
RucEmisor required | string Ruc emisor del comprobante |
Tipo required | string Enum: "01" "02" Tipo de comprobante
|
Serie required | string Serie del comprobante. Solo se permite E001 y F###. |
Numero required | integer Número del comprobante |
required | object (CredencialesAutenticacion) Credenciales de autenticación en la SUNAT |
Servidor de Homologación
Servidor de Producción
{- "RucEmisor": "2A",
- "Tipo": "01",
- "Serie": "F004",
- "Numero": 15,
- "CredencialesAutenticacion": {
- "Ruc": "2B",
- "Usuario": "usuario",
- "Password": "P4$$w0rd"
}
}
Comprobante con eventos
{- "Codigo": "0",
- "Mensaje": null,
- "EventosCpe": [
- {
- "FechaRegistro": "2023-11-22T11:12:12",
- "Comentario": "Comentario",
- "Adquiriente": "2A",
- "Evento": "CPE puesto a disposición",
- "EstadoCPE": "Pendiente"
}
]
}
Permite obtener los eventos registrados de un comprobante en la SUNAT de forma asíncrona. Al recibir los datos necesarios para realizar la consulta, se devuelve un identificador único de solicitud. Posteriormente, se debe utilizar dicho identificador para consultar el estado de la solicitud a través de la API de verificación de estado.
RucEmisor required | string Ruc emisor del comprobante |
Tipo required | string Enum: "01" "02" Tipo de comprobante
|
Serie required | string Serie del comprobante. Solo se permite E001 y F###. |
Numero required | integer Número del comprobante |
required | object (CredencialesAutenticacion) Credenciales de autenticación en la SUNAT |
Servidor de Homologación
Servidor de Producción
{- "RucEmisor": "2A",
- "Tipo": "01",
- "Serie": "F004",
- "Numero": 15,
- "CredencialesAutenticacion": {
- "Ruc": "2B",
- "Usuario": "usuario",
- "Password": "P4$$w0rd"
}
}
{- "Codigo": "0",
- "Mensaje": null,
- "SolicitudId": "66587197-7137-4cdc-bb7b-1ce6acbfea5f"
}
Permite registrar eventos de conformidad o disconformidad en múltiples comprobantes recibidos por una empresa de forma asíncrona. Al recibir los datos necesarios para registrar los eventos, se devuelve un identificador único de solicitud. Posteriormente, se debe consultar el estado de dicha solicitud utilizando la API de verificación de estado.
EstadoComprobantes required | string Enum: "Pendiente" "PendientePorReinicio" "Subsanado" "Disconforme" Estado actual de los comprobantes para el registro de eventos. Se deben tener en cuenta las siguientes reglas:
|
required | Arreglo de objects Comprobantes para el registro de eventos |
required | object (CredencialesAutenticacion) Credenciales de autenticación en la SUNAT |
Servidor de Homologación
Servidor de Producción
{- "EstadoComprobantes": "Pendiente",
- "Comprobantes": [
- {
- "CodigoEvento": "Conformidad",
- "RucEmisor": "2A",
- "Tipo": "01",
- "Serie": "F004",
- "Numero": 15,
- "Motivos": [
- "PlazoPagoAcordado"
], - "Comentario": "Comentario sobre el evento",
- "ComprobanteSubsanacion": {
- "Tipo": "07",
- "Serie": "F004",
- "Numero": 15,
- "Motivos": [
- "PlazoPagoAcordado"
]
}
}
], - "CredencialesAutenticacion": {
- "Ruc": "2B",
- "Usuario": "usuario",
- "Password": "P4$$w0rd"
}
}
{- "Codigo": "0",
- "Mensaje": null,
- "SolicitudId": "66587197-7137-4cdc-bb7b-1ce6acbfea5f"
}
Permite registrar, de manera síncrona, el sustento de disconformidad de comprobantes recibidos a través de la SUNAT. Esta operación solo es válida para comprobantes que se encuentran en estado Disconforme.
Sustento required | string Documento de sustento de disconformidad en Base64. Solo está permitido cargar archivos de tipo pdf, doc, docx, xls, xlsx, ppt, pptx, jpg, jpeg o txt. |
required | Arreglo de objects Comprobantes para el registro del sustento de disconformidad. |
required | object (CredencialesAutenticacion) Credenciales de autenticación en la SUNAT |
Servidor de Homologación
Servidor de Producción
{- "Sustento": "Ynl0ZVtdIGRlbCBYTUwgZGVsIERURSBhIGNlZGVyIGVuIEJhc2U2NA==",
- "Comprobantes": [
- {
- "RucEmisor": "2A",
- "Tipo": "01",
- "Serie": "F004",
- "Numero": 15
}
], - "CredencialesAutenticacion": {
- "Ruc": "2B",
- "Usuario": "usuario",
- "Password": "P4$$w0rd"
}
}
Registro de sustento de disconformidad
{- "Codigo": "0",
- "Mensaje": null
}
Permite consultar el estado de una solicitud relacionada con la obtención o el registro de eventos en comprobantes. Proporciona información sobre el progreso o la finalización de la solicitud realizada previamente.
solicitud-id required | string Ejemplo: 0e13bf35-ffa5-4f29-8266-db51828eae1d Identificador único asignado al realizar una petición para obtener o registrar eventos. |
Servidor de Homologación
Servidor de Producción
curl --request GET \ --url 'https://homo.api.datamart.pe/cpe-events/v1/events/async/{solicitud-id}/status' \ --header 'x-api-key: {API_KEY_CLIENTE}' \ --header 'x-dmrt-customer-id: {ID_CLIENTE}'
Comprobante con eventos
{- "Codigo": "0",
- "Mensaje": null,
- "Estado": "Completado",
- "EventosCpe": [
- {
- "FechaRegistro": "2023-11-22T11:12:12",
- "Comentario": "Comentario",
- "Adquiriente": "2A",
- "Evento": "CPE puesto a disposición",
- "EstadoCPE": "Pendiente"
}
]
}
Servicio que sincroniza diariamente la existencia de deudas tributarias que el contribuyente no ha podido pagar.
Para una empresa subscrita al servicio, periódicamente y de forma automática se notifica vía webhook o por correo electrónico el reporte de deuda coactiva.
Notificaciones
Este servicio notifica de forma automática, vía webhook o por correo electrónico, el reporte de deuda coactiva de la empresa.
El siguiente modelo representa los datos enviados en la notificación.
SubscriberId | string RUC de la empresa |
RazonSocial | string Razón social de la empresa |
EnlaceXml | string Enlace para descarga del fichero XML del documento |
DeudasCoactiva | Arreglo de objetc (Deuda) |
{- "SubscriberId": "1I",
- "RazonSocial": "Empresa SA",
- "DeudasCoactiva": [
- null
]
}
Permite subscribir una empresa al servicio DCASync
customer-id required | any Ejemplo: 1I Identificador del cliente en Datamart |
subscriber-id required | any Ejemplo: 2B RUC empresa a subscribir al servicio |
Servidor de Homologación
Servidor de Producción
curl --request POST \ --url 'https://homo.api.datamart.pe/dca-sync/v1/subscriptions/{customer-id}/{subscriber-id}' \ --header 'x-api-key: {API_KEY_CLIENTE}'
{- "Codigo": "0",
- "Mensaje": null
}
Permite actualizar la subscripción de una empresa al servicio DCASync
customer-id required | any Ejemplo: 1I Identificador del cliente en Datamart |
subscriber-id required | any Ejemplo: 2B RUC empresa a subscribir al servicio |
Servidor de Homologación
Servidor de Producción
curl --request PUT \ --url 'https://homo.api.datamart.pe/dca-sync/v1/subscriptions/{customer-id}/{subscriber-id}' \ --header 'x-api-key: {API_KEY_CLIENTE}'
{- "Codigo": "0",
- "Mensaje": null
}
Permite eliminar una subscripción al servicio DCASync
customer-id required | any Ejemplo: 1I Identificador del cliente en Datamart |
subscriber-id required | any Ejemplo: 2B RUC empresa a subscribir al servicio |
Servidor de Homologación
Servidor de Producción
curl --request DELETE \ --url 'https://homo.api.datamart.pe/dca-sync/v1/subscriptions/{customer-id}/{subscriber-id}' \ --header 'x-api-key: {API_KEY_CLIENTE}'
{- "Codigo": "0",
- "Mensaje": null
}
Permite iniciar la ejecución del servicio para descargar la deuda coactiva de una empresa
customer-id required | any Ejemplo: 1I Identificador del cliente en Datamart |
subscriber-id required | any Ejemplo: 2B RUC empresa subscrita al servicio |
Servidor de Homologación
Servidor de Producción
curl --request POST \ --url 'https://homo.api.datamart.pe/dca-sync/v1/synchronizations/{customer-id}/{subscriber-id}' \ --header 'x-api-key: {API_KEY_CLIENTE}'
{- "Codigo": "0",
- "Mensaje": null
}
Servicio que permite verificar el estado de subscripción de una empresa a los servicios de Datamart e informar estado de credenciales de acceso.
Notificaciones
El servicio permite notificar en tiempo real determinados eventos
que ocurren relacionados con las subscripciones.
El siguiente modelo representa los datos enviados para un Evento subscripción.
SuscriptorId | string <SuscriptorId> Identificador del subscriptor |
RazonSocial | string Razón Social del Subscriptor |
CodigoEvento | string Enum: "SubscripcionCreada" "SubscripcionEliminada" Código del evento |
FechaEvento | string <YYYY-MM-DDThh:mm:ss> Fecha en que ocurrió el evento |
ServicioEvento | string Servicio en que ocurrió el evento |
Servicio | string Valor: "Subscriptions" Código del servicio que envía la notificación |
Notificacion | string Valor: "EVENTO_SUBSCRIPCION" Código de la notificación |
Extras | any Datos adicionales enviados en la subscripción |
{- "SuscriptorId": "1-9",
- "RazonSocial": null,
- "CodigoEvento": "SubscripcionCreada",
- "FechaEvento": "2019-03-07T13:10:01",
- "ServicioEvento": "RTTSync",
- "Servicio": "Subscriptions",
- "Notificacion": "EVENTO_SUBSCRIPCION",
- "Extras": null
}
Consulta estado de subscripción y credenciales de acceso en un servicio
cliente-id required | string Ejemplo: 1-9 Identificador del cliente en Datamart |
subscriptor-id required | string Ejemplo: 1-8 Identificador de la empresa para chequear subscripción |
servicio-id required | string Enum: "CPESync" "RTTSync" "Factrack" "BSHSync" "DCASync" "DECPAGOSSync" "AFPSync" Ejemplo: CPESync Identificador del servicio para chequear subscripción
|
check-cred-status | boolean Ejemplo: check-cred-status=false Indica si se debe chequear estado de las credenciales de acceso o no |
Servidor de Homologación
Servidor de Producción
curl --request GET \ --url 'https://homo.api.datamart.pe/subscriptions/v1/check-subscription/{cliente-id}/{subscriptor-id}/{servicio-id}?check-cred-status=true' \ --header 'x-api-key: {API_KEY_CLIENTE}'
Empresa no subscrita
{- "Codigo": "60",
- "Mensaje": null,
- "EstadoCredencial": "",
- "Servicio": "AECSync"
}
Consulta estado de subscripción y credenciales de acceso en varios servicios
cliente-id required | string Ejemplo: 1-9 Identificador del cliente en Datamart |
subscriptor-id required | string Ejemplo: 1-8 Identificador de la empresa para chequear subscripción |
check-cred-status | boolean Ejemplo: check-cred-status=false Indica si se debe chequear estado de las credenciales de acceso o no |
Servicios | Arreglo de strings Items Enum: "CPESync" "RTTSync" "Factrack" "BSHSync" "DCASync" "DECPAGOSSync" "AFPSync" |
Servidor de Homologación
Servidor de Producción
{- "Servicios": [
- "CPESync",
- "RTTSync"
]
}
Respuesta satisfactoria
{- "Codigo": "0",
- "Mensaje": null,
- "EstadoSubscripcion": [
- {
- "Codigo": "61",
- "Mensaje": null,
- "EstadoCredencial": "CredencialValida",
- "Facturador": "sii",
- "Servicio": "DTESync"
}, - {
- "Codigo": "60",
- "Mensaje": null,
- "EstadoCredencial": "",
- "Servicio": "AECSync"
}
]
}
Servicio que brinda la posibilidad de obtención de la Ficha RUC en la SUNAT.
Notificaciones
Al finalizar la obtención de la Ficha RUC solicitada, se notifica de manera automática, vía
Webhook o por correo electrónico, de acuerdo a la configuración del cliente.
El siguiente modelo representa los datos enviados en la notificación.
RUC | string <RUC> RUC contribuyente |
EnlaceJson | string <url> Enlace para descarga del documento en formato JSON |
EnlacePdf | string <url> Enlace para descarga del documento en formato PDF |
Enlace | string <url> Enlace para descarga del compactado ZIP |
Notificacion | string Código de la notificación |
Servicio | string Código del servicio que envía la notificación |
object (MapExtras) Diccionario <llave, valor> |
{- "RUC": 11111111111,
- "Notificacion": "FICHA_RUC_ACTUALIZADA",
- "Servicio": "rucfolder",
- "Extras": null
}
Permite realizar una petición para obtener la Ficha RUC de un contribuyente de manera asíncrona.
La respuesta incluye un ID de solicitud que se debe utilizar para consultar el estado del proceso mediante la API, para verificar estado y obtener los datos.
RucContribuyente required | string Ruc del contribuyente a consultar |
required | object (CredencialesAutenticacionContribuyente) Credenciales de autenticación a la SUNAT |
object (MapExtras) Diccionario <llave, valor> |
Servidor de Homologación
Servidor de Producción
{- "RucContribuyente": 11111111111,
- "CredencialesAutenticacion": {
- "Usuario": "mi.usuario",
- "Password": "P4$$w0rd"
}, - "ExtrasNotificacion": null
}
Respuesta satisfactoria
{- "Codigo": "0",
- "Mensaje": null,
- "SolicitudId": "0e13bf35-ffa5-4f29-8266-db51828aee1d"
}
Permite verificar el estado de una solicitud de obtención de datos de una Ficha RUC.
solicitud-id required | string Ejemplo: 0e13bf35-ffa5-4f29-8266-db51828eae1d Identificador de solicitud recibido al realizar una petición de obtención de datos de una Ficha RUC |
Servidor de Homologación
Servidor de Producción
curl --request GET \ --url 'https://homo.api.datamart.pe/ruc-folder/v1/requests/async/{solicitud-id}/status' \ --header 'x-api-key: {API_KEY_CLIENTE}' \ --header 'x-dmrt-customer-id: {ID_CLIENTE}'
Respuesta satisfactoria
{- "Codigo": "0",
- "Mensaje": null,
- "Estado": "Completado",
}
Realiza el proceso de suscripción y sincroniza la Ficha RUC de un contribuyente.
x-api-key required | string Ejemplo: AbhCM24Zz123Y22aa5TTbnn55Yay700a5Y5Oo00 ApiKey del cliente |
x-dmrt-customer-id required | string Ejemplo: 1-0 Identificador del cliente |
SubscriptorId | string Identificador del suscriptor |
ModoAcceso | string Default: "Simple" Enum: "Simple" "Recurrente" 'Modo de acceso'
|
Recurrencia | string Default: "BajoDemanda" Valor: "BajoDemanda" 'Tipo de Recurrencia en caso de que el ModoAcceso sea Recurrente'
|
object (CredencialesAutenticacionContribuyenteOpcional) Credenciales de autenticación a la SUNAT. No se requiere su envío para la sincronización de un RUC ya suscrito al servicio. | |
object (MapExtras) Diccionario <llave, valor> |
Servidor de Homologación
Servidor de Producción
{- "SubscriptorId": "1-0",
- "ModoAcceso": "Recurrente",
- "Recurrencia": "BajoDemanda",
- "CredencialesAutenticacion": {
- "Usuario": "mi.usuario",
- "Password": "P4$$w0rd"
}, - "ExtrasNotificacion": null
}
Respuesta satisfactoria
{- "Codigo": "0",
- "Mensaje": null,
- "SolicitudId": "61213001-6b6d-45be-9542-4bc0fdc07557"
}
Realiza el proceso de actualizar un suscripción y sincroniza la Ficha RUC de un contribuyente.
x-api-key required | string Ejemplo: AbhCM24Zz123Y22aa5TTbnn55Yay700a5Y5Oo00 ApiKey del cliente |
x-dmrt-customer-id required | string Ejemplo: 1-0 Identificador del cliente |
SubscriptorId | string Identificador del suscriptor |
ModoAcceso | string Default: "Simple" Enum: "Simple" "Recurrente" 'Modo de acceso'
|
Recurrencia | string Default: "BajoDemanda" Valor: "BajoDemanda" 'Tipo de Recurrencia en caso de que el ModoAcceso sea Recurrente'
|
object (CredencialesAutenticacionContribuyenteOpcional) Credenciales de autenticación a la SUNAT. No se requiere su envío para la sincronización de un RUC ya suscrito al servicio. | |
object (MapExtras) Diccionario <llave, valor> |
Servidor de Homologación
Servidor de Producción
{- "SubscriptorId": "1-0",
- "ModoAcceso": "Recurrente",
- "Recurrencia": "BajoDemanda",
- "CredencialesAutenticacion": {
- "Usuario": "mi.usuario",
- "Password": "P4$$w0rd"
}, - "ExtrasNotificacion": null
}
Respuesta satisfactoria
{- "Codigo": "0",
- "Mensaje": null,
- "SolicitudId": "61213001-6b6d-45be-9542-4bc0fdc07557"
}
Permite eliminar la suscripción de un contribuyente.
subscriptor-id required | string Identificador del suscriptor |
x-api-key required | string Ejemplo: AbhCM24Zz123Y22aa5TTbnn55Yay700a5Y5Oo00 ApiKey del cliente |
x-dmrt-customer-id required | string Ejemplo: 1-0 Identificador del cliente |
Servidor de Homologación
Servidor de Producción
curl --request DELETE \ --url 'https://homo.api.datamart.pe/ruc-folder/v1/synchronizations/{subscriptor-id}' \ --header 'x-api-key: {API_KEY_CLIENTE}' \ --header 'x-dmrt-customer-id: {ID_CLIENTE}'
Respuesta satisfactoria
{- "Codigo": "0",
- "Mensaje": ""
}
Permite verificar el estado de la solicitud de sincronización.
solicitud-id required | string Identificador de la solicitud |
x-api-key required | string Ejemplo: AbhCM24Zz123Y22aa5TTbnn55Yay700a5Y5Oo00 ApiKey del cliente |
x-dmrt-customer-id required | string Ejemplo: 1-0 Identificador del cliente |
Servidor de Homologación
Servidor de Producción
curl --request GET \ --url 'https://homo.api.datamart.pe/ruc-folder/v1/synchronizations/async/{solicitud-id}/status' \ --header 'x-api-key: {API_KEY_CLIENTE}'
Respuesta satisfactoria
{- "Codigo": "0",
- "Mensaje": null,
- "Estado": "Completado",
}
Servicio para gestionar las cesiones a través de Cavali y Factrack.
Para una empresa suscrita al servicio, periódicamente y de forma automática se notifica vía Webhook o por correo electrónico cuando se complete el proceso de cesión iniciado.
Notificaciones
Este servicio notifica de forma automática, vía Webhook o por correo electrónico, cuando se complete el proceso de cesión iniciado.
El siguiente modelo representa los datos enviados en la notificación.
Ruc | integer RUC proveedor |
Serie | string Número de serie |
Numeracion | string Numeración de Factura |
Tipo | string Enum: "Anotar" "Registrar" "Transferir" Tipo de operación |
Fecha | string <yyyy-MM-ddTHH:mm> Fecha de la notificación |
Codigo | string Enum: "CESSION_SUCCESS" "CESSION_REMOVED" "REDEEM_INVOICE" "RESCHEDULE_PAYMENT" "ERROR" Tipo de notificación
|
{- "Ruc": 123456789101112,
- "Serie": "E001",
- "Numeracion": "57",
- "Tipo": "01",
- "Fecha": "2020-08-10T12:12:12:12",
- "Codigo": "CESSION_SUCCESS"
}
Permite consultar el estado de una cesión.
Servidor de Homologación
Servidor de Producción
curl --request GET \ --url 'https://homo.api.datamart.pe/cession-cpe/v1/status/{cessionId}' \ --header 'x-api-key: {API_KEY_CLIENTE}' \ --header 'x-dmrt-customer-id: {ID_CLIENTE}'
Respuesta satisfactoria
{- "Codigo": "0",
- "Mensaje": null,
- "Proceso": {
- "NumeroProceso": 12345,
- "CodigoUsuarioCreado": "CODIGO",
- "CodigoParticipante": "PARTICIPANTE",
- "TipoFactura": "1",
- "RucProveedor": 123456789,
- "NombreNegocio": "Hello World SA",
- "FechaRegistro": "01/01/2020",
- "FechaEmision": "01/01/2020",
- "Serie": "E001",
- "Numeracion": 2,
- "RespuestaSunat": null,
- "FechaEntregaFactura": "01/01/2020",
- "FechaEntregaAcq": "01/01/2020",
- "FechaNotificacionAcq": "01/01/2020",
- "IndicadorFehaciencia": null,
- "RespuestaAcq": 1,
- "FechaRespuestaAcq": "01/01/2020",
- "FechaAnotacion": "01/01/2020",
- "FechaTransferenciaContable": "01/01/2020",
- "FechaRetiro": "01/01/2020",
- "FechaRedencion": "01/01/2020",
- "FechaGeneracionConstancia": "01/01/2020",
- "NumeroRutProveedor": 12345,
- "NumeroRutActualFactura": 12345,
- "EstadoFactura": 1,
- "EstadoProceso": "3001",
- "TipoProceso": "4012",
- "ResultadoProceso": "Factura duplicada.",
- "IndicadorReintento": 0
}
}
Permite iniciar un proceso de cesión de CPE.
RucProveedor required | integer RUC de la empresa proveedora |
Tipo required | string Enum: "01" "02" Tipo de comprobante
|
Serie required | string Número de serie |
Numeracion required | string Numeración de factura |
NombreArchivo required | string Nombre de archivo XML |
ArchivoXml required | string Base 64 del archivo XML |
FechaVencimiento required | string <DD/MM/YYYY> Fecha de expiración del documento |
DepartamentoProveedor required | string [ 1 .. 2 ] characters Código del departamento de empresa proveedora |
ProvinciaProveedor required | string [ 1 .. 2 ] characters Código de la provincia de empresa proveedora |
DistritoProveedor required | string [ 1 .. 2 ] characters Código del distrito de empresa proveedora |
DireccionProveedor required | string Domicilio Proveedor |
DepartamentoAcq required | string [ 1 .. 2 ] characters Departamento de empresa adquirente |
ProvinciaAcq required | string [ 1 .. 2 ] characters Provincia de empresa adquirente |
DistritoAcq required | string [ 1 .. 2 ] characters Distrito de empresa adquirente |
DireccionAcq required | string Domicilio de empresa adquirente |
RucAcq required | integer RUC de empresa aquiriente |
TipoPago required | integer Enum: "1" "2" Tipo de pago
|
FechaPago required | string <DD/MM/YYYY> Fecha de pago (del importe neto pendiente de pago) |
MontoNeto required | number Monto neto pendiente de pago |
RznSocialAcq | string Nombre de empresa adquiriente |
RznSocialProveedor | string Nombre empresa proveedora |
RucParticipante | integer RUC empresa participante |
RznParticipante | string Nombre empresa participante |
EmailAcq | string Email empresa adquirente |
TipoIngreso | integer Default: 1 Enum: "1" "2" Tipo de ingreso
|
PeriodoConsultaCavali | integer Default: 12 Período de consulta |
Servidor de Homologación
Servidor de Producción
{- "RucProveedor": 123456789101112,
- "Tipo": "01",
- "Serie": "E001",
- "Numeracion": "57",
- "NombreArchivo": "E001-01-57.xml",
- "ArchivoXml": "Xml en base 64",
- "FechaVencimiento": "20/09/2020",
- "DepartamentoProveedor": "01",
- "ProvinciaProveedor": "01",
- "DistritoProveedor": "01",
- "DireccionProveedor": "Ave Prueba 123",
- "DepartamentoAcq": "01",
- "ProvinciaAcq": "01",
- "DistritoAcq": "01",
- "DireccionAcq": "Ave Prueba 123",
- "RucAcq": 123456789101112,
- "TipoPago": 0,
- "FechaPago": "20/09/2020",
- "MontoNeto": 123.55,
- "RznSocialAcq": "E001",
- "RznSocialProveedor": "Empresa ejemplo",
- "RucParticipante": 123456789101112,
- "RznParticipante": "Empresa prueba",
- "EmailAcq": "email@prueba.com",
- "TipoIngreso": "1",
- "PeriodoConsultaCavali": 12
}
{- "Codigo": "0",
- "Mensaje": null,
- "IdCesion": "123456789-1234567-01-E001-1-20210326050546"
}
Permite ejecutar el pago de una factura.
RucProveedor required | integer RUC de la empresa proveedora |
Tipo required | string Enum: "01" "02" Tipo de comprobante
|
Serie required | string Número de serie |
Numeracion required | string Numeración de factura |
object Detalles del pago |
Servidor de Homologación
Servidor de Producción
{- "RucProveedor": 123456789101112,
- "Tipo": "01",
- "Serie": "E001",
- "Numeracion": "57",
- "DetallePago": {
- "numero": 1
}
}
{- "Codigo": "0",
- "Mensaje": null
}
Permite reprogramar un pago.
RucProveedor required | integer RUC de la empresa proveedora |
Tipo required | string Enum: "01" "02" Tipo de comprobante
|
Serie required | string Número de serie |
Numeracion required | string Numeración de factura |
FechaVencimiento | string <DD/MM/YYYY> Fecha de expiración del documento |
Arreglo de objects (QuotaDetail) Detalles de las cuotas |
Servidor de Homologación
Servidor de Producción
{- "RucProveedor": 123456789101112,
- "Tipo": "01",
- "Serie": "E001",
- "Numeracion": "57",
- "FechaVencimiento": "20/09/2020",
- "detalleCuota": {
- "cuota": [
- {
- "numeroCuota": 1,
- "montoNeto": 123.45,
- "fecha": "15/09/2020"
}
]
}
}
{- "Codigo": "0",
- "Mensaje": null
}
Servicio que recupera las Declaraciones y pagos registrados en SUNAT, enviados a través del sistema PDT.
Para una empresa subscrita al servicio, periódicamente y de forma automática se notifica vía webhook o por correo electrónico el reporte de la declaración y pago actualizado.
Notificaciones
Este servicio notifica de forma automática, vía webhook o por correo electrónico, la declaración y pago actualizado de la empresa.
El siguiente modelo representa los datos enviados en la notificación.
SubscriberId | string RUC de la empresa |
EnlaceXml | string <url> Enlace para descarga del documento XML de la declaración y pago |
EnlaceJson | string <url> Enlace para descarga del documento JSON de la declaración y pago |
EnlacePdf | string <url> Enlace para descarga del Pdf de la declaración y pago para un período |
Message | string Mensaje de la notificación |
Period | string <yyyymm> Período de la declaración |
FchPresentacion | string <YYYYMMDDhhmmss> Fecha de presentación de la declaración |
{- "SubscriberId": "1I",
- "Message": null,
- "Period": "202305",
- "FchPresentacion": "20230608"
}
Permite subscribir una empresa al servicio DECPAGOSSync.
customer-id required | any Ejemplo: 1I Identificador del cliente en Datamart |
subscriber-id required | any Ejemplo: 2B RUC empresa a subscribir al servicio |
x-api-key required | text Ejemplo: AbhCM24Zz123Y22aa5TTbnn55Yay700a5Y5Oo00 ApiKey del cliente |
required | object (CredencialesDECPAGOS) |
Servidor de Homologación
Servidor de Producción
{- "CredencialesAutenticacion": {
- "Usuario": "usuario",
- "Password": "P4$$w0rd"
}
}
{- "Codigo": "0",
- "Mensaje": null
}
Permite actualizar la subscripción de una empresa al servicio DECPAGOSSync.
customer-id required | any Ejemplo: 1I Identificador del cliente en Datamart |
subscriber-id required | any Ejemplo: 2B RUC empresa a subscribir al servicio |
x-api-key required | text Ejemplo: AbhCM24Zz123Y22aa5TTbnn55Yay700a5Y5Oo00 ApiKey del cliente |
required | object (CredencialesDECPAGOS) |
Servidor de Homologación
Servidor de Producción
{- "CredencialesAutenticacion": {
- "Usuario": "usuario",
- "Password": "P4$$w0rd"
}
}
{- "codigo": "0",
- "Mensaje": "Subscripción actualizada"
}
Permite eliminar una subscripción al servicio DECPAGOSSync.
customer-id required | any Ejemplo: 1I Identificador del cliente en Datamart |
subscriber-id required | any Ejemplo: 2B RUC empresa a subscribir al servicio |
x-api-key required | text Ejemplo: AbhCM24Zz123Y22aa5TTbnn55Yay700a5Y5Oo00 ApiKey del cliente |
Servidor de Homologación
Servidor de Producción
curl --request DELETE \ --url 'https://homo.api.datamart.pe/decpagos-sync/v1/subscriptions/{customer-id}/{subscriber-id}' \ --header 'x-api-key: {API_KEY_CLIENTE}'
{- "Codigo": "0",
- "Mensaje": "Subscripción eliminada"
}
Permite iniciar la ejecución del servicio para actualizar el reporte de declaraciones y pagos de una empresa subscrita.
customer-id required | any Ejemplo: 1I Identificador del cliente en Datamart |
subscriber-id required | any Ejemplo: 2B RUC empresa subscrita al servicio |
x-api-key required | text Ejemplo: AbhCM24Zz123Y22aa5TTbnn55Yay700a5Y5Oo00 ApiKey del cliente |
Servidor de Homologación
Servidor de Producción
curl --request POST \ --url 'https://homo.api.datamart.pe/decpagos-sync/v1/synchronizations/{customer-id}/{subscriber-id}' \ --header 'x-api-key: {API_KEY_CLIENTE}'
{- "codigo": "0",
- "Mensaje": "Proceso de sincronizacion iniciado."
}
Permite obtener el documento con los datos de la información obtenida de la declaración y pagos de una empresa.
customer-id required | any Ejemplo: 1I Identificador del cliente en Datamart |
subscriber-id required | any Ejemplo: 2B RUC empresa subscrita al servicio |
format | string Enum: "json" "xml" "pdf" Ejemplo: format=json Indica el formato del documento a descargar, puediendo ser json, xml o pdf.
Por defecto es |
period | string <yyyymm> Ejemplo: period=202305 Período a consultar en formato |
generation-date | string <YYYYMMDDhhmmss> Ejemplo: generation-date=20230608053810 Fecha de generación del documento en formato |
output | string Enum: "file" "inline" Indica la salida de los datos, en el cuerpo de la respuesta o un enlace a un
archivo externo. Su valor por defecto es |
x-api-key required | text Ejemplo: AbhCM24Zz123Y22aa5TTbnn55Yay700a5Y5Oo00 ApiKey del cliente |
Servidor de Homologación
Servidor de Producción
curl --request GET \ --url 'https://homo.api.datamart.pe/decpagos-sync/v1/documents/{customer-id}/{subscriber-id}?format=SOME_STRING_VALUE&period=SOME_STRING_VALUE&generation-date=SOME_STRING_VALUE&output=SOME_STRING_VALUE' \ --header 'x-api-key: {API_KEY_CLIENTE}'
{- "EnlacePdf": null,
- "EnlaceXml": null,
- "FechaGeneracion": "2023-06-08T05:38",
- "DeclaracionPagos": null,
- "Codigo": "0",
- "Mensaje": null
}
Servicio que recupera los Balances financieros registrados en SUNAT, enviados a través del sistema PDT.
Para una empresa subscrita al servicio, periódicamente y de forma automática se notifica vía webhook o por correo electrónico el reporte del balance financiero actualizado.
Notificaciones
Este servicio notifica de forma automática, vía webhook o por correo electrónico, el balance financiero actualizado de la empresa.
El siguiente modelo representa los datos enviados en la notificación.
Servicio | string Código del servicio que envía la notificación |
CustomerCode | string Identificador del cliente |
SubscriberId | string RUC de la empresa |
FechaGeneracion | string <DD/MM/YYYY> Fecha de generación del documento |
EnlaceXml | string <url> Enlace para descarga del documento XML del balance financiero |
EnlaceJson | string <url> Enlace para descarga del documento JSON del balance financiero |
EnlacePdf | string <url> Enlace para descarga del documento PDF del balance financiero |
EnlaceZip | string <url> Enlace para descarga del compactado ZIP del balance financiero |
Ejercicio | string Año/Mes de la fecha en que se obtiene el documento. En el caso del reporte 0710 se genera anual y el 0621 se genera mensual |
FechaPresentacion | string <DD/MM/YYYY> Fecha de última actualización |
FormType | string Tipo de formulario |
Message | string Mensaje de la notificación |
NroOrden | string Número de orden |
MetodoObtencion | string Indica el método utilizado para obtener el balance financiero |
Notificacion | string Código de la notificación |
Extras | object Datos adicionales enviados en la notificación |
{- "Servicio": "BSHSync",
- "CustomerCode": "1-0",
- "SubscriberId": "1I",
- "FechaGeneracion": "23/08/2023",
- "Ejercicio": "2020",
- "FechaPresentacion": "09/04/2021",
- "FormType": "0710",
- "Message": null,
- "NroOrden": "1001479405",
- "MetodoObtencion": "Subscripción",
- "Notificacion": "BSH_SINCRONIZADO",
- "Extras": null
}
Permite subscribir una empresa al servicio BSHSync.
subscriber-id required | any Ejemplo: 2B RUC empresa a subscribir al servicio |
x-dmrt-customer-id required | any Ejemplo: 1-0 Identificador del cliente |
x-api-key required | text Ejemplo: GufJM3ZlR468Y27zp3TnD5mm4Yay780k2W9OnoYG ApiKey del cliente |
required | object (NuevasCredencialesBSH) |
VigenciaSubscripcion | string Estado de la subscripción |
ExtrasNotificacion | object |
Servidor de Homologación
Servidor de Producción
{- "CredencialesAutenticacion": {
- "Tipo": "ClaveSolRUC",
- "RUC": 1234567890,
- "Usuario": "usuario",
- "Password": "p4$$w0rd"
}, - "VigenciaSubscripcion": "Indefinida",
- "ExtrasNotificacion": null
}
{- "Codigo": "0",
- "Mensaje": null
}
Permite actualizar la subscripción de una empresa al servicio BSHSync.
subscriber-id required | any Ejemplo: 2B RUC empresa a subscribir al servicio |
x-dmrt-customer-id required | any Ejemplo: 1-0 Identificador del cliente |
object (CredencialesBSH) |
Servidor de Homologación
Servidor de Producción
{- "CredencialesAutenticacion": {
- "Usuario": "usuario",
- "Password": "P4$$w0rd"
}
}
{- "Codigo": "0",
- "Mensaje": null
}
Permite eliminar una subscripción al servicio BSHSync.
subscriber-id required | any Ejemplo: 2B RUC empresa a subscribir al servicio |
x-dmrt-customer-id required | any Ejemplo: 1-0 Identificador del cliente |
Servidor de Homologación
Servidor de Producción
curl --request DELETE \ --url 'https://homo.api.datamart.pe/bsh-sync/v1/subscriptions/{customer-id}/{subscriber-id}' \ --header 'x-api-key: {API_KEY_CLIENTE}'
{- "Codigo": "0",
- "Mensaje": null
}
Permite iniciar la ejecución del servicio para actualizar el reporte de declaración de balance de la empresa.
subscriber-id required | any Ejemplo: 2B RUC empresa a subscribir al servicio |
x-dmrt-customer-id required | any Ejemplo: 1-0 Identificador del cliente |
Servidor de Homologación
Servidor de Producción
curl --request POST \ --url 'https://homo.api.datamart.pe/bsh-sync/v1/synchronize/{customer-id}/{subscriber-id}' \ --header 'x-api-key: {API_KEY_CLIENTE}'
{- "Codigo": "0",
- "Mensaje": null
}
Servicio que permite obtener el Reporte Tributario (RT) de un contribuyente desde la SUNAT.
Para un contribuyente subscrito al servicio, periódicamente y de forma automática se notifica vía webhook o por correo electrónico el reporte tributario actualizado.
Notificaciones
Este servicio notifica de forma automática, vía webhook o por correo electrónico, el reporte tributario actualizado del contribuyente.
El siguiente modelo representa los datos enviados en la notificación.
SubscriberId | string RUC del contribuyente |
RazonSocial | string Razón social del contribuyente |
EnlaceXml | string <url> Enlace para descarga del documento XML del reporte tributario |
EnlacePdf | string <url> Enlace para descarga del documento PDF del reporte tributario |
EnlaceJson | string <url> Enlace para descarga del documento JSON del reporte tributario |
{- "SubscriberId": "1I",
- "RazonSocial": "Empresa SA",
}
Permite subscribir un contribuyente al servicio RTT.
customer-id required | any Ejemplo: 1I Identificador del cliente en Datamart |
subscriber-id required | any Ejemplo: 2B RUC contribuyente subscrito al servicio |
x-api-key required | string Ejemplo: AbhCM24Zz123Y22aa5TTbnn55Yay700a5Y5Oo00 ApiKey del cliente |
required | object (CredencialesRTT) |
object (Map) Diccionario <llave, valor> |
Servidor de Homologación
Servidor de Producción
{- "CredencialesAutenticacion": {
- "Usuario": "usuario",
- "Tipo": "ClaveDNI",
- "Password": "P4$$w0rd"
}, - "ExtrasNotificacion": null
}
{- "Codigo": "0",
- "Mensaje": null
}
Permite actualizar la subscripción de un contribuyente al servicio RTT.
customer-id required | any Ejemplo: 1I Identificador del cliente en Datamart |
subscriber-id required | any Ejemplo: 2B RUC contribuyente subscrito al servicio |
required | object (CredencialesRTT) |
Servidor de Homologación
Servidor de Producción
{- "CredencialesAutenticacion": {
- "Usuario": "usuario",
- "Tipo": "ClaveDNI",
- "Password": "P4$$w0rd"
}
}
{- "Codigo": "0",
- "Mensaje": null
}
Permite eliminar una subscripción de un contribuyente al servicio RTT.
customer-id required | any Ejemplo: 1I Identificador del cliente en Datamart |
subscriber-id required | any Ejemplo: 2B RUC contribuyente subscrito al servicio |
Servidor de Homologación
Servidor de Producción
curl --request DELETE \ --url 'https://homo.api.datamart.pe/rtt-sync/v1/subscriptions/{customer-id}/{subscriber-id}' \ --header 'x-api-key: {API_KEY_CLIENTE}'
{- "Codigo": "0",
- "Mensaje": null
}
Permite iniciar la ejecución del servicio para actualizar el reporte tributario de un contribuyente subscrito.
customer-id required | any Ejemplo: 1I Identificador del cliente en Datamart |
subscriber-id required | any Ejemplo: 2B RUC contribuyente subscrito al servicio |
Servidor de Homologación
Servidor de Producción
curl --request POST \ --url 'https://homo.api.datamart.pe/rtt-sync/v1/synchronize/{customer-id}/{subscriber-id}' \ --header 'x-api-key: {API_KEY_CLIENTE}'
{- "Codigo": "0",
- "Mensaje": null
}