← HomeFleetPay / Schema

ContraCteLoteResult

Structure preserved from the versioned API contract.

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

A report row: one access key (1:1) or one leg.

chavestringOptional

refstringOptional

Legs only: the leg's payload path (ctes.0.pernas.2).

statusstringOptional

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

counter_cte_idstring · uuidOptional

Counter-CT-e UUID (for emitted, duplicated and failures where the draft already existed).

outcomestringOptional

Provider acceptance result (e.g. accepted).

tipo_servicointegerOptional

The ide/tpServ used to issue the key/leg (leg → key → batch → 1). For a duplicated row, this is the requested type; the existing counter-CT-e's type is available from GET /fiscal/cte/{counter_cte_id} (service_type).

1 · 2 · 3

documento_financeirostringOptional

Legs only: the leg document's internal_id (ROUTE:<lote>:<hex>).

financeirostringOptional

The financial step for the issued key: nenhum (batch without repasse, or with repasse but no link — see motivo), contratante (the source CT-e joined the contracting company's transfer group), ja_configurado (the source already had a transfer configured for the contracting company and was not overwritten). failed: the provider accepted the document, but the financial step failed.

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

motivostringOptional

Only with repasse and financeiro: "nenhum": why the contracting carrier did not receive the link.

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

reasonstringOptional

Reason for rejection or duplication. Stable codes: cte_proprio, sem_regra_tributacao, origem_ja_subcontratada_1a1, origem_ja_subcontratada_em_pernas, redespacho_exige_rota (type 2/3 with a segment identical to the contracting company's entire trip), origem_incompativel_com_tipo (source linked to multimodal transport); other reasons are text (for example, "contra-CT-e já existe" [counter-CT-e already exists], "CT-e original não recebido" [original CT-e not received]).

messagestringOptional

valorstringOptional

Frozen amount for the key (per-document mode), while pending.

driver_user_idintegerOptional

Legs only, while pending.

Original JSON Definition (Portuguese Descriptions)

{
  "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`."
    }
  }
}