← InicioFleetPay / Schema

Agregado

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.

CertificadoDoAgregado ↗ContaDoAgregado ↗

tipostringObligatorio

Tipo de colaborador: conductor de tu empresa o transportista que contratas o invitaste.

"motorista" · "transportadora"

documentostringObligatorio

CPF o CNPJ, solo dígitos.

nomestring | nullOpcional

Nombre registrado en FleetPay. Es null para quien recibió una invitación pero aún no completó el registro: FleetPay todavía no conoce el nombre y lo indica de forma explícita en lugar de devolver una etiqueta genérica.

cadastrostringObligatorio

convidado — existe la invitación, pero no el registro; todavía no hay una cuenta que mostrar. cadastrado — existe el registro en FleetPay y conta refleja su estado real.

"convidado" · "cadastrado"

contaobjectObligatorio

ContaDoAgregado ↗

certificado_digitalobjectObligatorio

CertificadoDoAgregado ↗

Definición JSON Original (Descripciones en Portugués)

{
  "type": "object",
  "required": [
    "tipo",
    "documento",
    "cadastro",
    "conta",
    "certificado_digital"
  ],
  "properties": {
    "tipo": {
      "type": "string",
      "enum": [
        "motorista",
        "transportadora"
      ],
      "description": "A natureza do agregado — motorista da sua empresa ou transportadora que você contrata/convidou."
    },
    "documento": {
      "type": "string",
      "description": "CPF ou CNPJ, somente dígitos."
    },
    "nome": {
      "type": [
        "string",
        "null"
      ],
      "description": "Como está cadastrado na FleetPay. `null` para quem foi convidado e ainda não concluiu o cadastro — nesse momento a FleetPay ainda não sabe o nome, e preferimos dizer isso a devolver um rótulo genérico."
    },
    "cadastro": {
      "type": "string",
      "enum": [
        "convidado",
        "cadastrado"
      ],
      "description": "`convidado` — o convite existe e o cadastro não; não há conta a mostrar ainda. `cadastrado` — existe cadastro na FleetPay, e `conta` reflete o estado real dele."
    },
    "conta": {
      "$ref": "#/components/schemas/ContaDoAgregado"
    },
    "certificado_digital": {
      "$ref": "#/components/schemas/CertificadoDoAgregado"
    }
  }
}