← InícioFleetPay / API

Obter pré-preenchimento de CT-e a partir de NF-e vinculada

Parâmetros, estrutura de dados e respostas do contrato versionado.

GET/embarcador/solicitacoes-transporte/{id}/fiscal/preenchimento-cte
preencherCteSolicitacaoTransporteEmbarcadorBase de Homologação: https://api.fleetpay.site/v1

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

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.

Autenticação

Escopo Necessário
operacao — Operação
Módulo
Contratação Direta (Embarcador)
Perfis Aplicáveis
Embarcador · Gestor de Transporte · Agregado Empresarial
Mecanismos
OAuth2 client_credentials (POST /oauth/token) ou API Key em Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.

Parâmetros

idpath · stringObrigatório
Restrições
{
  "type": "string"
}

Respostas

200 Resposta HTTP

Payload de pré-preenchimento de CT-e gerado (fiscal_status: cte_prefilled)

application/json

successbooleanOpcional
commercial_resolutionobject | nullOpcional
404 Resposta HTTP

Solicitação não encontrada

application/json

errorobjectOpcional
422 Resposta HTTP

NF-e ausente ou com incerteza pendente de confirmação

application/json

errorobjectOpcional
Definição Completa da Operação
{
  "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"
}