14.1 Iniciar Matrícula

Observações

Responsáveis e dependentes novos serão incluídos e os existentes serão atualizados.

Request

Request

mutation StartEnrollment {
    startEnrollment(
        data: {
            companyCnpj: "12345678000190"
            targetYear: 2025
            registry: "2025001"
            generateRegistry: false
            financialOwner: {
                name: "Maria Silva Santos"
                email: "maria.silva@email.com"
                cpf: "12345678900"
                phone: "11987654321"
                zipCode: "01310100"
                street: "Avenida Paulista"
                number: "1578"
                city: "São Paulo"
                state: "SP"
                district: "Bela Vista"
                country: "Brasil"
                complement: "Apto 301"
            }
            dependent: {
                name: "João Silva Santos"
                birthDate: "2015-03-15T00:00:00Z"
                cpf: "98765432100"
            }
        }) {
        enrollmentId
        enrollmentRefId
        financialOwnerId
        financialOwnerRefId
        financialOwnerName
        financialOwnerCPF
        dependentId
        dependentRefId
        dependentName
        registry
        targetYear
        companyName
        }
    }

Params

Parâmetro	Tipo	Obrigatório	Descrição
data	StartEnrollmentDataInput!	Sim (!)	Dados para iniciar a matrícula (inclusão de informações do aluno, curso, etc.).

Objeto StartEnrollmentDataInput

Campo	Tipo	Obrigatório	Descrição
companyCnpj	String	Sim (!)	CNPJ da escola
targetYear	Int	Sim (!)	Ano letivo
registry	String	Não	Número de matrícula (Se não for gerado automaticamente)
generateRegistry	Boolean	Sim (!)	Gerar número de matrícula automaticamente
financialOwner	AddOrUpdateFinancialOwnerDataInput!	Sim (!)	Dados do responsável financeiro
dependent	AddOrUpdateDependentDataInput`	Sim (!)	Dados do dependente (aluno)

Objeto AddOrUpdateFinancialOwnerDataInput

Campo	Tipo	Obrigatório	Descrição
name	String	Sim (!)	Nome completo do responsável financeiro
email	String	Sim (!)	E-mail do responsável financeiro
cpf	String	Sim (!)	CPF do responsável financeiro
phone	String	Sim (!)	Telefone do responsável financeiro
zipCode	String	Sim (!)	CEP do responsável financeiro
street	String	Sim (!)	Rua do endereço
number	String	Sim (!)	Número do endereço
city	String	Sim (!)	Cidade
state	String	Sim (!)	Estado
district	String	Sim (!)	Bairro
country	String	Não	País do responsável financeiro
complement	String	Não	Complemento do endereço

Objeto AddOrUpdateDependentDataInput

Campo	Tipo	Obrigatório	Descrição
name	String	Sim (!)	Nome completo do dependente
birthDate	DateTime	Sim (!)	Data de nascimento
cpf	String	Não	CPF do dependente (Opcional)

Response

Campo	Tipo	Descrição
enrollmentId	Int	ID interno da matrícula
enrollmentRefId	UUID	ID de referência (externo) da matrícula
financialOwnerId	Int	ID interno do responsável financeiro
financialOwnerRefId	UUID	ID de referência (externo) do responsável financeiro
financialOwnerName	String	Nome completo do responsável financeiro
financialOwnerCPF	String	CPF do responsável financeiro
dependentId	Int	ID interno do dependente (aluno)
dependentRefId	UUID	ID de referência (externo) do dependente
dependentName	String	Nome completo do dependente (aluno)
registry	String	Número oficial da matrícula
targetYear	Int	Ano de referência da matrícula (Ano letivo)
companyName	String	Nome da escola ou empresa