← HomeFleetPay / Schema

ContraCteLoteIncluirRequest

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.

redistribuirbooleanOptional

Prorated mode only. true re-splits frete_bruto by N; false keeps each key's value.

justificativastringOptional

Mandatory with redistribuir: true when there is an authorized key (those whose value changes are cancelled and reissued).

minLength15
maxLength255
Original JSON Definition (Portuguese Descriptions)
{
  "type": "object",
  "required": [
    "ctes"
  ],
  "properties": {
    "ctes": {
      "type": "array",
      "minItems": 1,
      "items": {
        "oneOf": [
          {
            "type": "string",
            "description": "Só a chave (44 dígitos) — no rateio com `redistribuir: true`."
          },
          {
            "allOf": [
              {
                "type": "object",
                "required": [
                  "chave"
                ],
                "properties": {
                  "chave": {
                    "type": "string"
                  }
                }
              },
              {
                "$ref": "#/components/schemas/ContraCteLoteChaveEdicao"
              }
            ]
          }
        ]
      }
    },
    "redistribuir": {
      "type": "boolean",
      "default": false,
      "description": "Só no rateio. `true` redivide o frete_bruto por N; `false` mantém o valor de cada chave."
    },
    "justificativa": {
      "type": "string",
      "minLength": 15,
      "maxLength": 255,
      "description": "Obrigatória com `redistribuir: true` quando há chave autorizada (as que mudam de valor são canceladas e reemitidas)."
    }
  }
}