posicaointegerOpcionalPosición de la cuota en la regla, de 1 a 3.
Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.
Una cuota de la transferencia al conductor. Los campos *_label son textos de visualización y pueden cambiar; utiliza status y evento para las condiciones del código, ya que son estables.
eventointegerOpcionalEl evento que libera esta cuota, siempre correspondiente a su posición:
1— escaneo2— finalización en la app3— rendición de cuentas
1 · 2 · 3evento_labelstringOpcionalpercentualintegerOpcionalPorcentaje de la transferencia total correspondiente a esta cuota, congelado al materializarse.
prazo_diasintegerOpcionalPlazo D+N de la regla, contado desde el evento. Solo se aplica en modo automático: en modo manual, el vencimiento es la fecha de la orden de pago y este número es informativo.
valornumber · floatOpcionalstatusintegerOpcional| valor | significado | tiene vencimiento | tiene pago |
|---|---|---|---|
1 | esperando evento | no | no |
5 | esperando orden de pago (solo modo manual) | no | no |
2 | liberada: tiene vencimiento y se pagará | sí | todavía no |
3 | pago generado | sí | sí |
4 | cancelada (CT-e cancelado ante SEFAZ) | — | — |
En modo manual, la cuota permanece en 5. pagar la lleva a 2.
1 · 2 · 3 · 4 · 5status_labelstringOpcionalocorrido_emstring | null · date-timeOpcionalCuándo ocurrió el evento de referencia, según tu declaración.
vencimentostring | null · dateOpcionalSolo existe a partir de la liberación (modo automático) o de la orden de pago (modo manual). Es null mientras la cuota no tiene fecha: es un estado normal, no un error.
liberado_emstring | null · date-timeOpcionalorigem_liberacaostring | nullOpcionalQuién la liberó: api (esta API), panel (alguien en el panel) o un evento interno: scan (escaneo), completion (finalización en la aplicación) o import_delivered (importación de una entrega ya realizada). Solo api y panel cuentan como certificación del pagador para el anticipo.
antecipavelbooleanOpcionalIndica si la cuota cumple el requisito de plazo para la elegibilidad de anticipo. Depende únicamente del plazo: true cuando prazo_dias es 1 o más, false para una cuota D+0; no cambia con status. Una cuota D+0 no tiene un intervalo entre liberación y pago, por lo que no hay nada que anticipar.
pagamento_idinteger | nullOpcionalPago generado por esta cuota, cuando existe.
Definición JSON Original (Descripciones en Portugués)
{
"type": "object",
"description": "Uma parcela do repasse ao motorista. Os campos `*_label` são texto para exibição e podem\nmudar; ramifique por `status` e `evento`, que são estáveis.\n",
"properties": {
"posicao": {
"type": "integer",
"description": "Posição da parcela na regra, de 1 a 3."
},
"evento": {
"type": "integer",
"enum": [
1,
2,
3
],
"description": "O evento que libera esta parcela — sempre igual à posição:\n\n- `1` — bipagem\n- `2` — conclusão no app\n- `3` — prestação de contas\n"
},
"evento_label": {
"type": "string"
},
"percentual": {
"type": "integer",
"description": "Percentual do repasse total desta parcela, congelado na materialização."
},
"prazo_dias": {
"type": "integer",
"description": "D+N da regra, contado a partir do evento. **Vale só no modo automático**: no manual o\nvencimento é a data da ordem de pagamento, e este número é informativo.\n"
},
"valor": {
"type": "number",
"format": "float"
},
"status": {
"type": "integer",
"enum": [
1,
2,
3,
4,
5
],
"description": "| valor | significado | tem vencimento | tem pagamento |\n|---|---|---|---|\n| `1` | aguardando evento | não | não |\n| `5` | aguardando ordem de pagamento *(só modo manual)* | não | não |\n| `2` | liberada — tem vencimento e vai pagar | sim | ainda não |\n| `3` | pagamento gerado | sim | sim |\n| `4` | cancelada (CT-e cancelado na SEFAZ) | — | — |\n\nNo modo manual, `5` é onde a parcela para. `pagar` a leva para `2`.\n"
},
"status_label": {
"type": "string"
},
"ocorrido_em": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Quando o evento âncora aconteceu, como você declarou."
},
"vencimento": {
"type": [
"string",
"null"
],
"format": "date",
"description": "Só existe a partir da liberação (automático) ou da ordem de pagamento (manual). `null`\nenquanto a parcela não tem data — o que é estado normal, não erro.\n"
},
"liberado_em": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"origem_liberacao": {
"type": [
"string",
"null"
],
"description": "Quem liberou: `api` (esta API), `panel` (alguém no painel) ou o evento interno —\n`scan` (bipagem), `completion` (conclusão no app) ou `import_delivered` (importação\njá entregue). Só `api` e `panel` contam como atestação do pagador para a antecipação.\n"
},
"antecipavel": {
"type": "boolean",
"description": "Se a parcela entra na elegibilidade de antecipação. Depende só do prazo: `true` quando\n`prazo_dias` é 1 ou mais, `false` quando a parcela é D+0 — não muda com o `status`.\nUma parcela D+0 não tem janela entre liberação e pagamento, logo não há o que antecipar.\n"
},
"pagamento_id": {
"type": [
"integer",
"null"
],
"description": "O pagamento gerado por esta parcela, quando já existe."
}
}
}