01
Documentos de Transporte
Localiza documentos y consulta su estado por empresa.
- Herramienta
fleetpay_core_documents_list- Permiso
read:documents.list
Parámetros, Respuesta y Límites
- Parámetros
company_idinteger · Opcional- ID de la empresa autorizada. Puede resolverse por CNPJ o nombre; las sesiones del panel usan su empresa fijada. Se requiere un contexto de empresa autorizado antes de consultar.
company_cnpjstring · Opcional- Alternativa al ID, con o sin formato. Identificar una empresa no concede acceso a sus datos.
company_namestring · Opcional- Alternativa por nombre de al menos tres caracteres. Los nombres ambiguos requieren desambiguación. Prioridad: ID, CNPJ, nombre.
statusstring · Opcional- Filtro por estado del documento, según los valores aceptados en el entorno.
fromstring · YYYY-MM-DD · Opcional- Inicio del período, aplicado a payment_date / shipper_due_date.
tostring · YYYY-MM-DD · Opcional- Fin del período, aplicado a payment_date / shipper_due_date.
limitinteger · Opcional- Elementos por página: 25 por defecto, máximo 100.
cursorinteger · Opcional- ID del último elemento para consultar la siguiente página.
- Respuesta
Identificación, estado, importe y fechas de los documentos; paginación con cursor, has_more, limit y total.
Campos seleccionados para interpretar la respuesta; no sustituyen un schema de salida validado en pruebas.
data[].iddata[].internal_iddata[].statusdata[].amount- Identificación, estado e importe del documento. Su estado no sustituye la evidencia de pago.
data[].sacado_payment_datedata[].sacado_due_datedata[].sacado_due_date_postponed- Fecha de pago del deudor, vencimiento contractual y vencimiento prorrogado. Pueden ser nulos; la consulta no calcula días de atraso.
meta.pagination.cursormeta.pagination.has_moremeta.pagination.total- Usa el cursor devuelto cuando has_more sea true. En la última página, cursor es null. total cuenta los documentos de todo el ámbito filtrado.
meta.company_ids_in_scopemeta.scope_expandedmeta.scope_note- Empresas incluidas efectivamente en la consulta. Revisa este ámbito antes de atribuir los resultados a un solo embarcador.
- Cómo Interpretar
- 25 elementos por defecto, hasta 100 por página. payment_date y shipper_due_date representan el vencimiento del embarcador. El pago efectivo del deudor usa sacado_payment_date.
Ejemplo de Entrada
Identificadores ficticios. Solo método y parámetros; el transporte y la autenticación se confirman durante la habilitación. Esta página no ejecuta consultas.
{
"method": "tools/call",
"params": {
"name": "fleetpay_core_documents_list",
"arguments": {
"company_id": 101,
"limit": 25
}
}
}Ejemplo de Respuesta Vacía
Datos sintéticos e IDs ficticios. Una lista vacía solo describe el ámbito consultado; no prueba la ausencia de registros fuera del ámbito autorizado. Consulta el archivo para los campos de los elementos, tipos pendientes y la variante not_found.
{
"data": [],
"meta": {
"company_id": 101,
"company_ids_in_scope": [
101
],
"scope_expanded": false,
"scope_note": null,
"field_semantics": "sacado_payment_date = dia em que o EMBARCADOR (sacado) pagou a fatura (pay_invoices.payment_date, via pay_payments SHIPPER_CARRIER_PAYMENT; null = em aberto). NÃO confunda com pay_documents.payment_date (= vencimento do embarcador, data futura) nem com pay_receivables.payment_date (= data em que o FIDC foi ressarcido). Atraso não é calculado aqui: use sacado_due_date (vencimento contratual) ou sacado_due_date_postponed (prorrogado) conforme a metodologia do score.",
"pagination": {
"cursor": null,
"has_more": false,
"limit": 25,
"total": 0
}
},
"error": null
}