FleetPayI'm a Driver
Menu
Solutions
Who It's For
PricingDevelopersBlogSign In ↗Talk to Our Team
EN
← HomeFleetPay / API

Generate a CT-e preview

Parameters, data structure and responses from the versioned contract.

POST/fiscal/cte/{cte_uuid}/previa
previewCteSandbox 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 the content and checks outstanding requirements without issuing the document.

Authentication

[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.

Parameters

cte_uuidpath · stringRequired

Public CT-e UUID.

Constraints
{
  "type": "string",
  "format": "uuid"
}

Responses

200 HTTP Response

Preview prepared without issuing the document.

application/json

CtePreviewEnvelope ↗

Headers

X-Request-Id

Call correlation identifier.

401 HTTP Response

FleetPay API key missing or invalid.

application/json

ErrorEnvelope ↗

Headers

X-Request-Id

Call correlation identifier.

403 HTTP Response

Fiscal scope disabled for the key, or no active carrier associated with the key.

application/json

ErrorEnvelope ↗

Headers

X-Request-Id

Call correlation identifier.

404 HTTP Response

Resource not found in the authenticated tenant.

application/json

ErrorEnvelope ↗

Headers

X-Request-Id

Call correlation identifier.

422 HTTP Response

An outstanding requirement or business rule prevented the operation.

application/json

ErrorEnvelope ↗

Headers

X-Request-Id

Call correlation identifier.

429 HTTP Response

Per-carrier limit exceeded.

application/json

ErrorEnvelope ↗

Headers

X-Request-Id

Call correlation identifier.

Retry-After

Seconds until another attempt.

500 HTTP Response

Internal failure without operational integration details.

application/json

ErrorEnvelope ↗

Headers

X-Request-Id

Call correlation identifier.

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