Listar receptores de comprobantes

get

https://api.alegra.com/api/v1/receivers-for-stamp-documents

Endpoint que permite consultar los receptores de comprobantes registrados para Colombia.

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

0 to 30

Defaults to 30

Cantidad máxima de receptores por página. Por defecto 30; admite de 0 a 30. Un valor negativo o superior a 30 genera el error 903.

fields

array of strings

Campos adicionales del receptor separados por comas; por ejemplo, fields=idGlobal,createdAt,updatedAt.

fields

Allowed:

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.

identification

string

Filtra por coincidencia parcial de la identificación del receptor.

firstname

string

Filtra por coincidencia parcial del primer nombre del receptor. En el cuerpo JSON se utiliza firstName.

lastname

string

Filtra por coincidencia parcial del apellido del receptor. En el cuerpo JSON se utiliza lastName.

receiverRole

string

Filtra por coincidencia parcial del cargo del receptor.

receiverArea

string

Filtra por coincidencia parcial del área del receptor.

receiverType

string

Filtra por coincidencia parcial del tipo de receptor, no por igualdad. Los tipos completos válidos son ACKNOWLEDGMENT, SERVICE_CONFIRMATION y ACKNOWLEDGMENT_AND_SERVICE_CONFIRMATION; también se admite un fragmento de texto, por ejemplo ACKNOWLEDGMENT.

Responses

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

400El parámetro "límite" supero el valor de 30