[API FE DOM] Consulta documentos recibidos por rangos fechas
about 2 months ago by Alanube
Para los endpoints de consulta de documentos electrónicos recibidos que forman parte del flujo emisor-receptor hemos añadido dos nuevos parámetros de consulta (start
& end
) que puedes utilizar para obtener una lista de documentos en un rango de fechas de emisión específico.
Para hacer uso de esta funcionalidad simplemente tienes que incorporar los dos nuevos parámetros como query params a la url de consulta:
https://sandbox.alanube.co/dom/v1/received-documents/idCompany/12345?limit=2&page=1&start=2024-09-01&end=2024-09-30
.
Y en caso de que existan documentos recibidos entre ese rango de fechas de emisión podrás ver una respuesta como la siguiente:
{
"metadata": {
"current_page": 1,
"limit": 2,
"from": 1,
"to": 2
},
"documents": [
{
"id": "01HRSNHPGVW7G6GM5FSZC8VMZ9",
"issuerIdentification": "131880738",
"buyerIdentification": "132109122",
"documentType": "31",
"documentNumber": "E310000000003",
"documentStampDate": "2024-03-12",
"signatureDateTime": "2024-03-12 11:47:07",
"totalAmount": "7080.00",
"status": "RECEIVED",
"errorMsg": null,
"commercialResponse": "NOT_DECLARED",
"timestamp": "2024-03-12T15:47:24.000Z"
},
{
"id": "01HRSXGVWY8GWX06P41XA83CR3",
"issuerIdentification": "131880738",
"buyerIdentification": "132109122",
"documentType": "31",
"documentNumber": "E310000000009",
"documentStampDate": "2024-03-12",
"signatureDateTime": "2024-03-12 02:06:29",
"totalAmount": "7080.00",
"status": "RECEIVED",
"errorMsg": null,
"commercialResponse": "NOT_DECLARED",
"timestamp": "2024-03-12T18:06:46.000Z"
}
]
}
Notas
- En caso de que sigas disparando las consultas sin esos parámetros, e.g
https://sandbox.alanube.co/dom/v1/received-documents/idCompany/12345?limit=2&page=1
debes de tener en cuenta que por defecto asignaremos un valor a los mismos; parastart
va a serfecha actual menos un mes
, paraend
simplemente va a ser lafecha actual
. - Todos los resultados estarán ordenados con base a la fecha de emisión (
documentStampDate
) de los documentos de forma descendente (DESC). O dicho de otra forma, de los records más recientes a los más antiguos. - Para información más detallada la documentación oficial siempre va a ser tu mejor aliado.