Text

link GraphQL Schema definition

link Require by

• AccessLogAn access log history on an entity.
• AccountA customer account.
• AccountAdtranMosaicServiceDetailAn account Adtran Mosaic service detail.
• AccountBillingParameterParameters that define the billing settings for an `Account`.
• AccountCalixServiceDetailHolds information for provisioning service on Calix devices.
• AccountEventA tracked event that has occurred for an `Account`.
• AccountGroupAn account group.
• AccountServiceThe relationship between an `Account` and a `Service`.
• AccountStatusThe status of an account.
• AccountTypeThe account type.
• AccountVoiceServiceDetailA voice service configuration that links a service parameter to an account.
• AchBatchAn ACH batch file.
• AddressA geographical address.
• AddressListAn address list defines some criteria by which to group accounts for network policy enforcement.
• AddressStatusAn address status.
• AdjustmentServiceDetailDetails about an adjustment `Service`.
• AdtranMosaicAuditAn Adtran Mosaic audit record.
• AdtranMosaicSettingAn Adtran Mosaic settings record.
• AdtranMosaicWorkflowEventAn Adtran Mosaic workflow event record.
• AlertingRotationAn alerting rotation.
• AlertingRotationDayAn alerting rotation day.
• AlertingRotationInventoryItemAn `InventoryItem` associated with an `AlertingRotation`.
• ApplicationFirewallRuleAn application firewall IP address or subnet rule.
• AuthProviderAn authentication provider.
• AvailableExploretypes.available_explore
• AvailableReportAn available report.
• AvalaraTaxCategoryA tax category defined by Avalara.
• AvalaraTaxDefinitionA tax Transaction/Service pair defined by Avalara.
• BankAccountA bank account.
• BankAccountProcessorA processor or method of processing bank account payments.
• BankAccountProcessorCredentialA credential used when processing bank account payments.
• BillingDefaultDefault billing settings that are applied to some accounts on creation.
• BillingServiceThe service items and overrides for linked billing defaults.
• BillingSettingBilling configuration settings.
• CableModemProvisionerA cable modem provisioner.
• CableModemProvisionerCredentialA cable modem provisioner credential.
• CalendarIcalAn iCalendar calendar.
• CalixCloudAuditA Calix Cloud audit record.
• CalixCloudSettingA Calix Cloud setting.
• CalixIntegrationA configuration for a specific Calix SMx endpoint.
• CallDetailRecordA call detail record (CDR).
• CallDetailRecordImportAn import of call detail records (CDRs).
• CallDetailRecordImportRecipeA recipe for importing call detail records (CDRs).
• CallLogA call log.
• CannedReplyA canned reply.
• CannedReplyCategoryA canned reply category.
• CompanyA company you do business as.
• CompanyDepartmentA department in a company.
• CompleteJobMutationInputThe input object that defines the fields for the completeJob mutation.
• ContactA contact person.
• ContractA contract.
• ContractTemplateA contract template.
• CoreCreditCardA Sonar credit card.
• CorePaymentA Sonar payment.
• CreateCalixCloudSettingMutationInputThe input object that defines the fields for the createCalixCloudSetting mutation.
• CreateCallLogMutationInputThe input object that defines the fields for the createCallLog mutation.
• CreateCannedReplyMutationInputThe input object that defines the fields for the createCannedReply mutation.
• CreateContractMutationInputThe input object that defines the fields for the createContract mutation.
• CreateContractTemplateMutationInputThe input object that defines the fields for the createContractTemplate mutation.
• CreateDepositSlipMutationInputThe input object that defines the fields for the createDepositSlip mutation.
• CreateEmailMessageContentMutationInputThe input object that defines the fields for the createEmailMessageContent mutation.
• CreateIdentityProviderSamlMutationInputThe input object that defines the fields for the createIdentityProviderSaml mutation.
• CreateInboundMailboxMutationInputThe input object that defines the fields for the createInboundMailbox mutation.
• CreateInternalTicketMutationInputThe input object that defines the fields for the createInternalTicket mutation.
• CreateInvoiceMutationInputThe input object that defines the fields for the createInvoice mutation.
• CreateIpAssignmentFromDhcpReservationMutationInputThe input object that defines the fields for the createIpAssignmentFromDhcpReservation mutation.
• CreateIpAssignmentMutationInputThe input object that defines the fields for the createIpAssignment mutation.
• CreateMassEmailMutationInputThe input object that defines the fields for the createMassEmail mutation.
• CreateMassMessageMutationInputThe input object that defines the fields for the createMassMessage mutation.
• CreateNoteMutationInputThe input object that defines the fields for the createNote mutation.
• CreatePublicTicketMutationInputThe input object that defines the fields for the createPublicTicket mutation.
• CreateServiceableAddressAccountAssignmentFutureMutationInputThe input object that defines the fields for the createServiceableAddressAccountAssignmentFuture mutation.
• CreateTaskMutationInputThe input object that defines the fields for the createTask mutation.
• CreateTicketCommentMutationInputThe input object that defines the fields for the createTicketComment mutation.
• CreateTicketReplyMutationInputThe input object that defines the fields for the createTicketReply mutation.
• CreditThe application of a `Discount` or `Payment` against an `Invoice`.
• CreditCardA credit card.
• CreditCardProcessorA company that processes `CreditCard` transactions.
• CreditCardProcessorCredentialCredentials for a `CreditCardProcessor`.
• CustomFieldA user defined field.
• CustomFieldDataData entered into a `CustomField`.
• CustomLinkA user defined link.
• DailyAggregateValueAn aggregated value calculated for a given date.
• DataServiceDetailDetails regarding a specific data `Service`.
• DataUsageHistoryA data usage history entry.
• DataUsageTopOffA data usage top off.
• DebitA debit.
• DelinquencyExclusionA period of time when invoices are not evaluated for delinquency.
• DepartmentA department.
• DeploymentTypeThe mode that an inventory item is deployed in.
• DepositSlipA deposit slip.
• DeviceInterfaceMappingThe interfaces on a device.
• DhcpServerA DHCP server.
• DhcpServerCredentialA credential for a `DhcpServer`.
• DhcpServerIdentifierA specific identifier for a DHCP server.
• DidA direct inward dial (DID).
• DidAssignmentA direct inward dial (DID) assignment.
• DidAssignmentHistoryA historical record of a direct inward dial (DID) assignment.
• DidImportRecipeA recipe for importing DIDs.
• DisbursementA disbursement.
• DisbursementDetailA disbursement detail.
• DisconnectionLogThe `Account` disconnections log.
• DiscountA discount.
• DisputeA dispute.
• DriveTimeResulttypes.drive_time_result
• EmailAn email.
• EmailCategoryA categorization of an `Email` by type.
• EmailClickA single click for a sent email.
• EmailDomainAn email domain.
• EmailLocationThe location of a single opened or clicked email.
• EmailMessageAn email message.
• EmailMessageContentThe localized content of an `EmailMessage`.
• EmailOpenA single open for a sent email.
• EpcAn LTE EPC.
• ExpiringServiceDetailDetails regarding a specific expiring `Service`.
• ExternalMarketingProviderA `ExternalMarketingProviderType` for `ExternalMarketingProvider` 3rd party integration.
• ExternalMarketingProviderCredentialThe `ExternalMarketingProvider` credentials for integration.
• FccForm477ReportA generated FCC Form 477 report.
• FibermapIntegrationFiberMap integration.
• FibermapPlanFiberMap plan.
• FibermapServiceLocationFiberMap service location.
• FileA file.
• FractionalDebitA fractional debit, stored to accurately calculate multi month billing.
• FractionalTaxTransactionA fractional tax transaction, stored to accurately calculate multi month billing.
• GeneralLedgerCodeA general ledger code.
• GenericInventoryAssigneeA generic assignee for inventory items.
• GenericInventoryItemA generic inventory item.
• GenericInventoryItemActionLogA log of an action taken against a set of generic inventory items.
• GeofenceA geographical restriction.
• GeoTaxZoneA geographical tax zone.
• GlobalInventoryModelMinMaxDefines the minimum and maximum of an inventory level for all locations per inventory model.
• GpsTrackingProviderA `GpsTrackingProvider`.
• GpsTrackingProviderCredential`GpsTrackingProvider` credentials.
• HandwrittenSignatureThe signature on a contract.
• IdentityProviderAn identity provider.
• IdentityProviderActiveDirectoryDetailDetails regarding an ActiveDirectory `IdentityProvider`.
• IdentityProviderGoogleDetailDetails regarding a Google `IdentityProvider`.
• IdentityProviderMicrosoftDetailDetails regarding a Microsoft `IdentityProvider`.
• IdentityProviderSamlDetailDetails regarding a SAML `IdentityProvider`.
• ImportAn import.
• ImportCredentialsFlatfileImport credentials for use with Flatfile.
• InboundMailboxAn inbound mailbox.
• IndividualInventoryItemFieldsMutationInputThe input object that defines the fields for the createInventoryItems mutation.
• InlineDeviceA device that sits inline with customer traffic to impose network policy.
• InlineDeviceCredentialAn inline device credential.
• InstanceManagementRequestRequests from Sonar staff to access your Sonar instance.
• IntegrationFieldMappingAn entity which maps an inventory model field to a vendor specific integration field type (ie serial number)
• IntegrationServiceMappingAn entity which maps a service to a vendor specific service name
• InternalLocationA location inside an `InventoryLocation` (e.g. a shelf or a room.)
• InventoryItemAn inventory item.
• InventoryItemEventA tracked event that has occurred for an `InventoryItem`.
• InventoryLocationA location that inventory is stored in.
• InventoryModelA type of item stored in inventory.
• InventoryModelCategoryA category of item stored in inventory.
• InventoryModelFieldA field on an inventory model.
• InventoryModelFieldDataData contained within an inventory item field.
• InventoryModelMinMaxDefines the minimum and maximum of an inventory level per location per inventory model.
• InvoiceAn invoice.
• InvoiceAttachmentA PDF to attach to invoices.
• InvoiceMessageA message that is appended to specific invoices.
• InvoiceTemplateA template for generating invoices.
• InvoiceTemplateVersionA version of a template for generating invoices, preserved for historical purposes.
• IpAssignmentAn IP address assignment.
• IpAssignmentHistoryA historical record of an IP assignment.
• IpPoolAn IP pool, used for single address assignments (e.g. DHCP, PPPoE.)
• JobA job, typically in the field.
• JobCheckInThe record of a check in to a `Job`.
• JobServiceA `Service` associated with a `Job`.
• JobTypeThe type of a `Job`.
• LocalPrefixA local prefix for a voice service.
• LogA log entry.
• LookerExploreLicenseA report builder license.
• LookerViewLicenseA report viewer license.
• LteProviderA provider of LTE provisioning.
• LteProviderCredentialCredentials for an `LteProvider`.
• ManufacturerA manufacturer of an item stored in inventory.
• MapOverlayMap Overlay.
• MassEmailA mass email communication.
• MessageCategoryA categorization of a message by type.
• MonthlyBillingCompletionA record of a monthly billing cycle.
• NetflowAllowedSubnetA subnet allowed to send data to a Netflow endpoint.
• NetflowEndpointA Netflow endpoint.
• NetflowOnPremiseA Netflow on premise record.
• NetflowWhitelistA whitelisted subnet for a Netflow endpoint.
• NetworkMonitoringGraphA `NetworkMonitoringGraph`.
• NetworkMonitoringTemplateA `NetworkMonitoringTemplate`.
• NetworkSiteA network site.
• NetworkSiteServiceableAddressListNetwork site serviceable address list.
• NonInventoryItemAn item purchasable from vendors that does not have an `Inventory Model` associated with it
• NoteA note.
• NoteMutationInputAllows the addition of a note to the parent entity.
• NotificationA `Notification`.
• NotificationSettingA user's notification setting.
• OrderGroupAn order group.
• OrderGroupUserThe relationship between an order group and a user.
• OverageServiceDetailDetails regarding a specific overage `Service`.
• PackageA collection of `Service`s.
• PackageServiceThe relationship between a `Package` and a `Service`.
• PasswordPolicyA password policy that defines password requirements.
• PaymentA payment.
• PayPalCredentialPaypal credentials for external payments.
• PersonalAccessTokenAn access token for the API.
• PhoneNumberA phone number.
• PhoneNumberTypeA phone number type (e.g. mobile, home, work.)
• PollerA `Poller`.
• PollerSettingPoller configuration settings.
• PreseemPreseem integration.
• PrintedInvoiceBatchA single PDF containing multiple invoices for printing.
• PrintToMailBatchA batch of invoices to mail and print.
• PrintToMailOrderThe print to mail order.
• PrintToMailOrderErrorAn error associated with the print to mail order.
• PrintToMailSettingPrint to mail configuration settings.
• PurchaseOrderA purchase order for items from a third party vendor.
• PurchaseOrderItemA line item on a purchase order.
• Querynull
• RadiusAccountA RADIUS account.
• RadiusGroupA RADIUS group.
• RadiusGroupReplyAttributeA RADIUS group reply attribute.
• RadiusServerA RADIUS server.
• RadiusServerCredentialA RADIUS server credential.
• RadiusSessionHistoryThe history of a RADIUS session.
• RateCenterA rate center.
• RecentItemA recently viewed entity.
• RecurringServiceDetailDetails regarding a specific recurring `Service`.
• RefundedPaymentA record of a refund applied to a `Payment`.
• ReversedPaymentA record a `Payment` reversal.
• RoleA role defines the permission set that a user has.
• SavedMessageCategorySaved message category.
• ScheduleAddressThe geographical point that a technician starts or ends their day at.
• ScheduleAvailabilityAvailability for `Job`s to be scheduled.
• ScheduleAvailabilityDayTimeA day and time associated with a `ScheduleAvailability`.
• ScheduleBlockerAn event that blocks off part of a calendar otherwise availability due to `ScheduleAvailability`.
• ScheduleBlockerDayTimeA day and time associated with a `ScheduleBlocker`.
• ScheduleBlockerOverrideAn override to a particular day and time a `ScheduleBlocker` would otherwise cover.
• ScheduledEventAn `Account` event that is run at a specific time.
• ScheduledEventAccountCalixServiceDetailThe `AccountCalixServiceDetail` records used to configure the Calix integrations when a `ScheduledEvent` is executed.
• ScheduledEventAccountVoiceServiceDetailThe `AccountVoiceServiceDetail` records used to configure a voice service when a `ScheduledEvent` is executed.
• ScheduleTimeOffTime off that removes availability from a `ScheduleAvailability`.
• SearchFilterA user-defined search filter that applies to a specific type of entity.
• SendgridDynamicTemplateExternalReferenceAn external reference to a dynamic template at SendGrid.
• ServiceA service.
• ServiceableAddressAccountAssignmentFutureAn expected change of serviceable address account assignment.
• ServiceableAddressAccountAssignmentHistoryA `ServiceableAddressAccountAssignmentHistory` for accounts and addresses.
• ServiceMetadataFields that store metadata about individual instances of `Service`s.
• ServiceMetadataValueThe value of a `ServiceMetadata` field, as it relates to a specific `Service` on a specific `Account`.
• ServiceTaxThe relationship between a `Service` and a `Tax`.
• ServiceTaxDefinitionThe relationship between a `Service` and a `TaxDefinition`.
• SignatureA signature.
• SmsMessageAn SMS message.
• SmsMessageContentAn SMS message content.
• SmsOutboundMessageAn SMS outbound message.
• SmsSettingSMS configuration settings.
• SmtpEventA single SMTP event for an email.
• SnmpOidAn `SnmpOid`.
• SnmpOidThresholdAn `SnmpOidThreshold`.
• SnmpOidThresholdViolationAn `SnmpOidThresholdViolation`.
• SnmpOverrideAn `SnmpOverride`.
• StoredFilterA filter applied in a `StoredView`.
• StoredGroupA group of filters in a `StoredView`.
• StoredViewA stored view.
• StoredViewUserA `StoredView` associated with a `User`.
• SubnetAn IPv4/IPv6 subnet.
• SubscriptionA subscription to notifications for an entity.
• SuccessResponseReturned when the result of a mutation is only true or false, and there is no other data to return. The `message` property can sometimes contain a description of the failure, if `success` is false.
• SuccessResponseWithIdReturned when the result of a mutation is not consistent. The `message` property can sometimes contain a description of the failure, if `success` is false. The id may contain the model created if `success` is true.
• SupernetThe largest example of a unique subnet on your network. A supernet contains many subnets. An example of a supernet is 10.0.0.0/8.
• SystemBackupA backup of your Sonar instance's data.
• SystemBackupDestinationA configured destination to export system backups to.
• SystemBackupDestinationCredentialA credential used to authenticate against configured destinations to export system backups to.
• SystemBackupExportA log of a system backup export attempt.
• SystemBackupSettingThe settings for system backups in your Sonar instance.
• SystemSettingSystem configuration settings.
• TaskA task.
• TaskMutationInputThe input object that defines the fields for the createTask mutation.
• TaskTemplateA `task template`.
• TaskTemplateItemA `task template item`.
• TaxA tax.
• TaxExemptionA tax exemption.
• TaxOverrideAn override to the default taxation rate.
• TaxProviderA tax provider.
• TaxProviderCredentialCredentials for a `TaxProvider`.
• TaxTransactionA tax transaction.
• TicketA ticket.
• TicketCategoryA ticket category.
• TicketCommentA comment on a `Ticket`.
• TicketGroupA ticket group.
• TicketingSettingTicketing configuration settings.
• TicketRecipientA ticket recipient.
• TicketReplyA reply on a `Ticket`.
• TowercoverageConfigurationTowerCoverage integration.
• TowercoverageSubmissionA TowerCoverage submission.
• TriggeredEmailAn `Email` that is sent when a particular event occurs.
• TriggeredMessageA message that is sent when a specific event occurs.
• UninventoriedMacAddressA MAC address that is not recorded in the inventory system.
• UpdateCalixCloudSettingMutationInputThe input object that defines the fields for the updateCalixCloudSetting mutation.
• UpdateCallLogMutationInputThe input object that defines the fields for the updateCallLog mutation.
• UpdateCannedReplyMutationInputThe input object that defines the fields for the updateCannedReply mutation.
• UpdateContractMutationInputThe input object that defines the fields for the updateContract mutation.
• UpdateContractTemplateMutationInputThe input object that defines the fields for the updateContractTemplate mutation.
• UpdateDepositSlipMutationInputThe input object that defines the fields for the updateDepositSlip mutation.
• UpdateEmailMessageContentMutationInputThe input object that defines the fields for the updateEmailMessageContent mutation.
• UpdateIdentityProviderSamlMutationInputThe input object that defines the fields for the updateIdentityProviderSaml mutation.
• UpdateInboundMailboxMutationInputThe input object that defines the fields for the updateInboundMailbox mutation.
• UpdateIpAssignmentMutationInputThe input object that defines the fields for the updateIpAssignment mutation.
• UpdateJobMutationInputThe input object that defines the fields for the updateJob mutation.
• UpdateMeMutationInputThe input object that defines the fields for the updateMe mutation.
• UpdateNetflowOnPremiseMutationInputThe input object that defines the fields for the updateNetflowOnPremise mutation.
• UpdateNoteMutationInputThe input object that defines the fields for the updateNote mutation.
• UpdatePreseemMutationInputThe input object that defines the fields for the updatePreseem mutation.
• UpdateServiceableAddressAccountAssignmentFutureMutationInputThe input object that defines the fields for the updateServiceableAddressAccountAssignmentFuture mutation.
• UpdateTaskMutationInputThe input object that defines the fields for the updateTask mutation.
• UpdateTicketCommentMutationInputThe input object that defines the fields for the updateTicketComment mutation.
• UpdateTicketMutationInputThe input object that defines the fields for the updateTicket mutation.
• UpdateTowercoverageConfigurationInputThe input object that defines the fields for the updateTowercoverageConfiguration mutation.
• UsageBasedBillingPolicyA usage based billing policy.
• UsageBasedBillingPolicyFreePeriodA period of free time in a `UsageBasedBillingPolicy`.
• UserA user that can login to Sonar.
• UserPreferencenull
• VehicleA vehicle.
• VehicleLocationHistoryA history of where the vehicle has travelled.
• VendorA third party vendor of inventory models.
• VendorItemAn item that can be purchased from a particular vendor.
• VoiceProviderA `VoiceProvider`.
• VoiceProviderRateA voice provider rate.
• VoiceProviderRateImportAn import of voice provider rates.
• VoiceProviderRateImportRecipeA recipe for importing voice provider rates.
• VoiceServiceDetailDetails regarding a specific voice `Service`.
• VoiceServiceGenericParameterA configurable attribute for a voice service.
• VoiceServiceGenericParameterTaxThe relationship between a `VoiceServiceGenericParameter` and a `Tax`.
• VoiceServiceGenericParameterTaxDefinitionThe relationship between a `VoiceServiceGenericParameter` and a `TaxDefinition`.
• VoidedPaymentA record of a `Payment` that was voided.
• WebhookEndpointA URL to an endpoint that a webhook can be sent to.
• WebhookEndpointEventAn event on a model that can fire a webhook
• WebhookEndpointEventDispatchA webhook for a model and event that has been queued to be sent.
• WebhookEndpointEventDispatchAttemptA send attempt of a dispatched webhook for a model and event.