[API FE DOM] Mejoras en las consultas de documentos recibidos

Para los endpoints de consulta de documentos electrónicos recibidos que forman parte del flujo emisor-receptor hemos añadido cuatro nuevos parámetros de consulta (rnc, documentNumber, status & commercialResponse) que puedes utilizar para obtener una lista de documentos basándonos en esos criterios de búsqueda.

Esta novedad se completa bastante con la funcionalidad de listar documentos por rangos de fechas. Esto abre la oportunidad de ser flexibles con respecto a la búsqueda y listado de la información.

Funcionamiento del listado de documentos recibidos

Cuando un emisor genera un documento electrónico (e.g., E31, E33, E34, E44) en el que tu RNC figura como comprador (receptor), el XML se envía automáticamente a tu URL de recepción. Nosotros gestionamos todo el proceso para que solo necesites listar la información.

Esta es la primera etapa del flujo emisor-receptor. Al recibir el documento, también respondemos automáticamente con un acuse de recibo para confirmar si se recibió correctamente o si hubo algún problema. Posteriormente, tienes la opción de emitir un acuse propio, que notificaremos tanto al emisor como a la DGII. Este flujo se fortalecerá con el tiempo, ya que será la forma estándar de comunicación entre emisor y receptor con la entidad. Por ello, es esencial mantener un histórico y una forma de recuperar esta información cuando sea necesario.

Ejemplos prácticos

• GET => sandbox.alanube.co/dom/v1/received-documents/idCompany/123?start=2024-10-01&end=2024-10-31&status=RECEIVED&commercialResponse=NOT_DECLARED&rnc=132109122&limit=10
  • Obtiene un listado de 10 documentos para la compañía 123 entre las fechas de emisión 2024-10-01 & 2024-10-31 que hayan sido recibidos, no se haya presentado alguna aprobación comercial y el RNC del emisor tiene que ser 132109122.
• GET => sandbox.alanube.co/dom/v1/received-documents/idCompany/123
  • Obtiene un listado de 25 documentos para la compañía 123 de los últimos 30 días que hayan sido recibidos y tengan la aprobación comercial pendiente.

A continuación se verá un ejemplo de respuesta en caso de encontrar documentos relacionados con los criterios de busqueda:

{
  "metadata":{
    "current_page":1,
    "limit":25,
    "from":1,
    "to":1
  },
  "documents":[
    {
      "id":"01JBD6YDVFEXP4M34VBMKCGSG1",
      "issuerIdentification":"132109122",
      "buyerIdentification":"132109122",
      "documentType":"31",
      "documentNumber":"E310009123706",
      "documentStampDate":"2024-10-29",
      "signatureDateTime":"2024-10-29 18:34:10",
      "totalAmount":"1000",
      "status":"RECEIVED",
      "errorMsg":null,
      "commercialResponse":"NOT_DECLARED",
      "timestamp":"2024-10-29T22:39:34.000Z"
    }
  ]
}

Consideraciones

• En caso de no enviar parámetros de consulta tienes que tener en cuenta que por debajo hay valores que se configurarán por defecto. Esto viene especificado en la documentación.