← InícioFleetPay / Schema

DocumentoCargaCiot

Estrutura preservada do contrato versionado da API.

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

ParteDocumentoCiot ↗

tipostringObrigatório

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

numerostringObrigatório

maxLength20

seriestring | nullOpcional

maxLength5

chave_acessostring | nullOpcional

Opcional. A operação não exige que a NF-e exista na FleetPay — este endpoint declara a viagem, não importa documento fiscal.

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

peso_carganumber · doubleObrigatório

minimum0.01

valor_mercadorianumber · doubleObrigatório

minimum0.01

partesarrayObrigatório

ParteDocumentoCiot ↗

minItems2

Definição JSON Completa

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