chavestringOptionalSource CT-e key (the batch key).
Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.
chavestringOptionalSource CT-e key (the batch key).
sequenciainteger | nullOptionalPosition of the key in the batch.
cte_uuidstring | nullOptionalUUID of the key's counter-CT-e.
documento_idinteger | nullOptionaldocumento_numerostring | nullOptionalThe internal_id of the scanned document (the source key).
entrega_idinteger | nullOptionalresultadostringOptional"bipado" · "ja_bipado" · "pendente_fiscal" · "recusada" · "ignorado" · "erro"motivostring | nullOptionalcontra_cte_nao_autorizado (pendente_fiscal); documento_vinculado_a_outro_motorista or bipagem_recusada (recusada); sem_documento_financeiro or documento_de_outra_empresa (ignorado); falha_ao_bipar (erro).
mensagemstring | nullOptionalparcelasarrayOptionalDocument installments after scanning. Empty while the batch group is held.
{
"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"
}
}
}
}