← HomeFleetPay / API

Query unified document tree (MDF-e → CT-e → NF-e)

Parameters, data structure and responses from the versioned contract.

GET/carriers/arvore-documental
consultarArvoreDocumentalSandbox Base: https://api.fleetpay.site/v1

Technical 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.

Authentication

Required Scope
operacao — Operations
Module
Disbursements & Receipts
Target Profiles
Transport Manager · Dedicated Fleet Contractor · Fleet Carrier
Schemes
OAuth2 client_credentials (POST /oauth/token) or API Key via Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.

Parameters

chavequery · stringOptional

Optional 44-digit access key to filter the tree.

Constraints
{
  "type": "string"
}
fromquery · stringOptional

Start date (YYYY-MM-DD).

Constraints
{
  "type": "string"
}
toquery · stringOptional

End date (YYYY-MM-DD).

Constraints
{
  "type": "string"
}

Responses

200 HTTP Response

Operation processed successfully.

application/json

data—Optional
metaobject | nullOptional
additionalPropertiestrue
ambientestringOptional
"homologacao" · "producao"
401 HTTP Response

Missing, invalid or cross-environment credential.

403 HTTP Response

Dashboard scope not enabled or resource outside company scope.

Complete Operation Definition
{
  "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"
}