← InícioFleetPay / Schema

ContraCteLoteResult

Estrutura preservada do contrato versionado da API.

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

Uma linha do relatório — uma chave (1:1) ou uma perna.

chavestringOpcional
refstringOpcional

Só nas pernas — o caminho da perna no payload (ctes.0.pernas.2).

statusstringOpcional
"pending" · "emitted" · "duplicated" · "failed"
counter_cte_idstring · uuidOpcional

UUID do contra-CT-e (em emitted, duplicated e nas falhas em que o rascunho já existia).

outcomestringOpcional

Resultado da aceitação pelo provedor (ex.: accepted).

tipo_servicointegerOpcional

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).

1 · 2 · 3
documento_financeirostringOpcional

Só nas pernas — internal_id do documento da perna (ROUTE:<lote>:<hex>).

financeirostringOpcional

O passo financeiro da chave emitida: nenhum (lote sem repasse, ou com repasse mas sem vínculo — veja motivo), contratante (o CT-e de origem entrou no grupo de repasse da contratante), ja_configurado (a origem já tinha repasse na contratante e não foi sobrescrita). failed: o provedor aceitou o documento mas a perna financeira falhou.

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

Só com repasse e financeiro: "nenhum" — por que a contratante não recebeu o 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 da recusa/duplicidade. Códigos estáveis: cte_proprio, sem_regra_tributacao, origem_ja_subcontratada_1a1, origem_ja_subcontratada_em_pernas, redespacho_exige_rota (tipo 2/3 com o trecho igual à viagem inteira da contratante), origem_incompativel_com_tipo (origem vinculada a multimodal); os demais são texto (ex.: "contra-CT-e já existe", "CT-e original não recebido").

messagestringOpcional
valorstringOpcional

Valor congelado da chave (modo por documento), enquanto pending.

driver_user_idintegerOpcional

Só nas pernas, enquanto pending.

Definição JSON Completa
{
  "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`."
    }
  }
}