Listar comprobantes recibidos

get

https://api.alegra.com/api/v1/stamp-documents-received

Endpoint que permite consultar los comprobantes del buzón de recepción para Colombia. Con metadata=true la respuesta incluye metadata.total y data. Para incluir el correo de recepción, solicita fields=stampReceptionEmail.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

start

integer

≥ 0

Defaults to 0

Desplazamiento de resultados basado en cero; start=0 inicia en el primer resultado.

limit

integer

Defaults to 30

Cantidad máxima de comprobantes por página. Por defecto 30; los valores superiores a 80 se ajustan a 80, sin generar el error 903 por exceder ese valor.

order_direction

string

enum

Defaults to DESC

Dirección de ordenamiento de los comprobantes; por defecto DESC.

Allowed:

order_field

string

Defaults to id

Campo de ordenamiento de los comprobantes; por defecto id.

metadata

boolean

Omite este parámetro para recibir una lista. Con metadata=true devuelve un objeto con data (página de resultados) y metadata.total (total que coincide con los filtros, antes de paginar). El texto metadata=false también activa este objeto; no lo uses para desactivar los metadatos.

simple

boolean

Solicita la representación simplificada del comprobante.

fields

array of strings

Campos adicionales del comprobante separados por comas; por ejemplo, fields=stampReceptionEmail,receiverInformation. Su disponibilidad depende del comprobante y de la representación solicitada.

fields

resource_type

string

Filtra por tipo de documento asociado. Los tipos conocidos incluyen bill (factura de compra) y debitNote (nota débito); no se valida como una lista cerrada de valores.

origin

string

Filtra por el origen del comprobante; por ejemplo, email para los recibidos por correo electrónico.

date

Filtra por igualdad de la fecha del comprobante (YYYY-MM-DD).

identification

string

Busca comprobantes cuya identificación del proveedor contenga el texto indicado (coincidencia parcial).

provider_name

string

Busca comprobantes cuyo nombre del proveedor contenga el texto indicado (coincidencia parcial).

total

string

Busca el texto indicado dentro del total del comprobante; es una coincidencia parcial, no una comparación de igualdad numérica.

response

array of strings

Filtra por pertenencia a las respuestas almacenadas indicadas, separadas por comas; por ejemplo, response=ACKNOWLEDGMENT,ACCEPT. Incluye la aceptación tácita almacenada (TACIT_ACCEPTANCE), que no es un evento emitible con POST. Usa UNANSWERED solo, sin combinarlo con otros valores, para buscar comprobantes sin respuesta (valor nulo).

response

Allowed:

query

string

Búsqueda textual.

number

string

Busca comprobantes cuyo número contenga el texto indicado (coincidencia parcial).

date_laterThanOrEqualTo

date

date_earlierThanOrEqualTo

date

datetime_laterThanOrEqualTo

string

datetime_earlierThanOrEqualTo

string

is_registered

boolean

Indica si se consultan comprobantes registrados o pendientes de registrar.

Responses

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Lista de comprobantes recibidos. Con metadata=true devuelve data con la página y metadata.total con el total de coincidencias antes de paginar.

400Datos requeridos faltantes o evento no válido. Este endpoint devuelve code y message; el esquema compartido GeneralError conserva error en lugar de message y no representa ese campo con el mismo nombre.