Tickets de venta

Lista de tickets de venta

Changed on

Endpoint que retorna llos tickets registrados en la cuenta de Alegra. Si no se envía límite de tickets, por defecto se envían 30.

get/sale-tickets

Request

  • Base URL
    https://api.alegra.com/api/v1
  • URL
    https://api.alegra.com/api/v1/sale-tickets
  • Auth
    HTTP basic

Query parameters

startinteger

Desde cual ticket se quiere consultar. Por ejemplo para consultar desde el ticket 20, se envía start=20 (diferente a id de ticket). Los resultados varian según el orden en el que se muestra la información.

limitinteger

Cantidad de tickets a partir del inicio que se desea retornar. Por defecto retorna 30 tickets. Si este valor es mayor que 30, la aplicación retorna error.

order_directionstring

Orden ascendente o descendente en el cual se quieren retornar las tickets. Opciones disponibles son DESC o ASC. Por defecto es ASC (ascendente).

order_fieldstring

Campo por el cual se desea ordenar, las opciones posibles son id, name, date, dueDate, status.

metadataboolean

Incluir en los resultados metadatos. Se debe tener en cuenta que si se envía este parámetro el objeto que retorna la aplicación incluye un atributo "metadata" y otro "data" en donde se envían las tickets. Actualmente la información que se envía en metadata incluye el total de tickets que tiene registrada la empresa.

datestring date

Filtrar resultados según fecha de creación de el ticket. Se retornarán todas las tickets de venta que su fecha de creación (atributo date) coincida exactamente con el valor enviado en este parámetro. El formato para la fecha es YYYY-MM-DD.

dueDatestring date

Filtrar resultados según fecha de vencimiento de el ticket. Se retornarán todas las tickets de venta que coincidan en su fecha de vencimiento (atributo dueDate) con el valor enviado en este parámetro. El formato para la fecha es YYYY-MM-DD.

statusstring

Filtrar resultados según el estado de el ticket. Se retornarán todas las tickets de venta que coincidan en su estado (atributo status) con el valor enviado en este parámetro. Los valores aceptados son open, closed, draft y void, para consultar varios estados se deben separar con una coma (closed,draft).

client_idstring

Filtrar resultados según el identificador del cliente de el ticket. Se retornarán todas las tickets de venta que estén asociadas a un cliente que en su identificador (campo del id) contenga el valor enviado en este parámetro.

client_namestring

Filtrar resultados según el nombre del cliente de el ticket. Se retornarán todas las tickets de venta que estén asociadas a un cliente que en su nombre contenga el valor enviado en este parámetro.

client_identificationstring

Filtrar resultados según la identificación del cliente de el ticket. Se retornarán todas las tickets de venta que estén asociadas a un cliente que en su identificación (campo del identification) contenga el valor enviado en este parámetro.

numberTemplate_fullNumberstring

Filtrar resultados según la numeración de el ticket. Se retornarán todas las tickets de venta que estén asociadas a una numeración que contenga el valor enviado en este parámetro.

item_idstring

Filtrar las tickets de venta por el id del item.

date_afterstring date

Fecha del documento desde la cual se deben obtener los resultados. Consulta desde el dia siguiente en adelante. El formato para la fecha es YYYY-MM-DD.

date_afterOrNowstring date

Fecha del documento desde la cual se deben obtener los resultados. Consulta desde el dia actual en adelante. El formato para la fecha es YYYY-MM-DD.

date_beforestring date

Fecha del documento desde la cual se deben obtener los resultados. Consulta desde el dia anterior para atras. El formato para la fecha es YYYY-MM-DD.

date_beforeOrNowstring date

Fecha del documento desde la cual se deben obtener los resultados. Consulta desde el dia actual para atras. El formato para la fecha es YYYY-MM-DD.

dueDate_afterstring date

Fecha de vencimiento del documento desde la cual se deben obtener los resultados. Consulta desde el dia siguiente en adelante. El formato para la fecha es YYYY-MM-DD.

dueDate_afterOrNowstring date

Fecha de vencimiento del documento desde la cual se deben obtener los resultados. Consulta desde el dia actual en adelante. El formato para la fecha es YYYY-MM-DD.

dueDate_beforestring date

Fecha de vencimeinto del documento desde la cual se deben obtener los resultados. Consulta desde el dia anterior para atras. El formato para la fecha es YYYY-MM-DD.

dueDate_beforeOrNowstring date

Fecha de vencimeinto del documento desde la cual se deben obtener los resultados. Consulta desde el dia anterior para atras. El formato para la fecha es YYYY-MM-DD.

Response

Retorna la lista de tickets de venta

Changes