01
Transport Documents
Find documents and track their status by company.
- Tool
fleetpay_core_documents_list- Scope
read:documents.list
Parameters, Output and Limits
- Parameters
company_idinteger · Optional- Authorized company ID. May be resolved from CNPJ or name; panel sessions use their pinned company. An authorized company context is required before the query.
company_cnpjstring · Optional- Alternative to the ID, with or without formatting. Identifying a company does not grant access to its data.
company_namestring · Optional- Name alternative with at least three characters. Ambiguous names require disambiguation. Priority: ID, CNPJ, name.
statusstring · Optional- Document status filter, using values accepted by the environment.
fromstring · YYYY-MM-DD · Optional- Start of the period, applied to payment_date / shipper_due_date.
tostring · YYYY-MM-DD · Optional- End of the period, applied to payment_date / shipper_due_date.
limitinteger · Optional- Items per page: default 25, maximum 100.
cursorinteger · Optional- Last item ID, used to request the next page.
- Output
Document identifiers, status, amount and dates; pagination with cursor, has_more, limit and total.
Selected fields for interpreting the response; they do not replace a sandbox-validated output schema.
data[].iddata[].internal_iddata[].statusdata[].amount- Document identifier, status and amount. Document status does not replace payment evidence.
data[].sacado_payment_datedata[].sacado_due_datedata[].sacado_due_date_postponed- Debtor payment date, contractual due date and extended due date. Values may be null; the query does not calculate overdue days.
meta.pagination.cursormeta.pagination.has_moremeta.pagination.total- Use the returned cursor when has_more is true. On the last page, cursor is null. total counts documents across the full filtered scope.
meta.company_ids_in_scopemeta.scope_expandedmeta.scope_note- Companies actually included in the query. Check this scope before attributing results to a single shipper.
- How to Interpret
- 25 items by default, up to 100 per page. payment_date and shipper_due_date represent the shipper’s due date. Actual debtor payment uses sacado_payment_date.
Input Example
Fictional identifiers. Method and parameters only; transport and authentication are confirmed during enablement. This page does not execute queries.
{
"method": "tools/call",
"params": {
"name": "fleetpay_core_documents_list",
"arguments": {
"company_id": 101,
"limit": 25
}
}
}Empty Result Example
Synthetic data and fictional IDs. An empty list only describes the queried scope; it does not prove that no records exist outside the authorized scope. See the download for item fields, unconfirmed types and the not_found variant.
{
"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
}