01
Documentos de Transporte
Localize documentos e acompanhe sua situação por empresa.
- Ferramenta
fleetpay_core_documents_list- Escopo
read:documents.list
Parâmetros, Retorno e Limites
- Parâmetros
company_idinteger · Opcional- ID da empresa autorizada. Pode ser resolvido por CNPJ ou nome; sessões do painel usam a empresa fixada na sessão. Um contexto de empresa autorizado é necessário antes da consulta.
company_cnpjstring · Opcional- Alternativa ao ID, com ou sem máscara. Identificar uma empresa não concede acesso a seus dados.
company_namestring · Opcional- Alternativa por nome, com pelo menos três caracteres. Nomes ambíguos exigem desambiguação. Prioridade: ID, CNPJ, nome.
statusstring · Opcional- Filtro por status do documento, conforme os valores aceitos no ambiente.
fromstring · YYYY-MM-DD · Opcional- Início do período, aplicado a payment_date / shipper_due_date.
tostring · YYYY-MM-DD · Opcional- Fim do período, aplicado a payment_date / shipper_due_date.
limitinteger · Opcional- Itens por página: padrão 25, máximo 100.
cursorinteger · Opcional- ID do último item, para consultar a próxima página.
- Retorno
Identificação, status, valor e datas dos documentos; paginação com cursor, has_more, limit e total.
Campos selecionados para interpretar a resposta; não substituem um schema de saída validado em homologação.
data[].iddata[].internal_iddata[].statusdata[].amount- Identificação, status e valor do documento. O status do documento não substitui a evidência de pagamento.
data[].sacado_payment_datedata[].sacado_due_datedata[].sacado_due_date_postponed- Data de pagamento do sacado, vencimento contratual e vencimento prorrogado. Podem ser nulos; a consulta não calcula atraso.
meta.pagination.cursormeta.pagination.has_moremeta.pagination.total- Use o cursor retornado quando has_more for true. Na última página, cursor é null. total conta os documentos de todo o recorte filtrado.
meta.company_ids_in_scopemeta.scope_expandedmeta.scope_note- Empresas efetivamente incluídas na consulta. Confira este recorte antes de atribuir os resultados a um único embarcador.
- Como Interpretar
- 25 itens por padrão, até 100 por página. payment_date e shipper_due_date representam o vencimento do embarcador. O pagamento efetivo do sacado usa sacado_payment_date.
Exemplo de Entrada
Identificadores fictícios. Apenas método e parâmetros; o transporte e a autenticação são confirmados na habilitação. Esta página não executa consultas.
{
"method": "tools/call",
"params": {
"name": "fleetpay_core_documents_list",
"arguments": {
"company_id": 101,
"limit": 25
}
}
}Exemplo de Retorno Vazio
Dados sintéticos e IDs fictícios. Uma lista vazia representa apenas o recorte consultado; não comprova ausência de registros fora do escopo autorizado. Consulte o arquivo para campos dos itens, tipos pendentes e a 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
}