Lista de documentos de traslado

get

https://api.alegra.com/api/v1/transportation-receipts

Endpoint que permite consultar los documentos de traslado registrados en la aplicación.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

start

integer

≥ 0

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

limit

integer

≤ 30

Defaults to 30

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

order_direction

string

enum

Defaults to ASC

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

Allowed:

order_field

string

enum

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

Allowed:

metadata

boolean

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 facturas. Actualmente la información que se envía en metadata incluye el total de facturas que tiene registrada la empresa.

string

Ids de las facturas de tralasdo. Sirve para consultar facturas específicas. Deben ir separados por coma (,) y sin espacios. Máximo se puede consultar un total de 30 facturas al tiempo. Si se especifica este parámetro, todos los otros parámetros serán ignorados.

date

Filtrar resultados según fecha de creación de la factura. Se retornarán todas las facturas de tralasdo 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.

dateShipping

date

Filtrar resultados según fecha de envio de la factura. Se retornarán todas las facturas de traslado que coincidan en su fecha de envio (atributo dateShipping) con el valor enviado en este parámetro. El formato para la fecha es YYYY-MM-DD.

status

string

Filtrar resultados según el estado de la factura. Se retornarán todas las facturas de tralasdo 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_id

string

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

number

string

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

item_id

string

Filtrar las facturas de tralasdo por el id del item.

number_invoice

string

Filtrar resultados según la numeración de la factura de venta asociada al documento de traslado. Se retornarán todas las facturas de tralasdo que estén asociadas a una factura de venta con el número que contenga el valor enviado en este parámetro.

emission_status

string

enum

Filtrar resultados según el estado de emisión de la factura. Se retornarán todas las facturas de tralasdo 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).

Allowed:

complement

string

enum

Filtra los resultados según si cuenta con el complemento carta porte o no.

Allowed:

Responses

200Retorna la lista de facturas de traslado

400Bad request - Límite sobrepasa máximo permitido