OBJECT

Service

A service.

link GraphQL Schema definition

  • type Service 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 amount, in the smallest currency value (e.g. cents, pence, pesos.)
  • amount: Int
  • # How this is applied.
  • application: ServiceApplication!
  • # The ID of the company that this entity operates under.
  • company_id: Int64Bit
  • # If the amount for this service is zero, it will still display on invoices.
  • display_if_zero: Boolean!
  • # Whether or not this is enabled.
  • enabled: Boolean!
  • # The ID of a GeneralLedgerCode.
  • general_ledger_code_id: Int64Bit
  • # A descriptive name.
  • name: String!
  • # The ID of a tax definition on a reversed transaction.
  • reverse_tax_definition_id: Int64Bit
  • # The ID of a tax definition on a transaction.
  • tax_definition_id: Int64Bit
  • # The type.
  • type: ServiceType!
  • # Details regarding a specific recurring `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.
  • # billing_frequency: How often this service bills, in months.
  • # 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.
  • recurring_service_detail(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • billing_frequency: Int,
  • service_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): RecurringServiceDetail
  • # Details regarding a specific expiring `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.
  • # billing_frequency: How often this service bills, in months.
  • # service_id: The ID of a Service.
  • # times_to_run: The number of times this expiring service should
  • # run.
  • # 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.
  • expiring_service_detail(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • billing_frequency: Int,
  • service_id: Int64Bit,
  • times_to_run: Int,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ExpiringServiceDetail
  • # Details about an adjustment `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 that can be adjusted using this service
  • # within the period defined in `adjustment_service_days`.
  • # days: The period of time in which transactions are tracked to
  • # calculate against the total defined in `adjustment_service_amount`.
  • # 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.
  • adjustment_service_detail(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • amount: Int,
  • days: Int,
  • service_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AdjustmentServiceDetail
  • # Details regarding a specific data `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.
  • # billing_frequency: How often this service bills, in months.
  • # download_speed_kilobits_per_second: The download speed of the
  • # service in kilobits per second.
  • # service_id: The ID of a Service.
  • # technology_code: The FCC technology code for the service. Only
  • # relevant to US ISPs filing FCC Form 477.
  • # telrad_global_service_profile_name: The global service profile
  • # name for this service if using Telrad provisioning.
  • # upload_speed_kilobits_per_second: The upload speed of the
  • # service in kilobits per second.
  • # usage_based_billing_policy_id: The ID of a
  • # `UsageBasedBillingPolicy`.
  • # 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.
  • data_service_detail(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • billing_frequency: Int,
  • download_speed_kilobits_per_second: Int,
  • service_id: Int64Bit,
  • technology_code: TechnologyCode,
  • telrad_global_service_profile_name: String,
  • upload_speed_kilobits_per_second: Int,
  • usage_based_billing_policy_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DataServiceDetail
  • # Details regarding a specific voice `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.
  • # billing_frequency: How often this service bills, in months.
  • # cost_per_minute_local_in_thousandths: The cost per minute for
  • # local calls, in thousandths of the smallest currency value (e.g. cents, pence,
  • # pesos.).
  • # cost_per_minute_long_distance_in_thousandths: The cost per
  • # minute for long distance calls, in thousandths of the smallest currency value
  • # (e.g. cents, pence, pesos.).
  • # country: A two character country code.
  • # first_interval_in_seconds: This is the minimum amount of time
  • # the customer will be charged for a call.
  • # inbound_toll_free_rate_per_minute_in_thousandths: If a customer
  • # has a toll free number, this is the rate charged to them for inbound calls, in
  • # thousandths of the smallest currency value (e.g. cents, pence, pesos.).
  • # local_minutes: The quantity of free local minutes provided, if
  • # `unlimited_local_minutes` is false.
  • # long_distance_minutes: The quantity of free long distance
  • # minutes provided, if `unlimited_long_distance_minutes` is false.
  • # rollup_generic_parameters: Hide parameters of this service on
  • # customer invoices/statements and in the customer portal.
  • # service_id: The ID of a Service.
  • # show_call_detail_records_on_invoice: Indicates if Call Detail
  • # Records (CDRs) for this service should be displayed on an invoice.
  • # sub_interval_in_seconds: After the `first_interval_in_seconds`
  • # time is exceeded, this is the minimum amount of subsequent time. For example, if
  • # `first_interval_in_seconds` is 30, and `sub_interval_in_seconds` is 6, then a 31
  • # second call would be charged at 36 seconds, and a 37 second call would be
  • # charged at 42 seconds.
  • # sub_type: The sub type of this voice service.
  • # unlimited_local_minutes: Whether this service provides
  • # unlimited local minutes.
  • # unlimited_long_distance_minutes: Whether this service provides
  • # unlimited long distance minutes.
  • # 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.
  • voice_service_detail(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • billing_frequency: Int,
  • cost_per_minute_local_in_thousandths: Int,
  • cost_per_minute_long_distance_in_thousandths: Int,
  • country: Country,
  • first_interval_in_seconds: Int,
  • inbound_toll_free_rate_per_minute_in_thousandths: Int,
  • local_minutes: Int,
  • long_distance_minutes: Int,
  • rollup_generic_parameters: Boolean,
  • service_id: Int64Bit,
  • show_call_detail_records_on_invoice: Boolean,
  • sub_interval_in_seconds: Int,
  • sub_type: VoiceServiceDetailSubType,
  • unlimited_local_minutes: Boolean,
  • unlimited_long_distance_minutes: Boolean,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): VoiceServiceDetail
  • # Details regarding a specific overage `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.
  • # gigabytes: A value in gigabytes.
  • # 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.
  • overage_service_detail(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • gigabytes: Int,
  • service_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): OverageServiceDetail
  • # A general ledger code.
  • #
  • # 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.
  • # code: A code.
  • # description: A human readable description.
  • # 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.
  • general_ledger_code(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • code: String,
  • description: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): GeneralLedgerCode
  • # 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.
  • # 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,
  • 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.
  • # 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 times this particular
  • # service has been billed to the customer. This is only used for expiring
  • # services.
  • # 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,
  • 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!
  • # The service items and overrides for linked billing defaults.
  • #
  • # 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.
  • # anchor_subsidy: The amount of the service that will be invoiced
  • # to the anchor account. Cannot exceed price provided.
  • # billing_default_id: The ID of a BillingDefault.
  • # name_override: Overriding the service name will alter the
  • # service name printed on an invoice.
  • # price: The price per unit of this item.
  • # 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.
  • billing_services(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • anchor_subsidy: Int,
  • billing_default_id: Int64Bit,
  • name_override: String,
  • price: Int,
  • service_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): BillingServiceConnection!
  • # Fields that store metadata about individual instances of `Service`s.
  • #
  • # 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.
  • # name: A descriptive name.
  • # 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.
  • service_metadata(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • name: String,
  • service_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ServiceMetadataConnection!
  • # A discount.
  • #
  • # 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.
  • # amount: The amount of the `Discount`.
  • # amount_remaining: The amount remaining that can be used.
  • # company_id: The ID of the company that this entity operates
  • # under.
  • # debit_id: If this discount was created due to reversal of a
  • # `Debit`, this field will link to the reversed `Debit`.
  • # description: A human readable description.
  • # general_ledger_code: A general ledger code.
  • # general_ledger_code_description: A general ledger code
  • # description.
  • # minutes: The total number of minutes.
  • # prorated_from: The date this transaction was prorated from.
  • # prorated_to: The date this transaction was prorated to.
  • # quantity: The quantity for this service.
  • # quantity_prorated_from: The quantity the associated service had
  • # before the quantity was changed and prorated.
  • # quantity_prorated_to: The quantity the associated service was
  • # changed to when the quantity was changed and prorated.
  • # reversed: Whether or not this has been reversed.
  • # reversed_at: When this was reversed.
  • # reversed_by_user_id: The user ID that reversed this.
  • # service_id: The ID of a Service.
  • # service_name: The name of a service.
  • # service_transaction_type: The type of transaction on this
  • # service.
  • # tax_committed: Whether this entity's taxes have been committed
  • # or not.
  • # tax_provider_id: The ID of an `TaxProvider`.
  • # type: The type.
  • # user_id: The ID of the user who created this transaction.
  • # 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.
  • discounts(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • amount: Int,
  • amount_remaining: Int,
  • company_id: Int64Bit,
  • debit_id: Int64Bit,
  • description: String,
  • general_ledger_code: String,
  • general_ledger_code_description: String,
  • minutes: Float,
  • prorated_from: Date,
  • prorated_to: Date,
  • quantity: Int,
  • quantity_prorated_from: Int,
  • quantity_prorated_to: Int,
  • reversed: Boolean,
  • reversed_at: Datetime,
  • reversed_by_user_id: Int64Bit,
  • service_id: Int64Bit,
  • service_name: String,
  • service_transaction_type: ServiceTransactionType,
  • tax_committed: Boolean,
  • tax_provider_id: Int64Bit,
  • type: ServiceType,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DiscountConnection!
  • # A debit.
  • #
  • # 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.
  • # amount: The amount, in the smallest currency value (e.g. cents,
  • # pence, pesos.)
  • # company_id: The ID of the company that this entity operates
  • # under.
  • # description: A human readable description.
  • # general_ledger_code: A general ledger code.
  • # general_ledger_code_description: A general ledger code
  • # description.
  • # invoice_id: The ID of an `Invoice`.
  • # linked_debit_id: The ID of the Debit which is linked to the
  • # current Debit.
  • # minutes: The total number of minutes.
  • # number_of_months: The number of months of service this invoice
  • # was billed for.
  • # prorated_from: The date this transaction was prorated from.
  • # prorated_to: The date this transaction was prorated to.
  • # quantity: The quantity for this service.
  • # quantity_prorated_from: The quantity the associated service had
  • # before the quantity was changed and prorated.
  • # quantity_prorated_to: The quantity the associated service was
  • # changed to when the quantity was changed and prorated.
  • # reversed: Whether or not this has been reversed.
  • # reversed_at: When this was reversed.
  • # reversed_by_user_id: The user ID that reversed this.
  • # service_id: The ID of a Service.
  • # service_name: The name of a service.
  • # service_transaction_type: The type of transaction on this
  • # service.
  • # type: The type.
  • # user_id: The ID of the user who created this transaction.
  • # voice_service_generic_parameter_id: The ID of a voice service
  • # configuration parameter.
  • # 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.
  • debits(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • amount: Int,
  • company_id: Int64Bit,
  • description: String,
  • general_ledger_code: String,
  • general_ledger_code_description: String,
  • invoice_id: Int64Bit,
  • linked_debit_id: Int64Bit,
  • minutes: Float,
  • number_of_months: Int,
  • prorated_from: Date,
  • prorated_to: Date,
  • quantity: Int,
  • quantity_prorated_from: Int,
  • quantity_prorated_to: Int,
  • reversed: Boolean,
  • reversed_at: Datetime,
  • reversed_by_user_id: Int64Bit,
  • service_id: Int64Bit,
  • service_name: String,
  • service_transaction_type: ServiceTransactionType,
  • type: ServiceType,
  • user_id: Int64Bit,
  • voice_service_generic_parameter_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DebitConnection!
  • # A direct inward dial (DID) assignment.
  • #
  • # 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.
  • # did_id: The ID of a `Did`.
  • # 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.
  • did_assignments(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • did_id: Int64Bit,
  • service_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DidAssignmentConnection!
  • # A historical record of a direct inward dial (DID) assignment.
  • #
  • # 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.
  • # assigned_datetime: The date and time of assignment.
  • # did_assignment_id: The ID of a `DidAssignment`.
  • # did_id: The ID of a `Did`.
  • # removed_datetime: The date and time of removal.
  • # 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.
  • did_assignment_histories(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • assigned_datetime: Datetime,
  • did_assignment_id: Int64Bit,
  • did_id: Int64Bit,
  • removed_datetime: Datetime,
  • service_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DidAssignmentHistoryConnection!
  • # The relationship between a `Service` and a `Tax`.
  • #
  • # 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.
  • # exemption_amount: The amount of the service that is exempt from
  • # taxation in the smallest currency value (e.g. cents, pence, pesos.)
  • # service_id: The ID of a Service.
  • # tax_id: The ID of a Tax.
  • # 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.
  • service_taxes(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • exemption_amount: Int,
  • service_id: Int64Bit,
  • tax_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ServiceTaxConnection!
  • # The `TaxDefinition` pair associated to this 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.
  • # discount: Whether this tax definition is for a discount or not.
  • # service_id: The ID of a Service.
  • # taxdefinitionable_id: The ID of entity this tax definition is
  • # related to.
  • # taxdefinitionable_type: The type of entity this tax definition
  • # is related to.
  • # 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.
  • tax_definitions(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • discount: Boolean,
  • service_id: Int64Bit,
  • taxdefinitionable_id: Int64Bit,
  • taxdefinitionable_type: TaxdefinitionableType,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ServiceTaxDefinitionConnection!
  • # A `Service` associated with a `Job`.
  • #
  • # 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.
  • # job_id: The ID of a `Job`.
  • # 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.
  • job_services(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • job_id: Int64Bit,
  • quantity: Int,
  • service_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): JobServiceConnection!
  • # 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 usage based billing policy.
  • #
  • # 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.
  • # allow_purchase_of_additional_capacity_during_billing_period:
  • # Whether or not a customer can purchase additional data usage capacity during a
  • # billing period.
  • # assess_charges_at_end_of_billing_period: Whether or not to
  • # assess charges for usage over the bandwidth limit at the end of the billing
  • # period.
  • # cap_in_gigabytes: The available data usage in this policy,
  • # measured in gigabytes.
  • # name: A descriptive name.
  • # rollover_enabled: Whether or not rollover is enabled.
  • # rollover_expiration_enabled: Whether or not rollover expiration
  • # is enabled.
  • # rollover_expiration_months: Rollover expires after this many
  • # months, if rollover expiration is enabled.
  • # 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.
  • usage_based_billing_policies(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • allow_purchase_of_additional_capacity_during_billing_period: Boolean,
  • assess_charges_at_end_of_billing_period: Boolean,
  • cap_in_gigabytes: Int,
  • name: String,
  • rollover_enabled: Boolean,
  • rollover_expiration_enabled: Boolean,
  • rollover_expiration_months: Int,
  • service_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): UsageBasedBillingPolicyConnection!
  • # A set of vendor items attached to 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.
  • # archived: Archived vendor items may not be used for creating
  • # new purchase orders or product requests.
  • # name: A descriptive name.
  • # part_number: Part number used by the vendor to identify this
  • # vendor item.
  • # price: The purchase price of this item from the vendor.
  • # quantity_per_unit: Number of inventory models that are included
  • # in a single unit of this vendors product.
  • # retail_item: Flag for vendor items that should create a
  • # one-time service for retail sale to customers.
  • # retail_item_price: The price of the one-time service created
  • # for this vendor item
  • # retail_item_service_id: The ID of the one-time service created
  • # when this vendor item was created.
  • # vendor_id: The ID of the vendor that sells this item
  • # vendoritemable_id: The ID of the entity that is referred to by
  • # this vendor item.
  • # vendoritemable_type: The type of entity that is referred to by
  • # this vendor item.
  • # 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.
  • vendor_items(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • archived: Boolean,
  • name: String,
  • part_number: String,
  • price: Int,
  • quantity_per_unit: Int,
  • retail_item: Boolean,
  • retail_item_price: Int,
  • retail_item_service_id: Int64Bit,
  • vendor_id: Int64Bit,
  • vendoritemable_id: Int64Bit,
  • vendoritemable_type: VendoritemableType,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): VendorItemConnection!
  • # An entity which maps a service to a vendor specific service name
  • #
  • # 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.
  • # integrationconfigurable_id: The ID of the configuration entity
  • # which owns this mapping.
  • # integrationconfigurable_type: The type of the configuration
  • # entity which owns this mapping.
  • # policy_map: Policy Map.
  • # service_id: The ID of a Service.
  • # service_template_name: The service name in vendor system this
  • # mapping refers to.
  • # 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.
  • integration_service_mappings(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • integrationconfigurable_id: Int64Bit,
  • integrationconfigurable_type: String,
  • policy_map: String,
  • service_id: Int64Bit,
  • service_template_name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): IntegrationServiceMappingConnection!
  • # An account 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.
  • # 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.
  • account_groups(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccountGroupConnection!
  • # 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 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!
  • # The type of a `Job`.
  • #
  • # 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_completion: If this is set, any `Job` using
  • # this `JobType` that is completed successfully while associated with an `Account`
  • # will change the `Account` to this `AccountStatus`.
  • # account_status_id_failure: If this is set, any `Job` using this
  • # `JobType` that is completed unsuccessfully while associated with an `Account`
  • # will change the `Account` to this `AccountStatus`.
  • # action_on_completion: Completion ticket action.
  • # action_on_failure: Failure ticket action.
  • # all_companies: Whether or not this `JobType` is valid for all
  • # `Companies`.
  • # allow_completion_with_incomplete_tasks: Whether `Job`s
  • # associated with this `JobType` should be able to be completed with incomplete
  • # tasks.
  • # color: Color.
  • # contract_template_id: The ID of a `ContractTemplate`.
  • # default_length_in_minutes: The default length for a `Job`
  • # created using this `JobType`.
  • # disconnects_account: If this is set, any `Job` using this
  • # `JobType` that is completed successfully while associated with an `Account` will
  • # trigger the disconnection of the `Account`.
  • # enabled: Whether or not this is enabled.
  • # icon: An icon.
  • # name: A descriptive name.
  • # task_template_id: The ID of a `TaskTemplate`.
  • # ticket_group_id_completion: If this is set, any `Job` using
  • # this `JobType` that is completed successfully will create a `Ticket` and assign
  • # it to this `TicketGroup`.
  • # ticket_group_id_failure: If this is set, any `Job` using this
  • # `JobType` that is completed unsuccessfully will create a `Ticket` and assign it
  • # to this `TicketGroup`.
  • # ticket_status_on_completion: Ticket status on completion.
  • # ticket_status_on_failure: Ticket status on failure.
  • # 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.
  • job_types(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_status_id_completion: Int64Bit,
  • account_status_id_failure: Int64Bit,
  • action_on_completion: JobTypeAction,
  • action_on_failure: JobTypeAction,
  • all_companies: Boolean,
  • allow_completion_with_incomplete_tasks: Boolean,
  • color: HtmlHexColor,
  • contract_template_id: Int64Bit,
  • default_length_in_minutes: Int,
  • disconnects_account: Boolean,
  • enabled: Boolean,
  • icon: Icon,
  • name: String,
  • task_template_id: Int64Bit,
  • ticket_group_id_completion: Int64Bit,
  • ticket_group_id_failure: Int64Bit,
  • ticket_status_on_completion: TicketStatus,
  • ticket_status_on_failure: TicketStatus,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): JobTypeConnection!
  • # 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!
  • }