← HomeFleetPay / Schema

CertificadoDoAgregado

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 contracted carrier's A1 digital certificate (e-CNPJ or e-CPF), as held by FleetPay. Without it, tax documents cannot be issued on that carrier's behalf.

enviadobooleanRequired

Whether the certificate has already been submitted to FleetPay. true remains true for an expired certificate — in that case, situacao changes, not the submission status.

situacaostring | nullOptional

null when nothing has been submitted.

"valido" · "expirado" · null

valido_atestring | null · dateOptional

Last valid day. null when nothing has been submitted.

Original JSON Definition (Portuguese Descriptions)

{
  "type": "object",
  "required": [
    "enviado"
  ],
  "description": "Certificado digital A1 (e-CNPJ ou e-CPF) do agregado, como está na FleetPay. Sem ele a emissão de documento fiscal em nome desse agregado não acontece.",
  "properties": {
    "enviado": {
      "type": "boolean",
      "description": "Se o certificado já foi enviado à FleetPay. `true` continua verdadeiro para um certificado vencido — o que mudou nesse caso é `situacao`, não o envio."
    },
    "situacao": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "valido",
        "expirado",
        null
      ],
      "description": "`null` quando nada foi enviado."
    },
    "valido_ate": {
      "type": [
        "string",
        "null"
      ],
      "format": "date",
      "description": "Último dia de validade. `null` quando nada foi enviado."
    }
  }
}