← HomeFleetPay / Schema

EncerrarCiotInput

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.

peso_carganumber · floatRequired

Actual weight transported.

minimum0.01
origem_destinoarrayOptional

Breakdown of traveled segments (mandatory for Aggregated TAC).

minItems1
maxItems20
Original JSON Definition (Portuguese Descriptions)
{
  "type": "object",
  "required": [
    "peso_carga"
  ],
  "properties": {
    "peso_carga": {
      "type": "number",
      "format": "float",
      "minimum": 0.01,
      "description": "Peso efetivamente transportado."
    },
    "origem_destino": {
      "type": "array",
      "minItems": 1,
      "maxItems": 20,
      "description": "Detalhamento dos trechos percorridos (obrigatório para TAC Agregado).",
      "items": {
        "type": "object",
        "required": [
          "origem",
          "destino",
          "distancia_percorrida",
          "qtd_viagens",
          "peso_carga",
          "codigo_natureza_carga"
        ],
        "properties": {
          "origem": {
            "type": "object",
            "required": [
              "codigo_municipio_origem"
            ],
            "properties": {
              "codigo_municipio_origem": {
                "type": "string",
                "pattern": "^\\d{7}$"
              }
            }
          },
          "destino": {
            "type": "object",
            "required": [
              "codigo_municipio_destino"
            ],
            "properties": {
              "codigo_municipio_destino": {
                "type": "string",
                "pattern": "^\\d{7}$"
              }
            }
          },
          "distancia_percorrida": {
            "type": "number",
            "minimum": 0.01
          },
          "qtd_viagens": {
            "type": "integer",
            "minimum": 1,
            "maximum": 999
          },
          "peso_carga": {
            "type": "number",
            "format": "float",
            "minimum": 0.01
          },
          "codigo_natureza_carga": {
            "type": "string",
            "pattern": "^\\d{4}$",
            "description": "Código SH de 4 dígitos."
          }
        }
      }
    }
  }
}