← InícioFleetPay / Schema

ParteDocumentoCiot

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.

Quem está de cada lado da carga. Remetente e destinatário são obrigatórios porque a ANTT identifica a operação por eles, não pelo número da nota: é o par que diz de onde a carga saiu e para quem vai.

papelstringObrigatório
"remetente" · "destinatario" · "consignatario"
documentostringObrigatório

CPF ou CNPJ, somente dígitos.

pattern"^([0-9]{11}|[0-9]{14})$"
nomestringObrigatório
maxLength120
Definição JSON Completa
{
  "type": "object",
  "required": [
    "papel",
    "documento",
    "nome",
    "endereco"
  ],
  "description": "Quem está de cada lado da carga. **Remetente e destinatário são obrigatórios** porque a\nANTT identifica a operação por eles, não pelo número da nota: é o par que diz de onde a\ncarga saiu e para quem vai.\n",
  "properties": {
    "papel": {
      "type": "string",
      "enum": [
        "remetente",
        "destinatario",
        "consignatario"
      ]
    },
    "documento": {
      "type": "string",
      "pattern": "^([0-9]{11}|[0-9]{14})$",
      "description": "CPF ou CNPJ, somente dígitos."
    },
    "nome": {
      "type": "string",
      "maxLength": 120
    },
    "endereco": {
      "$ref": "#/components/schemas/EnderecoCiot"
    }
  }
}