← InícioFleetPay / Schema

ParcelaRepasse

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 parcela do repasse ao motorista. Os campos *_label são texto para exibição e podem mudar; ramifique por status e evento, que são estáveis.

posicaointegerOpcional

Posição da parcela na regra, de 1 a 3.

eventointegerOpcional

O evento que libera esta parcela — sempre igual à posição:

1 — bipagem
2 — conclusão no app
3 — prestação de contas

1 · 2 · 3

evento_labelstringOpcional

percentualintegerOpcional

Percentual do repasse total desta parcela, congelado na materialização.

prazo_diasintegerOpcional

D+N da regra, contado a partir do evento. Vale só no modo automático: no manual o vencimento é a data da ordem de pagamento, e este número é informativo.

valornumber · floatOpcional

statusintegerOpcional

valor	significado	tem vencimento	tem pagamento
`1`	aguardando evento	não	não
`5`	aguardando ordem de pagamento (só modo manual)	não	não
`2`	liberada — tem vencimento e vai pagar	sim	ainda não
`3`	pagamento gerado	sim	sim
`4`	cancelada (CT-e cancelado na SEFAZ)	—	—

No modo manual, 5 é onde a parcela para. pagar a leva para 2.

1 · 2 · 3 · 4 · 5

status_labelstringOpcional

ocorrido_emstring | null · date-timeOpcional

Quando o evento âncora aconteceu, como você declarou.

vencimentostring | null · dateOpcional

Só existe a partir da liberação (automático) ou da ordem de pagamento (manual). null enquanto a parcela não tem data — o que é estado normal, não erro.

liberado_emstring | null · date-timeOpcional

origem_liberacaostring | nullOpcional

Quem liberou: api (esta API), panel (alguém no painel) ou o evento interno — scan (bipagem), completion (conclusão no app) ou import_delivered (importação já entregue). Só api e panel contam como atestação do pagador para a antecipação.

antecipavelbooleanOpcional

Se a parcela entra na elegibilidade de antecipação. Depende só do prazo: true quando prazo_dias é 1 ou mais, false quando a parcela é D+0 — não muda com o status. Uma parcela D+0 não tem janela entre liberação e pagamento, logo não há o que antecipar.

pagamento_idinteger | nullOpcional

O pagamento gerado por esta parcela, quando já existe.

Definição JSON Completa

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