Input Objects
Argumentos para incluir nos nodeConnections




UserEntitiesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
UserEntitiesDateIntervalColumn
ENUM

OrganizationAcceptedTermDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
OrganizationAcceptedTermDateIntervalColumn
ENUM

OrganizationAcceptedTermOrder

ArgumentsTypeDescription
column
OrganizationAcceptedTermOrderColumn
ENUM
direction
OrderDirection
ENUM

OrganizationOrganizationMembershipDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
OrganizationOrganizationMembershipDateIntervalColumn
ENUM

OrganizationOrganizationMembershipOrder

ArgumentsTypeDescription
column
OrganizationOrganizationMembershipOrderColumn
ENUM
direction
OrderDirection
ENUM

StatsFields

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval

OrganizationArrivalsOrder

ArgumentsTypeDescription
column
Not Null
direction
OrderDirection
ENUM

OrganizationArrivalsSearch

ArgumentsTypeDescription
column
Not Null
criteria
String
SCALAR

OrganizationArrivalsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

OrganizationArrivalsDurationInput

ArgumentsTypeDescription
minimum
Int
SCALAR
Minimum of miliseconds to calculate wait time
maximum
Int
SCALAR
Maximum of miliseconds to calculate wait time

ConciergeGroupsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
ConciergeGroupsDateIntervalColumn
ENUM

ConciergeGroupsOrder

ArgumentsTypeDescription
column
ConciergeGroupsOrderColumn
ENUM
direction
OrderDirection
ENUM

GroupEntitiesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
GroupEntitiesDateIntervalColumn
ENUM

GroupCommitmentsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
GroupCommitmentsDateIntervalColumn
ENUM

GroupCommitmentsOrder

ArgumentsTypeDescription
column
GroupCommitmentsOrderColumn
ENUM
direction
OrderDirection
ENUM

MessageReactionsOrder

ArgumentsTypeDescription
column
Not Null
direction
OrderDirection
ENUM

MessageReactionsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

MessageMyConversationsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

ReplyMediasDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
ReplyMediasDateIntervalColumn
ENUM

ReplyMediasOrder

ArgumentsTypeDescription
column
ReplyMediasOrderColumn
ENUM
direction
OrderDirection
ENUM

ReplyConversationDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
ReplyConversationDateIntervalColumn
ENUM

ReplyReplyLogsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
ReplyReplyLogsDateIntervalColumn
ENUM

ReplyReplyLogsOrder

ArgumentsTypeDescription
column
ReplyReplyLogsOrderColumn
ENUM
direction
OrderDirection
ENUM

MessageAllRepliesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

MessageConversationsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

MessageConversationDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

ReportFieldsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
ReportFieldsDateIntervalColumn
ENUM

ReportFieldResultsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
ReportFieldResultsDateIntervalColumn
ENUM

ReportResultsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
ReportResultsDateIntervalColumn
ENUM

ReportGroupsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
ReportGroupsDateIntervalColumn
ENUM

ReportGroupsOrder

ArgumentsTypeDescription
column
ReportGroupsOrderColumn
ENUM
direction
OrderDirection
ENUM

ReportEntitiesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
ReportEntitiesDateIntervalColumn
ENUM

ReportEntitiesOrder

ArgumentsTypeDescription
column
ReportEntitiesOrderColumn
ENUM
direction
OrderDirection
ENUM

MessageRecipientsOrder

ArgumentsTypeDescription
column
Not Null
direction
OrderDirection
ENUM

MessageRecipientsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

MessageEntitiesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

MessageGroupsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

MessageMediasDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

MessageSignaturesOrder

ArgumentsTypeDescription
column
Not Null
direction
OrderDirection
ENUM

MessageSignaturesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

MessageSurveysDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

SurveyOptionsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
SurveyOptionsDateIntervalColumn
ENUM

SurveyOptionResultsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
SurveyOptionResultsDateIntervalColumn
ENUM

SurveyResultsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
SurveyResultsDateIntervalColumn
ENUM

SurveyEntitiesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
SurveyEntitiesDateIntervalColumn
ENUM

SurveySummaryDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
SurveySummaryDateIntervalColumn
ENUM

MessageCommitmentsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

MessageChargesOrder

ArgumentsTypeDescription
column
Not Null
direction
OrderDirection
ENUM

MessageChargesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

OrganizationAccountOrganizationWithdrawalOrder

ArgumentsTypeDescription
column
Not Null
direction
OrderDirection
ENUM

OrganizationAccountOrganizationWithdrawalConnectionDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
OrganizationAccountOrganizationWithdrawalConnectionDateIntervalColumn
ENUM

OrganizationAccountTransactionsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval

PlanProductsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
PlanProductsDateIntervalColumn
ENUM

PlanProductsOrder

ArgumentsTypeDescription
column
PlanProductsOrderColumn
ENUM
direction
OrderDirection
ENUM

ProductPlansDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
ProductPlansDateIntervalColumn
ENUM

ProductPlansOrder

ArgumentsTypeDescription
column
ProductPlansOrderColumn
ENUM
direction
OrderDirection
ENUM

ProductLogsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
ProductLogsDateIntervalColumn
ENUM

ProductLogsOrder

ArgumentsTypeDescription
column
ProductLogsOrderColumn
ENUM
direction
OrderDirection
ENUM

PlanContractsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
PlanContractsDateIntervalColumn
ENUM

PlanContractsOrder

ArgumentsTypeDescription
column
PlanContractsOrderColumn
ENUM
direction
OrderDirection
ENUM

ContractLogsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
ContractLogsDateIntervalColumn
ENUM

ContractLogsOrder

ArgumentsTypeDescription
column
ContractLogsOrderColumn
ENUM
direction
OrderDirection
ENUM

ContractInvoicesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
ContractInvoicesDateIntervalColumn
ENUM

ContractInvoicesOrder

ArgumentsTypeDescription
column
ContractInvoicesOrderColumn
ENUM
direction
OrderDirection
ENUM

InvoiceLogsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
InvoiceLogsDateIntervalColumn
ENUM

InvoiceLogsOrder

ArgumentsTypeDescription
column
InvoiceLogsOrderColumn
ENUM
direction
OrderDirection
ENUM

InvoiceDiscountsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
InvoiceDiscountsDateIntervalColumn
ENUM

InvoiceDiscountsOrder

ArgumentsTypeDescription
column
InvoiceDiscountsOrderColumn
ENUM
direction
OrderDirection
ENUM

InvoiceChargesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
InvoiceChargesDateIntervalColumn
ENUM

InvoiceChargesOrder

ArgumentsTypeDescription
column
InvoiceChargesOrderColumn
ENUM
direction
OrderDirection
ENUM

PlanLogsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
PlanLogsDateIntervalColumn
ENUM

PlanLogsOrder

ArgumentsTypeDescription
column
PlanLogsOrderColumn
ENUM
direction
OrderDirection
ENUM

ChargeEntitiesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
ChargeEntitiesDateIntervalColumn
ENUM

ChargeEntitiesOrder

ArgumentsTypeDescription
column
ChargeEntitiesOrderColumn
ENUM
direction
OrderDirection
ENUM

ChargeChargePaymentsOrder

ArgumentsTypeDescription
column
Not Null
direction
OrderDirection
ENUM

ChargeChargePaymentsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

MessageFormsOrder

ArgumentsTypeDescription
column
Not Null
direction
OrderDirection
ENUM

MessageFormsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

FormFieldsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
FormFieldsDateIntervalColumn
ENUM

FormFieldsOrder

ArgumentsTypeDescription
column
FormFieldsOrderColumn
ENUM
direction
OrderDirection
ENUM

FormFieldResultsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
FormFieldResultsDateIntervalColumn
ENUM

FormFieldResultsOrder

ArgumentsTypeDescription
column
FormFieldResultsOrderColumn
ENUM
direction
OrderDirection
ENUM

FormResultsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
FormResultsDateIntervalColumn
ENUM

FormResultsOrder

ArgumentsTypeDescription
column
FormResultsOrderColumn
ENUM
direction
OrderDirection
ENUM

FormGroupsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
FormGroupsDateIntervalColumn
ENUM

FormGroupsOrder

ArgumentsTypeDescription
column
FormGroupsOrderColumn
ENUM
direction
OrderDirection
ENUM

FormEntitiesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
FormEntitiesDateIntervalColumn
ENUM

FormEntitiesOrder

ArgumentsTypeDescription
column
FormEntitiesOrderColumn
ENUM
direction
OrderDirection
ENUM

MessageReportsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

TagAddressesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
TagAddressesDateIntervalColumn
ENUM

AddressAddressesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
AddressAddressesDateIntervalColumn
ENUM

TagEntitiesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
TagEntitiesDateIntervalColumn
ENUM

TagUsersDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
TagUsersDateIntervalColumn
ENUM

TagMessagesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
TagMessagesDateIntervalColumn
ENUM

MessageLogsOrder

ArgumentsTypeDescription
column
Not Null
direction
OrderDirection
ENUM

MessageLogsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

MessageNotificationsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

MessageMessageStatusOrder

ArgumentsTypeDescription
column
Not Null
direction
OrderDirection
ENUM

MessageMessageStatusDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

CommitmentRemindsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
CommitmentRemindsDateIntervalColumn
ENUM

CommitmentEntitiesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
CommitmentEntitiesDateIntervalColumn
ENUM

CommitmentGroupsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
CommitmentGroupsDateIntervalColumn
ENUM

CommitmentGroupsOrder

ArgumentsTypeDescription
column
CommitmentGroupsOrderColumn
ENUM
direction
OrderDirection
ENUM

CommitmentCommitmentsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
CommitmentCommitmentsDateIntervalColumn
ENUM

CommitmentCommitmentsOrder

ArgumentsTypeDescription
column
CommitmentCommitmentsOrderColumn
ENUM
direction
OrderDirection
ENUM

OrganizationMyEntitiesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
OrganizationMyEntitiesDateIntervalColumn
ENUM

OrganizationMyEntitiesOrder

ArgumentsTypeDescription
column
OrganizationMyEntitiesOrderColumn
ENUM
direction
OrderDirection
ENUM

OrganizationInvoicesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
OrganizationInvoicesAmountDateIntervalColumn
ENUM

OrganizationPaymentsAmountDateLimitInterval

ArgumentsTypeDescription
initialDate
String
SCALAR
Initial date for interval
finalDate
String
SCALAR
Final date for interval

OrganizationEntitiesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
OrganizationEntitiesDateIntervalColumn
ENUM

OrganizationRecipientTagsOrder

ArgumentsTypeDescription
column
Not Null
direction
OrderDirection
ENUM

OrganizationGroupsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
OrganizationGroupsDateIntervalColumn
ENUM

OrganizationLinksOrder

ArgumentsTypeDescription
column
Not Null
direction
OrderDirection
ENUM

OrganizationLinksDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

OrganizationApplicationAccessDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
OrganizationApplicationAccessDateIntervalColumn
ENUM

OrganizationApplicationAccessOrder

ArgumentsTypeDescription
column
OrganizationApplicationAccessOrderColumn
ENUM
direction
OrderDirection
ENUM

ApplicationAccessundefinedDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
ApplicationAccessundefinedDateIntervalColumn
ENUM

ApplicationAccessundefinedOrder

ArgumentsTypeDescription
column
ApplicationAccessundefinedOrderColumn
ENUM
direction
OrderDirection
ENUM

ApplicationAccessintegrationModulesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
ApplicationAccessintegrationModulesDateIntervalColumn
ENUM

ApplicationAccessintegrationModulesOrder

ArgumentsTypeDescription
column
ApplicationAccessintegrationModulesOrderColumn
ENUM
direction
OrderDirection
ENUM

ApplicationAccessintegrationContractsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
ApplicationAccessintegrationContractsDateIntervalColumn
ENUM

ApplicationAccessintegrationContractsOrder

ArgumentsTypeDescription
column
ApplicationAccessintegrationContractsOrderColumn
ENUM
direction
OrderDirection
ENUM

LabelOrder

ArgumentsTypeDescription
column
Not Null
direction
OrderDirection
ENUM

LabelDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

OrganizationReportsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
OrganizationReportsDateIntervalColumn
ENUM

OrganizationFormsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
OrganizationFormsDateIntervalColumn
ENUM

OrganizationFormsOrder

ArgumentsTypeDescription
column
OrganizationFormsOrderColumn
ENUM
direction
OrderDirection
ENUM

OrganizationOrganizationAccountOrder

ArgumentsTypeDescription
column
Not Null
direction
OrderDirection
ENUM

OrganizationOrganizationAccountDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

OrganizationRulesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
OrganizationRulesDateIntervalColumn
ENUM

OrganizationRulesOrder

ArgumentsTypeDescription
column
OrganizationRulesOrderColumn
ENUM
direction
OrderDirection
ENUM

OrganizationPlansDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
OrganizationPlansDateIntervalColumn
ENUM

OrganizationPlansOrder

ArgumentsTypeDescription
column
OrganizationPlansOrderColumn
ENUM
direction
OrderDirection
ENUM

OrganizationProductsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
OrganizationProductsDateIntervalColumn
ENUM

OrganizationProductsOrder

ArgumentsTypeDescription
column
OrganizationProductsOrderColumn
ENUM
direction
OrderDirection
ENUM

OrganizationMessagesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

OrganizationMomentsOrder

ArgumentsTypeDescription
column
Not Null
direction
OrderDirection
ENUM

OrganizationMomentsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

OrganizationDraftsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
OrganizationDraftsDateIntervalColumn
ENUM

OrganizationDraftsOrder

ArgumentsTypeDescription
column
OrganizationDraftsOrderColumn
ENUM
direction
OrderDirection
ENUM

OrganizationCommitmentsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
OrganizationCommitmentsDateIntervalColumn
ENUM

OrganizationCommitmentsOrder

ArgumentsTypeDescription
column
OrganizationCommitmentsOrderColumn
ENUM
direction
OrderDirection
ENUM

OrganizationCommitmentsPeriod

ArgumentsTypeDescription
month
Int
SCALAR
year
Int
SCALAR

OrganizationChargeRecipientDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
OrganizationChargeRecipientDateIntervalColumn
ENUM

OrganizationChargeRecipientOrder

ArgumentsTypeDescription
column
OrganizationChargeRecipientOrderColumn
ENUM
direction
OrderDirection
ENUM

OrganizationChargeDateLimitInterval

ArgumentsTypeDescription
initialDate
String
SCALAR
Initial date for interval
finalDate
String
SCALAR
Final date for interval

OrganizationOrganizationBannersOrder

ArgumentsTypeDescription
column
Not Null
direction
OrderDirection
ENUM

OrganizationPaymentsOrder

ArgumentsTypeDescription
column
OrganizationPaymentsOrderColumn
ENUM
direction
OrderDirection
ENUM

OrganizationPaymentsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

OrganizationChargesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
OrganizationChargesDateIntervalColumn
ENUM

OrganizationChargesOrder

ArgumentsTypeDescription
column
OrganizationChargesOrderColumn
ENUM
direction
OrderDirection
ENUM

OrganizationInvoicesOrder

ArgumentsTypeDescription
column
OrganizationInvoicesOrderColumn
ENUM
direction
OrderDirection
ENUM

OrganizationWebhooksDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
OrganizationWebhooksDateIntervalColumn
ENUM

OrganizationWebhooksOrder

ArgumentsTypeDescription
column
OrganizationWebhooksOrderColumn
ENUM
direction
OrderDirection
ENUM

OrganizationApplicationDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
OrganizationApplicationDateIntervalColumn
ENUM

OrganizationApplicationOrder

ArgumentsTypeDescription
column
OrganizationApplicationOrderColumn
ENUM
direction
OrderDirection
ENUM

OrganizationundefinedDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
OrganizationundefinedDateIntervalColumn
ENUM

OrganizationundefinedOrder

ArgumentsTypeDescription
column
OrganizationundefinedOrderColumn
ENUM
direction
OrderDirection
ENUM

OrganizationOrganizationWithdrawalDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
OrganizationOrganizationWithdrawalDateIntervalColumn
ENUM

OrganizationOrganizationWithdrawalOrder

ArgumentsTypeDescription
column
OrganizationOrganizationWithdrawalOrderColumn
ENUM
direction
OrderDirection
ENUM

OrganizationintegrationContractDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
OrganizationintegrationContractDateIntervalColumn
ENUM

OrganizationintegrationContractOrder

ArgumentsTypeDescription
column
OrganizationintegrationContractOrderColumn
ENUM
direction
OrderDirection
ENUM

OrganizationOrganizationConciergesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
OrganizationOrganizationConciergesDateIntervalColumn
ENUM

OrganizationOrganizationConciergesOrder

ArgumentsTypeDescription
column
OrganizationOrganizationConciergesOrderColumn
ENUM
direction
OrderDirection
ENUM

ArrivedConfigurationConciergesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
ArrivedConfigurationConciergesDateIntervalColumn
ENUM

ArrivedConfigurationConciergesOrder

ArgumentsTypeDescription
column
ArrivedConfigurationConciergesOrderColumn
ENUM
direction
OrderDirection
ENUM

OrganizationEntitiesWithArrivedOrder

ArgumentsTypeDescription
column
Not Null
direction
OrderDirection
ENUM

OrganizationEntitiesWithArrivedDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

OrganizationProductFeaturesOrder

ArgumentsTypeDescription
column
Not Null
direction
OrderDirection
ENUM

OrganizationProductFeaturesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

ProductFeatureOrganizationsOrder

ArgumentsTypeDescription
column
Not Null
direction
OrderDirection
ENUM

ProductFeatureOrganizationsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

EntityContractsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
EntityContractsDateIntervalColumn
ENUM

EntityContractsOrder

ArgumentsTypeDescription
column
EntityContractsOrderColumn
ENUM
direction
OrderDirection
ENUM

EntityConciergesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
EntityConciergesDateIntervalColumn
ENUM

EntityConciergesOrder

ArgumentsTypeDescription
column
EntityConciergesOrderColumn
ENUM
direction
OrderDirection
ENUM

EntityUsersDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
EntityUsersDateIntervalColumn
ENUM

EntityEntityMessageStatusDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
EntityEntityMessageStatusDateIntervalColumn
ENUM

EntityEntityMessageStatusOrder

ArgumentsTypeDescription
column
EntityEntityMessageStatusOrderColumn
ENUM
direction
OrderDirection
ENUM

EntityAddressesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
EntityAddressesDateIntervalColumn
ENUM

EntityRolesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
EntityRolesDateIntervalColumn
ENUM

EntityGroupsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
EntityGroupsDateIntervalColumn
ENUM

EntityGroupRecipientsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
EntityGroupRecipientsDateIntervalColumn
ENUM

EntityStaffRecipientsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
EntityStaffRecipientsDateIntervalColumn
ENUM

EntityNotificationsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
EntityNotificationsDateIntervalColumn
ENUM

EntityNotificationsOrder

ArgumentsTypeDescription
column
EntityNotificationsOrderColumn
ENUM
direction
OrderDirection
ENUM

EntityMessagesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

EntityMomentsOrder

ArgumentsTypeDescription
column
Not Null
direction
OrderDirection
ENUM

EntityMomentsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

EntityDraftsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
EntityDraftsDateIntervalColumn
ENUM

EntityDraftsOrder

ArgumentsTypeDescription
column
EntityDraftsOrderColumn
ENUM
direction
OrderDirection
ENUM

EntityDraftLogsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
EntityDraftLogsDateIntervalColumn
ENUM

EntityDraftLogsOrder

ArgumentsTypeDescription
column
EntityDraftLogsOrderColumn
ENUM
direction
OrderDirection
ENUM

EntityMediasDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
EntityMediasDateIntervalColumn
ENUM

EntitySurveysDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
EntitySurveysDateIntervalColumn
ENUM

EntityCommitmentsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
EntityCommitmentsDateIntervalColumn
ENUM

EntityChargesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
EntityChargesDateIntervalColumn
ENUM

EntityChargesOrder

ArgumentsTypeDescription
column
EntityChargesOrderColumn
ENUM
direction
OrderDirection
ENUM

EntityRecipientsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
EntityRecipientsDateIntervalColumn
ENUM

EntityReportsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
EntityReportsDateIntervalColumn
ENUM

EntityReportsOrder

ArgumentsTypeDescription
column
EntityReportsOrderColumn
ENUM
direction
OrderDirection
ENUM

EntityFormsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
EntityFormsDateIntervalColumn
ENUM

EntityFormsOrder

ArgumentsTypeDescription
column
EntityFormsOrderColumn
ENUM
direction
OrderDirection
ENUM

EntityChargePaymentsOrder

ArgumentsTypeDescription
column
Not Null
direction
OrderDirection
ENUM

EntityChargePaymentsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

EntityInvoicesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
EntityInvoicesDateIntervalColumn
ENUM

EntityInvoicesOrder

ArgumentsTypeDescription
column
EntityInvoicesOrderColumn
ENUM
direction
OrderDirection
ENUM

EntityOverdueInvoicesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval

EntityExternalChannelsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
EntityExternalChannelsDateIntervalColumn
ENUM

EntityExternalChannelsOrder

ArgumentsTypeDescription
column
EntityExternalChannelsOrderColumn
ENUM
direction
OrderDirection
ENUM

EntityArrivalsOrder

ArgumentsTypeDescription
column
Not Null
direction
OrderDirection
ENUM

EntityArrivalsSearch

ArgumentsTypeDescription
column
Not Null
criteria
String
SCALAR

EntityArrivalsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

EntityArrivalsDurationInput

ArgumentsTypeDescription
minimum
Int
SCALAR
Minimum of miliseconds to calculate wait time
maximum
Int
SCALAR
Maximum of miliseconds to calculate wait time

UserAddressesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
UserAddressesDateIntervalColumn
ENUM

UserAcceptedTermsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
UserAcceptedTermsDateIntervalColumn
ENUM

UserAcceptedTermsOrder

ArgumentsTypeDescription
column
UserAcceptedTermsOrderColumn
ENUM
direction
OrderDirection
ENUM

UserInvitationsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
UserInvitationsDateIntervalColumn
ENUM

UserApplicationsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
UserApplicationsDateIntervalColumn
ENUM

UserArrivedFilterConciergesOrder

ArgumentsTypeDescription
column
Not Null
direction
OrderDirection
ENUM

UserArrivedFilterConciergesSearch

ArgumentsTypeDescription
column
Not Null
criteria
Not Null

UserArrivedFilterConciergesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

UserArrivedFilterGroupsOrder

ArgumentsTypeDescription
column
Not Null
direction
OrderDirection
ENUM

UserArrivedFilterGroupsSearch

ArgumentsTypeDescription
column
Not Null
criteria
Not Null

UserArrivedFilterGroupsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time unit
column
Not Null

UserConciergesOrder

ArgumentsTypeDescription
column
Not Null
direction
OrderDirection
ENUM

UserOauthProvidersDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
UserOauthProvidersDateIntervalColumn
ENUM

UserDevicesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
UserDevicesDateIntervalColumn
ENUM

UserDraftsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
UserDraftsDateIntervalColumn
ENUM

UserDraftsOrder

ArgumentsTypeDescription
column
UserDraftsOrderColumn
ENUM
direction
OrderDirection
ENUM

UserNotificationsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
UserNotificationsDateIntervalColumn
ENUM

UserOrganizationsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
UserOrganizationsDateIntervalColumn
ENUM

UserFeedbacksDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
UserFeedbacksDateIntervalColumn
ENUM

UserFeedbacksOrder

ArgumentsTypeDescription
column
UserFeedbacksOrderColumn
ENUM
direction
OrderDirection
ENUM

UserCardsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
UserCardsDateIntervalColumn
ENUM

UserCardsOrder

ArgumentsTypeDescription
column
UserCardsOrderColumn
ENUM
direction
OrderDirection
ENUM

UserPlansDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
UserPlansDateIntervalColumn
ENUM

UserPlansOrder

ArgumentsTypeDescription
column
UserPlansOrderColumn
ENUM
direction
OrderDirection
ENUM

UserSubscriptionsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
UserSubscriptionsDateIntervalColumn
ENUM

UserSubscriptionsOrder

ArgumentsTypeDescription
column
UserSubscriptionsOrderColumn
ENUM
direction
OrderDirection
ENUM

PlanSubscriptionChargesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
PlanSubscriptionChargesDateIntervalColumn
ENUM

PlanSubscriptionChargesOrder

ArgumentsTypeDescription
column
PlanSubscriptionChargesOrderColumn
ENUM
direction
OrderDirection
ENUM

UserVehiclesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
UserVehiclesDateIntervalColumn
ENUM

UserVehiclesOrder

ArgumentsTypeDescription
column
UserVehiclesOrderColumn
ENUM
direction
OrderDirection
ENUM

UserEntitiesWithArrivedDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
UserEntitiesWithArrivedDateIntervalColumn
ENUM

UserEntitiesWithArrivedOrder

ArgumentsTypeDescription
column
UserEntitiesWithArrivedOrderColumn
ENUM
direction
OrderDirection
ENUM

ApplicationDevicesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
ApplicationDevicesDateIntervalColumn
ENUM

ApplicationOauthProvidersDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
ApplicationOauthProvidersDateIntervalColumn
ENUM

ApplicationOrganizationDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
ApplicationOrganizationDateIntervalColumn
ENUM

ApplicationOrganizationOrder

ArgumentsTypeDescription
column
ApplicationOrganizationOrderColumn
ENUM
direction
OrderDirection
ENUM

ApplicationExternalChannelsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
ApplicationExternalChannelsDateIntervalColumn
ENUM

ApplicationExternalChannelsOrder

ArgumentsTypeDescription
column
ApplicationExternalChannelsOrderColumn
ENUM
direction
OrderDirection
ENUM

OrganizationsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
OrganizationsDateIntervalColumn
ENUM

OrganizationConf

ArgumentsTypeDescription
confMessage
Boolean
SCALAR
Message can be sent
confMessageStudent
Boolean
SCALAR
Parent/student can send messages
confMessageStaff
Boolean
SCALAR
Staff can send messages
confMedia
Boolean
SCALAR
Media can be sent
confAudio
Boolean
SCALAR
Audio can be sent
confAudioStudent
Boolean
SCALAR
Audio can be sent by students
confOtherFiles
Boolean
SCALAR
Other files can be sent
confCommitment
Boolean
SCALAR
Commitment can be sent
confSurvey
Boolean
SCALAR
Survey can be sent
confReport
Boolean
SCALAR
Report can be sent
confCharge
Boolean
SCALAR
Charge can be sent
confChargeList
Boolean
SCALAR
Charge list can be showed for entities
confForm
Boolean
SCALAR
Form can be sent
confReplyStudent
Boolean
SCALAR
Parent/student can send replies
confMediaStudent
Boolean
SCALAR
Parent/student can send media
confTerms
LIST
String
Terms that were accepted by the user
confPresence
Boolean
SCALAR
Presence can be sent
confAdminList
Boolean
SCALAR
Show admin list for staff
confRecurrence
Boolean
SCALAR
Organization has access to recurrrence module
confAnticipationDiscount
Boolean
SCALAR
Allow anticipation discount for charges
confFine
Boolean
SCALAR
Allow fine for charges
confInterest
Boolean
SCALAR
Allow interest for charges
confPaymentDetailsInboleto
Boolean
SCALAR
Allow boleto details for fine payments
confChannelMetrics
Boolean
SCALAR
Parent/student can see channels metrics before sending messages
confArrived
Boolean
SCALAR
If arrived feature are enabled this sends true
confRepliesStudent
Boolean
SCALAR
Combined with confReplyStudent this tells if students can reply more than once time.

OrganizationSize

ArgumentsTypeDescription
min
Int
SCALAR
max
Int
SCALAR
entityTypes
LIST
EntityType

IntegrationStatusAndType

ArgumentsTypeDescription
status
LIST
IntegrationStatus
type
ApplicationAccessTypeEnum
ENUM

ChannelsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
ChannelsDateIntervalColumn
ENUM

ChannelsOrder

ArgumentsTypeDescription
column
ChannelsOrderColumn
ENUM
direction
OrderDirection
ENUM

UsersDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
UsersDateIntervalColumn
ENUM

ModulesDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
ModulesDateIntervalColumn
ENUM

ModulesOrder

ArgumentsTypeDescription
column
ModulesOrderColumn
ENUM
direction
OrderDirection
ENUM

IntegrationCancellationReasonsDateInterval

ArgumentsTypeDescription
limit
Int
SCALAR
offset
Int
SCALAR
interval
Interval
ENUM
Time period interval
column
IntegrationCancellationReasonsDateIntervalColumn
ENUM

IntegrationCancellationReasonsOrder

ArgumentsTypeDescription
column
IntegrationCancellationReasonsOrderColumn
ENUM
direction
OrderDirection
ENUM

CreateAcceptedTermInput

ArgumentsTypeDescription
ipAddress
String
SCALAR
Ip address of user
organizationId
Int
SCALAR
which organization does it belong to
clientMutationId
String
SCALAR

CreateAnAcceptedTermInput

ArgumentsTypeDescription
ipAddress
String
SCALAR
Ip address of user
organizationId
Int
SCALAR
which organization does it belong to
termName
Not Null
clientMutationId
String
SCALAR

CreateAddressInput

ArgumentsTypeDescription
entityId
Not Null
The entity that the address belongs to
address
Not Null
The address itself
type
Not Null
The type of address is an ENUM: EMAIL or PHONE
ntfInvite
Boolean
SCALAR
notify when invite
ntfMessage
Boolean
SCALAR
notify when new message is sent
ntfMoment
Boolean
SCALAR
notify when new moment is sent
ntfUnread
Boolean
SCALAR
notify when there are unread messages
ntfReset
Boolean
SCALAR
notify to reset addresses
tags
LIST
AddressTagsInput
invite
Boolean
SCALAR
Send invitations
clientMutationId
String
SCALAR

AddressTagsInput

ArgumentsTypeDescription
id
ID
SCALAR
name
String
SCALAR

UpdateAddressInput

ArgumentsTypeDescription
id
Not Null
The ID of an address object
code
String
SCALAR
The ID of an address object
address
String
SCALAR
The address itself
type
AddressType
ENUM
The type of address is an ENUM: EMAIL or PHONE
ntfInvite
Boolean
SCALAR
notify when invite
ntfMessage
Boolean
SCALAR
notify when new message is sent
ntfMoment
Boolean
SCALAR
notify when new moment is sent
ntfUnread
Boolean
SCALAR
notify when there are unread messages
ntfReset
Boolean
SCALAR
notify to reset addresses
tags
LIST
AddressTagsInput
invite
Boolean
SCALAR
Send invitations
attach
LIST
String
Attach related rather than replace
clientMutationId
String
SCALAR

DeleteAddressInput

ArgumentsTypeDescription
id
Not Null
The ID of an address object
code
String
SCALAR
The ID of an address object
clientMutationId
String
SCALAR

CreateArrivedConfigurationInput

ArgumentsTypeDescription
organizationId
Not Null
The organization who is configured
tagsIds
Not Null
Tags configured to organization
usersIds
Not Null
Users configured by organization to use arrived
enabled
Not Null
The organization who is configured
createConcierges
LIST
createConciergeArrivedConfigurationInput
Concierges to create in organization
updateConcierges
LIST
updateConciergeArrivedConfigurationInput
Concierges to update in organization
deleteConcierges
LIST
ID
Concierges to create in organization
clientMutationId
String
SCALAR

createConciergeArrivedConfigurationInput

ArgumentsTypeDescription
name
Not Null
The name of the concierge
address
String
SCALAR
The address of the concierge
organizationId
Not Null
The id of organization the concierge belongs
groupIds
Not Null
Groups related to this concierge

updateConciergeArrivedConfigurationInput

ArgumentsTypeDescription
id
Not Null
The ID of concierge object
name
String
SCALAR
The name of the concierge
address
String
SCALAR
The address of the concierge
organizationId
ID
SCALAR
The id of organization the concierge belongs
groupIds
LIST
ID
Groups related to this concierge

UpdateArrivedConfigurationInput

ArgumentsTypeDescription
organizationId
Not Null
The organization who is configured
tagsIds
LIST
ID
Tags configured to organization
usersIds
LIST
ID
Users configured by organization to use arrived
enabled
Not Null
The organization who is configured
createConcierges
LIST
createConciergeArrivedConfigurationInput
Concierges to create in organization
updateConcierges
LIST
updateConciergeArrivedConfigurationInput
Concierges to update in organization
deleteConcierges
LIST
ID
Concierges to create in organization
clientMutationId
String
SCALAR

CreateApplicationAccessInput

ArgumentsTypeDescription
applicationId
Not Null
Id of application
organizationId
Not Null
Id of organization
isActive
Boolean
SCALAR
Activates the integration
configuration
JSONObject
SCALAR
Application general configuration
status
Not Null
Application status
canceledAt
String
SCALAR
Cancellation date
type
Not Null
Application access type
comments
String
SCALAR
Comments of Application Access
responsible
String
SCALAR
Responsible of application access
entityId
Int
SCALAR
Responsible entity
clientMutationId
String
SCALAR

UpdateApplicationAccessInput

ArgumentsTypeDescription
id
Not Null
The ID application access
applicationId
Int
SCALAR
Id of application
organizationId
Int
SCALAR
Id of organization
isActive
Boolean
SCALAR
Activates the integration
configuration
JSONObject
SCALAR
Application general configuration
status
ApplicationAccessStatus
ENUM
Application status
canceledAt
String
SCALAR
Cancellation date
type
Not Null
Application access type
comments
String
SCALAR
Comments of Application Access
responsible
String
SCALAR
Responsible of application access
entityId
Int
SCALAR
Responsible entity
clientMutationId
String
SCALAR

DeleteApplicationAccessInput

ArgumentsTypeDescription
id
Not Null
The ID application access
clientMutationId
String
SCALAR

CreateApplicationInput

ArgumentsTypeDescription
name
Not Null
application name
type
Not Null
web=null,ios=1,android=2,windows_phone=3
description
String
SCALAR
description if available
appUrl
String
SCALAR
application url
published
Boolean
SCALAR
0=unpublished,1=published
author
String
SCALAR
app author
urlAuthor
String
SCALAR
author url
redirectUri
String
SCALAR
where application is redirected to
logo
String
SCALAR
logo source
visible
Boolean
SCALAR
if an application can be listed
scope
String
SCALAR
logo source
entityScope
LIST
EntityScope
Permission scope to be added to created entities
systemName
String
SCALAR
simple system name to be used to search
privacy
ApplicationPrivacy
ENUM
turn this application available on the store
lock
ApplicationLock
ENUM
current status of the application
isActive
Boolean
SCALAR
if application portal service is active
baseConfiguration
String
SCALAR
Application's base configuration
expiresIn
Int
SCALAR
Expiration time for portal logged
clientMutationId
String
SCALAR

UpdateApplicationInput

ArgumentsTypeDescription
id
Not Null
The ID of an application object
name
String
SCALAR
application name
type
ApplicationType
ENUM
web=null,ios=1,android=2,windows_phone=3
description
String
SCALAR
description if available
appUrl
String
SCALAR
application url
published
Boolean
SCALAR
0=unpublished,1=published
author
String
SCALAR
app author
urlAuthor
String
SCALAR
author url
redirectUri
String
SCALAR
where application is redirected to
logo
String
SCALAR
logo source
visible
Boolean
SCALAR
if an application can be listed
scope
String
SCALAR
logo source
entityScope
LIST
EntityScope
Permission scope to be added to created entities
systemName
String
SCALAR
simple system name to be used to search
privacy
ApplicationPrivacy
ENUM
turn this application available on the store
lock
ApplicationLock
ENUM
current status of the application
isActive
Boolean
SCALAR
if application portal service is active
baseConfiguration
String
SCALAR
Application's base configuration
expiresIn
Int
SCALAR
Expiration time for portal logged
clientMutationId
String
SCALAR

uploadApplicationLogoInput

ArgumentsTypeDescription
id
Not Null
The ID of an application object
clientMutationId
String
SCALAR

DeleteApplicationInput

ArgumentsTypeDescription
id
Not Null
The ID of an application object
clientMutationId
String
SCALAR

CreateArrivalInput

ArgumentsTypeDescription
organizationId
Not Null
Organization this arrival belongs to
entityId
Not Null
Entity who's being picked up
vehicleId
ID
SCALAR
Vehicle used for pick up
conciergeId
Not Null
Concierge where pick up will take place
clientMutationId
String
SCALAR

UpdateArrivalInput

ArgumentsTypeDescription
id
Not Null
The ID of an arrival
status
ArrivalStatus
ENUM
Arrival status
vehicleId
ID
SCALAR
Vehicle used for pick up
caller
EntityType
ENUM
Defines what type of entity is calling this mutation
allowUndo
Boolean
SCALAR
Should allow arrival status to be reversed
clientMutationId
String
SCALAR

UpdateChargeInput

ArgumentsTypeDescription
id
ID
SCALAR
organizationAccountId
ID
SCALAR
Organization account
invoiceId
ID
SCALAR
invoice
name
String
SCALAR
Charge's name
description
String
SCALAR
Charge description
amount
Float
SCALAR
Charge amount
dateLimit
String
SCALAR
Date limit to pay charge
notifyAt
String
SCALAR
Date to notify users to pay charge
paymentMethods
LIST
PaymentMethod
custom payment method defined for this charge
absorbedFee
LIST
PaymentMethod
which payment method will have its fee absorbed by default
allowedInstallments
Int
SCALAR
Number of allowed installments
anticipationDiscountUntil
Int
SCALAR
Number of days before the expiration of a charge that the discount is still applied
anticipationDiscountType
DiscountType
ENUM
Type of the discount (percentange or amount)
anticipationDiscountValue
Float
SCALAR
Discount value in percentage or total amount
fineStart
Int
SCALAR
Number of days after the expiration of a charge that the fine should start
fineType
DiscountType
ENUM
Type of the fine (percentange or amount)
fineValue
Float
SCALAR
Fine value in percentage or total amount
interestStart
Int
SCALAR
Number of days after the expiration of a charge that the interest should start
interestType
DiscountType
ENUM
Type of the interest (percentange or amount)
interestValue
Float
SCALAR
interest value in percentage or total amount
payableExpired
Boolean
SCALAR
Whether the charge can be paid when expired or not
reason
String
SCALAR
Reason for changing charge
remindPending
remindPending
INPUT_OBJECT
Remind pending entities
clientMutationId
String
SCALAR

remindPending

ArgumentsTypeDescription
remindAll
Boolean
SCALAR
Remind all pending entities
entityIds
LIST
ID
Remind some entities

DeleteChargeInput

ArgumentsTypeDescription
id
Not Null
The ID of a charge object
reason
String
SCALAR
Reason for changing charge
clientMutationId
String
SCALAR

CreateChargePaymentInput

ArgumentsTypeDescription
entityId
Not Null
Id of entity that will make the payment
chargeId
Not Null
Id of charge
method
Not Null
Payment method to authorize
cardToken
String
SCALAR
Card token
documentNumber
String
SCALAR
Personal document number (CPF)
email
String
SCALAR
Email associated with card
phone
String
SCALAR
Phone number associated with card
installments
Int
SCALAR
Number of installments
reason
String
SCALAR
Charge Payment reason for manual-confirmation
clientMutationId
String
SCALAR

DeleteChargePaymentInput

ArgumentsTypeDescription
id
Not Null
The ID of a charge payment object
bankCode
String
SCALAR
The bank code of the account that should receive the refund
agency
String
SCALAR
The agency number of the account that should receive the refund
agencyDv
String
SCALAR
The agency`s digit of the account that should receive the refund
account
String
SCALAR
The account number of the account that should receive the refund
accountDv
String
SCALAR
The account`s digit of the account that should receive the refund
legalName
String
SCALAR
The legal name of the account holder
documentNumber
String
SCALAR
The document of the account holder
clientMutationId
String
SCALAR

CreateCodeAndSendInput

ArgumentsTypeDescription
address
String
SCALAR
The address that the code will be sent
type
String
SCALAR
The address type: phone or email
language
String
SCALAR
The message language. (Example: en, es, pt etc.)
clientMutationId
String
SCALAR

validateCodeInput

ArgumentsTypeDescription
code
String
SCALAR
The code that will be validated
address
String
SCALAR
The address that the code will be sent
clientMutationId
String
SCALAR

CreateCommitmentInput

ArgumentsTypeDescription
organizationId
ID
SCALAR
Organization owner of the commitment
entityId
ID
SCALAR
Entity owner, personal commitment
name
Not Null
Commitment name
description
String
SCALAR
Commitment description
date
String
SCALAR
date of commitment
time
String
SCALAR
time of commitment
dateEnd
String
SCALAR
date of commitment
timeEnd
String
SCALAR
time of commitment
noConfirm
Boolean
SCALAR
No confirmation = 1
color
String
SCALAR
No confirmation = 1
dateLimit
String
SCALAR
Date limit to confirm commitment
notifyAt
String
SCALAR
Date to notify users to confirm commitment
videocallType
String
SCALAR
Type video call commitment
videocallLink
String
SCALAR
Link video call commitment
remindPending
remindPending
INPUT_OBJECT
Remind pending entities
repeat
CommitmentRepeatInput
INPUT_OBJECT
groupIds
LIST
Int
Group ids that the commitment will be created
clientMutationId
String
SCALAR

CommitmentRepeatInput

ArgumentsTypeDescription
recurrence
Not Null
How often the commitment will be repeated
until
Not Null
Repeat over the recurrence until this date

UpdateCommitmentInput

ArgumentsTypeDescription
id
Not Null
The ID of a commitment object
name
String
SCALAR
Commitment name
description
String
SCALAR
Commitment description
date
String
SCALAR
date of commitment
time
String
SCALAR
time of commitment
dateEnd
String
SCALAR
date of commitment
timeEnd
String
SCALAR
time of commitment
noConfirm
Boolean
SCALAR
No confirmation = 1
color
String
SCALAR
No confirmation = 1
dateLimit
String
SCALAR
Date limit to confirm commitment
notifyAt
String
SCALAR
Date to notify users to confirm commitment
videocallType
String
SCALAR
Type video call commitment
videocallLink
String
SCALAR
Link video call commitment
reason
String
SCALAR
Reason for changing commitment
remindPending
remindPending
INPUT_OBJECT
Remind pending entities
targetRecurrence
CommitmentTargetRecurrence
ENUM
Should update or delete all next schedules
unlink
Boolean
SCALAR
Generate a new hash reference
clientMutationId
String
SCALAR

DeleteCommitmentInput

ArgumentsTypeDescription
id
Not Null
The ID of a commitment object
reason
String
SCALAR
Reason for changing commitment
targetRecurrence
CommitmentTargetRecurrence
ENUM
Should update or delete all next schedules
clientMutationId
String
SCALAR

CreateCommitmentRemindInput

ArgumentsTypeDescription
entityId
Not Null
Id of entity that will receive the reminder
commitmentId
Not Null
Id of the commitment
status
CommitmentRemindStatus
ENUM
date
String
SCALAR
Date of remind
clientMutationId
String
SCALAR

CreateConfirmAddressInput

ArgumentsTypeDescription
addressType
AddressType
ENUM
The type of address is an ENUM: EMAIL or PHONE
isNewCode
Boolean
SCALAR
if true, a six-digit code will be genetared, otherwise, eight-digit code
clientMutationId
String
SCALAR

ConfirmAddressInput

ArgumentsTypeDescription
code
Not Null
Confirm address code
clientMutationId
String
SCALAR

CreateConciergeInput

ArgumentsTypeDescription
name
Not Null
The name of the concierge
address
String
SCALAR
The address of the concierge
organizationId
Not Null
The id of organization the concierge belongs
groupIds
Not Null
Groups related to this concierge
clientMutationId
String
SCALAR

UpdateConciergeInput

ArgumentsTypeDescription
id
Not Null
The ID of the concierge object
name
String
SCALAR
The name of the concierge
address
String
SCALAR
The address of the concierge
organizationId
ID
SCALAR
The id of organization the concierge belongs
groupIds
LIST
ID
Groups related to this concierge
clientMutationId
String
SCALAR

DeleteConciergeInput

ArgumentsTypeDescription
id
Not Null
The ID of the concierge object
clientMutationId
String
SCALAR

CreateContractInput

ArgumentsTypeDescription
planId
Not Null
plan
organizationAccountId
Not Null
organization account
name
String
SCALAR
contract name
messageSubject
String
SCALAR
subject of message that will be sent to the entity
messageContent
String
SCALAR
content of message that will be sent to the entity
chargeExpirationDay
Int
SCALAR
@TODO DESCRIBE ME
sendMessageDay
Int
SCALAR
@TODO DESCRIBE ME
anticipationDiscountUntil
Int
SCALAR
@TODO DESCRIBE ME
anticipationDiscountType
DiscountType
ENUM
@TODO DESCRIBE ME
anticipationDiscountValue
Float
SCALAR
@TODO DESCRIBE ME
paymentMethods
LIST
PaymentMethod
@TODO DESCRIBE ME
absorbedFee
LIST
PaymentMethod
@TODO DESCRIBE ME
status
Not Null
Contract status
cancelInvoices
Boolean
SCALAR
Tells if should cancel all scheduled invoices
invoices
LIST
ContractInvoiceInput
discounts
LIST
ContractInvoiceProductDiscountInput
products
LIST
ContractInvoiceProductInput
Products to insert in the contract
entityId
Not Null
entity who signed contract
clientMutationId
String
SCALAR

ContractInvoiceInput

ArgumentsTypeDescription
sendAt
String
SCALAR
date and time to send message
chargeExpiration
String
SCALAR
date and time to expire the charge
invoiceNumber
Int
SCALAR
invoice number
amount
Float
SCALAR
amount to be charged
status
InvoiceStatus
ENUM
invoice status
discountType
DiscountType
ENUM
type of discount
discountValue
Float
SCALAR
discount value
anticipationDiscountUntil
Int
SCALAR
Number of days before the expiration of a charge that the discount is still applied
anticipationDiscountType
DiscountType
ENUM
Type of the discount (percentange or amount)
anticipationDiscountValue
Float
SCALAR
Discount value in percentage or total amount
fineStart
Int
SCALAR
Number of days after the expiration of a charge that the fine should start
fineType
DiscountType
ENUM
Type of the fine (percentange or amount)
fineValue
Float
SCALAR
Fine value in percentage or total amount
interestStart
Int
SCALAR
Number of days after the expiration of a charge that the interest should start
interestType
DiscountType
ENUM
Type of the interest (percentange or amount)
interestValue
Float
SCALAR
interest value in percentage or total amount
paymentMethods
LIST
PaymentMethod
custom payment method defined for this charge
absorbedFee
LIST
PaymentMethod
which payment method will have its fee absorbed by default

ContractInvoiceProductDiscountInput

ArgumentsTypeDescription
productId
ID
SCALAR
discountType
DiscountType
ENUM
discountValue
Float
SCALAR

ContractInvoiceProductInput

ArgumentsTypeDescription
id
ID
SCALAR
amount
Float
SCALAR

CreateContractsInput

ArgumentsTypeDescription
planId
Not Null
plan
organizationAccountId
Not Null
organization account
name
String
SCALAR
contract name
messageSubject
String
SCALAR
subject of message that will be sent to the entity
messageContent
String
SCALAR
content of message that will be sent to the entity
chargeExpirationDay
Int
SCALAR
@TODO DESCRIBE ME
sendMessageDay
Int
SCALAR
@TODO DESCRIBE ME
anticipationDiscountUntil
Int
SCALAR
@TODO DESCRIBE ME
anticipationDiscountType
DiscountType
ENUM
@TODO DESCRIBE ME
anticipationDiscountValue
Float
SCALAR
@TODO DESCRIBE ME
paymentMethods
LIST
PaymentMethod
@TODO DESCRIBE ME
absorbedFee
LIST
PaymentMethod
@TODO DESCRIBE ME
status
Not Null
Contract status
cancelInvoices
Boolean
SCALAR
Tells if should cancel all scheduled invoices
invoices
LIST
ContractInvoiceInput
discounts
LIST
ContractInvoiceProductDiscountInput
products
LIST
ContractInvoiceProductInput
Products to insert in the contract
entityIds
Not Null
entities who signed the contract
clientMutationId
String
SCALAR

UpdateContractInput

ArgumentsTypeDescription
id
Not Null
contract id
name
String
SCALAR
contract name
messageSubject
String
SCALAR
subject of message that will be sent to the entity
messageContent
String
SCALAR
content of message that will be sent to the entity
chargeExpirationDay
Int
SCALAR
@TODO DESCRIBE ME
sendMessageDay
Int
SCALAR
@TODO DESCRIBE ME
anticipationDiscountUntil
Int
SCALAR
@TODO DESCRIBE ME
anticipationDiscountType
DiscountType
ENUM
@TODO DESCRIBE ME
anticipationDiscountValue
Float
SCALAR
@TODO DESCRIBE ME
paymentMethods
LIST
PaymentMethod
@TODO DESCRIBE ME
absorbedFee
LIST
PaymentMethod
@TODO DESCRIBE ME
status
Not Null
Contract status
cancelInvoices
Boolean
SCALAR
Tells if should cancel all scheduled invoices
invoices
LIST
ContractInvoiceInput
discounts
LIST
ContractInvoiceProductDiscountInput
products
LIST
ContractInvoiceProductInput
Products to insert in the contract
clientMutationId
String
SCALAR

CreateCoverInput

ArgumentsTypeDescription
organizationId
Not Null
The organization that Cover belongs to
clientMutationId
String
SCALAR

DeleteCoverInput

ArgumentsTypeDescription
organizationId
Not Null
The organization that Cover belongs to
clientMutationId
String
SCALAR

UpdateDailyMessagesRecordInput

ArgumentsTypeDescription
date
SimpleDate
SCALAR
Date to be updated (if not provided this defaults to yesterday)
organizationId
Not Null
The organization from which the number of messages will be counted
clientMutationId
String
SCALAR

CreateDeviceInput

ArgumentsTypeDescription
deviceToken
Not Null
device unique token
deviceVersion
Not Null
os version
appVersion
Not Null
application version
clientMutationId
String
SCALAR

UpdateDeviceInput

ArgumentsTypeDescription
deviceToken
Not Null
device unique token
deviceVersion
Not Null
os version
appVersion
Not Null
application version
clientMutationId
String
SCALAR

DeleteDeviceInput

ArgumentsTypeDescription
deviceToken
Not Null
The user's device token
clientMutationId
String
SCALAR

CreateEntityInput

ArgumentsTypeDescription
organizationId
Not Null
The organization that entity is
fullname
Not Null
Entity fullname
type
Not Null
The type of entity is an ENUM: STUDENT, STAFF, ADMIN
eid
String
SCALAR
External ID to identify an entity
externalData
JSONObject
SCALAR
External data to access External Access
description
String
SCALAR
Role person has in organization
invisible
Boolean
SCALAR
Invisible for student entity
seeAll
Boolean
SCALAR
See all for staff entity
unreachable
Boolean
SCALAR
Pending messages are not read
disabled
Boolean
SCALAR
Disabled for communication
scope
LIST
EntityScope
Permission scope for staff
ntfStartTime
String
SCALAR
time that the entity starts to receive notifications
ntfEndTime
String
SCALAR
time that the entity starts to receive notifications
ntfWeekDays
Int
SCALAR
week days that the entity receives notifications
ntfWeekDaysArray
LIST
String
days of the week to receive notification
addresses
LIST
EntityAddressesInput
groups
LIST
EntityGroupsInput
invite
InviteEnum
ENUM
Send invitations
attach
LIST
String
Attach related rather than replace
updateIfExists
Boolean
SCALAR
If fullname or eid exists update Entity
defaultFeatures
LIST
EntityDefaultFeatures
Features that should have default items
clientMutationId
String
SCALAR

EntityAddressesInput

ArgumentsTypeDescription
address
Not Null
The address itself
type
Not Null
The type of address is an ENUM: EMAIL or PHONE
ntfInvite
Boolean
SCALAR
notify when invite
ntfMessage
Boolean
SCALAR
notify when new message is sent
ntfMoment
Boolean
SCALAR
notify when new moment is sent
ntfUnread
Boolean
SCALAR
notify when there are unread messages
ntfReset
Boolean
SCALAR
notify to reset addresses
tags
LIST
AddressTagsInput
invite
Boolean
SCALAR
Send invitations

EntityGroupsInput

ArgumentsTypeDescription
id
ID
SCALAR
name
String
SCALAR
type
GroupType
ENUM

UpdateEntityInput

ArgumentsTypeDescription
id
Not Null
The ID of an entity object
fullname
String
SCALAR
Entity fullname
type
EntityType
ENUM
The type of entity is an ENUM: STUDENT, STAFF, ADMIN
eid
String
SCALAR
External ID to identify an entity
externalData
JSONObject
SCALAR
External data to access External Access
description
String
SCALAR
Role person has in organization
invisible
Boolean
SCALAR
Invisible for student entity
seeAll
Boolean
SCALAR
See all for staff entity
unreachable
Boolean
SCALAR
Pending messages are not read
disabled
Boolean
SCALAR
Disabled for communication
scope
LIST
EntityScope
Permission scope for staff
ntfStartTime
String
SCALAR
time that the entity starts to receive notifications
ntfEndTime
String
SCALAR
time that the entity starts to receive notifications
ntfWeekDays
Int
SCALAR
week days that the entity receives notifications
ntfWeekDaysArray
LIST
String
days of the week to receive notification
addresses
LIST
EntityAddressesInput
groups
LIST
EntityGroupsInput
invite
InviteEnum
ENUM
Send invitations
attach
LIST
String
Attach related rather than replace
updateIfExists
Boolean
SCALAR
If fullname or eid exists update Entity
clientMutationId
String
SCALAR

ImportEntityInput

ArgumentsTypeDescription
organizationId
Not Null
The organization that entity is
id
ID
SCALAR
The ID of an entity object
fullname
String
SCALAR
Entity fullname
type
EntityType
ENUM
The type of entity is an ENUM: STUDENT, STAFF, ADMIN
eid
String
SCALAR
External ID to identify an entity
externalData
JSONObject
SCALAR
External data to access External Access
description
String
SCALAR
Role person has in organization
invisible
Boolean
SCALAR
Invisible for student entity
seeAll
Boolean
SCALAR
See all for staff entity
unreachable
Boolean
SCALAR
Pending messages are not read
disabled
Boolean
SCALAR
Disabled for communication
scope
LIST
EntityScope
Permission scope for staff
ntfStartTime
String
SCALAR
time that the entity starts to receive notifications
ntfEndTime
String
SCALAR
time that the entity starts to receive notifications
ntfWeekDays
Int
SCALAR
week days that the entity receives notifications
ntfWeekDaysArray
LIST
String
days of the week to receive notification
addresses
LIST
EntityAddressesInput
groups
LIST
EntityGroupsInput
invite
InviteEnum
ENUM
Send invitations
attach
LIST
String
Attach related rather than replace
defaultFeatures
LIST
EntityDefaultFeatures
Features that should have default items
clientMutationId
String
SCALAR

CreateEntityTemplateInput

ArgumentsTypeDescription
organizationId
Not Null
The organization that entity is
type
Not Null
Entity template
clientMutationId
String
SCALAR

CreateExportRequestInput

ArgumentsTypeDescription
organizationId
Not Null
type
Not Null
Type of the export
emailTo
String
SCALAR
filters
String
SCALAR
clientMutationId
String
SCALAR

CreateExternalChannelInput

ArgumentsTypeDescription
applicationId
Not Null
The application ID that tag belongs to
type
ExternalChannelType
ENUM
type of external channel
configuration
JSONObject
SCALAR
configuration to b used on configuration
status
String
SCALAR
external channel status
clientMutationId
String
SCALAR

UpdateExternalChannelInput

ArgumentsTypeDescription
id
Not Null
The ID of a External Channel object
type
ExternalChannelType
ENUM
type of external channel
configuration
JSONObject
SCALAR
configuration to b used on configuration
status
String
SCALAR
external channel status
clientMutationId
String
SCALAR

DeleteExternalChannelInput

ArgumentsTypeDescription
id
Not Null
The ID of a External Channel object
clientMutationId
String
SCALAR

CreateExternalChannelEntityInput

ArgumentsTypeDescription
externalChannelId
ID
SCALAR
The externalchannel ID
entityId
Not Null
The entity ID
clientMutationId
String
SCALAR

DeleteExternalChannelEntityInput

ArgumentsTypeDescription
externalChannelId
ID
SCALAR
The externalchannel ID
entityId
Not Null
The entity ID
clientMutationId
String
SCALAR

CreateFeedbackInput

ArgumentsTypeDescription
userId
Not Null
The ID of user
feedback
String
SCALAR
Feedback wrote by user
clientMutationId
String
SCALAR

CreateFormInput

ArgumentsTypeDescription
organizationId
Not Null
The organization ID that form belongs to
name
Not Null
Form name
description
String
SCALAR
Form description
default
Int
SCALAR
Form is used as default
template
Boolean
SCALAR
Form is a template
fields
LIST
FormFieldsInput
groups
LIST
FormGroupsInput
clientMutationId
String
SCALAR

FormFieldsInput

ArgumentsTypeDescription
id
ID
SCALAR
Form field id, for updating
name
Not Null
Field name
type
Not Null
Type of input field
options
LIST
String
Options to check or select
initial
LIST
String
Initial selected values
position
Int
SCALAR
Position to order by

FormGroupsInput

ArgumentsTypeDescription
id
ID
SCALAR
Group ID

UpdateFormInput

ArgumentsTypeDescription
id
Not Null
The ID of form object
name
String
SCALAR
Form name
description
String
SCALAR
Form description
default
Int
SCALAR
Form is used as default
template
Boolean
SCALAR
Form is a template
fields
LIST
FormFieldsInput
groups
LIST
FormGroupsInput
attach
LIST
String
Attach related rather than replace
clientMutationId
String
SCALAR

DeleteFormInput

ArgumentsTypeDescription
id
Not Null
The ID of form object
clientMutationId
String
SCALAR

CreateFormFieldInput

ArgumentsTypeDescription
formId
Not Null
The form ID that fields belongs to
name
Not Null
Field name
type
Not Null
Type of input field
options
LIST
String
Options to check or select
initial
LIST
String
Initial selected values
position
Int
SCALAR
Position to order by
clientMutationId
String
SCALAR

UpdateFormFieldInput

ArgumentsTypeDescription
id
Not Null
The ID of a form field object
name
String
SCALAR
Field name
type
ReportFieldType
ENUM
Type of input field
options
LIST
String
Options to check or select
initial
LIST
String
Initial selected values
position
Int
SCALAR
Position to order by
clientMutationId
String
SCALAR

DeleteFormFieldInput

ArgumentsTypeDescription
id
Not Null
The ID of a form field object
clientMutationId
String
SCALAR

DeleteFormMessageInput

ArgumentsTypeDescription
id
Not Null
form message id
clientMutationId
String
SCALAR

CreateFormResultInput

ArgumentsTypeDescription
messageId
Int
SCALAR
message
formId
Int
SCALAR
form
entityId
Not Null
entity
formMessageId
Int
SCALAR
form message
dontNotify
Boolean
SCALAR
Notifications of form
results
LIST
FormResultsInput
clientMutationId
String
SCALAR

FormResultsInput

ArgumentsTypeDescription
value
Not Null
input value
formFieldId
Not Null
field

CreateGroupInput

ArgumentsTypeDescription
organizationId
Not Null
The organization that groups belongs to
name
Not Null
Group's name
internal
Boolean
SCALAR
for internal staff use
seeAll
Boolean
SCALAR
visible to all staff
type
GroupType
ENUM
group enum type
updateIfExists
Boolean
SCALAR
If name exists update Group
clientMutationId
String
SCALAR

UpdateGroupInput

ArgumentsTypeDescription
id
Not Null
The ID of a group object
name
String
SCALAR
Group's name
internal
Boolean
SCALAR
for internal staff use
seeAll
Boolean
SCALAR
visible to all staff
type
GroupType
ENUM
group enum type
clientMutationId
String
SCALAR

DeleteGroupInput

ArgumentsTypeDescription
id
Not Null
The ID of a group object
clientMutationId
String
SCALAR

ImportChangesInput

ArgumentsTypeDescription
organizationId
Not Null
The ID of organization
entityType
Not Null
Entity type
hasToUpdate
HasToUpdateInput
INPUT_OBJECT
clientMutationId
String
SCALAR

HasToUpdateInput

ArgumentsTypeDescription
list
LIST
HasToUpdateInputEntity

HasToUpdateInputEntity

ArgumentsTypeDescription
id
Int
SCALAR
Entity id
eid
String
SCALAR
External id
code
String
SCALAR
Entity code
organizationId
Int
SCALAR
Organization id
organization_id
Int
SCALAR
Organization id from db
fullname
String
SCALAR
Entity name
description
String
SCALAR
Entity description
invisible
Int
SCALAR
Invisible
see_all
Int
SCALAR
See all
external_data
String
SCALAR
Entity external data
type
String
SCALAR
Entity type
disabled
Int
SCALAR
Disabled
manualDisabled
Boolean
SCALAR
Manual disabled
manualEnabled
Boolean
SCALAR
Manual enabled
enable
Boolean
SCALAR
Enable
disable
Boolean
SCALAR
Disable
insert
Boolean
SCALAR
Insert
update
Boolean
SCALAR
Update
delete
Boolean
SCALAR
Delete
updateGroups
Boolean
SCALAR
Update groups
updateAddress
Boolean
SCALAR
Update address
infoUpdateEid
Boolean
SCALAR
Update eid
infoUpdateFullname
Boolean
SCALAR
Update fullname
infoUpdateDescription
Boolean
SCALAR
Update description
infoUpdateInvisible
Boolean
SCALAR
Update invisible
infoUpdateSee_all
Boolean
SCALAR
Update see_all
infoUpdateExternal_data
Boolean
SCALAR
Update external_data
found
Boolean
SCALAR
Is found
ignore
Boolean
SCALAR
Ignore
attach
Boolean
SCALAR
Attach
addresses
LIST
HasToUpdateInputAddress
groups
LIST
HasToUpdateInputGroup

HasToUpdateInputAddress

ArgumentsTypeDescription
code
String
SCALAR
Address code
id
Int
SCALAR
Address id
address
String
SCALAR
Address
type
String
SCALAR
Address code
insert
Boolean
SCALAR
Insert
update
Boolean
SCALAR
Update
delete
Boolean
SCALAR
Delete
updateGroups
Boolean
SCALAR
Update groups
updateAddress
Boolean
SCALAR
Update address
infoUpdateEid
Boolean
SCALAR
Update eid
infoUpdateFullname
Boolean
SCALAR
Update fullname
infoUpdateDescription
Boolean
SCALAR
Update description
infoUpdateInvisible
Boolean
SCALAR
Update invisible
infoUpdateSee_all
Boolean
SCALAR
Update see_all
infoUpdateExternal_data
Boolean
SCALAR
Update external_data
found
Boolean
SCALAR
Is found
ignore
Boolean
SCALAR
Ignore
attach
Boolean
SCALAR
Attach
tags
LIST
HasToUpdateInputTag

HasToUpdateInputTag

ArgumentsTypeDescription
id
Int
SCALAR
Tag id
name
String
SCALAR
Tag name
insert
Boolean
SCALAR
Insert
update
Boolean
SCALAR
Update
delete
Boolean
SCALAR
Delete
updateGroups
Boolean
SCALAR
Update groups
updateAddress
Boolean
SCALAR
Update address
infoUpdateEid
Boolean
SCALAR
Update eid
infoUpdateFullname
Boolean
SCALAR
Update fullname
infoUpdateDescription
Boolean
SCALAR
Update description
infoUpdateInvisible
Boolean
SCALAR
Update invisible
infoUpdateSee_all
Boolean
SCALAR
Update see_all
infoUpdateExternal_data
Boolean
SCALAR
Update external_data
found
Boolean
SCALAR
Is found
ignore
Boolean
SCALAR
Ignore
attach
Boolean
SCALAR
Attach

HasToUpdateInputGroup

ArgumentsTypeDescription
id
Int
SCALAR
Group id
name
String
SCALAR
Group name
type
Int
SCALAR
Group type
updateType
Boolean
SCALAR
Update group type
insert
Boolean
SCALAR
Insert
update
Boolean
SCALAR
Update
delete
Boolean
SCALAR
Delete
updateGroups
Boolean
SCALAR
Update groups
updateAddress
Boolean
SCALAR
Update address
infoUpdateEid
Boolean
SCALAR
Update eid
infoUpdateFullname
Boolean
SCALAR
Update fullname
infoUpdateDescription
Boolean
SCALAR
Update description
infoUpdateInvisible
Boolean
SCALAR
Update invisible
infoUpdateSee_all
Boolean
SCALAR
Update see_all
infoUpdateExternal_data
Boolean
SCALAR
Update external_data
found
Boolean
SCALAR
Is found
ignore
Boolean
SCALAR
Ignore
attach
Boolean
SCALAR
Attach

CreateIntegrationInput

ArgumentsTypeDescription
applicationId
Not Null
Module's id application
moduleId
Not Null
Module's id module
organizationId
Not Null
Module's id organization
entityId
Int
SCALAR
Responsible entity
address
ID
SCALAR
Id
time
String
SCALAR
Module's time execution
status
Not Null
Module's integration status
onlyReport
Not Null
configuration
JSONObject
SCALAR
comments
String
SCALAR
Module's integration comments
lastRun
String
SCALAR
Last run
lastRunStatus
IntegrationLastRunStatus
ENUM
Last run: failed or success
startDev
String
SCALAR
Start of development
conclusion
String
SCALAR
Conclusion
labelId
Int
SCALAR
Label to send charge from integration
labelType
LabelTypeEnum
ENUM
The type of the label
clientMutationId
String
SCALAR

UpdateIntegrationInput

ArgumentsTypeDescription
id
Not Null
The ID of a tag object
moduleId
Not Null
Module's id module
applicationId
Not Null
Module's id application
organizationId
Not Null
Module's id organization
address
ID
SCALAR
Id
time
String
SCALAR
Module's time execution
status
IntegrationStatus
ENUM
Module's integration status
onlyReport
Boolean
SCALAR
configuration
JSONObject
SCALAR
comments
String
SCALAR
Module's integration comments
lastRun
String
SCALAR
Last run
lastRunStatus
IntegrationLastRunStatus
ENUM
Last run: failed or success
startDev
String
SCALAR
Start of development
conclusion
String
SCALAR
Conclusion
entityId
Int
SCALAR
Responsible entity
labelId
Int
SCALAR
Label to send charge from integration
labelType
LabelTypeEnum
ENUM
The type of the label
clientMutationId
String
SCALAR

DeleteIntegrationInput

ArgumentsTypeDescription
id
Not Null
The ID of a tag object
clientMutationId
String
SCALAR

CreateIntegrationContractInput

ArgumentsTypeDescription
applicationId
Not Null
The application ID that tag belongs to
organizationId
Not Null
The application ID that tag belongs to
link
String
SCALAR
Module's name
activatedAt
String
SCALAR
Activation date
fee
Float
SCALAR
Contract fee
type
IntegrationContractTypeEnum
ENUM
Type of the contract
comments
String
SCALAR
Comments about the contract
isActive
Boolean
SCALAR
Is the contract active?
clientMutationId
String
SCALAR

UpdateIntegrationContractInput

ArgumentsTypeDescription
id
Not Null
The ID of a tag object
link
String
SCALAR
Module's name
activatedAt
String
SCALAR
Activation date
fee
Float
SCALAR
Contract fee
type
IntegrationContractTypeEnum
ENUM
Type of the contract
comments
String
SCALAR
Comments about the contract
isActive
Boolean
SCALAR
Is the contract active?
cancellationReasonId
ID
SCALAR
The ID of a cancellation reason object
canceledAt
String
SCALAR
The date when the contract was canceled
clientMutationId
String
SCALAR

DeleteIntegrationContractInput

ArgumentsTypeDescription
id
Not Null
The ID of a tag object
clientMutationId
String
SCALAR

CancelIntegrationContractInput

ArgumentsTypeDescription
id
Not Null
The ID of a tag object
link
String
SCALAR
Module's name
activatedAt
String
SCALAR
Activation date
fee
Float
SCALAR
Contract fee
type
IntegrationContractTypeEnum
ENUM
Type of the contract
comments
String
SCALAR
Comments about the contract
isActive
Boolean
SCALAR
Is the contract active?
cancellationReasonId
Not Null
The ID of a cancellation reason object
canceledAt
Not Null
The date when the contract was canceled
clientMutationId
String
SCALAR

CreateIntegrationCancellationReasonInput

ArgumentsTypeDescription
name
Not Null
Reason name for cancellation
description
String
SCALAR
Description of the reason for cancellation
isActive
Boolean
SCALAR
Is the reason active?
clientMutationId
String
SCALAR

UpdateIntegrationCancellationReasonInput

ArgumentsTypeDescription
id
Not Null
The ID of a tag object
name
Not Null
Reason name for cancellation
description
String
SCALAR
Description of the reason for cancellation
isActive
Boolean
SCALAR
Is the reason active?
clientMutationId
String
SCALAR

DeleteIntegrationCancellationReasonInput

ArgumentsTypeDescription
id
Not Null
The ID of a tag object
clientMutationId
String
SCALAR

CreateInvoiceInput

ArgumentsTypeDescription
contractId
Not Null
contract ID
organizationAccountId
Not Null
organization account ID
sendAt
String
SCALAR
date and time to send message
chargeExpiration
String
SCALAR
date and time to expire the charge
invoiceNumber
Int
SCALAR
invoice number
amount
Float
SCALAR
amount to be charged
status
InvoiceStatus
ENUM
invoice status
discountType
DiscountType
ENUM
type of discount
discountValue
Float
SCALAR
discount value
anticipationDiscountUntil
Int
SCALAR
Number of days before the expiration of a charge that the discount is still applied
anticipationDiscountType
DiscountType
ENUM
Type of the discount (percentange or amount)
anticipationDiscountValue
Float
SCALAR
Discount value in percentage or total amount
fineStart
Int
SCALAR
Number of days after the expiration of a charge that the fine should start
fineType
DiscountType
ENUM
Type of the fine (percentange or amount)
fineValue
Float
SCALAR
Fine value in percentage or total amount
interestStart
Int
SCALAR
Number of days after the expiration of a charge that the interest should start
interestType
DiscountType
ENUM
Type of the interest (percentange or amount)
interestValue
Float
SCALAR
interest value in percentage or total amount
paymentMethods
LIST
PaymentMethod
custom payment method defined for this charge
absorbedFee
LIST
PaymentMethod
which payment method will have its fee absorbed by default
discounts
LIST
InvoiceProductDiscountInput
clientMutationId
String
SCALAR

InvoiceProductDiscountInput

ArgumentsTypeDescription
productId
ID
SCALAR
discountType
DiscountType
ENUM
discountValue
Float
SCALAR

UpdateInvoiceInput

ArgumentsTypeDescription
id
Not Null
Invoice ID
sendAt
String
SCALAR
date and time to send message
chargeExpiration
String
SCALAR
date and time to expire the charge
invoiceNumber
Int
SCALAR
invoice number
amount
Float
SCALAR
amount to be charged
status
InvoiceStatus
ENUM
invoice status
discountType
DiscountType
ENUM
type of discount
discountValue
Float
SCALAR
discount value
anticipationDiscountUntil
Int
SCALAR
Number of days before the expiration of a charge that the discount is still applied
anticipationDiscountType
DiscountType
ENUM
Type of the discount (percentange or amount)
anticipationDiscountValue
Float
SCALAR
Discount value in percentage or total amount
fineStart
Int
SCALAR
Number of days after the expiration of a charge that the fine should start
fineType
DiscountType
ENUM
Type of the fine (percentange or amount)
fineValue
Float
SCALAR
Fine value in percentage or total amount
interestStart
Int
SCALAR
Number of days after the expiration of a charge that the interest should start
interestType
DiscountType
ENUM
Type of the interest (percentange or amount)
interestValue
Float
SCALAR
interest value in percentage or total amount
paymentMethods
LIST
PaymentMethod
custom payment method defined for this charge
absorbedFee
LIST
PaymentMethod
which payment method will have its fee absorbed by default
discounts
LIST
InvoiceProductDiscountInput
clientMutationId
String
SCALAR

DeleteInvoiceInput

ArgumentsTypeDescription
id
Not Null
Invoice ID
clientMutationId
String
SCALAR

PayInvoiceManuallyInput

ArgumentsTypeDescription
id
Not Null
Invoice ID
date
Not Null
Date the manual payment was made
amount
Not Null
Amount manually paid
media
InvoiceMediasInput
INPUT_OBJECT
Media about the manual payment
reason
String
SCALAR
Description about the manual payment
clientMutationId
String
SCALAR

InvoiceMediasInput

ArgumentsTypeDescription
id
ID
SCALAR
filename
Not Null
type
Not Null

CreateLabelInput

ArgumentsTypeDescription
organizationId
Not Null
organization ID
title
Not Null
label title
color
Not Null
color of label
type
LabelType
ENUM
The type of label is an ENUM
clientMutationId
String
SCALAR

UpdateLabelInput

ArgumentsTypeDescription
id
Not Null
Label ID
title
String
SCALAR
label title
color
String
SCALAR
color of label
type
LabelType
ENUM
The type of label is an ENUM
clientMutationId
String
SCALAR

DeleteLabelInput

ArgumentsTypeDescription
id
Not Null
Label ID
forceDelete
Boolean
SCALAR
Force delete label
clientMutationId
String
SCALAR

createLinkInput

ArgumentsTypeDescription
organizationId
Not Null
The organization that link belongs to
icon
String
SCALAR
icon of link
title
Not Null
description of the link
url
Not Null
address of the link
type
Not Null
The type of link is an ENUM
accessType
LinkAccessTypeEnum
ENUM
The access type of link is an ENUM
replaces
JSONObject
SCALAR
fields to be replaced from the link
isActive
Boolean
SCALAR
link activation indicator
applicationId
Int
SCALAR
application id of link
clientMutationId
String
SCALAR

updateLinkInput

ArgumentsTypeDescription
id
Not Null
The ID of an link object
icon
String
SCALAR
icon of link
title
String
SCALAR
description of the link
url
String
SCALAR
address of the link
type
LinkType
ENUM
The type of link is an ENUM
accessType
LinkAccessTypeEnum
ENUM
The access type of link is an ENUM
replaces
JSONObject
SCALAR
fields to be replaced from the link
isActive
Boolean
SCALAR
link activation indicator
applicationId
Int
SCALAR
application id of link
clientMutationId
String
SCALAR

deleteLinkInput

ArgumentsTypeDescription
id
Not Null
The ID of an link object
clientMutationId
String
SCALAR

portalLoggedInput

ArgumentsTypeDescription
linkId
Not Null
Link id
entityId
Not Null
Entity id
clientMutationId
String
SCALAR

CreateLogoInput

ArgumentsTypeDescription
organizationId
Not Null
The organization that logo belongs to
clientMutationId
String
SCALAR

DeleteLogoInput

ArgumentsTypeDescription
organizationId
Not Null
The organization that logo belongs to
clientMutationId
String
SCALAR

RegisterMarketingPQLInput

ArgumentsTypeDescription
organizationId
ID
SCALAR
organizationSize
String
SCALAR
platform
String
SCALAR

CreateSignedUrlInput

ArgumentsTypeDescription
mimeType
Not Null
clientMutationId
String
SCALAR

CreateMediaWithKeyInput

ArgumentsTypeDescription
key
Not Null
fileName
String
SCALAR
mimeType
String
SCALAR
width
Int
SCALAR
height
Int
SCALAR
clientMutationId
String
SCALAR

CreateMediaInput

ArgumentsTypeDescription
transcode
Boolean
SCALAR
clientMutationId
String
SCALAR

UploadMediaInput

ArgumentsTypeDescription
entityId
Not Null
Entity Id
transcode
Boolean
SCALAR
clientMutationId
String
SCALAR

CreateMessageDraftInput

ArgumentsTypeDescription
entityId
Not Null
The entity that send the message
sendAt
String
SCALAR
date and time to send the message
type
MessageDraftType
ENUM
Message type
toEntityId
ID
SCALAR
First recipient
isHtml
Boolean
SCALAR
Content is in html
helpers
String
SCALAR
Helper JSON to re-render report and recipient fields
status
MessageDraftLogReason
ENUM
The last operation of message draft
status_by
ID
SCALAR
User that perform operation in message draft
subject
String
SCALAR
Subject from message
content
String
SCALAR
Content from message
pin
Boolean
SCALAR
pin=1
public
Boolean
SCALAR
public=1
moment
Boolean
SCALAR
moment=1
forum
Boolean
SCALAR
public forum=1
noReply
Boolean
SCALAR
no reply=1
fwMessageId
Int
SCALAR
message being forwarded
labelId
Int
SCALAR
label used to filter message
dontNotify
Boolean
SCALAR
Notifications of message
surveys
LIST
MessageSurveysInput
commitments
LIST
MessageCommitmentsInput
charges
LIST
MessageChargesInput
reports
LIST
MessageReportsInput
medias
LIST
MessageMediasInput
forms
LIST
MessageFormInputFields
tags
LIST
MessageTagsInput
recipients
MessageRecipientsInput
INPUT_OBJECT
signatures
LIST
MessageSignaturesInput
clientMutationId
String
SCALAR

MessageSurveysInput

ArgumentsTypeDescription
name
Not Null
Survey's name
optionNumber
Int
SCALAR
number of selectable options
dateLimit
String
SCALAR
Date limit to answer survey
notifyAt
String
SCALAR
Date to notify users to answer survey
previousId
Int
SCALAR
ID of a Survey
options
LIST
SurveyOptionsInput

SurveyOptionsInput

ArgumentsTypeDescription
value
Not Null
Survey options value

MessageCommitmentsInput

ArgumentsTypeDescription
name
Not Null
Commitment name
description
String
SCALAR
Commitment description
date
String
SCALAR
date of commitment
time
String
SCALAR
time of commitment
dateEnd
String
SCALAR
date of commitment
timeEnd
String
SCALAR
time of commitment
noConfirm
Boolean
SCALAR
No confirmation = 1
color
String
SCALAR
No confirmation = 1
dateLimit
String
SCALAR
Date limit to confirm commitment
notifyAt
String
SCALAR
Date to notify users to confirm commitment
videocallType
String
SCALAR
Type video call commitment
videocallLink
String
SCALAR
Link video call commitment

MessageChargesInput

ArgumentsTypeDescription
id
ID
SCALAR
organizationAccountId
Not Null
Organization account
invoiceId
ID
SCALAR
invoice
name
Not Null
Charge's name
description
String
SCALAR
Charge description
amount
Not Null
Charge amount
currency
Currency
ENUM
Charge currency
dateLimit
String
SCALAR
Date limit to pay charge
notifyAt
String
SCALAR
Date to notify users to pay charge
paymentMethods
LIST
PaymentMethod
custom payment method defined for this charge
absorbedFee
LIST
PaymentMethod
which payment method will have its fee absorbed by default
allowedInstallments
Int
SCALAR
Number of allowed installments
anticipationDiscountUntil
Int
SCALAR
Number of days before the expiration of a charge that the discount is still applied
anticipationDiscountType
DiscountType
ENUM
Type of the discount (percentange or amount)
anticipationDiscountValue
Float
SCALAR
Discount value in percentage or total amount
fineStart
Int
SCALAR
Number of days after the expiration of a charge that the fine should start
fineType
DiscountType
ENUM
Type of the fine (percentange or amount)
fineValue
Float
SCALAR
Fine value in percentage or total amount
interestStart
Int
SCALAR
Number of days after the expiration of a charge that the interest should start
interestType
DiscountType
ENUM
Type of the interest (percentange or amount)
interestValue
Float
SCALAR
interest value in percentage or total amount
payableExpired
Boolean
SCALAR
Whether the charge can be paid when expired or not

MessageReportsInput

ArgumentsTypeDescription
reportId
Not Null
reportName
String
SCALAR
Optional name to store in draft
reportFieldId
ID
SCALAR
DEPRECATED
value
String
SCALAR
DEPRECATED
entityId
ID
SCALAR
DEPRECATED
reportFields
LIST
MessageReportFieldsInput

MessageReportFieldsInput

ArgumentsTypeDescription
reportFieldId
Not Null
value
String
SCALAR
Value of report field
entityId
ID
SCALAR
Entity id who will receive this result

MessageMediasInput

ArgumentsTypeDescription
id
ID
SCALAR
filename
Not Null
type
Not Null
uri
String
SCALAR
Uri reference in case of message draft
origName
String
SCALAR
Original name in case of message draft
position
Int
SCALAR
Media position in message

MessageFormInputFields

ArgumentsTypeDescription
id
Not Null
dateLimit
String
SCALAR

MessageTagsInput

ArgumentsTypeDescription
id
ID
SCALAR
name
String
SCALAR

MessageRecipientsInput

ArgumentsTypeDescription
entityIds
LIST
ID
groupIds
LIST
ID
types
LIST
EntityType
eids
LIST
String

MessageSignaturesInput

ArgumentsTypeDescription
dateLimit
String
SCALAR
Maximum date to accept signatures
maxSigners
Not Null
Maximum number of signatures allowed
title
String
SCALAR
The signature title or content

UpdateMessageDraftInput

ArgumentsTypeDescription
entityId
Not Null
The entity that send the message
id
Not Null
The ID of an message draft object
sendAt
String
SCALAR
date and time to send the message
type
MessageDraftType
ENUM
Message type
toEntityId
ID
SCALAR
First recipient
isHtml
Boolean
SCALAR
Content is in html
helpers
String
SCALAR
Helper JSON to re-render report and recipient fields
status
MessageDraftLogReason
ENUM
The last operation of message draft
status_by
ID
SCALAR
User that perform operation in message draft
subject
String
SCALAR
Subject from message
content
String
SCALAR
Content from message
pin
Boolean
SCALAR
pin=1
public
Boolean
SCALAR
public=1
moment
Boolean
SCALAR
moment=1
forum
Boolean
SCALAR
public forum=1
noReply
Boolean
SCALAR
no reply=1
fwMessageId
Int
SCALAR
message being forwarded
labelId
Int
SCALAR
label used to filter message
dontNotify
Boolean
SCALAR
Notifications of message
surveys
LIST
MessageSurveysInput
commitments
LIST
MessageCommitmentsInput
charges
LIST
MessageChargesInput
reports
LIST
MessageReportsInput
medias
LIST
MessageMediasInput
forms
LIST
MessageFormInputFields
tags
LIST
MessageTagsInput
recipients
MessageRecipientsInput
INPUT_OBJECT
signatures
LIST
MessageSignaturesInput
clientMutationId
String
SCALAR

DeleteMessageDraftInput

ArgumentsTypeDescription
id
Not Null
The ID of an message draft object
status
MessageDraftLogReason
ENUM
Status of message draft log
clientMutationId
String
SCALAR

CreateMessageStatusInput

ArgumentsTypeDescription
messageId
Not Null
The ID of message
entityId
Not Null
The ID of entity
status
Not Null
status of message
clientMutationId
String
SCALAR

CreateMessageStatusInBatchInput

ArgumentsTypeDescription
messagesId
Not Null
The ID of messages
entityId
Not Null
The ID of entity
status
Not Null
status of message
clientMutationId
String
SCALAR

DeleteMessageStatusInput

ArgumentsTypeDescription
id
Not Null
The ID of a message status object
clientMutationId
String
SCALAR

DeleteMessageStatusInBatchInput

ArgumentsTypeDescription
messagesId
Not Null
The ID of messages
entityId
Not Null
The ID of entity
clientMutationId
String
SCALAR

CreateMessageInput

ArgumentsTypeDescription
entityId
Not Null
The entity that send the message
labelId
Int
SCALAR
label used to filter message
subject
String
SCALAR
Subject from message
content
String
SCALAR
Content from message
pin
Boolean
SCALAR
pin=1
public
Boolean
SCALAR
public=1
moment
Boolean
SCALAR
moment=1
forum
Boolean
SCALAR
public forum=1
noReply
Boolean
SCALAR
no reply=1
fwMessageId
Int
SCALAR
message being forwarded
isHtml
Boolean
SCALAR
Content is in html
dontNotify
Boolean
SCALAR
Notifications of message
surveys
LIST
MessageSurveysInput
commitments
LIST
MessageCommitmentsInput
charges
LIST
MessageChargesInput
reports
LIST
MessageReportsInput
medias
LIST
MessageMediasInput
forms
LIST
MessageFormInputFields
tags
LIST
MessageTagsInput
recipients
Not Null
signatures
LIST
MessageSignaturesInput
clientMutationId
String
SCALAR

UpdateMessageInput

ArgumentsTypeDescription
id
ID
SCALAR
The ID of an user object
subject
String
SCALAR
Subject from message
content
String
SCALAR
Content from message
pin
Boolean
SCALAR
pin=1
public
Boolean
SCALAR
public=1
moment
Boolean
SCALAR
moment=1
forum
Boolean
SCALAR
public forum=1
noReply
Boolean
SCALAR
no reply=1
fwMessageId
Int
SCALAR
message being forwarded
isHtml
Boolean
SCALAR
Content is in html
labelId
Int
SCALAR
label used to filter message
dontNotify
Boolean
SCALAR
Notifications of message
surveys
LIST
MessageSurveysInput
commitments
LIST
MessageCommitmentsInput
charges
LIST
MessageChargesInput
reports
LIST
MessageReportsInput
medias
LIST
MessageMediasInput
forms
LIST
MessageFormInputFields
tags
LIST
MessageTagsInput
recipients
MessageRecipientsInput
INPUT_OBJECT
signatures
LIST
MessageSignaturesInput
notifyUpdate
Boolean
SCALAR
should notify users who read the message about update
clientMutationId
String
SCALAR

DeleteMessageInput

ArgumentsTypeDescription
id
ID
SCALAR
The ID of an user object
subject
String
SCALAR
Subject from message
content
String
SCALAR
Content from message
pin
Boolean
SCALAR
pin=1
public
Boolean
SCALAR
public=1
moment
Boolean
SCALAR
moment=1
forum
Boolean
SCALAR
public forum=1
noReply
Boolean
SCALAR
no reply=1
fwMessageId
Int
SCALAR
message being forwarded
isHtml
Boolean
SCALAR
Content is in html
labelId
Int
SCALAR
label used to filter message
dontNotify
Boolean
SCALAR
Notifications of message
surveys
LIST
MessageSurveysInput
commitments
LIST
MessageCommitmentsInput
charges
LIST
MessageChargesInput
reports
LIST
MessageReportsInput
medias
LIST
MessageMediasInput
forms
LIST
MessageFormInputFields
tags
LIST
MessageTagsInput
recipients
MessageRecipientsInput
INPUT_OBJECT
signatures
LIST
MessageSignaturesInput
clientMutationId
String
SCALAR

NotifyPendingMessageInput

ArgumentsTypeDescription
id
ID
SCALAR
The ID of an user object
subject
String
SCALAR
Subject from message
content
String
SCALAR
Content from message
pin
Boolean
SCALAR
pin=1
public
Boolean
SCALAR
public=1
moment
Boolean
SCALAR
moment=1
forum
Boolean
SCALAR
public forum=1
noReply
Boolean
SCALAR
no reply=1
fwMessageId
Int
SCALAR
message being forwarded
isHtml
Boolean
SCALAR
Content is in html
labelId
Int
SCALAR
label used to filter message
dontNotify
Boolean
SCALAR
Notifications of message
surveys
LIST
MessageSurveysInput
commitments
LIST
MessageCommitmentsInput
charges
LIST
MessageChargesInput
reports
LIST
MessageReportsInput
medias
LIST
MessageMediasInput
forms
LIST
MessageFormInputFields
tags
LIST
MessageTagsInput
recipients
MessageRecipientsInput
INPUT_OBJECT
signatures
LIST
MessageSignaturesInput
clientMutationId
String
SCALAR

CreateModuleInput

ArgumentsTypeDescription
applicationId
Not Null
Module's name
name
Not Null
Module's name
type
Not Null
Module's integration type
activationType
Not Null
Module's integration type
baseConfiguration
String
SCALAR
Module's base configuration
formConfiguration
String
SCALAR
Module's form layout
scope
String
SCALAR
Module's name
lock
Not Null
Module's integration type
privacy
Not Null
Module's integration type
description
String
SCALAR
Module's name
clientMutationId
String
SCALAR

UpdateModuleInput

ArgumentsTypeDescription
id
Not Null
The ID of a tag object
name
String
SCALAR
Module's name
applicationId
Int
SCALAR
Module's name
type
ModuleType
ENUM
Module's integration type
activationType
ModuleActivationType
ENUM
Module's integration type
baseConfiguration
String
SCALAR
Module's base configuration
formConfiguration
String
SCALAR
Module's form layout
scope
String
SCALAR
Module's name
lock
ModuleLock
ENUM
Module's integration type
privacy
ModulePrivacy
ENUM
Module's integration type
description
String
SCALAR
Module's name
clientMutationId
String
SCALAR

DeleteModuleInput

ArgumentsTypeDescription
id
Not Null
The ID of a tag object
clientMutationId
String
SCALAR

CreateReactionInput

ArgumentsTypeDescription
messageId
Not Null
The ID of message
entityId
Not Null
The ID of entity
type
Not Null
The type of the moment/message reaction
clientMutationId
String
SCALAR

DeleteReactionInput

ArgumentsTypeDescription
messageId
Not Null
The ID of message
entityId
Not Null
The ID of entity
clientMutationId
String
SCALAR

ClearAllNotificationsInput

ArgumentsTypeDescription
userId
Not Null
The user is being notificated
clientMutationId
String
SCALAR

CreateOnboardingInput

ArgumentsTypeDescription
organizationId
Not Null
The organization ID that onboarding belongs to
step
Not Null
studentJson
String
SCALAR
JSON containg the data inserted on the STUDENT Step of the Onboarding
channelJson
String
SCALAR
JSON containg the data inserted on the CHANNEL Step of the Onboarding
clientMutationId
String
SCALAR

UpdateOnboardingInput

ArgumentsTypeDescription
id
Not Null
The ID of a Onboarding object
step
OnboardingStep
ENUM
studentJson
String
SCALAR
JSON containg the data inserted on the STUDENT Step of the Onboarding
channelJson
String
SCALAR
JSON containg the data inserted on the CHANNEL Step of the Onboarding
clientMutationId
String
SCALAR

DeleteOnboardingInput

ArgumentsTypeDescription
id
Not Null
The ID of a Onboarding object
finishOnboarding
Boolean
SCALAR
Finishing onboarding
sendInvites
Boolean
SCALAR
send invites after finishing onboarding
clientMutationId
String
SCALAR

CreateOauthProviderInput

ArgumentsTypeDescription
userId
Not Null
The ID of user
applicationId
Not Null
The ID of application
clientMutationId
String
SCALAR

CreateOrganizationAccountInput

ArgumentsTypeDescription
organizationId
Not Null
Organization account is part of
legalName
Not Null
Organization legal name
taxId
Not Null
Country tax id (Brazil -> CNPJ or CPF) (US -> EIN)
holderName
String
SCALAR
Name of holder of the account
phone
Not Null
Contact phone number
email
Not Null
Contact email address
bankName
Not Null
Bank name
bank
Not Null
Bank info separated by comma
currency
Not Null
Currency chosen
addressStreet
String
SCALAR
Street address of the account holder
addressNumber
String
SCALAR
Address number of the account holder
addressComplement
String
SCALAR
Address complement of the account holder
zipCode
String
SCALAR
Zip code of the account holder
neighborhood
String
SCALAR
Neighborhood of the account holder
addressState
String
SCALAR
abbreviated state of the account holder (ex: SP)
city
String
SCALAR
City of the account holder
country
Not Null
Country operating
default
Boolean
SCALAR
bank account should be considered as default
transferDay
String
SCALAR
Weekday(1=Monday;5=Friday) or day of the month(1-31)
transferInterval
OrganizationAccountTransferInterval
ENUM
transfer interval
absorbedFee
LIST
PaymentMethod
which payment method will have its fee absorbed by default
clientMutationId
String
SCALAR

UpdateOrganizationAccountInput

ArgumentsTypeDescription
id
Not Null
Organization account ID
legalName
String
SCALAR
Organization legal name
taxId
String
SCALAR
Country tax id (Brazil -> CNPJ or CPF) (US -> EIN)
holderName
String
SCALAR
Name of holder of the account
phone
String
SCALAR
Contact phone number
email
String
SCALAR
Contact email address
bankName
String
SCALAR
Bank name
bank
String
SCALAR
Bank info separated by comma
currency
Currency
ENUM
Currency chosen
addressStreet
String
SCALAR
Street address of the account holder
addressNumber
String
SCALAR
Address number of the account holder
addressComplement
String
SCALAR
Address complement of the account holder
zipCode
String
SCALAR
Zip code of the account holder
neighborhood
String
SCALAR
Neighborhood of the account holder
addressState
String
SCALAR
abbreviated state of the account holder (ex: SP)
city
String
SCALAR
City of the account holder
country
Country
ENUM
Country operating
default
Boolean
SCALAR
bank account should be considered as default
transferDay
String
SCALAR
Weekday(1=Monday;5=Friday) or day of the month(1-31)
transferInterval
OrganizationAccountTransferInterval
ENUM
transfer interval
absorbedFee
LIST
PaymentMethod
which payment method will have its fee absorbed by default
clientMutationId
String
SCALAR

DeleteOrganizationAccountInput

ArgumentsTypeDescription
id
Not Null
Organization account ID
clientMutationId
String
SCALAR

CreateOrganizationApplicationInput

ArgumentsTypeDescription
userId
Not Null
The user ID who gives authorization in organization
entityId
ID
SCALAR
The entity ID
organizationId
Not Null
The organization ID
applicationId
Not Null
The application ID
clientMutationId
String
SCALAR

deleteOrganizationApplicationInput

ArgumentsTypeDescription
userId
Not Null
The user ID who gives authorization in organization
entityId
ID
SCALAR
The entity ID
organizationId
Not Null
The organization ID
applicationId
Not Null
The application ID
clientMutationId
String
SCALAR

CreateOrganizationBannerInput

ArgumentsTypeDescription
organizationId
Not Null
Organization ID
bannerType
Not Null
Banner type

DeleteOrganizationBannerInput

ArgumentsTypeDescription
id
Not Null
Banner ID

CreateOrganizationWithdrawalInput

ArgumentsTypeDescription
organizationId
Not Null
Organization that has the withdrawal
organizationAccountId
Not Null
Organization account that has the withdrawal
entityId
Not Null
entity that requested the withdrawal
amount
Not Null
withdrawal amount
clientMutationId
String
SCALAR

CreateOrganizationInput

ArgumentsTypeDescription
type
OrganizationType
ENUM
Type of organization
plan
OrganizationPlan
ENUM
Plan of organization
username
String
SCALAR
unique username
fullname
Not Null
display name
color
String
SCALAR
theme color
link
String
SCALAR
url for more info
tzOffset
Int
SCALAR
timezone offset from UTC
confMessage
Boolean
SCALAR
Message can be sent
confMessageStudent
Boolean
SCALAR
Parent/student can send messages
confMessageStaff
Boolean
SCALAR
Staff can send messages
confMedia
Boolean
SCALAR
Media can be sent
confAudio
Boolean
SCALAR
Audio can be sent
confAudioStudent
Boolean
SCALAR
Audio can be sent by students
confOtherFiles
Boolean
SCALAR
Other files can be sent
confCommitment
Boolean
SCALAR
Commitment can be sent
confSurvey
Boolean
SCALAR
Survey can be sent
confReport
Boolean
SCALAR
Report can be sent
confCharge
Boolean
SCALAR
Charge can be sent
confChargeList
Boolean
SCALAR
Charge list can be showed for entities
confForm
Boolean
SCALAR
Form can be sent
confReplyStudent
Boolean
SCALAR
Parent/student can send replies
confMediaStudent
Boolean
SCALAR
Parent/student can send media
confTerms
LIST
String
Terms that were accepted by the user
confPresence
Boolean
SCALAR
Presence can be sent
confAdminList
Boolean
SCALAR
Show admin list for staff
confRecurrence
Boolean
SCALAR
Organization has access to recurrrence module
confAnticipationDiscount
Boolean
SCALAR
Allow anticipation discount for charges
confFine
Boolean
SCALAR
Allow fine for charges
confInterest
Boolean
SCALAR
Allow interest for charges
confPaymentDetailsInboleto
Boolean
SCALAR
Allow boleto details for fine payments
confChannelMetrics
Boolean
SCALAR
Parent/student can see channels metrics before sending messages
confArrived
Boolean
SCALAR
If arrived feature are enabled this sends true
confRepliesStudent
Boolean
SCALAR
Combined with confReplyStudent this tells if students can reply more than once time.
anticipationDiscountUntil
Int
SCALAR
Number of days before the expiration of a charge that the discount is still applied
anticipationDiscountType
DiscountType
ENUM
Type of the discount (percentange or amount)
anticipationDiscountValue
Float
SCALAR
Discount value in percentage or total amount
fineStart
Int
SCALAR
Number of days after the expiration of a charge that the fine should start
fineType
DiscountType
ENUM
Type of the fine (percentange or amount)
fineValue
Float
SCALAR
Fine value in percentage or total amount
interestStart
Int
SCALAR
Number of days after the expiration of a charge that the interest should start
interestType
DiscountType
ENUM
Type of the interest (percentange or amount)
interestValue
Float
SCALAR
interest value in percentage or total amount
consultantId
Int
SCALAR
consultant id of organization
client
Boolean
SCALAR
is paying client
usage
OrganizationUsage
ENUM
Why this organization exists in ClassApp.
entryMethod
OrganizationEntryMethod
ENUM
entry method for organization
latitude
String
SCALAR
latitude of organization
longitude
String
SCALAR
longitude of organization
timezone
String
SCALAR
base timezone of organization
language
String
SCALAR
preferred language
country
String
SCALAR
preferred country
currency
Currency
ENUM
preferred currency
ntfStartTime
String
SCALAR
time that users of this organization start to receive notifications
ntfEndTime
String
SCALAR
time that users of this organization start to receive notifications
ntfWeekDays
Int
SCALAR
week days that users of this organization receive notifications
legalName
String
SCALAR
Organization legal name
taxId
String
SCALAR
Country tax id (Brazil -> CNPJ or CPF) (US -> EIN)
phone
String
SCALAR
Contact phone number
email
String
SCALAR
Contact email address
addressStreet
String
SCALAR
Street address of the account holder
addressNumber
String
SCALAR
Address number of the account holder
addressComplement
String
SCALAR
Address complement of the account holder
zipCode
String
SCALAR
Zip code of the account holder
neighborhood
String
SCALAR
Neighborhood of the account holder
addressState
String
SCALAR
abbreviated state of the account holder (ex: SP)
city
String
SCALAR
City of the account holder
ntfWeekDaysArray
LIST
String
days of the week to receive notification
includeViewer
Boolean
SCALAR
Add currently authenticated user
recipientTags
LIST
OrganizationTagsInput
user
OrganizationUserInput
INPUT_OBJECT
entity
OrganizationEntityInput
INPUT_OBJECT
defaultFeatures
LIST
DefaultFeatures
Features that should have default items
invite
InviteEnum
ENUM
Send invitations
clientMutationId
String
SCALAR

OrganizationTagsInput

ArgumentsTypeDescription
id
ID
SCALAR

OrganizationUserInput

ArgumentsTypeDescription
email
String
SCALAR
User's email
phone
String
SCALAR
User's phone
fullname
Not Null
User's fullname
language
String
SCALAR
Language preference
tzOffset
Int
SCALAR
The time zone offset from UTC
documentNumber
String
SCALAR
Personal document number (CPF)
onboardingApp
String
SCALAR
Onboarding on app step
onboardingSite
String
SCALAR
Onboarding on site step
loginMethod
LoginMethodEnum
ENUM
Users can choose the way they will sign in
confirmEmail
Boolean
SCALAR
User can be notify by e-mail
confirmPhone
Boolean
SCALAR
User can be notify by phone
emailNtf
Boolean
SCALAR
User can be notify by e-mail
phoneNtf
Boolean
SCALAR
User can be notify by phone
webNtf
Boolean
SCALAR
User can be notify by web
ntfAnnouncement
Boolean
SCALAR
Can notify current viewer when there are announcements
ntfMessage
LIST
UserNotificationType
Can notify when someone sends current viewer a message
ntfCommitmentRemind
LIST
UserNotificationType
Can notify when current viewer has pending commitments
ntfReply
LIST
UserNotificationType
Can notify when someone replies to current viewer's message
ntfSurvey
LIST
UserNotificationType
Can notify when someone responds current viewer's survey
ntfSurveyPending
LIST
UserNotificationType
Can notify when someone send reminder for current viewer's survey
ntfCommitment
LIST
UserNotificationType
Can notify when someone confirms current viewer's commitment
ntfCharge
LIST
UserNotificationType
Can notify when someone pays current viewer's charge
ntfChargePending
LIST
UserNotificationType
Can notify when someone send reminder for current viewer's charge
ntfForm
LIST
UserNotificationType
Can notify when someone fills current viewer's form
ntfFormPending
LIST
UserNotificationType
Can notify when form is pending
ntfUnread
LIST
UserNotificationType
Can notify when current viewer has unread messages
ntfArrived
LIST
UserNotificationType
Can notify when arrivals has update
code
String
SCALAR
User oauth code to recover password
verifiedAddressCode
String
SCALAR
If address code is valid, address is confirmed (just valid for phone yet)
nextFeedback
String
SCALAR
Date when user will receive pop up to give feedback
resendFeedback
Boolean
SCALAR
User should receive pop up to rate after seven days
password
String
SCALAR
New password, optional
isNewCode
Boolean
SCALAR
should send six digit confirm address code

OrganizationEntityInput

ArgumentsTypeDescription
fullname
String
SCALAR
Entity fullname
description
String
SCALAR
Role person has in organization
defaultFeatures
LIST
EntityDefaultFeatures
Features that should have default items
invisible
Boolean
SCALAR
Invisible for student entity
seeAll
Boolean
SCALAR
See all for staff entity

UpdateOrganizationInput

ArgumentsTypeDescription
id
Not Null
The ID of an organization object
includeViewer
Boolean
SCALAR
Add currently authenticated user
recipientTags
LIST
OrganizationTagsInput
user
OrganizationUserInput
INPUT_OBJECT
entity
OrganizationEntityInput
INPUT_OBJECT
type
OrganizationType
ENUM
Type of organization
plan
OrganizationPlan
ENUM
Plan of organization
username
String
SCALAR
unique username
fullname
String
SCALAR
display name
color
String
SCALAR
theme color
link
String
SCALAR
url for more info
tzOffset
Int
SCALAR
timezone offset from UTC
confMessage
Boolean
SCALAR
Message can be sent
confMessageStudent
Boolean
SCALAR
Parent/student can send messages
confMessageStaff
Boolean
SCALAR
Staff can send messages
confMedia
Boolean
SCALAR
Media can be sent
confAudio
Boolean
SCALAR
Audio can be sent
confAudioStudent
Boolean
SCALAR
Audio can be sent by students
confOtherFiles
Boolean
SCALAR
Other files can be sent
confCommitment
Boolean
SCALAR
Commitment can be sent
confSurvey
Boolean
SCALAR
Survey can be sent
confReport
Boolean
SCALAR
Report can be sent
confCharge
Boolean
SCALAR
Charge can be sent
confChargeList
Boolean
SCALAR
Charge list can be showed for entities
confForm
Boolean
SCALAR
Form can be sent
confReplyStudent
Boolean
SCALAR
Parent/student can send replies
confMediaStudent
Boolean
SCALAR
Parent/student can send media
confTerms
LIST
String
Terms that were accepted by the user
confPresence
Boolean
SCALAR
Presence can be sent
confAdminList
Boolean
SCALAR
Show admin list for staff
confRecurrence
Boolean
SCALAR
Organization has access to recurrrence module
confAnticipationDiscount
Boolean
SCALAR
Allow anticipation discount for charges
confFine
Boolean
SCALAR
Allow fine for charges
confInterest
Boolean
SCALAR
Allow interest for charges
confPaymentDetailsInboleto
Boolean
SCALAR
Allow boleto details for fine payments
confChannelMetrics
Boolean
SCALAR
Parent/student can see channels metrics before sending messages
confArrived
Boolean
SCALAR
If arrived feature are enabled this sends true
confRepliesStudent
Boolean
SCALAR
Combined with confReplyStudent this tells if students can reply more than once time.
anticipationDiscountUntil
Int
SCALAR
Number of days before the expiration of a charge that the discount is still applied
anticipationDiscountType
DiscountType
ENUM
Type of the discount (percentange or amount)
anticipationDiscountValue
Float
SCALAR
Discount value in percentage or total amount
fineStart
Int
SCALAR
Number of days after the expiration of a charge that the fine should start
fineType
DiscountType
ENUM
Type of the fine (percentange or amount)
fineValue
Float
SCALAR
Fine value in percentage or total amount
interestStart
Int
SCALAR
Number of days after the expiration of a charge that the interest should start
interestType
DiscountType
ENUM
Type of the interest (percentange or amount)
interestValue
Float
SCALAR
interest value in percentage or total amount
consultantId
Int
SCALAR
consultant id of organization
client
Boolean
SCALAR
is paying client
usage
OrganizationUsage
ENUM
Why this organization exists in ClassApp.
entryMethod
OrganizationEntryMethod
ENUM
entry method for organization
latitude
String
SCALAR
latitude of organization
longitude
String
SCALAR
longitude of organization
timezone
String
SCALAR
base timezone of organization
language
String
SCALAR
preferred language
country
String
SCALAR
preferred country
currency
Currency
ENUM
preferred currency
ntfStartTime
String
SCALAR
time that users of this organization start to receive notifications
ntfEndTime
String
SCALAR
time that users of this organization start to receive notifications
ntfWeekDays
Int
SCALAR
week days that users of this organization receive notifications
legalName
String
SCALAR
Organization legal name
taxId
String
SCALAR
Country tax id (Brazil -> CNPJ or CPF) (US -> EIN)
phone
String
SCALAR
Contact phone number
email
String
SCALAR
Contact email address
addressStreet
String
SCALAR
Street address of the account holder
addressNumber
String
SCALAR
Address number of the account holder
addressComplement
String
SCALAR
Address complement of the account holder
zipCode
String
SCALAR
Zip code of the account holder
neighborhood
String
SCALAR
Neighborhood of the account holder
addressState
String
SCALAR
abbreviated state of the account holder (ex: SP)
city
String
SCALAR
City of the account holder
ntfWeekDaysArray
LIST
String
days of the week to receive notification
invite
InviteEnum
ENUM
Send invitations
clientMutationId
String
SCALAR

DeleteOrganizationInput

ArgumentsTypeDescription
id
Not Null
The ID of an organization object
clientMutationId
String
SCALAR

DeleteDemonstrationInput

ArgumentsTypeDescription
id
Not Null
The ID of an organization object
clientMutationId
String
SCALAR

CreatePictureInput

ArgumentsTypeDescription
entityId
Not Null
The entity that picture belongs to
clientMutationId
String
SCALAR

DeletePictureInput

ArgumentsTypeDescription
entityId
Not Null
The entity that picture belongs to
clientMutationId
String
SCALAR

CreatePlanInput

ArgumentsTypeDescription
organizationId
Not Null
organization ID
products
LIST
PlanProductInputFields
name
Not Null
Plan name
description
String
SCALAR
Plan description
recurrenceInterval
Not Null
Recurrence interval
chargeExpirationDay
Not Null
charge's expiration day
sendMessageDay
Not Null
Day of the month or week(1=Sundsay and 7=Saturday) message should be sent
installments
Not Null
Date limit of the recurrence
trialDays
String
SCALAR
number of days of trial before start charging
status
Not Null
Plan status
invisible
Boolean
SCALAR
Whether the plan is invisible
clientMutationId
String
SCALAR

PlanProductInputFields

ArgumentsTypeDescription
id
Not Null

UpdatePlanInput

ArgumentsTypeDescription
id
Not Null
Plan ID
products
LIST
PlanProductInputFields
name
Not Null
Plan name
description
String
SCALAR
Plan description
recurrenceInterval
Not Null
Recurrence interval
chargeExpirationDay
Not Null
charge's expiration day
sendMessageDay
Not Null
Day of the month or week(1=Sundsay and 7=Saturday) message should be sent
installments
Not Null
Date limit of the recurrence
trialDays
String
SCALAR
number of days of trial before start charging
status
Not Null
Plan status
invisible
Boolean
SCALAR
Whether the plan is invisible
clientMutationId
String
SCALAR

DeletePlanInput

ArgumentsTypeDescription
id
Not Null
Plan ID
clientMutationId
String
SCALAR

CreateProductInput

ArgumentsTypeDescription
organizationId
Not Null
organization ID
name
Not Null
Product name
description
String
SCALAR
Product description
amount
Not Null
Product name
status
Not Null
Product status
clientMutationId
String
SCALAR

UpdateProductInput

ArgumentsTypeDescription
id
Not Null
Product ID
name
Not Null
Product name
description
String
SCALAR
Product description
amount
Not Null
Product name
status
Not Null
Product status
clientMutationId
String
SCALAR

DeleteProductInput

ArgumentsTypeDescription
id
Not Null
Product ID
clientMutationId
String
SCALAR

CreateProductFeatureInput

ArgumentsTypeDescription
identifier
Not Null
plan
Not Null
paid
Not Null

enableProductFeatureInput

ArgumentsTypeDescription
identifier
Not Null
organizationId
Not Null

launchProductFeatureInput

ArgumentsTypeDescription
identifier
Not Null

revertLaunchProductFeatureInput

ArgumentsTypeDescription
identifier
Not Null

updateProductFeatureInput

ArgumentsTypeDescription
identifier
Not Null
newIdentifier
String
SCALAR
newPlan
ProductFeaturePlan
ENUM
newPaid
Boolean
SCALAR

disableProductFeatureInput

ArgumentsTypeDescription
identifier
Not Null
organizationId
Not Null

deleteProductFeatureInput

ArgumentsTypeDescription
identifier
Not Null

UpdateRecipientInput

ArgumentsTypeDescription
messageId
Not Null
The ID of message
entityId
Not Null
The ID of entity
status
UpdateRecipientStatus
ENUM
New state to be associated with a recipient
deleteNotification
Boolean
SCALAR
Notification will be deleted
legacyMode
Boolean
SCALAR
clientMutationId
String
SCALAR

updateRecipientInBatchInput

ArgumentsTypeDescription
status
UpdateRecipientStatus
ENUM
New state to be associated with a recipient
deleteNotification
Boolean
SCALAR
Notification will be deleted
messagesId
LIST
ID
The IDs of messages
entityId
Not Null
The ID of entity
legacyMode
Boolean
SCALAR
clientMutationId
String
SCALAR

CreateReplyInput

ArgumentsTypeDescription
messageId
Not Null
The message ID that being reply to
entityId
Not Null
The entity ID that replies
parentId
Not Null
entity parent id
content
String
SCALAR
actual comment text
dontNotify
Boolean
SCALAR
Notifications of reply
medias
LIST
ReplyMediasInput
clientMutationId
String
SCALAR

ReplyMediasInput

ArgumentsTypeDescription
filename
Not Null
type
Not Null

UpdateReplyInput

ArgumentsTypeDescription
id
Not Null
The ID of a reply object
parentId
Int
SCALAR
entity parent id
content
String
SCALAR
actual comment text
dontNotify
Boolean
SCALAR
Notifications of reply
medias
LIST
ReplyMediasInput
status
Not Null
clientMutationId
String
SCALAR

DeleteReplyInput

ArgumentsTypeDescription
id
Not Null
The ID of a reply object
clientMutationId
String
SCALAR

ReportDenounceInput

ArgumentsTypeDescription
entityId
Not Null
Entity id from requested
organizationId
Not Null
Entity id from requested
referenceId
Not Null
ID of object denounced
reason
Not Null
Reason of the denounce
reference
Not Null
Kind of referene
clientMutationId
String
SCALAR

CreateReportFieldInput

ArgumentsTypeDescription
reportId
Not Null
The report ID that fields belongs to
name
Not Null
Field name
type
Not Null
Type of input field
options
LIST
String
Options to check or select
initial
LIST
String
Initial selected values
position
Int
SCALAR
Position to order by
clientMutationId
String
SCALAR

UpdateReportFieldInput

ArgumentsTypeDescription
id
Not Null
The ID of a report field object
name
String
SCALAR
Field name
type
ReportFieldType
ENUM
Type of input field
options
LIST
String
Options to check or select
initial
LIST
String
Initial selected values
position
Int
SCALAR
Position to order by
clientMutationId
String
SCALAR

DeleteReportFieldInput

ArgumentsTypeDescription
id
Not Null
The ID of a report field object
clientMutationId
String
SCALAR

CreateReportInput

ArgumentsTypeDescription
organizationId
Not Null
The organization ID that report belongs to
name
Not Null
Report name
description
String
SCALAR
Report description
default
Int
SCALAR
Report is used as default
fields
LIST
ReportFieldsInput
groups
LIST
ReportGroupsInput
clientMutationId
String
SCALAR

ReportFieldsInput

ArgumentsTypeDescription
id
ID
SCALAR
Report field id, for updating
name
Not Null
Field name
type
Not Null
Type of input field
options
LIST
String
Options to check or select
initial
LIST
String
Initial selected values
position
Int
SCALAR
Position to order by

ReportGroupsInput

ArgumentsTypeDescription
id
ID
SCALAR
Group ID

UpdateReportInput

ArgumentsTypeDescription
id
Not Null
The ID of report object
name
String
SCALAR
Report name
description
String
SCALAR
Report description
default
Int
SCALAR
Report is used as default
fields
LIST
ReportFieldsInput
groups
LIST
ReportGroupsInput
attach
LIST
String
Attach related rather than replace
clientMutationId
String
SCALAR

DeleteReportInput

ArgumentsTypeDescription
id
Not Null
The ID of report object
clientMutationId
String
SCALAR

CreateRoleInput

ArgumentsTypeDescription
entityId
Not Null
The enitty ID
groupId
Not Null
The group ID
clientMutationId
String
SCALAR

DeleteRoleInput

ArgumentsTypeDescription
entityId
Not Null
The enitty ID
groupId
Not Null
The group ID
clientMutationId
String
SCALAR

CreateRuleInput

ArgumentsTypeDescription
organizationId
Not Null
organization that create collection rule
value
Int
SCALAR
value to count how many (interval type) notification should be sent
interval
RuleInterval
ENUM
interval type related to value
dueDateInterval
DueDateInterval
ENUM
notification before or after the due date
clientMutationId
String
SCALAR

UpdateRuleInput

ArgumentsTypeDescription
id
Not Null
Rule ID
value
Int
SCALAR
value to count how many (interval type) notification should be sent
interval
RuleInterval
ENUM
interval type related to value
dueDateInterval
DueDateInterval
ENUM
notification before or after the due date
clientMutationId
String
SCALAR

DeleteRuleInput

ArgumentsTypeDescription
id
Not Null
Rule ID
clientMutationId
String
SCALAR

deleteSignatureInput

ArgumentsTypeDescription
signatureId
Not Null
The signature to be deleted
clientMutationId
String
SCALAR

CreateSignatureResultInput

ArgumentsTypeDescription
signatureId
Not Null
The signature attachment this acceptance belongs to
entityId
Not Null
The entity the signature belongs to
documentNumber
Not Null
Signer document number
clientMutationId
String
SCALAR

deleteSignatureResultInput

ArgumentsTypeDescription
id
Not Null
Signature result ID
clientMutationId
String
SCALAR

deleteSignatureResultFromSignatureInput

ArgumentsTypeDescription
signatureId
Not Null
Signature ID
clientMutationId
String
SCALAR

UpdateSurveyInput

ArgumentsTypeDescription
id
Not Null
The ID of a survey object
name
String
SCALAR
Survey's name
optionNumber
Int
SCALAR
number of selectable options
dateLimit
String
SCALAR
Date limit to answer survey
notifyAt
String
SCALAR
Date to notify users to answer survey
previousId
Int
SCALAR
ID of a Survey
options
LIST
UpdateSurveyOptionsInput
reason
String
SCALAR
Reason for changing survey
remindPending
remindPending
INPUT_OBJECT
Remind pending entities
clientMutationId
String
SCALAR

UpdateSurveyOptionsInput

ArgumentsTypeDescription
id
Not Null
Survey Option Id
value
Not Null
Survey options value

DeleteSurveyInput

ArgumentsTypeDescription
id
Not Null
The ID of a survey object
reason
String
SCALAR
Reason for changing survey
clientMutationId
String
SCALAR

CreateSurveyResultInput

ArgumentsTypeDescription
surveyId
Not Null
The survey ID that the result refers to
entityId
Not Null
The entity ID that answer the survey
surveyOptionId
Not Null
The option ID
clientMutationId
String
SCALAR

CreateTagInput

ArgumentsTypeDescription
organizationId
Not Null
The organization ID that tag belongs to
name
Not Null
Tag's name
checked
Boolean
SCALAR
Tag can be set as default
clientMutationId
String
SCALAR

UpdateTagInput

ArgumentsTypeDescription
id
Not Null
The ID of a tag object
name
String
SCALAR
Tag's name
checked
Boolean
SCALAR
Tag can be set as default
clientMutationId
String
SCALAR

DeleteTagInput

ArgumentsTypeDescription
id
Not Null
The ID of a tag object
clientMutationId
String
SCALAR

CreateTermInput

ArgumentsTypeDescription
name
String
SCALAR
Name of term
description
String
SCALAR
Description of term
links
String
SCALAR
Link of term
relevant_to
LIST
TermRelevantToEnum
term relevant to
application_id
ID
SCALAR
id of application
last_update
String
SCALAR
date of last term update
clientMutationId
String
SCALAR

UpdateTermInput

ArgumentsTypeDescription
id
Not Null
The ID of a term
name
String
SCALAR
Name of term
description
String
SCALAR
Description of term
links
String
SCALAR
Link of term
relevant_to
LIST
TermRelevantToEnum
term relevant to
application_id
ID
SCALAR
id of application
last_update
String
SCALAR
date of last term update
clientMutationId
String
SCALAR

CreateTermNotificationInput

ArgumentsTypeDescription
title
String
SCALAR
title that will be shown in modal
link
String
SCALAR
Links of terms that will be shown in modal
description
String
SCALAR
Description that will be shown in modal
image
String
SCALAR
Image that will be shown in modal
termsId
LIST
ID
clientMutationId
String
SCALAR

CreateUserCardInput

ArgumentsTypeDescription
cardToken
String
SCALAR
Card id (for recurrence) provided by service
cardHash
String
SCALAR
Card hash to generate card id
cardholderName
Not Null
Card holder name
last4Digits
Not Null
Last 4 digits of credit card
expiration
Not Null
Credit card date of expiration
brand
Not Null
Credit card brand
service
PaymentService
ENUM
External payment service name
documentNumber
String
SCALAR
Personal document number (CPF)
email
String
SCALAR
Email associated with card
phone
String
SCALAR
Phone number associated with card
clientMutationId
String
SCALAR

DeleteUserCardInput

ArgumentsTypeDescription
id
Not Null
The user card ID
clientMutationId
String
SCALAR

UpdateUserEntityConfigurationInput

ArgumentsTypeDescription
entityId
Int
SCALAR
Entity ID
configuration
Not Null
Attributes from configuration

UserEntityConfigurationInput

ArgumentsTypeDescription
filterArrivedConcierges
LIST
List of concierge IDs

UpdateUserConciergeFilterInput

ArgumentsTypeDescription
userId
Not Null
User ID
conciergeIds
Not Null
Concierge IDs
organizationId
Not Null
Organization ID

UpdateUserArrivedFilterInput

ArgumentsTypeDescription
userId
Not Null
User ID
organizationId
Not Null
Organization ID
conciergeIds
LIST
Concierge IDs
groupIds
LIST
Group IDs

CreateUserEntityInput

ArgumentsTypeDescription
userId
ID
SCALAR
The user ID
entityId
Not Null
The entity ID
clientMutationId
String
SCALAR

UserEntityTagsOrder

ArgumentsTypeDescription
column
Not Null
direction
OrderDirection
ENUM

DeleteUserEntityInput

ArgumentsTypeDescription
userId
ID
SCALAR
The user ID
entityId
Not Null
The entity ID
clientMutationId
String
SCALAR

CreateUserEntityTagInput

ArgumentsTypeDescription
userId
ID
SCALAR
The user ID
entityId
Not Null
The entity ID
tagId
Not Null
The tag ID
clientMutationId
String
SCALAR

DeleteUserEntityTagInput

ArgumentsTypeDescription
userId
ID
SCALAR
The user ID
entityId
Not Null
The entity ID
tagId
Not Null
The tag ID
clientMutationId
String
SCALAR

CreateUserVehicleInput

ArgumentsTypeDescription
isDefault
Boolean
SCALAR
Whether is the default vehicle or not
licensePlate
Not Null
Vehicles license plate
color
Not Null
Vehicle color
brand
String
SCALAR
Vehicle brand
model
String
SCALAR
Vehicle model
clientMutationId
String
SCALAR

UpdateUserVehicleInput

ArgumentsTypeDescription
id
Not Null
The user vehicle ID
isDefault
Boolean
SCALAR
Whether is the default vehicle or not
licensePlate
String
SCALAR
Vehicles license plate
color
String
SCALAR
Vehicle color
brand
String
SCALAR
Vehicle brand
model
String
SCALAR
Vehicle model
clientMutationId
String
SCALAR

RemoveDefaultVehicleInput

ArgumentsTypeDescription
clientMutationId
String
SCALAR

DeleteUserVehicleInput

ArgumentsTypeDescription
id
Not Null
The user vehicle ID
clientMutationId
String
SCALAR

UndeleteUserVehicleInput

ArgumentsTypeDescription
id
Not Null
The user vehicle ID
clientMutationId
String
SCALAR

RecreateUserVehicleInput

ArgumentsTypeDescription
id
Not Null
The user vehicle ID
isDefault
Boolean
SCALAR
Whether is the default vehicle or not
licensePlate
Not Null
Vehicles license plate
color
Not Null
Vehicle color
brand
String
SCALAR
Vehicle brand
model
String
SCALAR
Vehicle model
clientMutationId
String
SCALAR

CreateUserInput

ArgumentsTypeDescription
email
String
SCALAR
User's email
phone
String
SCALAR
User's phone
fullname
Not Null
User's fullname
language
String
SCALAR
Language preference
tzOffset
Int
SCALAR
The time zone offset from UTC
documentNumber
String
SCALAR
Personal document number (CPF)
onboardingApp
String
SCALAR
Onboarding on app step
onboardingSite
String
SCALAR
Onboarding on site step
loginMethod
LoginMethodEnum
ENUM
Users can choose the way they will sign in
confirmEmail
Boolean
SCALAR
User can be notify by e-mail
confirmPhone
Boolean
SCALAR
User can be notify by phone
emailNtf
Boolean
SCALAR
User can be notify by e-mail
phoneNtf
Boolean
SCALAR
User can be notify by phone
webNtf
Boolean
SCALAR
User can be notify by web
ntfAnnouncement
Boolean
SCALAR
Can notify current viewer when there are announcements
ntfMessage
LIST
UserNotificationType
Can notify when someone sends current viewer a message
ntfCommitmentRemind
LIST
UserNotificationType
Can notify when current viewer has pending commitments
ntfReply
LIST
UserNotificationType
Can notify when someone replies to current viewer's message
ntfSurvey
LIST
UserNotificationType
Can notify when someone responds current viewer's survey
ntfSurveyPending
LIST
UserNotificationType
Can notify when someone send reminder for current viewer's survey
ntfCommitment
LIST
UserNotificationType
Can notify when someone confirms current viewer's commitment
ntfCharge
LIST
UserNotificationType
Can notify when someone pays current viewer's charge
ntfChargePending
LIST
UserNotificationType
Can notify when someone send reminder for current viewer's charge
ntfForm
LIST
UserNotificationType
Can notify when someone fills current viewer's form
ntfFormPending
LIST
UserNotificationType
Can notify when form is pending
ntfUnread
LIST
UserNotificationType
Can notify when current viewer has unread messages
ntfArrived
LIST
UserNotificationType
Can notify when arrivals has update
code
String
SCALAR
User oauth code to recover password
verifiedAddressCode
String
SCALAR
If address code is valid, address is confirmed (just valid for phone yet)
nextFeedback
String
SCALAR
Date when user will receive pop up to give feedback
resendFeedback
Boolean
SCALAR
User should receive pop up to rate after seven days
password
String
SCALAR
New password, optional
isNewCode
Boolean
SCALAR
should send six digit confirm address code
addresses
LIST
UserAddressesInput
clientMutationId
String
SCALAR

UserAddressesInput

ArgumentsTypeDescription
code
String
SCALAR

UpdateUserInput

ArgumentsTypeDescription
id
ID
SCALAR
The ID of an user object
email
String
SCALAR
User's email
phone
String
SCALAR
User's phone
fullname
String
SCALAR
User's fullname
language
String
SCALAR
Language preference
tzOffset
Int
SCALAR
The time zone offset from UTC
documentNumber
String
SCALAR
Personal document number (CPF)
onboardingApp
String
SCALAR
Onboarding on app step
onboardingSite
String
SCALAR
Onboarding on site step
loginMethod
LoginMethodEnum
ENUM
Users can choose the way they will sign in
confirmEmail
Boolean
SCALAR
User can be notify by e-mail
confirmPhone
Boolean
SCALAR
User can be notify by phone
emailNtf
Boolean
SCALAR
User can be notify by e-mail
phoneNtf
Boolean
SCALAR
User can be notify by phone
webNtf
Boolean
SCALAR
User can be notify by web
ntfAnnouncement
Boolean
SCALAR
Can notify current viewer when there are announcements
ntfMessage
LIST
UserNotificationType
Can notify when someone sends current viewer a message
ntfCommitmentRemind
LIST
UserNotificationType
Can notify when current viewer has pending commitments
ntfReply
LIST
UserNotificationType
Can notify when someone replies to current viewer's message
ntfSurvey
LIST
UserNotificationType
Can notify when someone responds current viewer's survey
ntfSurveyPending
LIST
UserNotificationType
Can notify when someone send reminder for current viewer's survey
ntfCommitment
LIST
UserNotificationType
Can notify when someone confirms current viewer's commitment
ntfCharge
LIST
UserNotificationType
Can notify when someone pays current viewer's charge
ntfChargePending
LIST
UserNotificationType
Can notify when someone send reminder for current viewer's charge
ntfForm
LIST
UserNotificationType
Can notify when someone fills current viewer's form
ntfFormPending
LIST
UserNotificationType
Can notify when form is pending
ntfUnread
LIST
UserNotificationType
Can notify when current viewer has unread messages
ntfArrived
LIST
UserNotificationType
Can notify when arrivals has update
code
String
SCALAR
User oauth code to recover password
verifiedAddressCode
String
SCALAR
If address code is valid, address is confirmed (just valid for phone yet)
nextFeedback
String
SCALAR
Date when user will receive pop up to give feedback
resendFeedback
Boolean
SCALAR
User should receive pop up to rate after seven days
password
String
SCALAR
Current password
newPassword
String
SCALAR
New password
isNewCode
Boolean
SCALAR
should send six digit confirm address code
scope
UserScope
ENUM
clientMutationId
String
SCALAR

DeleteUserInput

ArgumentsTypeDescription
id
ID
SCALAR
The ID of an user object
password
String
SCALAR
Current password
clientMutationId
String
SCALAR

CreateWebhookInput

ArgumentsTypeDescription
organizationId
ID
SCALAR
The organization ID that webhook belongs to
applicationId
ID
SCALAR
The application ID that webhook belongs to
uri
Not Null
URI of webhook
model
Not Null
Model wich will be apllied the webhook
event
Not Null
Event wich will trigger the webhook
modelId
Int
SCALAR
Specific Id of the model wich will trigger the webhook
clientMutationId
String
SCALAR

UpdateWebhookInput

ArgumentsTypeDescription
id
Not Null
The ID of a webhook object
uri
String
SCALAR
URI of webhook
model
WebhookModelType
ENUM
Model wich will be apllied the webhook
event
WebhookEventType
ENUM
Event wich will trigger the webhook
modelId
Int
SCALAR
Specific Id of the model wich will trigger the webhook
clientMutationId
String
SCALAR

DeleteWebhookInput

ArgumentsTypeDescription
id
Not Null
The ID of a webhook object
clientMutationId
String
SCALAR

AuthorizeApplicationInput

ArgumentsTypeDescription
clientId
Not Null
Client ID
redirectUri
Not Null
Redirect URI
clientMutationId
String
SCALAR

authorizeMarketplaceInput

ArgumentsTypeDescription
clientId
Not Null
Client ID
redirectUri
Not Null
Redirect URI
organizationId
Not Null
Redirect URI
clientMutationId
String
SCALAR

PasswordAuthenticateInput

ArgumentsTypeDescription
email
String
SCALAR
User email
phone
String
SCALAR
User phone
password
Not Null
Password to login
clientMutationId
String
SCALAR

CodeAuthenticateInput

ArgumentsTypeDescription
code
Not Null
Code received in two factor authenticate
address
String
SCALAR
Address used by user to authenticate
clientMutationId
String
SCALAR

RefreshTokenAuthenticateInput

ArgumentsTypeDescription
refreshToken
Not Null
Refresh token to login
clientMutationId
String
SCALAR