← HomeFleetPay / Schema

LiberarParcelaRepasse

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.

documentostringRequired

The same identifiers accepted by GET: FleetPay internal ID, document number (internal_id), or the 44-digit CT-e key; for counter-CT-e documents, also counter_cte_id, the leg's documento_financeiro (ROUTE:...), or the authorized counter-CT-e key.

maxLength64

posicaointegerRequired

1 scanning · 2 completion in the app · 3 submission of accounts.

minimum1

maximum3

ocorrido_emstring · dateRequired

When the event occurred. Past dates are allowed; future dates are rejected with data_no_futuro.

Original JSON Definition (Portuguese Descriptions)

{
  "type": "object",
  "required": [
    "documento",
    "posicao",
    "ocorrido_em"
  ],
  "properties": {
    "documento": {
      "type": "string",
      "maxLength": 64,
      "description": "Os mesmos identificadores do `GET`: ID interno FleetPay, número do documento\n(`internal_id`) ou chave do CT-e de 44 dígitos; para contra-CT-e, também o\n`counter_cte_id`, o `documento_financeiro` da perna (`ROUTE:...`) ou a chave do\ncontra-CT-e autorizado.\n"
    },
    "posicao": {
      "type": "integer",
      "minimum": 1,
      "maximum": 3,
      "description": "1 bipagem · 2 conclusão no app · 3 prestação de contas."
    },
    "ocorrido_em": {
      "type": "string",
      "format": "date",
      "description": "Quando o evento aconteceu. Pode ser retroativa; futura é recusada com\n`data_no_futuro`.\n"
    }
  }
}