Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | UserEntitiesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | OrganizationAcceptedTermDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | OrganizationAcceptedTermOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | OrganizationOrganizationMembershipDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | OrganizationOrganizationMembershipOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
criteria | String SCALAR |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
minimum | Int SCALAR | Minimum of miliseconds to calculate wait time |
maximum | Int SCALAR | Maximum of miliseconds to calculate wait time |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | ConciergeGroupsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | ConciergeGroupsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | GroupEntitiesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | GroupCommitmentsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | GroupCommitmentsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | ReplyMediasDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | ReplyMediasOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | ReplyConversationDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | ReplyReplyLogsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | ReplyReplyLogsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | ReportFieldsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | ReportFieldResultsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | ReportResultsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | ReportGroupsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | ReportGroupsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | ReportEntitiesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | ReportEntitiesOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | SurveyOptionsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | SurveyOptionResultsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | SurveyResultsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | SurveyEntitiesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | SurveySummaryDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | OrganizationAccountOrganizationWithdrawalConnectionDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | PlanProductsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | PlanProductsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | ProductPlansDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | ProductPlansOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | ProductLogsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | ProductLogsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | PlanContractsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | PlanContractsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | ContractLogsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | ContractLogsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | ContractInvoicesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | ContractInvoicesOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | InvoiceLogsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | InvoiceLogsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | InvoiceDiscountsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | InvoiceDiscountsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | InvoiceChargesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | InvoiceChargesOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | PlanLogsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | PlanLogsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | ChargeEntitiesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | ChargeEntitiesOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | FormFieldsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | FormFieldsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | FormFieldResultsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | FormFieldResultsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | FormResultsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | FormResultsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | FormGroupsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | FormGroupsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | FormEntitiesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | FormEntitiesOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | TagAddressesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | AddressAddressesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | TagEntitiesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | TagUsersDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | TagMessagesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | CommitmentRemindsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | CommitmentEntitiesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | CommitmentGroupsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | CommitmentGroupsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | CommitmentCommitmentsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | CommitmentCommitmentsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | OrganizationMyEntitiesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | OrganizationMyEntitiesOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | OrganizationInvoicesAmountDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
initialDate | String SCALAR | Initial date for interval |
finalDate | String SCALAR | Final date for interval |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | OrganizationEntitiesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | OrganizationGroupsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | OrganizationApplicationAccessDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | OrganizationApplicationAccessOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | ApplicationAccessundefinedDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | ApplicationAccessundefinedOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | ApplicationAccessintegrationModulesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | ApplicationAccessintegrationModulesOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | ApplicationAccessintegrationContractsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | ApplicationAccessintegrationContractsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | OrganizationReportsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | OrganizationFormsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | OrganizationFormsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | OrganizationRulesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | OrganizationRulesOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | OrganizationPlansDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | OrganizationPlansOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | OrganizationProductsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | OrganizationProductsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | OrganizationDraftsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | OrganizationDraftsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | OrganizationCommitmentsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | OrganizationCommitmentsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
month | Int SCALAR | |
year | Int SCALAR |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | OrganizationChargeRecipientDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | OrganizationChargeRecipientOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
initialDate | String SCALAR | Initial date for interval |
finalDate | String SCALAR | Final date for interval |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
column | OrganizationPaymentsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | OrganizationChargesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | OrganizationChargesOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
column | OrganizationInvoicesOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | OrganizationWebhooksDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | OrganizationWebhooksOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | OrganizationApplicationDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | OrganizationApplicationOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | OrganizationundefinedDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | OrganizationundefinedOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | OrganizationOrganizationWithdrawalDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | OrganizationOrganizationWithdrawalOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | OrganizationintegrationContractDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | OrganizationintegrationContractOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | OrganizationOrganizationConciergesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | OrganizationOrganizationConciergesOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | ArrivedConfigurationConciergesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | ArrivedConfigurationConciergesOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | EntityContractsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | EntityContractsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | EntityConciergesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | EntityConciergesOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | EntityUsersDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | EntityEntityMessageStatusDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | EntityEntityMessageStatusOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | EntityAddressesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | EntityRolesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | EntityGroupsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | EntityGroupRecipientsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | EntityStaffRecipientsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | EntityNotificationsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | EntityNotificationsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | EntityDraftsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | EntityDraftsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | EntityDraftLogsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | EntityDraftLogsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | EntityMediasDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | EntitySurveysDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | EntityCommitmentsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | EntityChargesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | EntityChargesOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | EntityRecipientsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | EntityReportsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | EntityReportsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | EntityFormsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | EntityFormsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | EntityInvoicesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | EntityInvoicesOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | EntityExternalChannelsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | EntityExternalChannelsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
criteria | String SCALAR |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
minimum | Int SCALAR | Minimum of miliseconds to calculate wait time |
maximum | Int SCALAR | Maximum of miliseconds to calculate wait time |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | UserAddressesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | UserAcceptedTermsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | UserAcceptedTermsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | UserInvitationsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | UserApplicationsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
criteria | Not Null |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
criteria | Not Null |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time unit |
column | Not Null |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | UserOauthProvidersDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | UserDevicesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | UserDraftsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | UserDraftsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | UserNotificationsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | UserOrganizationsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | UserFeedbacksDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | UserFeedbacksOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | UserCardsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | UserCardsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | UserPlansDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | UserPlansOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | UserSubscriptionsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | UserSubscriptionsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | PlanSubscriptionChargesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | PlanSubscriptionChargesOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | UserVehiclesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | UserVehiclesOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | UserEntitiesWithArrivedDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | UserEntitiesWithArrivedOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | ApplicationDevicesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | ApplicationOauthProvidersDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | ApplicationOrganizationDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | ApplicationOrganizationOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | ApplicationExternalChannelsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | ApplicationExternalChannelsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | OrganizationsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
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. |
Arguments | Type | Description |
---|---|---|
min | Int SCALAR | |
max | Int SCALAR | |
entityTypes | LIST EntityType |
Arguments | Type | Description |
---|---|---|
status | LIST IntegrationStatus | |
type | ApplicationAccessTypeEnum ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | ChannelsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | ChannelsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | UsersDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | ModulesDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | ModulesOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
limit | Int SCALAR | |
offset | Int SCALAR | |
interval | Interval ENUM | Time period interval |
column | IntegrationCancellationReasonsDateIntervalColumn ENUM |
Arguments | Type | Description |
---|---|---|
column | IntegrationCancellationReasonsOrderColumn ENUM | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
ipAddress | String SCALAR | Ip address of user |
organizationId | Int SCALAR | which organization does it belong to |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
ipAddress | String SCALAR | Ip address of user |
organizationId | Int SCALAR | which organization does it belong to |
termName | Not Null | |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | ID SCALAR | |
name | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null | The ID of an address object |
code | String SCALAR | The ID of an address object |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null | The ID application access |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null | The ID of an application object |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
id | Not Null | The ID of an application object |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
remindAll | Boolean SCALAR | Remind all pending entities |
entityIds | LIST ID | Remind some entities |
Arguments | Type | Description |
---|---|---|
id | Not Null | The ID of a charge object |
reason | String SCALAR | Reason for changing charge |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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) |
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
code | String SCALAR | The code that will be validated |
address | String SCALAR | The address that the code will be sent |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
recurrence | Not Null | How often the commitment will be repeated |
until | Not Null | Repeat over the recurrence until this date |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
code | Not Null | Confirm address code |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null | The ID of the concierge object |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
productId | ID SCALAR | |
discountType | DiscountType ENUM | |
discountValue | Float SCALAR |
Arguments | Type | Description |
---|---|---|
id | ID SCALAR | |
amount | Float SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
organizationId | Not Null | The organization that Cover belongs to |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
organizationId | Not Null | The organization that Cover belongs to |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
deviceToken | Not Null | device unique token |
deviceVersion | Not Null | os version |
appVersion | Not Null | application version |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
deviceToken | Not Null | device unique token |
deviceVersion | Not Null | os version |
appVersion | Not Null | application version |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
deviceToken | Not Null | The user's device token |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | ID SCALAR | |
name | String SCALAR | |
type | GroupType ENUM |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
organizationId | Not Null | The organization that entity is |
type | Not Null | Entity template |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
organizationId | Not Null | |
type | Not Null | Type of the export |
emailTo | String SCALAR | |
filters | String SCALAR | |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null | The ID of a External Channel object |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
externalChannelId | ID SCALAR | The externalchannel ID |
entityId | Not Null | The entity ID |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
externalChannelId | ID SCALAR | The externalchannel ID |
entityId | Not Null | The entity ID |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
userId | Not Null | The ID of user |
feedback | String SCALAR | Feedback wrote by user |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | ID SCALAR | Group ID |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null | The ID of form object |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null | The ID of a form field object |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
id | Not Null | form message id |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
value | Not Null | input value |
formFieldId | Not Null | field |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null | The ID of a group object |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
organizationId | Not Null | The ID of organization |
entityType | Not Null | Entity type |
hasToUpdate | HasToUpdateInput INPUT_OBJECT | |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
list | LIST HasToUpdateInputEntity |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null | The ID of a tag object |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null | The ID of a tag object |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null | The ID of a tag object |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
productId | ID SCALAR | |
discountType | DiscountType ENUM | |
discountValue | Float SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null | Invoice ID |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | ID SCALAR | |
filename | Not Null | |
type | Not Null |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null | Label ID |
forceDelete | Boolean SCALAR | Force delete label |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null | The ID of an link object |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
linkId | Not Null | Link id |
entityId | Not Null | Entity id |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
organizationId | Not Null | The organization that logo belongs to |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
organizationId | Not Null | The organization that logo belongs to |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
organizationId | ID SCALAR | |
organizationSize | String SCALAR | |
platform | String SCALAR |
Arguments | Type | Description |
---|---|---|
mimeType | Not Null | |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
key | Not Null | |
fileName | String SCALAR | |
mimeType | String SCALAR | |
width | Int SCALAR | |
height | Int SCALAR | |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
transcode | Boolean SCALAR | |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
entityId | Not Null | Entity Id |
transcode | Boolean SCALAR | |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
value | Not Null | Survey options value |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
reportFieldId | Not Null | |
value | String SCALAR | Value of report field |
entityId | ID SCALAR | Entity id who will receive this result |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null | |
dateLimit | String SCALAR |
Arguments | Type | Description |
---|---|---|
id | ID SCALAR | |
name | String SCALAR |
Arguments | Type | Description |
---|---|---|
entityIds | LIST ID | |
groupIds | LIST ID | |
types | LIST EntityType | |
eids | LIST String |
Arguments | Type | Description |
---|---|---|
dateLimit | String SCALAR | Maximum date to accept signatures |
maxSigners | Not Null | Maximum number of signatures allowed |
title | String SCALAR | The signature title or content |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null | The ID of an message draft object |
status | MessageDraftLogReason ENUM | Status of message draft log |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
messageId | Not Null | The ID of message |
entityId | Not Null | The ID of entity |
status | Not Null | status of message |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
messagesId | Not Null | The ID of messages |
entityId | Not Null | The ID of entity |
status | Not Null | status of message |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
id | Not Null | The ID of a message status object |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
messagesId | Not Null | The ID of messages |
entityId | Not Null | The ID of entity |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null | The ID of a tag object |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
messageId | Not Null | The ID of message |
entityId | Not Null | The ID of entity |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
userId | Not Null | The user is being notificated |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
userId | Not Null | The ID of user |
applicationId | Not Null | The ID of application |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
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 |
Arguments | Type | Description |
---|---|---|
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 |
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null | Organization account ID |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
organizationId | Not Null | Organization ID |
bannerType | Not Null | Banner type |
Arguments | Type | Description |
---|---|---|
id | Not Null | Banner ID |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
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 |
Arguments | Type | Description |
---|---|---|
id | ID SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null | The ID of an organization object |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
id | Not Null | The ID of an organization object |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
entityId | Not Null | The entity that picture belongs to |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
entityId | Not Null | The entity that picture belongs to |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null | Plan ID |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null | Product ID |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
identifier | Not Null | |
plan | Not Null | |
paid | Not Null |
Arguments | Type | Description |
---|---|---|
identifier | Not Null | |
organizationId | Not Null |
Arguments | Type | Description |
---|---|---|
identifier | Not Null |
Arguments | Type | Description |
---|---|---|
identifier | Not Null |
Arguments | Type | Description |
---|---|---|
identifier | Not Null | |
newIdentifier | String SCALAR | |
newPlan | ProductFeaturePlan ENUM | |
newPaid | Boolean SCALAR |
Arguments | Type | Description |
---|---|---|
identifier | Not Null | |
organizationId | Not Null |
Arguments | Type | Description |
---|---|---|
identifier | Not Null |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
filename | Not Null | |
type | Not Null |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null | The ID of a reply object |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null | The ID of a report field object |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | ID SCALAR | Group ID |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null | The ID of report object |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
entityId | Not Null | The enitty ID |
groupId | Not Null | The group ID |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
entityId | Not Null | The enitty ID |
groupId | Not Null | The group ID |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null | Rule ID |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
signatureId | Not Null | The signature to be deleted |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null | Signature result ID |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
signatureId | Not Null | Signature ID |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null | Survey Option Id |
value | Not Null | Survey options value |
Arguments | Type | Description |
---|---|---|
id | Not Null | The ID of a survey object |
reason | String SCALAR | Reason for changing survey |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null | The ID of a tag object |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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) |
String SCALAR | Email associated with card | |
phone | String SCALAR | Phone number associated with card |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
id | Not Null | The user card ID |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
entityId | Int SCALAR | Entity ID |
configuration | Not Null | Attributes from configuration |
Arguments | Type | Description |
---|---|---|
filterArrivedConcierges | LIST | List of concierge IDs |
Arguments | Type | Description |
---|---|---|
userId | Not Null | User ID |
conciergeIds | Not Null | Concierge IDs |
organizationId | Not Null | Organization ID |
Arguments | Type | Description |
---|---|---|
userId | Not Null | User ID |
organizationId | Not Null | Organization ID |
conciergeIds | LIST | Concierge IDs |
groupIds | LIST | Group IDs |
Arguments | Type | Description |
---|---|---|
userId | ID SCALAR | The user ID |
entityId | Not Null | The entity ID |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
column | Not Null | |
direction | OrderDirection ENUM |
Arguments | Type | Description |
---|---|---|
userId | ID SCALAR | The user ID |
entityId | Not Null | The entity ID |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
userId | ID SCALAR | The user ID |
entityId | Not Null | The entity ID |
tagId | Not Null | The tag ID |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
userId | ID SCALAR | The user ID |
entityId | Not Null | The entity ID |
tagId | Not Null | The tag ID |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
id | Not Null | The user vehicle ID |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
id | Not Null | The user vehicle ID |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
code | String SCALAR |
Arguments | Type | Description |
---|---|---|
id | ID SCALAR | The ID of an user object |
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 |
Arguments | Type | Description |
---|---|---|
id | ID SCALAR | The ID of an user object |
password | String SCALAR | Current password |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
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 |
Arguments | Type | Description |
---|---|---|
id | Not Null | The ID of a webhook object |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
clientId | Not Null | Client ID |
redirectUri | Not Null | Redirect URI |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
clientId | Not Null | Client ID |
redirectUri | Not Null | Redirect URI |
organizationId | Not Null | Redirect URI |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
String SCALAR | User email | |
phone | String SCALAR | User phone |
password | Not Null | Password to login |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
code | Not Null | Code received in two factor authenticate |
address | String SCALAR | Address used by user to authenticate |
clientMutationId | String SCALAR |
Arguments | Type | Description |
---|---|---|
refreshToken | Not Null | Refresh token to login |
clientMutationId | String SCALAR |