← HomeFleetPay / API

Get CT-e pre-fill payload from linked NF-e

Parameters, data structure and responses from the versioned contract.

GET/embarcador/solicitacoes-transporte/{id}/fiscal/preenchimento-cte
preencherCteSolicitacaoTransporteEmbarcadorSandbox Base: https://api.fleetpay.site/v1

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

Prepares and returns the CT-e pre-fill payload (CtePrefillService) from an attached NF-e with no pending uncertainties, updating fiscal_status to cte_prefilled without automatically issuing the CT-e.

Authentication

Required Scope
operacao — Operations
Module
Direct Contracting (Shipper)
Target Profiles
Shipper · Transport Manager · Dedicated Fleet Contractor
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

idpath · stringRequired
Constraints
{
  "type": "string"
}

Responses

200 HTTP Response

CT-e pre-fill payload generated (fiscal_status: cte_prefilled)

application/json

successbooleanOptional
commercial_resolutionobject | nullOptional
404 HTTP Response

Request not found

application/json

errorobjectOptional
422 HTTP Response

Missing NF-e or pending confirmation uncertainty

application/json

errorobjectOptional
Complete Operation Definition
{
  "tags": [
    "Solicitações e Contratação de Transporte (Embarcador)"
  ],
  "summary": "Obter pré-preenchimento de CT-e a partir de NF-e vinculada",
  "description": "Prepara e retorna o payload pré-preenchido de CT-e (`CtePrefillService`) a partir de documento fiscal NF-e já anexado e sem incertezas pendentes, atualizando `fiscal_status` para `cte_prefilled` sem emitir CT-e automaticamente.\n",
  "operationId": "preencherCteSolicitacaoTransporteEmbarcador",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Payload de pré-preenchimento de CT-e gerado (`fiscal_status: cte_prefilled`)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/SolicitacaoTransporteResponse"
          }
        }
      }
    },
    "404": {
      "description": "Solicitação não encontrada",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    },
    "422": {
      "description": "NF-e ausente ou com incerteza pendente de confirmação",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    }
  },
  "x-fleetpay-scope": "operacao",
  "x-fleetpay-module": "contratacao-direta",
  "x-fleetpay-profiles": [
    "embarcador",
    "gestor",
    "agregado_empresarial"
  ],
  "method": "GET",
  "path": "/embarcador/solicitacoes-transporte/{id}/fiscal/preenchimento-cte"
}