← InicioFleetPay / API

Sincronizar estado de emisión de CT-e de la operación

Parámetros, estructura de datos y respuestas del contrato versionado.

POST/embarcador/solicitacoes-transporte/{id}/fiscal/sincronizar
sincronizarFiscalSolicitacaoTransporteEmbarcadorBase de Pruebas: https://api.fleetpay.site/v1

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

Sincroniza el estado fiscal (fiscal_status) de la solicitud con un CteDraft autorizado del Transportador Agregado responsable, validando emisor, entorno fiscal (tp_amb), vínculo con la operación/NF-e y evidencia canónica SEFAZ (sefaz_protocol / cstat = 100 / authorized_at / status = authorized). En caso de cte_timeout, reintentar exige evidencia canónica de consulta previa en SEFAZ sobre el CteDraft (nunca un booleano enviado por el cliente).

Autenticación

Permiso Requerido
operacao — Operación
Módulo
Contratación Directa (Embarcador)
Perfiles Aplicables
Embarcador · Gestor de Transporte · Agregado Empresarial
Mecanismos
OAuth2 client_credentials (POST /oauth/token) o API Key vía Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
La disponibilidad depende del entorno, los permisos habilitados y el proveedor. Esta referencia no ejecuta solicitudes ni recibe credenciales.

Parámetros

idpath · stringObligatorio
Restricciones
{
  "type": "string"
}

Cuerpo de la Solicitud

Obligatorio

application/json

cte_draft_idinteger | nullOpcional

ID del CteDraft vinculado a la operación y emitido por el Transportista Agregado responsable.

fiscal_statusstring | nullOpcional
"ready_for_cte" · "ready_for_cte_prefill" · "cte_prefilled" · "cte_issuing" · "cte_authorized" · "cte_rejected" · "cte_timeout" · null
outcomestring | nullOpcional
"ready_for_cte" · "issuing" · "cte_issuing" · "authorized" · "cte_authorized" · "rejected" · "cte_rejected" · "timeout" · "cte_timeout" · null
expected_tp_ambinteger | nullOpcional

Entorno fiscal SEFAZ esperado (1 = producción, 2 = pruebas).

1 · 2 · null

Respuestas

200 Respuesta HTTP

Estado fiscal sincronizado con evidencia canónica

application/json

successbooleanOpcional
commercial_resolutionobject | nullOpcional
404 Respuesta HTTP

Solicitud no encontrada

application/json

errorobjectOpcional
422 Respuesta HTTP

Documento fiscal inexistente, de otra empresa/operación, entorno fiscal incompatible o sin evidencia canónica SEFAZ

application/json

errorobjectOpcional
Definición Completa de la Operación
{
  "tags": [
    "Solicitações e Contratação de Transporte (Embarcador)"
  ],
  "summary": "Sincronizar situação de emissão de CT-e da operação",
  "description": "Sincroniza o estado fiscal (`fiscal_status`) da solicitação com um `CteDraft` autorizado pertencente ao Transportador Agregado responsável pela operação, validando emitente, ambiente fiscal (`tp_amb`), vínculo com a operação/NF-e da solicitação e evidência canônica SEFAZ (`sefaz_protocol` / `cstat = 100` / `authorized_at` / `status = authorized`). Em caso de `cte_timeout`, nova tentativa exige evidência canônica de consulta prévia de status SEFAZ no `CteDraft` (nunca um booleano enviado pelo cliente).\n",
  "operationId": "sincronizarFiscalSolicitacaoTransporteEmbarcador",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "cte_draft_id": {
              "type": [
                "integer",
                "null"
              ],
              "description": "ID do `CteDraft` vinculado à operação e emitido pelo Transportador Agregado responsável."
            },
            "fiscal_status": {
              "type": [
                "string",
                "null"
              ],
              "enum": [
                "ready_for_cte",
                "ready_for_cte_prefill",
                "cte_prefilled",
                "cte_issuing",
                "cte_authorized",
                "cte_rejected",
                "cte_timeout",
                null
              ]
            },
            "outcome": {
              "type": [
                "string",
                "null"
              ],
              "enum": [
                "ready_for_cte",
                "issuing",
                "cte_issuing",
                "authorized",
                "cte_authorized",
                "rejected",
                "cte_rejected",
                "timeout",
                "cte_timeout",
                null
              ]
            },
            "expected_tp_amb": {
              "type": [
                "integer",
                "null"
              ],
              "enum": [
                1,
                2,
                null
              ],
              "description": "Ambiente fiscal SEFAZ esperado (`1` = produção, `2` = homologação)."
            }
          }
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Estado fiscal sincronizado com evidência canônica",
      "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": "Documento fiscal inexistente, de outra empresa/operação, ambiente fiscal incompatível ou sem evidência canônica SEFAZ",
      "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": "POST",
  "path": "/embarcador/solicitacoes-transporte/{id}/fiscal/sincronizar"
}