chavequery · stringOptionalOptional 44-digit access key to filter the tree.
Constraints
{
"type": "string"
}Parameters, data structure and responses from the versioned contract.
/carriers/arvore-documentalTechnical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.
Returns the full hierarchical chain connecting linked MDF-e, CT-e/CIOT and NF-e with payout status.
operacao — Operations[
{
"oauth2": []
},
{
"chaveApi": []
}
]chavequery · stringOptionalOptional 44-digit access key to filter the tree.
{
"type": "string"
}fromquery · stringOptionalStart date (YYYY-MM-DD).
{
"type": "string"
}toquery · stringOptionalEnd date (YYYY-MM-DD).
{
"type": "string"
}200 HTTP ResponseOperation processed successfully.
application/jsondata—Optionalmetaobject | nullOptionaladditionalPropertiestrueambientestringOptional"homologacao" · "producao"401 HTTP ResponseMissing, invalid or cross-environment credential.
403 HTTP ResponseDashboard scope not enabled or resource outside company scope.
{
"tags": [
"Parcelas"
],
"operationId": "consultarArvoreDocumental",
"summary": "Consultar árvore documental unificada (MDF-e → CT-e → NF-e)",
"description": "Retorna a cadeia hierárquica completa conectando MDF-e, CT-e/CIOT e NF-e vinculadas com o status de repasse.",
"parameters": [
{
"name": "chave",
"in": "query",
"required": false,
"description": "Chave de acesso opcional (44 dígitos) para filtrar a árvore.",
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"required": false,
"description": "Data inicial (YYYY-MM-DD).",
"schema": {
"type": "string"
}
},
{
"name": "to",
"in": "query",
"required": false,
"description": "Data final (YYYY-MM-DD).",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Operação processada com sucesso.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
}
]
},
"meta": {
"type": [
"object",
"null"
],
"additionalProperties": true
},
"ambiente": {
"type": "string",
"enum": [
"homologacao",
"producao"
]
}
}
}
}
}
},
"401": {
"description": "Credencial ausente, inválida ou de outro ambiente."
},
"403": {
"description": "Escopo do painel não habilitado ou recurso fora do escopo da company."
}
},
"x-fleetpay-scope": "operacao",
"x-fleetpay-module": "repasses-comprovantes",
"x-fleetpay-profiles": [
"gestor",
"agregado_empresarial",
"transportador_frotista"
],
"method": "GET",
"path": "/carriers/arvore-documental"
}