ALalegra
Operational Tools

Listar documentos de traslado

Herramienta MCP: transportationReceipts_listTransportationReceipts.

Lista los documentos de traslado de México ("documentos de traslado" o CFDI de traslado con el Complemento Carta Porte del SAT), con paginación y filtros.

Esta herramienta es exclusiva para México (MEX). Úsala para encontrar documentos cuando no conoces sus IDs, o para filtrar por fecha de emisión, fecha de envío, estado, cliente, factura vinculada o presencia del Complemento Carta Porte. Con complement: "yes" se listan solo las cartas porte y es la forma confiable de saber qué documentos tienen el complemento.

Devuelve hasta 30 registros por llamada, por defecto como proyección ligera (id, número, fechas, estado, cliente, numeración, factura vinculada y un resumen de los ítems trasladados). Con detail: true se devuelve el payload completo. Un registro ligero trae hasComplement: true solo cuando el payload reportó el complemento, así que la ausencia de esa marca no es prueba de que el documento no lo tenga: para responderlo, filtra con complement.

No confundas estos documentos con las facturas de venta, que viven en otra herramienta. Usa transportationReceipts_getTransportationReceipt cuando ya conoces el ID.

Esta herramienta nunca crea ni modifica nada.

Solo lectura.

post/tools/transportationReceipts_listTransportationReceipts

Request

  • Base URL
    https://mcp.alegra.com
  • URL
    https://mcp.alegra.com/tools/transportationReceipts_listTransportationReceipts
  • Auth
    HTTP bearer

Request body

startnumber

Desplazamiento desde el que empieza la lista (por ejemplo 0 para la primera página, 30 para la segunda).

limitnumber

Número de documentos de traslado a devolver por solicitud. Máximo 30.

order_direction'ASC' | 'DESC'

Dirección del orden. Por defecto ASC.

order_field'id' | 'date' | 'name' | 'dateShipping' | 'status' | 'number'

Campo por el que se ordena ("name" es el nombre del cliente).

metadataboolean

Si es true, envuelve la respuesta como { data: TransportationReceipt[], metadata: { total: number } } en lugar de devolver un arreglo plano.

idstring

Lista separada por comas de IDs específicos de documentos de traslado, sin espacios (por ejemplo "2,3,10"), máximo 30. ADVERTENCIA: cuando se envía este parámetro, la API ignora todos los demás filtros.

datestring

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

dateShippingstring

Filtra por fecha exacta de envío (AAAA-MM-DD), la fecha en que se mueve la mercancía.

statusstring

Filtra por estado: 'open', 'closed', 'draft' o 'void'. Puede ser una lista separada por comas.

client_idstring

Filtra por el ID del cliente.

numberstring

Filtra por número de documento, coincidencia parcial (por ejemplo "APITT" encuentra "APITT2" y "APITT3").

item_idstring

Filtra los documentos que incluyen este ID de ítem.

number_invoicestring

Filtra por el número de la factura de venta vinculada, coincidencia parcial.

emission_status'STAMPED_AND_ACCEPTED' | 'STAMPED_AND_ACCEPTED_WITH_OBSERVATIONS' | 'STAMPED_AND_CANCELLED' | 'STAMPED_AND_WAITING_RESPONSE' | 'CANCELLED_AND_WAITING_RESPONSE'

Filtra por el estado del timbrado del CFDI ante el SAT.

complement'yes' | 'no'

Filtra por la presencia del Complemento Carta Porte del SAT: "yes" solo los documentos que lo tienen, "no" solo los que no lo tienen.

detailboolean

Cuando es false (por defecto) devuelve una proyección ligera de cada documento (id, número, fecha, fecha de envío, estado, cliente, numeración, factura vinculada y resumen de ítems). Con true devuelve el payload completo de la API (dirección completa del cliente, configuración de numeración, regímenes fiscales, montos por ítem y datos del complemento). Úsalo solo cuando el usuario pida explícitamente ese nivel de detalle.

Response

Lista de documentos de traslado (o { data, metadata } cuando metadata es true)

Changes

No recorded changes to this operation across all 1 revision of this API.