cte_uuidpath · stringObrigatórioUUID público do CT-e.
Restrições
{
"type": "string",
"format": "uuid"
}← InícioFleetPay / API
Gerar prévia do CT-e
Parâmetros, estrutura de dados e respostas do contrato versionado.
POST
/fiscal/cte/{cte_uuid}/previaDescrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.
Monta o conteúdo e valida pendências sem efetivar a emissão.
Autenticação
[
{
"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
Respostas
200 Resposta HTTP
Prévia montada sem efetivar a emissão.
application/json
dataobjectObrigatórioenvironmentobjectObrigatórioHeaders
X-Request-IdIdentificador de correlação da chamada.
401 Resposta HTTP
Chave de API FleetPay ausente ou inválida.
Headers
X-Request-IdIdentificador de correlação da chamada.
403 Resposta HTTP
Escopo fiscal desabilitado na chave, ou chave sem transportadora ativa.
Headers
X-Request-IdIdentificador de correlação da chamada.
404 Resposta HTTP
Recurso não encontrado no tenant autenticado.
Headers
X-Request-IdIdentificador de correlação da chamada.
422 Resposta HTTP
Pendência ou regra de negócio impediu a operação.
Headers
X-Request-IdIdentificador de correlação da chamada.
429 Resposta HTTP
Limite por transportadora excedido.
Headers
X-Request-IdIdentificador de correlação da chamada.
Retry-AfterSegundos até uma nova tentativa.
500 Resposta HTTP
Falha interna sem detalhes de integrações operacionais.
Headers
X-Request-IdIdentificador de correlação da chamada.
Definição Completa da Operação
{
"tags": [
"CT-e"
],
"summary": "Gerar prévia do CT-e",
"description": "Monta o conteúdo e valida pendências sem efetivar a emissão.",
"operationId": "previewCte",
"responses": {
"200": {
"$ref": "#/components/responses/CtePreviewOk"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"422": {
"$ref": "#/components/responses/BusinessRuleFailed"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"500": {
"$ref": "#/components/responses/InternalError"
}
},
"method": "POST",
"path": "/fiscal/cte/{cte_uuid}/previa",
"parameters": [
{
"$ref": "#/components/parameters/CteUuid"
}
]
}