chavequery · stringOpcionalClave de acceso opcional (44 dígitos) para filtrar el árbol.
Restricciones
{
"type": "string"
}Parámetros, estructura de datos y respuestas del contrato versionado.
/carriers/arvore-documentalLas descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.
Devuelve la cadena jerárquica completa que conecta MDF-e, CT-e/CIOT y NF-e vinculados con el estado de transferencia.
operacao — Operación[
{
"oauth2": []
},
{
"chaveApi": []
}
]chavequery · stringOpcionalClave de acceso opcional (44 dígitos) para filtrar el árbol.
{
"type": "string"
}fromquery · stringOpcionalFecha inicial (YYYY-MM-DD).
{
"type": "string"
}toquery · stringOpcionalFecha final (YYYY-MM-DD).
{
"type": "string"
}200 Respuesta HTTPOperación procesada con éxito.
application/jsondata—Opcionalmetaobject | nullOpcionaladditionalPropertiestrueambientestringOpcional"homologacao" · "producao"401 Respuesta HTTPCredencial ausente, inválida o de otro entorno.
403 Respuesta HTTPPermiso del panel no habilitado o recurso fuera del alcance de la company.
{
"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"
}