Organization
A instituição




POST at this target:

https://joy.classapp.co/graphql?access_token=YOUR_TOKEN_HERE


Organization

ParamsDescription
idThe ID of an object
dbIdIdentifies the primary key from the database.
typeType of organization
planPlan of organization
usernameunique username
fullnamedisplay name
colortheme color
linkurl for more info
tzOffsettimezone offset from UTC
confMessageMessage can be sent
confMessageStudentParent/student can send messages
confMessageStaffStaff can send messages
confMediaMedia can be sent
confAudioAudio can be sent
confAudioStudentAudio can be sent by students
confOtherFilesOther files can be sent
confCommitmentCommitment can be sent
confSurveySurvey can be sent
confReportReport can be sent
confChargeCharge can be sent
confFormForm can be sent
confReplyStudentParent/student can send replies
confMediaStudentParent/student can send media
confTermsTerms that were accepted by the user
confPresencePresence can be sent
confAdminListShow admin list for staff
confRecurrenceOrganization has access to recurrrence module
confAnticipationDiscountAllow anticipation discount for charges
confFineAllow fine for charges
confInterestAllow interest for charges
confPaymentDetailsInboletoAllow boleto details for fine payments
confChannelMetricsParent/student can see channels metrics before sending messages
confArrivedIf arrived feature are enabled this sends true
anticipationDiscountUntilNumber of days before the expiration of a charge that the discount is still applied
anticipationDiscountTypeType of the discount (percentange or amount)
anticipationDiscountValueDiscount value in percentage or total amount
fineStartNumber of days after the expiration of a charge that the fine should start
fineTypeType of the fine (percentange or amount)
fineValueFine value in percentage or total amount
interestStartNumber of days after the expiration of a charge that the interest should start
interestTypeType of the interest (percentange or amount)
interestValueinterest value in percentage or total amount
consultantIdconsultant entity id
clienttype of client
usageWhy this organization exists in ClassApp.
entryMethodentry method for organization
latitudelatitude of organization
longitudelongitude of organization
timezonebase timezone of organization
languagepreferred language
countrypreferred country
currencypreferred currency
ntfStartTimetime that users of this organization start to receive notifications
ntfEndTimetime that users of this organization start to receive notifications
ntfWeekDaysweek days that users of this organization receive notifications
legalNameOrganization legal name
taxIdCountry tax id (Brazil -> CNPJ or CPF) (US -> EIN)
phoneContact phone number
emailContact email address
addressStreetStreet address of the account holder
addressNumberAddress number of the account holder
addressComplementAddress complement of the account holder
zipCodeZip code of the account holder
neighborhoodNeighborhood of the account holder
addressStateabbreviated state of the account holder (ex: SP)
cityCity of the account holder
ntfWeekDaysArraydays of the week to receive notification
userUser who created organization
livelive in production = 1
supporthas support
featuresOrganization features based on plan
premiumPeriodUntil when the organization has the right to use premium features
membershipEntities with users at the organization (members)
readingRateRate of messages read in organization
replyTimeStatsAverage reply time of staffs and admins in organization
replyStats
monthlyMessagesCountNumber of messages sent by admins and staff to students this month in this organization
monthlyMessageQuotaNumber of messages that admins and staff can send per student monthly
dailyEntityMessagesMetricsMetrics from channels from the organization
dailyMessagesMetricsSummary metrics from channels from the organization
messageStats
entityMessageStats
paymentStats
permissions
logoLogo of organization page
coverCover of organization page
consultantconsultant entity
arrivalsOrganization arrivals
hasArrivedForStaffShould show arrived for staff
myEntitiesMy entities (user) inside organization
organizationInvoicesInformationsContains informations about organization invoices
financialInformationsThis contains some informations about payments on organization
entitiesEntities of organization
recipientTagsRecipient tags from organization
groupsGroups of organization
tagsTags from organization
linksLinks of organization
labelsOrganization's label
reportsOrganization's report
formsOrganization's forms
accountsAll accounts in organization
collectionRuleorganization's collection rules
plansOrganization's plans
productsOrganization's products
messagesOrganization's messages
momentsOrganization's moments
messageDraftsMessage drafts that belongs to organization entities
commitmentsOrganization's commitments
chargeRecipientsCharge recipients made to organization
paymentsCharge payments made to organization
chargesCharges sent by organization
invoicesInvoices of the organization
webhooksOrganization's webhooks
applicationApplication
onboardingOrganizationOnboarding
isOnboardingIs the Organization Onboarding?
integrationIntegrations used by organization
withdrawalsOrganization's withdrawals
isDemonstrationIs the Organization on a Demonstration?
overdueInvoicesStatsOverdue invoices stats in the organization
conciergesConcierges related to this organization
arrivedConfiguration
createdAn ISO-8601 encoded UTC date string of when record was created
modifiedAn ISO-8601 encoded UTC date string of when record was updated
deletedAn ISO-8601 encoded UTC date string of when record was deleted
keyRandom ID to differentiate from others
selectedHelper field for clients
highlightedHelper field for clients
expandedHelper field for clients
loadedHelper field for clients
loadingHelper field for clients

CreateOrganizationInput

ArgumentsTypeDescription
type
OrganizationType
ENUM
Type of organization
plan
OrganizationPlan
ENUM
Plan of organization
username
String
SCALAR
unique username
fullname
Not Null
display name
color
String
SCALAR
theme color
link
String
SCALAR
url for more info
tzOffset
Int
SCALAR
timezone offset from UTC
confMessage
Boolean
SCALAR
Message can be sent
confMessageStudent
Boolean
SCALAR
Parent/student can send messages
confMessageStaff
Boolean
SCALAR
Staff can send messages
confMedia
Boolean
SCALAR
Media can be sent
confAudio
Boolean
SCALAR
Audio can be sent
confAudioStudent
Boolean
SCALAR
Audio can be sent by students
confOtherFiles
Boolean
SCALAR
Other files can be sent
confCommitment
Boolean
SCALAR
Commitment can be sent
confSurvey
Boolean
SCALAR
Survey can be sent
confReport
Boolean
SCALAR
Report can be sent
confCharge
Boolean
SCALAR
Charge can be sent
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
anticipationDiscountUntil
Int
SCALAR
Number of days before the expiration of a charge that the discount is still applied
anticipationDiscountType
DiscountType
ENUM
Type of the discount (percentange or amount)
anticipationDiscountValue
Float
SCALAR
Discount value in percentage or total amount
fineStart
Int
SCALAR
Number of days after the expiration of a charge that the fine should start
fineType
DiscountType
ENUM
Type of the fine (percentange or amount)
fineValue
Float
SCALAR
Fine value in percentage or total amount
interestStart
Int
SCALAR
Number of days after the expiration of a charge that the interest should start
interestType
DiscountType
ENUM
Type of the interest (percentange or amount)
interestValue
Float
SCALAR
interest value in percentage or total amount
consultantId
Int
SCALAR
consultant id of organization
client
Boolean
SCALAR
is paying client
usage
OrganizationUsage
ENUM
Why this organization exists in ClassApp.
entryMethod
OrganizationEntryMethod
ENUM
entry method for organization
latitude
String
SCALAR
latitude of organization
longitude
String
SCALAR
longitude of organization
timezone
String
SCALAR
base timezone of organization
language
String
SCALAR
preferred language
country
String
SCALAR
preferred country
currency
Currency
ENUM
preferred currency
ntfStartTime
String
SCALAR
time that users of this organization start to receive notifications
ntfEndTime
String
SCALAR
time that users of this organization start to receive notifications
ntfWeekDays
Int
SCALAR
week days that users of this organization receive notifications
legalName
String
SCALAR
Organization legal name
taxId
String
SCALAR
Country tax id (Brazil -> CNPJ or CPF) (US -> EIN)
phone
String
SCALAR
Contact phone number
email
String
SCALAR
Contact email address
addressStreet
String
SCALAR
Street address of the account holder
addressNumber
String
SCALAR
Address number of the account holder
addressComplement
String
SCALAR
Address complement of the account holder
zipCode
String
SCALAR
Zip code of the account holder
neighborhood
String
SCALAR
Neighborhood of the account holder
addressState
String
SCALAR
abbreviated state of the account holder (ex: SP)
city
String
SCALAR
City of the account holder
ntfWeekDaysArray
LIST
String
days of the week to receive notification
includeViewer
Boolean
SCALAR
Add currently authenticated user
recipientTags
LIST
OrganizationTagsInput
user
OrganizationUserInput
INPUT_OBJECT
entity
OrganizationEntityInput
INPUT_OBJECT
defaultFeatures
LIST
DefaultFeatures
Features that should have default items
invite
InviteEnum
ENUM
Send invitations
clientMutationId
String
SCALAR

UpdateOrganizationInput

ArgumentsTypeDescription
id
Not Null
The ID of an organization object
includeViewer
Boolean
SCALAR
Add currently authenticated user
recipientTags
LIST
OrganizationTagsInput
user
OrganizationUserInput
INPUT_OBJECT
entity
OrganizationEntityInput
INPUT_OBJECT
type
OrganizationType
ENUM
Type of organization
plan
OrganizationPlan
ENUM
Plan of organization
username
String
SCALAR
unique username
fullname
String
SCALAR
display name
color
String
SCALAR
theme color
link
String
SCALAR
url for more info
tzOffset
Int
SCALAR
timezone offset from UTC
confMessage
Boolean
SCALAR
Message can be sent
confMessageStudent
Boolean
SCALAR
Parent/student can send messages
confMessageStaff
Boolean
SCALAR
Staff can send messages
confMedia
Boolean
SCALAR
Media can be sent
confAudio
Boolean
SCALAR
Audio can be sent
confAudioStudent
Boolean
SCALAR
Audio can be sent by students
confOtherFiles
Boolean
SCALAR
Other files can be sent
confCommitment
Boolean
SCALAR
Commitment can be sent
confSurvey
Boolean
SCALAR
Survey can be sent
confReport
Boolean
SCALAR
Report can be sent
confCharge
Boolean
SCALAR
Charge can be sent
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
anticipationDiscountUntil
Int
SCALAR
Number of days before the expiration of a charge that the discount is still applied
anticipationDiscountType
DiscountType
ENUM
Type of the discount (percentange or amount)
anticipationDiscountValue
Float
SCALAR
Discount value in percentage or total amount
fineStart
Int
SCALAR
Number of days after the expiration of a charge that the fine should start
fineType
DiscountType
ENUM
Type of the fine (percentange or amount)
fineValue
Float
SCALAR
Fine value in percentage or total amount
interestStart
Int
SCALAR
Number of days after the expiration of a charge that the interest should start
interestType
DiscountType
ENUM
Type of the interest (percentange or amount)
interestValue
Float
SCALAR
interest value in percentage or total amount
consultantId
Int
SCALAR
consultant id of organization
client
Boolean
SCALAR
is paying client
usage
OrganizationUsage
ENUM
Why this organization exists in ClassApp.
entryMethod
OrganizationEntryMethod
ENUM
entry method for organization
latitude
String
SCALAR
latitude of organization
longitude
String
SCALAR
longitude of organization
timezone
String
SCALAR
base timezone of organization
language
String
SCALAR
preferred language
country
String
SCALAR
preferred country
currency
Currency
ENUM
preferred currency
ntfStartTime
String
SCALAR
time that users of this organization start to receive notifications
ntfEndTime
String
SCALAR
time that users of this organization start to receive notifications
ntfWeekDays
Int
SCALAR
week days that users of this organization receive notifications
legalName
String
SCALAR
Organization legal name
taxId
String
SCALAR
Country tax id (Brazil -> CNPJ or CPF) (US -> EIN)
phone
String
SCALAR
Contact phone number
email
String
SCALAR
Contact email address
addressStreet
String
SCALAR
Street address of the account holder
addressNumber
String
SCALAR
Address number of the account holder
addressComplement
String
SCALAR
Address complement of the account holder
zipCode
String
SCALAR
Zip code of the account holder
neighborhood
String
SCALAR
Neighborhood of the account holder
addressState
String
SCALAR
abbreviated state of the account holder (ex: SP)
city
String
SCALAR
City of the account holder
ntfWeekDaysArray
LIST
String
days of the week to receive notification
invite
InviteEnum
ENUM
Send invitations
clientMutationId
String
SCALAR

DeleteOrganizationInput

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