← InicioFleetPay / Schema

ContraCteLoteResult

Estructura preservada del contrato versionado de la API.

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

Una fila del informe: una clave (1:1) o un tramo.

chavestringOpcional

refstringOpcional

Solo en tramos: ruta del tramo en el payload (ctes.0.pernas.2).

statusstringOpcional

"pending" · "emitted" · "duplicated" · "failed"

counter_cte_idstring · uuidOpcional

UUID del contra-CT-e (en emitted, duplicated y fallos donde el borrador ya existía).

outcomestringOpcional

Resultado de aceptación del proveedor (p. ej. accepted).

tipo_servicointegerOpcional

El ide/tpServ con el que se emitió la clave o el tramo (tramo → clave → lote → 1). En una fila duplicated, corresponde al tipo solicitado; el tipo del contra-CT-e existente se obtiene en GET /fiscal/cte/{counter_cte_id} (service_type).

1 · 2 · 3

documento_financeirostringOpcional

Solo en tramos: internal_id del documento del tramo (ROUTE:<lote>:<hex>).

financeirostringOpcional

El paso financiero de la clave emitida: nenhum (lote sin repasse, o con repasse pero sin vínculo; consulte motivo), contratante (el CT-e de origen se incorporó al grupo de transferencias de la contratante), ja_configurado (el origen ya tenía una transferencia configurada en la contratante y no se sobrescribió). failed: el proveedor aceptó el documento, pero falló el paso financiero.

"failed" · "nenhum" · "contratante" · "ja_configurado"

motivostringOpcional

Solo con repasse y financeiro: "nenhum": motivo por el que el contratante no recibió el vínculo.

"contratante_nao_encontrada" · "contratante_sem_opt_in" · "origem_nao_encontrada_na_contratante" · "motorista_nao_vinculado_a_contratante" · "origem_ja_faturada_na_contratante"

reasonstringOpcional

Motivo del rechazo o la duplicidad. Códigos estables: cte_proprio, sem_regra_tributacao, origem_ja_subcontratada_1a1, origem_ja_subcontratada_em_pernas, redespacho_exige_rota (tipo 2/3 con un tramo idéntico al viaje completo de la contratante), origem_incompativel_com_tipo (origen vinculado a transporte multimodal); los demás motivos son texto (por ejemplo, "contra-CT-e já existe" [el contra-CT-e ya existe], "CT-e original não recebido" [CT-e original no recibido]).

messagestringOpcional

valorstringOpcional

Importe congelado de la clave (modo por documento), mientras está pending.

driver_user_idintegerOpcional

Solo en tramos, mientras está pending.

Definición JSON Original (Descripciones en Portugués)

{
  "type": "object",
  "description": "Uma linha do relatório — uma chave (1:1) ou uma perna.",
  "properties": {
    "chave": {
      "type": "string"
    },
    "ref": {
      "type": "string",
      "description": "Só nas pernas — o caminho da perna no payload (`ctes.0.pernas.2`)."
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "emitted",
        "duplicated",
        "failed"
      ]
    },
    "counter_cte_id": {
      "type": "string",
      "format": "uuid",
      "description": "UUID do contra-CT-e (em `emitted`, `duplicated` e nas falhas em que o rascunho já existia)."
    },
    "outcome": {
      "type": "string",
      "description": "Resultado da aceitação pelo provedor (ex.: `accepted`)."
    },
    "tipo_servico": {
      "type": "integer",
      "enum": [
        1,
        2,
        3
      ],
      "description": "O `ide/tpServ` com que a chave/perna saiu (perna → chave → lote → `1`). Na linha `duplicated` é o tipo pedido; o do contra-CT-e existente está em `GET /fiscal/cte/{counter_cte_id}` (`service_type`)."
    },
    "documento_financeiro": {
      "type": "string",
      "description": "Só nas pernas — `internal_id` do documento da perna (`ROUTE:<lote>:<hex>`)."
    },
    "financeiro": {
      "type": "string",
      "enum": [
        "failed",
        "nenhum",
        "contratante",
        "ja_configurado"
      ],
      "description": "O passo financeiro da chave emitida: `nenhum` (lote sem `repasse`, ou com `repasse` mas sem\nvínculo — veja `motivo`), `contratante` (o CT-e de origem entrou no grupo de repasse da\ncontratante),\n`ja_configurado` (a origem já tinha repasse na contratante e não foi sobrescrita).\n`failed`: o provedor aceitou o documento mas a perna financeira falhou.\n"
    },
    "motivo": {
      "type": "string",
      "enum": [
        "contratante_nao_encontrada",
        "contratante_sem_opt_in",
        "origem_nao_encontrada_na_contratante",
        "motorista_nao_vinculado_a_contratante",
        "origem_ja_faturada_na_contratante"
      ],
      "description": "Só com `repasse` e `financeiro: \"nenhum\"` — por que a contratante não recebeu o vínculo.\n"
    },
    "reason": {
      "type": "string",
      "description": "Motivo da recusa/duplicidade. Códigos estáveis: `cte_proprio`, `sem_regra_tributacao`,\n`origem_ja_subcontratada_1a1`, `origem_ja_subcontratada_em_pernas`,\n`redespacho_exige_rota` (tipo 2/3 com o trecho igual à viagem inteira da contratante),\n`origem_incompativel_com_tipo` (origem vinculada a multimodal); os demais são\ntexto (ex.: \"contra-CT-e já existe\", \"CT-e original não recebido\").\n"
    },
    "message": {
      "type": "string"
    },
    "valor": {
      "type": "string",
      "description": "Valor congelado da chave (modo por documento), enquanto `pending`."
    },
    "driver_user_id": {
      "type": "integer",
      "description": "Só nas pernas, enquanto `pending`."
    }
  }
}