OBJECT

AccountGroup

An account group.

link GraphQL Schema definition

  • type AccountGroup implements NoteableInterface, LoggableInterface, AccessloggableInterface {
  • # The ID of the entity.
  • id: Int64Bit!
  • # An ID that uniquely identifies this entity across the whole Sonar system.
  • sonar_unique_id: ID!
  • # The date and time this entity was created.
  • created_at: Datetime!
  • # The last date and time this entity was modified.
  • updated_at: Datetime!
  • # A string that shows the version of this entity. It will be incremented whenever
  • # the entity is modified.
  • _version: String!
  • # A descriptive name.
  • name: String!
  • # A customer account.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # account_status_id: The ID of an AccountStatus.
  • # account_type_id: The ID of an AccountType.
  • # activation_date: The date an account was first activated.
  • # activation_time: The time an account was first activated.
  • # company_id: The ID of the company that this entity operates
  • # under.
  • # data_usage_percentage: The percentage of the data usage cap
  • # that this account has consumed this month, taking into account any data usage
  • # top offs.
  • # geopoint: A geo-point.
  • # is_delinquent: Whether or not this account is delinquent.
  • # name: A descriptive name.
  • # next_bill_date: The next date this service will bill. If this
  • # is null, it will bill on the next account billing date.
  • # next_recurring_charge_amount: The next recurring charge amount
  • # for an account. This is the sum of data, expiring, recurring, and voice services
  • # of an account for this billing cycle, including tax.
  • # parent_account_id: The ID of the `Account` that is this
  • # `Account`s master.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • accounts(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_status_id: Int64Bit,
  • account_type_id: Int64Bit,
  • activation_date: Date,
  • activation_time: Time,
  • company_id: Int64Bit,
  • data_usage_percentage: Int,
  • geopoint: Geopoint,
  • is_delinquent: Boolean,
  • name: String,
  • next_bill_date: Date,
  • next_recurring_charge_amount: Int,
  • parent_account_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccountConnection!
  • # A service.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # amount: The amount, in the smallest currency value (e.g. cents,
  • # pence, pesos.)
  • # application: How this is applied.
  • # company_id: The ID of the company that this entity operates
  • # under.
  • # display_if_zero: If the amount for this service is zero, it
  • # will still display on invoices.
  • # enabled: Whether or not this is enabled.
  • # general_ledger_code_id: The ID of a GeneralLedgerCode.
  • # name: A descriptive name.
  • # reverse_tax_definition_id: The ID of a tax definition on a
  • # reversed transaction.
  • # tax_definition_id: The ID of a tax definition on a transaction.
  • # type: The type.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • services(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • amount: Int,
  • application: ServiceApplication,
  • company_id: Int64Bit,
  • display_if_zero: Boolean,
  • enabled: Boolean,
  • general_ledger_code_id: Int64Bit,
  • name: String,
  • reverse_tax_definition_id: Int64Bit,
  • tax_definition_id: Int64Bit,
  • type: ServiceType,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ServiceConnection!
  • # An address list defines some criteria by which to group accounts for network
  • # policy enforcement.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # account_status: The types of account statuses for accounts that
  • # are part of this grouping.
  • # delinquency: The delinquency state for accounts that are part
  • # of this grouping.
  • # name: A descriptive name.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • address_lists(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_status: AddressListAccountStatus,
  • delinquency: AddressListDelinquency,
  • name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AddressListConnection!
  • # A RADIUS group.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # account_status: The types of account statuses for accounts that
  • # are part of this grouping.
  • # delinquency: The delinquency state for accounts that are part
  • # of this grouping.
  • # fall_through: Whether or not this is a fall through group.
  • # name: A descriptive name.
  • # priority: The RADIUS priority.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • radius_groups(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_status: AddressListAccountStatus,
  • delinquency: AddressListDelinquency,
  • fall_through: Boolean,
  • name: String,
  • priority: Int,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): RadiusGroupConnection!
  • # An alerting rotation.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # all_accounts: Whether to include all account equipment in this
  • # rotation.
  • # all_inventory_models: Whether to include all inventory models
  • # in this rotation.
  • # all_network_sites: Whether to include all network site
  • # equipment in this rotation.
  • # down_time_in_minutes_before_alerting: The number of minutes a
  • # device can be in a down state before generating alert.
  • # down_time_in_minutes_before_repeat: The number of minutes a
  • # device can remain in a down state before sending a repeat alert.
  • # enabled: Whether or not this is enabled.
  • # infinite_repetitions: Whether this repeats forever or not.
  • # name: A descriptive name.
  • # repetitions: The number of times this repeats.
  • # start: The start.
  • # warning_time_in_minutes_before_alerting: The number of minutes
  • # a device can be in a warning state before generating alert.
  • # warning_time_in_minutes_before_repeat: The number of minutes a
  • # device can remain in a warning state before sending a repeat alert.
  • # weeks_between_repetitions: The number of weeks between
  • # repetitions.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • alerting_rotations(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • all_accounts: Boolean,
  • all_inventory_models: Boolean,
  • all_network_sites: Boolean,
  • down_time_in_minutes_before_alerting: Int,
  • down_time_in_minutes_before_repeat: Int,
  • enabled: Boolean,
  • infinite_repetitions: Boolean,
  • name: String,
  • repetitions: Int,
  • start: Date,
  • warning_time_in_minutes_before_alerting: Int,
  • warning_time_in_minutes_before_repeat: Int,
  • weeks_between_repetitions: Int,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AlertingRotationConnection!
  • # A note.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # message: The message.
  • # noteable_id: The ID of the entity that owns this note.
  • # noteable_type: The type of entity that owns this note.
  • # priority: The priority of this item.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • notes(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • message: Text,
  • noteable_id: Int64Bit,
  • noteable_type: NoteableType,
  • priority: NotePriority,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): NoteConnection!
  • # A log entry.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # current: Current data.
  • # legacy: Whether or not this log was transferred from a Sonar v1
  • # instance. If so, the formatting will not match current version logs.
  • # legacy_title: A title which is only populated on logs that were
  • # imported from Sonar v1.
  • # level: The severity level.
  • # loggable_id: The ID of the entity that this log is attached to.
  • # loggable_type: The type of entity that this log is attached to.
  • # logged_entity_id: The entity ID that triggered the log.
  • # logged_entity_type: The entity that triggered the log.
  • # message: The message.
  • # previous: Previous data.
  • # relation_data: Data from objects related to this change.
  • # type: The type.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • logs(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • current: Text,
  • legacy: Boolean,
  • legacy_title: String,
  • level: LogLevel,
  • loggable_id: Int64Bit,
  • loggable_type: String,
  • logged_entity_id: Int64Bit,
  • logged_entity_type: String,
  • message: Text,
  • previous: Text,
  • relation_data: Text,
  • type: LogType,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): LogConnection!
  • # An access log history on an entity.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # access_datetime: The date and time that this entity was
  • # accessed.
  • # accessloggable_id: The ID of the entity that this access log
  • # belongs to.
  • # accessloggable_type: The entity that this access log belongs
  • # to.
  • # entity_id: The ID of the entity that this access log belongs
  • # to.
  • # entity_name: The entity that this access log belongs to.
  • # user_id: The ID of the user that accessed this entity.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • access_logs(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • access_datetime: Datetime,
  • accessloggable_id: Int64Bit,
  • accessloggable_type: String,
  • entity_id: Int64Bit,
  • entity_name: String,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccessLogConnection!
  • }