Obtener remisiones

Herramienta MCP: remissions_getRemissions.

Obtiene remisiones (paginadas, máximo 30 por página). Por defecto devuelve una versión ligera de cada remisión; con detail: true devuelve la fila completa tal como la envía el listado. Las dos proyecciones no son una dentro de la otra: la fila del listado lleva el costCenter que remissions_getRemissionById siempre responde como null — así que es la única forma de leer el centro de costos de un documento —, mientras que solo la lectura por ID puede expandir comments, invoices y pdf.

Filtros: cliente (por ID con client_id, por nombre con client_name), estados (status, combinados con OR), moneda (currency_code, código ISO), bodega (warehouse_id), lista de precios (priceList_id), fechas exactas (date, dueDate) y número (number, que coincide por los dígitos significativos y no es único: una empresa puede tener varias remisiones con el mismo).

order_field aplica verificado sobre number, dueDate, status y name (ordena por nombre del cliente, mientras que el filtro para eso se llama client_name); cualquier otro valor se acepta y se ignora silenciosamente — incluidos date, client_name, deliveryDate, total e id — y el resultado vuelve en el orden por defecto (fecha más reciente primero). order_direction funciona por sí solo, sin order_field. El listado solo expande los cuatro indicadores de acción: editable, voidable, deletable y openable (por ejemplo "editable,voidable"); comments, invoices y pdf se aceptan aquí y nunca se expanden — lee esos campos con remissions_getRemissionById. limit va entre 0 y 30 (límite estricto de la API); si lo omites se pagina de a 30, el tamaño que usa el propio listado. Cuando el usuario quiera un conjunto grande (más de ~120 registros) o un rango completo de fechas, usa la herramienta exportable en lugar de paginar aquí.

Solo lectura.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Filtra por el ID del cliente (contacto).

string

Filtra por nombre del cliente.

status
array of strings

Filtra por uno o más estados de remisión (por ejemplo ["open"], ["open", "void"]). Los múltiples valores se combinan con OR.

status
Allowed:
string
enum

Dirección del orden: "ASC" ascendente, "DESC" descendente. Funciona por sí solo, sin order_field.

Allowed:
string

Nombre del campo por el que se ordena. Verificado que aplica: "number", "dueDate", "status" y "name" (ordena por nombre del cliente, mientras que el filtro para eso se llama client_name). Cualquier otro valor se acepta y se ignora silenciosamente — incluidos "date", "client_name", "deliveryDate", "total" e "id" — y el resultado vuelve en el orden por defecto (fecha más reciente primero).

integer
≥ 0

Desplazamiento basado en cero para la paginación. Usa limit * número de página para saltar páginas.

integer
0 to 30

Máximo de remisiones por página. Entre 0 y 30 (límite estricto de la API). Si lo omites se pagina de a 30, el tamaño que usa el propio listado de remisiones.

string

Filtra por código de moneda ISO (por ejemplo "USD").

string

Filtra por el ID de la bodega.

string

Filtra por el ID de la lista de precios.

string
^\d{4}-\d{2}-\d{2}$

Filtra por fecha de emisión exacta (YYYY-MM-DD).

string
^\d{4}-\d{2}-\d{2}$

Filtra por fecha de vencimiento exacta (YYYY-MM-DD).

string

Filtra por el número visible o el número completo de la remisión (por ejemplo "4515", "00011-00004515"). Coincide por los dígitos significativos, no necesariamente con la cadena completa con prefijo y relleno.

string

Lista separada por comas de campos adicionales a expandir en cada remisión. Este endpoint solo expande los cuatro indicadores de acción: "editable", "voidable", "deletable" y "openable" (por ejemplo "editable,voidable"). comments, invoices y pdf se aceptan aquí y nunca se expanden — lee esos campos con remissions_getRemissionById.

boolean
Defaults to false

Con false (por defecto) devuelve una versión ligera de cada remisión (IDs, fechas, estado, numeración, cliente y montos). Con true se incluye el payload completo (ítems, impuestos, etc.), solo cuando el usuario pide ese detalle.

Responses

401

No autorizado

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json