← HomeFleetPay / Schema

DocumentoCargaCiot

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.

ParteDocumentoCiot ↗

tipostringRequired

"nfe" · "nf" · "romaneio" · "outros"

numerostringRequired

maxLength20

seriestring | nullOptional

maxLength5

chave_acessostring | nullOptional

Optional. The NF-e does not need to exist in FleetPay: this endpoint declares the trip; it does not import a fiscal document.

pattern"^[0-9]{44}$"

peso_carganumber · doubleRequired

minimum0.01

valor_mercadorianumber · doubleRequired

minimum0.01

partesarrayRequired

ParteDocumentoCiot ↗

minItems2

Original JSON Definition (Portuguese Descriptions)

{
  "type": "object",
  "required": [
    "tipo",
    "numero",
    "peso_carga",
    "valor_mercadoria",
    "partes"
  ],
  "properties": {
    "tipo": {
      "type": "string",
      "enum": [
        "nfe",
        "nf",
        "romaneio",
        "outros"
      ]
    },
    "numero": {
      "type": "string",
      "maxLength": 20
    },
    "serie": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 5
    },
    "chave_acesso": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^[0-9]{44}$",
      "description": "Opcional. A operação não exige que a NF-e exista na FleetPay — este endpoint declara\na viagem, não importa documento fiscal.\n"
    },
    "peso_carga": {
      "type": "number",
      "format": "double",
      "minimum": 0.01
    },
    "valor_mercadoria": {
      "type": "number",
      "format": "double",
      "minimum": 0.01
    },
    "partes": {
      "type": "array",
      "minItems": 2,
      "items": {
        "$ref": "#/components/schemas/ParteDocumentoCiot"
      }
    }
  }
}