OBJECT
Package

A collection of Services.
GraphQL Schema definition

type Package 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! 
#   The ID of the company that this entity operates under.
company_id: Int64Bit 
#   Whether or not this is enabled.
enabled: Boolean! 
#   A descriptive name.
name: String! 
#   Setting to indicate if services in this package should be rolled up into a 
#   package total when this package is displayed.
rollup_services: Boolean! 
#   A company you do business as.
# 
# 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.
#   billing_communication_delay_end_local_time: The daily end time 
#   of the period during which billing communication e.g. new invoices, delinquency, 
#   etc. will not be sent.
#   billing_communication_delay_start_local_time: The daily start 
#   time of the period during which billing communication e.g. new invoices, 
#   delinquency, etc. will not be sent.
#   checks_payable_to: On an enabled remittance slip, who should 
#   checks be made payable to?
#   country: A two character country code.
#   customer_portal_url: The URL to your customer portal.
#   default: Whether or not this entity is a default entry.
#   enabled: Whether or not this is enabled.
#   isp_type: The ISP type of this `Company`.
#   name: A descriptive name.
#   phone_number: A telephone number.
#   primary_color: The primary color to use in Sonar.
#   secondary_color: The secondary color to use in Sonar.
#   show_remittance_slip: Whether or not to include a detachable 
#   remittance slip on the invoice.
#   tax_identification: A tax identification number. Should only be 
#   entered if you are required to share some type of tax identification information 
#   with your customers.
#   website_address: The address of the company website.
#   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.
company(
id: Int64Bit,
sonar_unique_id: ID,
created_at: Datetime,
updated_at: Datetime,
_version: String,
billing_communication_delay_end_local_time: Time,
billing_communication_delay_start_local_time: Time,
checks_payable_to: String,
country: Country,
customer_portal_url: URL,
default: Boolean,
enabled: Boolean,
isp_type: IspType,
name: String,
phone_number: Numeric,
primary_color: HtmlHexColor,
secondary_color: HtmlHexColor,
show_remittance_slip: Boolean,
tax_identification: String,
website_address: URL,
paginator: Paginator,
sorter: [Sorter],
search: [Search],
general_search: String,
aggregation: [Aggregator],
reverse_relation_filters: [ReverseRelationFilter]
): Company 
#   The relationship between an `Account` and 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.
#   account_id: The ID of an Account.
#   addition_prorate_date: If this service was prorated when added, 
#   this is the date it was prorated from.
#   data_usage_last_calculated_date: The date data usage was last 
#   calculated.
#   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.
#   is_additional: Whether or not this account service is an 
#   additional service.
#   name_override: Overriding the service name will alter the 
#   service name printed on an invoice.
#   next_bill_date: The next date this service will bill. If this 
#   is null, it will bill on the next account billing date.
#   number_of_times_billed: The number of billing cycles that have 
#   already been consumed by this particular service. This is only used for expiring 
#   services. NOTE: Typically this is the number of times billed but the value may 
#   be modified manually to adjust service expiration. See also the the 
#   `ExpiringServiceDetail` `times_to_run` field.
#   package_id: The ID of a `Package`.
#   price_override: The amount that this service price has been 
#   overridden to. If this is null, then the service price is used.
#   price_override_reason: The reason that the price of a service 
#   has been overridden.
#   quantity: The quantity for this service.
#   service_id: The ID of a Service.
#   unique_package_relationship_id: A unique ID that describes this 
#   unique instance of a `Package` assignment.
#   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.
account_services(
id: Int64Bit,
sonar_unique_id: ID,
created_at: Datetime,
updated_at: Datetime,
_version: String,
account_id: Int64Bit,
addition_prorate_date: Date,
data_usage_last_calculated_date: Date,
data_usage_percentage: Int,
is_additional: Boolean,
name_override: String,
next_bill_date: Date,
number_of_times_billed: Int,
package_id: Int64Bit,
price_override: Int,
price_override_reason: String,
quantity: Int,
service_id: Int64Bit,
unique_package_relationship_id: String,
paginator: Paginator,
sorter: [Sorter],
search: [Search],
general_search: String,
aggregation: [Aggregator],
reverse_relation_filters: [ReverseRelationFilter]
): AccountServiceConnection! 
#   A billing package.
# 
# 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.
#   billing_default_id: The ID of a BillingDefault.
#   name_override: Overriding the service name will alter the 
#   service name printed on an invoice.
#   package_id: The ID of a `Package`.
#   rollup_services_override: Overriding the setting to indicate if 
#   services in this package should be rolled up into a package total when this 
#   package is displayed.
#   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.
billing_packages(
id: Int64Bit,
sonar_unique_id: ID,
created_at: Datetime,
updated_at: Datetime,
_version: String,
billing_default_id: Int64Bit,
name_override: String,
package_id: Int64Bit,
rollup_services_override: Boolean,
paginator: Paginator,
sorter: [Sorter],
search: [Search],
general_search: String,
aggregation: [Aggregator],
reverse_relation_filters: [ReverseRelationFilter]
): BillingPackageConnection! 
#   The relationship between a `Package` and 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.
#   package_id: The ID of a `Package`.
#   quantity: The quantity for this service.
#   service_id: The ID of a Service.
#   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.
package_services(
id: Int64Bit,
sonar_unique_id: ID,
created_at: Datetime,
updated_at: Datetime,
_version: String,
package_id: Int64Bit,
quantity: Int,
service_id: Int64Bit,
paginator: Paginator,
sorter: [Sorter],
search: [Search],
general_search: String,
aggregation: [Aggregator],
reverse_relation_filters: [ReverseRelationFilter]
): PackageServiceConnection! 
#   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! 
}
Package

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
