← InicioFleetPay / Schema

DocumentoCargaCiot

Estructura preservada del contrato versionado de la API.

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

ParteDocumentoCiot ↗

tipostringObligatorio

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

numerostringObligatorio

maxLength20

seriestring | nullOpcional

maxLength5

chave_acessostring | nullOpcional

Opcional. No se exige que la NF-e exista en FleetPay: este endpoint declara el viaje, no importa un documento fiscal.

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

peso_carganumber · doubleObligatorio

minimum0.01

valor_mercadorianumber · doubleObligatorio

minimum0.01

partesarrayObligatorio

ParteDocumentoCiot ↗

minItems2

Definición JSON Original (Descripciones en Portugués)

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