← InícioFleetPay / Schema

BipagemPorLoteLinha

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.

chavestringOpcional

Chave do CT-e de origem (a chave do lote).

sequenciainteger | nullOpcional

Posição da chave no lote.

cte_uuidstring | nullOpcional

UUID do contra-CT-e da chave.

documento_idinteger | nullOpcional
documento_numerostring | nullOpcional

O internal_id do documento bipado (a chave da origem).

entrega_idinteger | nullOpcional
resultadostringOpcional
"bipado" · "ja_bipado" · "pendente_fiscal" · "recusada" · "ignorado" · "erro"
motivostring | nullOpcional

contra_cte_nao_autorizado (pendente_fiscal); documento_vinculado_a_outro_motorista ou bipagem_recusada (recusada); sem_documento_financeiro ou documento_de_outra_empresa (ignorado); falha_ao_bipar (erro).

mensagemstring | nullOpcional
parcelasarrayOpcional

As parcelas do documento depois da bipagem. Vazia enquanto o grupo do lote estiver retido.

Definição JSON Completa
{
  "type": "object",
  "properties": {
    "chave": {
      "type": "string",
      "description": "Chave do CT-e de origem (a chave do lote)."
    },
    "sequencia": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Posição da chave no lote."
    },
    "cte_uuid": {
      "type": [
        "string",
        "null"
      ],
      "description": "UUID do contra-CT-e da chave."
    },
    "documento_id": {
      "type": [
        "integer",
        "null"
      ]
    },
    "documento_numero": {
      "type": [
        "string",
        "null"
      ],
      "description": "O `internal_id` do documento bipado (a chave da origem)."
    },
    "entrega_id": {
      "type": [
        "integer",
        "null"
      ]
    },
    "resultado": {
      "type": "string",
      "enum": [
        "bipado",
        "ja_bipado",
        "pendente_fiscal",
        "recusada",
        "ignorado",
        "erro"
      ]
    },
    "motivo": {
      "type": [
        "string",
        "null"
      ],
      "description": "`contra_cte_nao_autorizado` (pendente_fiscal); `documento_vinculado_a_outro_motorista`\nou `bipagem_recusada` (recusada); `sem_documento_financeiro` ou\n`documento_de_outra_empresa` (ignorado); `falha_ao_bipar` (erro).\n"
    },
    "mensagem": {
      "type": [
        "string",
        "null"
      ]
    },
    "parcelas": {
      "type": "array",
      "description": "As parcelas do documento depois da bipagem. Vazia enquanto o grupo do lote estiver retido.",
      "items": {
        "$ref": "#/components/schemas/ParcelaRepasse"
      }
    }
  }
}