Pular para o conteúdo principal

14.5 Consultar Contrato

Request

Request
query Contract {
contract(id: 1141) {
totalInstallmentValue
installmentQuantity
installmentValue
installmentsMaturity
startDateInstallment
lastDayInstallment
discountLimitDate
withdrawalFee
withdrawalFeeIsPercentage
punctualityDiscount
punctualityDiscountIsPercentage
dependentId
financialOwnerId
enrollmentId
relationshipDegree
documentId
type
integralWeekDays
integralStartTime
integralEndTime
includedMeals
minimumMealsDaysPerWeek
minimumAbsenceDaysPerWeek
paymentPlanId
integralAnnuityValue
integralInstallmentValue
integralEndDayForChanges
integralShift
integralLimitDayAbsenceForDiscount
manualContract
paymentPlanScheduled
id
refId
externalId
creationDate
active
deleted
lastUpdateDate
}
}

Params

CampoTipoDescrição
idInt!Id do contrato

Response

Response
{
"data": {
"contract": {
"totalInstallmentValue": 1500,
"installmentQuantity": 10,
"installmentValue": 150,
"installmentsMaturity": 10,
"startDateInstallment": "2025-10-10T03:00:00.000Z",
"lastDayInstallment": "2026-08-10T03:00:00.000Z",
"discountLimitDate": null,
"withdrawalFee": 0,
"withdrawalFeeIsPercentage": null,
"punctualityDiscount": 10,
"punctualityDiscountIsPercentage": true,
"dependentId": 7389,
"financialOwnerId": 7388,
"enrollmentId": 1178,
"relationshipDegree": "Pai",
"documentId": 1113,
"type": "INTEGRAL",
"integralWeekDays": [
"Segunda",
"Sexta"
],
"integralStartTime": "PT8H",
"integralEndTime": "PT17H",
"includedMeals": [
"café da manhã",
"almoço",
"jantar"
],
"minimumMealsDaysPerWeek": 2,
"minimumAbsenceDaysPerWeek": 1,
"paymentPlanId": null,
"integralAnnuityValue": 400,
"integralInstallmentValue": 40,
"integralEndDayForChanges": 4,
"integralShift": "NOITE",
"integralLimitDayAbsenceForDiscount": 1,
"manualContract": false,
"paymentPlanScheduled": null,
"id": 1141,
"refId": "8b4dca2d-1d56-45eb-951e-7792b786c7cf",
"externalId": null,
"creationDate": "2025-10-06T01:49:36.942Z",
"active": true,
"deleted": false,
"lastUpdateDate": null
}
}
}

Result

CampoTipoDescrição
contractContract!Objeto Contract

Objeto Contract

CampoTipoDescrição
idIntId do contrato
refIdStringId do contrato
totalInstallmentValueDecimal?Valor total das parcelas
installmentQuantityInt?Quantidade de parcelas
installmentValueDecimal?Valor da parcela
installmentsMaturityInt?Dia de vencimento da parcelas
startDateInstallmentDateTime?Data de início das parcelas
lastDayInstallmentDateTime?Data do último vencimento de parcela
discountLimitDateDateTime?Regra desconto pontualidade (Data limite)
withdrawalFeeDecimal?Multa por desistência
withdrawalFeeIsPercentageBoolean?Multa por desistência é percentual
punctualityDiscountDecimal?Desconto por pontualidade
punctualityDiscountIsPercentageBoolean?Desconto por pontualidade é percentual
dependentIdIntId do dependente
financialOwnerIdIntId do responsável financeiro
enrollmentIdIntId da matrícula
enrollmentEnrollmentMatrícula (Objeto relacionado)
relationshipDegreeString?Grau de parentesco entre o responsável e o dependente
documentIdInt?Id do documento de aceite digital
documentDigitalAcceptanceDocument?Dados do documento de aceite digital
typeContractType?Tipo de contrato
integralWeekDays[String]?Dias da semana que o aluno frequentará o integral
integralStartTimeTimeSpan?Horário do integral - Início
integralEndTimeTimeSpan?Horário do integral - Fim
includedMeals[String]?Refeições incluídas
minimumMealsDaysPerWeekInt?Número mínimo de dias por semana com refeições obrigatórias
minimumAbsenceDaysPerWeekInt?Número mínimo de ausências para direito a desconto de alimentação
paymentPlanIdInt?Id do plano de pagamento vinculado ao contrato
paymentPlanPaymentPlan?Dados do plano de pagamento vinculado ao contrato
integralAnnuityValueDecimal?Valor da anuidade integral
integralInstallmentValueDecimal?Valor de parcelas integral
integralEndDayForChangesInt?Dia do mês final para alterações integral
integralShiftContractIntegralShift?Turno integral
integralLimitDayAbsenceForDiscountInt?Dia limite de ausência para solicitação do desconto
manualContractBooleanContrato manual
manualContractFileStorageFile?Documento do contrato manual