API Descarga Masiva 2.0

Documentación de la API de Descarga Masiva 2.0

RevisiónFechaComentarios
12021-­06-­16Documento inicial

Tabla de contenido

  • Introducción
  • Razón social
    • Agregar razón social
    • Actualizar razón social
    • Eliminar razón social
    • Lista de razones sociales
  • Sincronización con SAT
  • Lista de peticiones con SAT
  • Comprobante
  • Consultar comprobante
    • Solicitar
    • Verificar
  • Multi comprobantes
    • Solicitar
    • Verificar
  • Códigos de respuestas
  • Anexos: Diagramas del Proceso de Descarga Masiva

Introducción

Descarga Masiva 2.0 es un servicio en el cual se pueden dar de alta en un proceso de sincronización, permitiendo la descarga y visualización de los comprobantes fiscales de forma automática. Creado para ser la base para un sistema de información escalable.

Razón Social

Pre-requisitos

  • Contar con la FIEL de cada RFC a usar en las consultas.
  • Estar registrado en la plataforma PADE, lo que garantizará que cuente con usuario, contraseña y contrato para autenticarse en el servicio.
  • Contar con un software cliente que le permita realizar las peticiones a nuestro servicio.

Agregar razón social.

URL para agregar una razón social.

https://dm.pade.mx/prod/razon-social/create

Descripción.

Este método se utiliza para agregar una razón social (RFC) a la lista de catálogo para el usuario que mande las credenciales. En caso de no encontrar el usuario será dado de alta con las credenciales de PADE. Características de la petición.

  • Petición REST.
  • Tipo POST.
  • Headers: Content-Type = application/json Parámetros del servicio:
  • userPade*: Indica el usuario con el cual se autenticará al servicio de Pade.
  • passPade*: Indica la contraseña del usuario con el cual se autenticará al servicio de Pade.
  • contrato*: Indica el código de contrato del usuario con el que se realizará la solicitud.
  • pfx*: Archivo generado con la Fiel del contribuyente y enviado en base64.
  • passPfx*: Indica la contraseña de la clave privada de su archivo Fiel.
  • razonSocial: Nombre de la empresa.
  • fechaInicioSync*: Rango inicial de fechas que requiere en su consulta ante el SAT con formato (Año-Mes-Día) ej. 2019-10-19.
  • maxComprobantesMensual: Cantidad máxima de los comprobantes por mes.
  • celular*: el número de celular para notificaciones. Códigos de marcado de móviles internacionales. Ej. +520000000000.

Los parámetros marcados con * son obligatorios

Ejemplo del request body

Ejemplo de respuesta exitoso:

Actualizar razón social.

URL para actualizar una razón social.

https://dm.pade.mx/prod/razon-social/update

Descripción.

Este método se utiliza para actualizar una razón social (RFC) a la lista del catálogo para el usuario que mande las credenciales. Solo se pueden actualizar algunos parámetros (pfx, passPfx, certificado).

Características de la petición

  • Petición REST
  • Tipo POST
  • Headers: Content-Type = application/json

Parámetros del servicio:

  • userPade*: Indica el usuario con el cual se autenticará al servicio.
  • passPade*: Indica la contraseña del usuario con el cual se autenticará al servicio.
  • contrato*: Indica el código de certificado del usuario con el que se realizará la solicitud.
  • rfc*: RFC correspondiente a la razón social que se modificara.
  • razonSocial
    • pfx: campo pfx a modificar en base 64
    • passPfx: campo contraseña pfx a modificar
    • certificado: campo certificado a modificar

Los parámetros marcados con * son obligatorios.

Ejemplo del request body.

Ejemplo de respuesta exitoso:

Eliminar razón social.

URL para eliminar una razón social.

https://dm.pade.mx/prod/razon-social/delete

Descripción.

Este método elimina una razón social del catálogo, si envían las credenciales correctas.

Características de la petición

  • Petición REST
  • Tipo POST
  • Headers: Content-Type = application/json

Parámetros del servicio:

  • userPade*: Indica el usuario con el cual se autenticará al servicio.
  • passPade*: Indica la contraseña del usuario con el cual se autenticará al servicio.
  • contrato*: Indica el código de contrato del usuario con el que se realizará la solicitud.
  • rfc*: RFC correspondiente de la razón social a eliminar.

Los parámetros marcados con * son obligatorios.

Ejemplo de request body.

Ejemplo de respuesta exitoso:

Ejemplo de respuesta con error:

Lista de razones sociales.

URL para enlistar razones sociales.

https://dm.pade.mx/prod/razon-social/select-all-by-user

Descripción.

Este método se utiliza para enlistar las razones sociales, de la lista del catálogo para el usuario que mande las credenciales.

Características de la petición

  • Petición REST
  • Tipo POST
  • Headers: Content-Type = application/json

Parámetros del servicio:

  • userPade*: Indica el usuario con el cual se autenticará al servicio.
  • passPade*: Indica la contraseña del usuario con el cual se autenticará al servicio.
  • contrato*: Indica el código de contrato del usuario con el que se realizará la solicitud.

Los parámetros marcados con * son obligatorios.

Ejemplo del request body.

Ejemplo de respuesta exitoso:

Ejemplo de respuesta con error:

Sincronización con SAT.

URL para sincronizar una razón social automáticamente con el SAT.

https://dm.pade.mx/prod/razon-social/sat/sync

Descripción.

Este método se utiliza para habilitar una razón social de la lista de catálogo para el usuario que mande las credenciales. Si se habilita se activará la sincronización automática. En caso contrario se deshabilita la sincronización automática.

Características de la petición

  • Petición REST
  • Tipo POST
  • Headers: Content-Type = application/json

Parámetros del servicio:

  • userPade*: Indica el usuario con el cual se autenticará al servicio.
  • passPade*: Indica la contraseña del usuario con el cual se autenticará al servicio.
  • contrato*: Indica el código de contrato del usuario con el que se realizará la solicitud.
  • rfc*: RFC correspondiente a la razón social de la empresa.
  • habilitado*: Indica si se está deshabilitando el servicio de sincronización automática o habilitando (1 ó 0).

Los parámetros marcados con * son obligatorios.

Ejemplo del request body.

Ejemplo de respuesta exitoso:

Lista de peticiones con SAT.

URL para enlistar las peticiones hechas con el SAT.

https://dm.pade.mx/prod/razon-social/sat/peticiones

Descripción.

Este método se utiliza enlistar las peticiones realizadas con el SAT.

Características de la petición

  • Petición REST
  • Tipo POST
  • Headers: Content-Type = application/json

Parámetros del servicio:

  • userPade*: Indica el usuario con el cual se autenticará al servicio.
  • passPade*: Indica la contraseña del usuario con el cual se autenticará al servicio.
  • contrato*: Indica el código de contrato del usuario con el que se realizará la solicitud.
  • rfc*: RFC correspondiente a la razón social de la empresa.
  • limit*: corresponde al número máximo de la lista de peticiones a mostrar.

Los parámetros marcados con * son obligatorios.

Ejemplo del request body.

Ejemplo de respuesta exitoso:

Comprobante

Pre-requisitos

  • Estar registrado en la plataforma PADE, lo que garantizará que cuente con usuario, contraseña y contrato para autenticarse en el servicio.
  • Contar con un software cliente que le permita realizar las peticiones a nuestro servicio.

Limitantes

  • El contrato en relación con el usuario de estar vigente
  • Se debe contar con un folio fiscal

URL de generación de una solicitud de consulta de comprobantes:

https://dm.pade.mx/prod/comprobante

Este método se utiliza para la obtención de un comprobante en formato base 64 enviando un folio fiscal. El método realiza la autenticación al servicio, valida los parámetros y regresa un Json como respuesta.

Características de la petición

  • Petición REST
  • Tipo POST
  • Headers: Content-Type = application/json

Parámetros del servicio:

  • userPade *: Indica el usuario con el cual se autenticará al servicio.
  • passPade*: Indica la contraseña del usuario con el cual se autenticará al servicio.
  • contrato*: Indica el código de contrato del usuario con el que se realizará la solicitud.
  • uuid*: Folio fiscal

Ejemplo para solicitar comprobante:

Ejemplo de solicitud exitosa

Consulta de comprobantes

Pre-requisitos

  • Estar registrado en la plataforma PADE, lo que garantizará que cuente con usuario, contraseña y contrato para autenticarse en el servicio.
  • Contar con un software cliente que le permita realizar las peticiones a nuestro servicio.

Limitantes

  • El contrato en relación con el usuario de estar vigente
  • Se debe contar con una fecha inicio y una fecha fin para poder consultar el servicio, así como un rfcs emisor y/o receptor
  • Solo se pueden solicitar comprobantes de rfcs relacionados al usuario que realiza la petición
  • Los rfcs a solicitar deben estar activos para el usuario
  • Se realiza una petición para solicitar los comprobantes, y otra para verificar el estatus de descarga
  • Cada solicitud tiene su propio número de solicitud

Generar Solicitud Consulta de Comprobantes

URL de generación de una solicitud de consulta de comprobantes:

https://dm.pade.mx/prod/consulta-comprobantes/solicitar

Este método se utiliza para generar la solicitud según los parámetros especificados en la petición para mostrar la información relacionada con la búsqueda en los comprobantes en la relación a los parámetros enviados son los parámetros que mostrará como respuesta. El método realiza la autenticación al servicio, valida los parámetros y regresa un Json como respuesta al servicio, con un número de único de solicitud.

Características de la petición

  • Petición REST
  • Tipo POST
  • Headers: Content-Type = application/json

Parámetros del servicio:

  • userPade *: Indica el usuario con el cual se autenticará al servicio.
  • passPade*: Indica la contraseña del usuario con el cual se autenticará al servicio.
  • contrato*: Indica el código de contrato del usuario con el que se realizará la solicitud.
  • Comprobante*: El nodo comprobante contiene toda la estructura de un comprobante la cual queremos que nos muestre, la información enviada de este nodo debe contener valores vacíos de los campos enviados ya que la estructura del nodo Comprobante solo nos sirve para decir en la petición que campos son los que quieren que nos muestre. Los campos que siempre se mostraran dentro de una petición son de la estructura: Comprobante, cfdi_complemento, tfd_timbrefiscaldigital y todos sus atributos.
  • filtros*: Dentro de nodo filtros se encuentran diferentes tipos de campos los cuales con estos buscara toda la información relacionada en la información contenida dentro de los comprobantes del cliente los campos dentro del nodo filtros son:
    • tipoPeticion: puede ser de tipo emisor o receptor,
    • moneda: Listado de tipos de moneda
    • lugarExpedicion: Lugar donde fue emitida la factura
    • fecha: Dentro de fecha, from:  “rango inicial de filtro”, to: ”rango final de filtro” formato de fechas YYY-MM-dd (año-mes-dia)
    • serie: Listado de numero de series
    • tipoComprobante Listado de tipo de comprobantes
    • emisor: Dentro de emisor tenemos un atributo llamado rfc el cual es un listado de los rfc tipo emisor a buscar
    • receptor: Dentro de receptor tenemos un atributo llamado rfc el cual es un listado de los rfc tipo receptor a buscar
    • complementos: Dentro de complemento tenemos timbreFiscalDigital y dentro de este mismo tenemos el atributo fechaTimbrado, en el cual lleva un valor de fecha YYY-MM-dd (año-mes-dia)

Los parámetros marcados con * son obligatorios.

Sin embargo, los parámetros emisor o receptor dentro del componente filtros debe de ir al menos uno, ya que uno de los dos (emisor o receptor) debe coincidir con el rfc del solicitante.

Ejemplo de solicitud solo con campos requeridos

Ejemplo de solicitud con todos los campos posibles

Ejemplo de generación de solicitud:

Ejemplo de respuesta exitoso:

No todos los atributos estarán presentes siempre en la respuesta. La descripción de los mismos se define a continuación:

  • solicitud: Número correspondiente a la solicitud generada.
  • codigo: Código correspondiente al estado de la solicitud procesada.
  • mensaje: Mensaje referente al estado de la solicitud.
  • respuesta: Este valor de la respuesta de la solicitud al ser exitosa.

Verificar Solicitud Consulta de Comprobantes

URL de verificación de una solicitud para consultar comprobantes:

https://dm.pade.mx/prod/consulta-comprobantes/verificar

Este método se utiliza para verificar el estatus de la solicitud según los parámetros de autenticación con pade y numero de solicitud creado. El método realiza la autenticación al servicio, valida los parámetros, el número de solicitud y regresa un Json como respuesta al servicio, con un código y toda la información relacionada a los comprobantes con la información filtrada de descarga en caso de respuesta exitosa.

Características de la petición

  • Petición REST
  • Tipo POST
  • Headers: Content-Type = application/json

Parámetros del servicio:

  • userPade*: Indica el usuario con el cual se autenticará al servicio.
  • passPade*: Indica la contraseña del usuario con el cual se autenticará al servicio.
  • contrato*: Indica el código de contrato del usuario con el que se realizará la solicitud.
  • solicitud*: número de solicitud que se realizó en la solicitud

Ejemplo de verificación de solicitud:

Solicitud exitosa:

No todos los atributos estarán presentes siempre en la respuesta. La descripción de los mismos se define a continuación:

  • solicitud: Número correspondiente a la solicitud generada.
  • codigo: Código correspondiente al estado de la solicitud procesada.
  • mensaje: Mensaje referente al estado de la solicitud.
  • respuesta: El valor contiene la dirección el json con comprobantes filtrados en la búsqueda

Multi comprobantes

Pre-requisitos

  • Estar registrado en la plataforma PADE, lo que garantizará que cuente con usuario, contraseña y contrato para autenticarse en el servicio.
  • Contar con un software cliente que le permita realizar las peticiones a nuestro servicio.

Limitantes

  • El contrato en relación con el usuario de estar vigente
  • Se debe contar con una fecha inicio y una fecha fin para poder consultar el servicio, así como un rfcs emisor y/o receptor
  • Solo se pueden solicitar comprobantes de rfcs relacionados al usuario que realiza la petición
  • Los rfcs a solicitar deben estar activos para el usuario
  • Se realiza una petición para solicitar los comprobantes, y otra para verificar el estatus de descarga
  • Cada solicitud tiene su propio número de solicitud

Generar Solicitud de multicomprobantes

URL de generación de una solicitud de multicomprobantes:

https://dm.pade.mx/prod/multicomprobantes/solicitar

Este método se utiliza para generar la solicitud según los parámetros especificados en la petición para mostrar la información relacionada con la búsqueda en los comprobantes en la relación a los parámetros enviados son los parámetros que mostrará como respuesta. El método realiza la autenticación al servicio, valida los parámetros y regresa un Json como respuesta al servicio, con un número de único de solicitud.

Características de la petición

  • Petición REST
  • Tipo POST
  • Headers: Content-Type = application/json

Parámetros del servicio:

  • userPade*: Indica el usuario con el cual se autenticará al servicio.
  • passPade*: Indica la contraseña del usuario con el cual se autenticará al servicio.
  • contrato*: Indica el código de contrato del usuario con el que se realizará la solicitud.
  • fechaInicio*: Indica la fecha inicial de búsqueda
  • fechaFin*: Indica la fecha final de búsqueda
  • emisor*: listado de los rfc tipo emisor a buscar
  • receptor*: listado de los rfc tipo receptor a buscar

Filtros opcionales que se pueden agregar como parámetros para ampliar la búsqueda (no son obligatorios)

  • uuid: Folio fiscal
  • tipo: tipo de comprobante (I,E,T,N,P)
    • I = Ingreso
    • E= Egreso
    • T = Traslado
    • N = Nomina
    • P = Pago
  • serie: serie de un comprobante
  • montoMin: monto mínimo del comprobante, valor entero
  • montoMax: monto máximo del comprobante, valor entero

Los parámetros marcados con * son obligatorios.

Sin embargo, los parámetros emisor o receptor debe de ir al menos uno, ya que uno de los dos (emisor o receptor) debe coincidir con el rfc del solicitante.

Ejemplo de generación de solicitud:

Solicitud exitosa:

No todos los atributos estarán presentes siempre en la respuesta. La descripción de los mismos se define a continuación:

  • solicitud: Número correspondiente a la solicitud generada.
  • codigo: Código correspondiente al estado de la solicitud procesada.
  • mensaje: Mensaje referente al estado de la solicitud.
  • respuesta: Este valor de la respuesta de la solicitud al ser exitosa.

Verificar Solicitud de multicomprobantes

URL de verificación de una solicitud para consultar comprobantes:

https://dm.pade.mx/prod/multicomprobantes/verificar

Este método se utiliza para verificar el estatus de la solicitud según los parámetros de autenticación con pade y numero de solicitud creado. El método realiza la autenticación al servicio, valida los parámetros, el número de solicitud y regresa un Json como respuesta al servicio, con un código y toda la información relacionada a los comprobantes con la información filtrada de descarga en caso de respuesta exitosa

Características de la petición

  • Petición REST
  • Tipo POST
  • Headers: Content-Type = application/json

 Parámetros del servicio:

  • usuario*: Indica el usuario con el cual se autenticará al servicio.
  • passPade*: Indica la contraseña del usuario con el cual se autenticará al servicio.
  • contrato*: Indica el código de contrato del usuario con el que se realizará la solicitud.
  • solicitud*: número de solicitud que se realizó en la solicitud

 Ejemplo de verificación de solicitud:

Solicitud exitosa:

No todos los atributos estarán presentes siempre en la respuesta. La descripción de los mismos se define a continuación:

  • solicitud: Número correspondiente a la solicitud generada.
  • codigo: Código correspondiente al estado de la solicitud procesada.
  • mensaje: Mensaje referente al estado de la solicitud.
  • respuesta: El valor contiene la dirección el json con comprobantes filtrados en la búsqueda

Códigos de respuestas

CódigoMensaje
0Solicitud Exitosa: <mensaje de confirmación>
1Solicitud vacía
2 No se encontró el parámetro <parámetro>, favor de verificar
3Solicitud errónea: Error de sintaxis
4El parámetro <parámetro> no puede estar vacío, favor de verificar
5El parámetro <parámetro> no es válido, favor de verificar. <detalles de validación>
6Error autenticación pade: Código pade, mensaje error
7Error de conexión a bd : <nombre db>
8Error de base de datos: <mensaje personalizado>
9Solicitud en proceso
10Listo para Consultar
101El rfc <RFC> ya existe
102 El rfc <RFC> no existe
103Hubo un problema al tratar con el pfx favor de verificar que sea válido e igual su contraseña
201No se encontró uuid
202Rfc deshabilitado
203 No existe rfc
204No se encontraron comprobantes
205Error al crear zip
206Error al generar url de descarga
207Hubo un error interno
208Error al crear Solicitud
209Información expirada
210No se encontró información solicitada

Anexos: Diagramas del Proceso de Descarga Masiva

Dar de Alta razón social

  • Es necesario dar de alta las razones sociales en el servicio de crear razón social.

¿Cómo obtener mis comprobantes?

  • Una vez Dadas de alta nuestras razones sociales, es necesario habilitar uso del servicio de sincronización automática de descarga de comprobantes

Sincronización SAT

  • Habilitada la sincronización automática, el servicio se hará cargo de realizar la descarga y almacenamiento de tus comprobantes al día, de esta manera para poder obtenerlos y consultarlos dentro de los servicios de Descarga masiva

Descargar comprobante

  • El flujo consiste en enviar la petición al servicio de descargar comprobante, el servicio pide el comprobante en el lugar donde esta almacenado, el comprobante se encripta para mayor seguridad y regresa una cadena base64.

Descarga multicomprobantes

  • Se realiza una petición al servicio de multicomprobantes, este valida la información, obtiene todos los comprobantes relacionados a la búsqueda, crea un archivo zip, inserta los comprobantes al archivo, crea una dirección temporal para descargar el archivo, y se regresa la URL

Consultar comprobantes

  • El servicio realiza la petición, se realiza búsqueda de contenido de los comprobantes en relación a la información a buscar y regresa información de los comprobantes encontrados.

Actualizar razón social

  • Se envía al servicio la información solicitada a actualiza, el servicio la recibe y ejecuta el cambio.

Eliminar razón social

  • Se envía al servicio la información solicitada, el servicio la recibe y elimina la razón social.

Lista de razones sociales

  • Se solicita el servicio de lista de comprobantes, el cual busca el listado de razones sociales que hacen referencia al usuario.
«
»