← HomeFleetPay / Schema

ParteDocumentoCiot

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.

The parties at each end of the shipment. Sender and recipient are required because ANTT identifies the operation through them, not through the invoice number: together they establish where the cargo came from and whom it is going to.

papelstringRequired
"remetente" · "destinatario" · "consignatario"
documentostringRequired

CPF or CNPJ, digits only.

pattern"^([0-9]{11}|[0-9]{14})$"
nomestringRequired
maxLength120
Original JSON Definition (Portuguese Descriptions)
{
  "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"
    }
  }
}