← InicioFleetPay / Schema

ParteDocumentoCiot

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.

Las partes en cada extremo del envío. El remitente y el destinatario son obligatorios porque ANTT identifica la operación a través de ellos, no del número de factura: juntos indican de dónde salió la carga y a quién se dirige.

papelstringObligatorio
"remetente" · "destinatario" · "consignatario"
documentostringObligatorio

CPF o CNPJ, solo dígitos.

pattern"^([0-9]{11}|[0-9]{14})$"
nomestringObligatorio
maxLength120
Definición JSON Original (Descripciones en Portugués)
{
  "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"
    }
  }
}