OBJECT

Query

link GraphQL Schema definition

  • type Query {
  • # All access logs for 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.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccessLogConnection!
  • # Account billing parameters.
  • #
  • # 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.
  • # aggregate_invoice_taxes: Whether or not to aggregate invoice
  • # taxes instead of printing with each charge.
  • # auto_pay_day: If `invoice_day` is not null, this allows you to
  • # select whether `auto_pay_days` is calculated from the billing day, or the
  • # invoice day.
  • # auto_pay_days: The number of days after `auto_pay_day` that
  • # auto pay runs for an invoice.
  • # bill_day: The day that billing runs.
  • # bill_day_mode: Whether the account bill and invoice day are
  • # fixed, the account activation day is used as bill day, or the account activation
  • # day is used as the invoice day.
  • # bill_mode: The type of bill this account receives.
  • # days_of_delinquency_for_status_switch: If
  • # `switch_status_after_delinquency` is `true`, then this is the number of days of
  • # delinquency to allow before the status switch.
  • # delinquency_account_status_id: If
  • # `switch_status_after_delinquency` is true, this is the account status that the
  • # account will be moved into after `days_of_delinquency_for_status_switch` days of
  • # delinquency.
  • # delinquency_removal_account_status_id: If
  • # `switch_status_after_delinquency` is `true`, then this is the status the account
  • # will be moved back into if delinquency is cleared while the account is set to
  • # the `delinquency_account_status_id` account status.
  • # due_days: The number of days after the invoice date that it is
  • # due.
  • # due_days_day: If `invoice_day` is not null, this allows you to
  • # select whether `due_days` is calculated from the billing day, or the invoice
  • # day.
  • # grace_days: The number of days after the invoice due date that
  • # the invoice is marked delinquent.
  • # grace_until: A temporary override that stops the account
  • # becoming delinquent until this date.
  • # invoice_day: The day that automatic billing invoices are
  • # generated for. If this is `null`, then `bill_day` is used.
  • # lifeline: Whether or not this account participates in the
  • # federal Lifeline program.
  • # months_to_bill: The number of months to bill at a time.
  • # print_invoice: Whether this account receives a printed invoice.
  • # switch_status_after_delinquency: Whether or not this account
  • # should be moved into another status after being delinquent for a preset period.
  • # tax_exempt: Whether or not this account is tax exempt.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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_billing_parameters(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • aggregate_invoice_taxes: Boolean,
  • auto_pay_day: BillingParameterDayOption,
  • auto_pay_days: Int,
  • bill_day: Int,
  • bill_day_mode: BillDayModeOption,
  • bill_mode: BillMode,
  • days_of_delinquency_for_status_switch: Int,
  • delinquency_account_status_id: Int64Bit,
  • delinquency_removal_account_status_id: Int64Bit,
  • due_days: Int,
  • due_days_day: BillingParameterDayOption,
  • grace_days: Int,
  • grace_until: Date,
  • invoice_day: Int,
  • lifeline: Boolean,
  • months_to_bill: Int,
  • print_invoice: Boolean,
  • switch_status_after_delinquency: Boolean,
  • tax_exempt: Boolean,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccountBillingParameterConnection!
  • # Account Calix Service Details.
  • #
  • # 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_service_id: The ID of an AccountService.
  • # calix_integration_id: Calix Inegartion ID.
  • # custom_json: Custom JSON.
  • # cvlan: C-VLAN.
  • # global_vlan: Global VLAN.
  • # ont_port_id: ONT Port ID.
  • # policy_map: Policy Map.
  • # use_custom_json: Use Custom JSON.
  • # vlan: VLAN.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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_calix_service_details(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_service_id: Int64Bit,
  • calix_integration_id: Int64Bit,
  • custom_json: String,
  • cvlan: Int,
  • global_vlan: String,
  • ont_port_id: String,
  • policy_map: String,
  • use_custom_json: Boolean,
  • vlan: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccountCalixServiceDetailConnection!
  • # Account events.
  • #
  • # 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.
  • # current: Current data.
  • # event: An event.
  • # event_datetime: The date and time of an event sent from
  • # Mandrill
  • # previous: Previous data.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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_events(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • current: String,
  • event: AccountUpdateEvent,
  • event_datetime: Datetime,
  • previous: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccountEventConnection!
  • # Account groups.
  • #
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccountGroupConnection!
  • # Services that have been attached to accounts.
  • #
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccountServiceConnection!
  • # Account statuses.
  • #
  • # 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.
  • # activates_account: Whether or not this status activates the
  • # account.
  • # color: Color.
  • # icon: An icon.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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_statuses(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • activates_account: Boolean,
  • color: HtmlHexColor,
  • icon: Icon,
  • name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccountStatusConnection!
  • # Account types.
  • #
  • # 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.
  • # color: Color.
  • # icon: An icon.
  • # invoice_message_id: The ID of an `InvoiceMessage`.
  • # name: A descriptive name.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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_types(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • color: HtmlHexColor,
  • icon: Icon,
  • invoice_message_id: Int64Bit,
  • name: String,
  • type: AccountTypeEnum,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccountTypeConnection!
  • # Details of a voice service attached to an 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_service_id: The ID of an AccountService.
  • # 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.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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_voice_service_details(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_service_id: Int64Bit,
  • price_override: Int,
  • price_override_reason: String,
  • quantity: Int,
  • voice_service_generic_parameter_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccountVoiceServiceDetailConnection!
  • # Customer accounts.
  • #
  • # 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.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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,
  • name: String,
  • next_bill_date: Date,
  • next_recurring_charge_amount: Int,
  • parent_account_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccountConnection!
  • # ACH batches.
  • #
  • # 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.
  • # ach_sequence: The batch ID that gets inserted into the ACH file
  • # on generation.
  • # format: The provider to use when transacting against bank
  • # accounts.
  • # payments_after: This batch includes payments after this date.
  • # payments_before: This batch includes payments before this date.
  • # type: Whether this is a batch of debits or credits.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • ach_batches(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • ach_sequence: Int64Bit,
  • format: BankAccountProvider,
  • payments_after: Datetime,
  • payments_before: Datetime,
  • type: AchBatchType,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AchBatchConnection!
  • # Address lists.
  • #
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AddressListConnection!
  • # Address statuses.
  • #
  • # 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.
  • # color: Color.
  • # icon: An icon.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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_statuses(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • color: HtmlHexColor,
  • icon: Icon,
  • name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AddressStatusConnection!
  • # Geographical addresses.
  • #
  • # 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.
  • # address_status_id: Address status ID.
  • # addressable_id: The ID of the entity that owns this address.
  • # addressable_type: The type of entity that owns this address.
  • # avalara_pcode: Avalara PCode.
  • # census_year: The year used for calculating fips and census
  • # tract information.
  • # city: A city.
  • # country: A two character country code.
  • # county: A US county. Only used for US addresses.
  • # fips: Only used in the USA, this is the census tract
  • # information used for calculating things like FCC Form 477.
  • # latitude: A decimal latitude.
  • # line1: Address line 1.
  • # line2: Address line 2.
  • # longitude: A decimal longitude.
  • # serviceable: Whether or not the address is serviceable, and can
  • # be used for new accounts.
  • # subdivision: A state, province, or other country subdivision.
  • # timezone: The timezone you want times in the system displayed
  • # in.
  • # type: The type.
  • # zip: A ZIP or postal code.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • addresses(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • address_status_id: Int64Bit,
  • addressable_id: Int64Bit,
  • addressable_type: AddressableType,
  • avalara_pcode: String,
  • census_year: Int,
  • city: String,
  • country: Country,
  • county: UsCounty,
  • fips: String,
  • latitude: Latitude,
  • line1: String,
  • line2: String,
  • longitude: Longitude,
  • serviceable: Boolean,
  • subdivision: Subdivision,
  • timezone: Timezone,
  • type: AddressType,
  • zip: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AddressConnection!
  • # Details related to 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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_details(
  • 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,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AdjustmentServiceDetailConnection!
  • # Alerting rotation days and times.
  • #
  • # 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.
  • # alerting_rotation_id: The alerting rotation ID.
  • # day: A day.
  • # end_time: The end time for the day.
  • # start_time: The start time for the day.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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_rotation_days(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • alerting_rotation_id: Int64Bit,
  • day: Day,
  • end_time: Time,
  • start_time: Time,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AlertingRotationDayConnection!
  • # Inventory items associated with alerting rotations.
  • #
  • # 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.
  • # alerting_rotation_id: The alerting rotation ID.
  • # inventory_item_id: The ID of an `InventoryItem`.
  • # last_alerted_datetime: The date and time that this rotation was
  • # last notified of a status change.
  • # last_overall_status: The last monitoring status of an inventory
  • # item.
  • # last_status_change_datetime: The date and time that the
  • # inventory item status last changed.
  • # next_alert_datetime: The next date and time to send a status
  • # alert for this rotation.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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_rotation_inventory_items(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • alerting_rotation_id: Int64Bit,
  • inventory_item_id: Int64Bit,
  • last_alerted_datetime: Datetime,
  • last_overall_status: InventoryItemDeviceStatus,
  • last_status_change_datetime: Datetime,
  • next_alert_datetime: Datetime,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AlertingRotationInventoryItemConnection!
  • # Alerting rotations.
  • #
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AlertingRotationConnection!
  • # Application firewall rules.
  • #
  • # 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.
  • # description: A human readable description.
  • # subnet: An IPv4/IPv6 subnet.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • application_firewall_rules(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • description: String,
  • subnet: SubnetScalar,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ApplicationFirewallRuleConnection!
  • # Auth providers.
  • #
  • # 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.
  • # auth0_client_id: The Auth0 client ID.
  • # auth0_client_secret: The Auth0 client secret.
  • # enabled: Whether or not this is enabled.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • auth_providers(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • auth0_client_id: String,
  • auth0_client_secret: String,
  • enabled: Boolean,
  • type: AuthProviderType,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AuthProviderConnection!
  • # Available explores.
  • available_explores: AvailableExploresConnection!
  • # Available reports.
  • available_reports: AvailableReportsConnection!
  • # Avalara tax categories.
  • #
  • # 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.
  • # value: The value.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • avalara_tax_categories(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • name: String,
  • value: Int,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AvalaraTaxCategoryConnection!
  • # Avalara tax definitions.
  • #
  • # 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: Whether or not this entity is archived.
  • # is_custom: Whether or not this tax definition is custom.
  • # service_name: The service name as defined by Avalara.
  • # service_type: The service type as defined by Avalara.
  • # transaction_name: The transaction name as defined by Avalara.
  • # transaction_type: The transaction type as defined by Avalara.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • avalara_tax_definitions(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • archived: Boolean,
  • is_custom: Boolean,
  • service_name: String,
  • service_type: Int,
  • transaction_name: String,
  • transaction_type: Int,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AvalaraTaxDefinitionConnection!
  • # Bank account processor credentials.
  • #
  • # 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.
  • # bank_account_processor_id: The ID of a BankProcessor.
  • # credential: The credential name.
  • # value: The value.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • bank_account_processor_credentials(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • bank_account_processor_id: Int64Bit,
  • credential: BankAccountProviderCredential,
  • value: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): BankAccountProcessorCredentialConnection!
  • # Processors of transactions to and from bank accounts.
  • #
  • # 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.
  • # enabled: Whether or not this is enabled.
  • # primary: Whether or not this is the primary type of entity.
  • # provider: The provider for this processor.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • bank_account_processors(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • enabled: Boolean,
  • primary: Boolean,
  • provider: BankAccountProvider,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): BankAccountProcessorConnection!
  • # Bank accounts.
  • #
  • # 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.
  • # auto: Whether or not this payment method is enabled for
  • # automatic payments.
  • # bank_account_processor_id: The ID of a BankProcessor.
  • # bank_account_type: The type of bank account this is.
  • # customer_profile_id: The profile ID provided by a credit card
  • # processing service.
  • # masked_account_number: A partial account number that can be
  • # used for identification.
  • # name_on_account: The name on the account.
  • # routing_number: The bank routing number.
  • # token: The tokenized value that represents a credit card,
  • # provided by a credit card processing 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • bank_accounts(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • auto: Boolean,
  • bank_account_processor_id: Int64Bit,
  • bank_account_type: BankAccountType,
  • customer_profile_id: String,
  • masked_account_number: String,
  • name_on_account: String,
  • routing_number: String,
  • token: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): BankAccountConnection!
  • # Default billing values for new accounts.
  • #
  • # 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_type_id: The ID of an AccountType.
  • # aggregate_invoice_taxes: Whether or not to aggregate invoice
  • # taxes instead of printing with each charge.
  • # auto_pay_day: If `invoice_day` is not null, this allows you to
  • # select whether `auto_pay_days` is calculated from the billing day, or the
  • # invoice day.
  • # auto_pay_days: The number of days after `auto_pay_day` that
  • # auto pay runs for an invoice.
  • # bill_day: The day that billing runs.
  • # bill_day_mode: Whether the account bill and invoice day are
  • # fixed, the account activation day is used as bill day, or the account activation
  • # day is used as the invoice day.
  • # bill_mode: The type of bill this account receives.
  • # days_of_delinquency_for_status_switch: If
  • # `switch_status_after_delinquency` is `true`, then this is the number of days of
  • # delinquency to allow before the status switch.
  • # default: If this is `true`, then this is the default billing
  • # default that is used, if there is no more specific billing default option for an
  • # account.
  • # delinquency_account_status_id: If
  • # `switch_status_after_delinquency` is true, this is the account status that the
  • # account will be moved into after `days_of_delinquency_for_status_switch` days of
  • # delinquency.
  • # delinquency_removal_account_status_id: If
  • # `switch_status_after_delinquency` is `true`, then this is the status the account
  • # will be moved back into if delinquency is cleared while the account is set to
  • # the `delinquency_account_status_id` account status.
  • # due_days: The number of days after the invoice date that it is
  • # due.
  • # due_days_day: If `invoice_day` is not null, this allows you to
  • # select whether `due_days` is calculated from the billing day, or the invoice
  • # day.
  • # fixed_bill_day: Whether or not to use a fixed bill day, versus
  • # anniversary day billing. Use `bill_day_mode` for further customization.
  • # grace_days: The number of days after the invoice due date that
  • # the invoice is marked delinquent.
  • # invoice_day: The day that automatic billing invoices are
  • # generated for. If this is `null`, then `bill_day` is used.
  • # lifeline: Whether or not this account participates in the
  • # federal Lifeline program.
  • # months_to_bill: The number of months to bill at a time.
  • # name: A descriptive name.
  • # print_invoice: Whether this account receives a printed invoice.
  • # switch_status_after_delinquency: Whether or not this account
  • # should be moved into another status after being delinquent for a preset period.
  • # tax_exempt: Whether or not this account is tax exempt.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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_defaults(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_type_id: Int64Bit,
  • aggregate_invoice_taxes: Boolean,
  • auto_pay_day: BillingParameterDayOption,
  • auto_pay_days: Int,
  • bill_day: Int,
  • bill_day_mode: BillDayModeOption,
  • bill_mode: BillMode,
  • days_of_delinquency_for_status_switch: Int,
  • default: Boolean,
  • delinquency_account_status_id: Int64Bit,
  • delinquency_removal_account_status_id: Int64Bit,
  • due_days: Int,
  • due_days_day: BillingParameterDayOption,
  • fixed_bill_day: Boolean,
  • grace_days: Int,
  • invoice_day: Int,
  • lifeline: Boolean,
  • months_to_bill: Int,
  • name: String,
  • print_invoice: Boolean,
  • switch_status_after_delinquency: Boolean,
  • tax_exempt: Boolean,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): BillingDefaultConnection!
  • # Billing settings.
  • billing_setting: BillingSetting!
  • # Cable modem provisioner credentials.
  • #
  • # 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.
  • # cable_modem_provisioner_id: The ID of a
  • # `CableModemProvisioner`.
  • # credential: An individual credential to authenticate to a cable
  • # modem provisioner.
  • # value: The credential value (e.g. username, password, etc.)
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • cable_modem_provisioner_credentials(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • cable_modem_provisioner_id: Int64Bit,
  • credential: CableModemProvisionerAuthenticationCredential,
  • value: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CableModemProvisionerCredentialConnection!
  • # Cable modem provisioners.
  • #
  • # 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.
  • # enabled: Whether or not this is enabled.
  • # hostname: Hostname.
  • # last_synchronized: The date and time this device was last
  • # synchronized.
  • # name: A descriptive name.
  • # status: The status.
  • # status_message: A message describing what caused the current
  • # status of this device.
  • # synchronization_queued: Whether or not a synchronization
  • # request is queued.
  • # synchronization_start: The date/time that synchronization
  • # started.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • cable_modem_provisioners(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • enabled: Boolean,
  • hostname: String,
  • last_synchronized: Datetime,
  • name: String,
  • status: ProvisioningDeviceStatus,
  • status_message: String,
  • synchronization_queued: Boolean,
  • synchronization_start: Datetime,
  • type: CableModemProvisionerType,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CableModemProvisionerConnection!
  • # Calendar - iCalendar
  • #
  • # 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.
  • # enabled: Whether or not this is enabled.
  • # name: A descriptive name.
  • # url: The url that can be used on remote calendars for
  • # integration of Sonar events.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • calendar_icals(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • enabled: Boolean,
  • name: String,
  • url: URL,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CalendarIcalConnection!
  • # Unique Calix SMx server configuration.
  • #
  • # 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.
  • # alarms_change_device_status: Controls if Sonar updates the ICMP
  • # device status from SMx alarms
  • # alarms_create_logs: Controls if Sonar should add SMx device
  • # alarms to inventory item logs
  • # alarms_update_ip_assignment: Controls if Sonar updates the
  • # inventory item's soft IP address from SMx DHCP lease alarms.
  • # bounce_ports: Disable, pause, then re-enable Calix ONT ports
  • # after creating or removing service. Recommended for deployments using DHCP
  • # within SMx.
  • # commercial_delinquency_policy_map: The Calix policy map name to
  • # use when a commercial account becomes delinquent.
  • # commercial_delinquency_service_template: The Calix service
  • # template name to use when a commercial account becomes delinquent.
  • # enable_ont_synchronization: Controls whether to turn on
  • # synchronization of Calix ONTs and Subscribers, from Sonar Inventory Items and
  • # Accounts.
  • # government_delinquency_policy_map: The Calix policy map name to
  • # use when a government account becomes delinquent.
  • # government_delinquency_service_template: The Calix service
  • # template name to use when a government account becomes delinquent.
  • # last_synchronized: The date and time this device was last
  • # synchronized.
  • # org_id: Subscriber organization ID to use for integration
  • # residential_delinquency_policy_map: The Calix policy map name
  • # to use when a residential account becomes delinquent.
  • # residential_delinquency_service_template: The Calix service
  • # template name to use when a residential account becomes delinquent.
  • # smx_credentials: The basic auth credentials to use with SMx,
  • # username:password
  • # smx_url: The URL of the SMx server including the SMx API port,
  • # eg. mysmx.org:18443 (SMx uses 18443 as the default API port)
  • # smx_version: The software version of SMx that will be used in
  • # integration
  • # status: The status.
  • # status_message: A message describing what caused the current
  • # status of this device.
  • # subscriber_custom_field_id: The ID of the account custom field
  • # which holds the SMx subscriber ID of the account.
  • # synchronization_queued: Whether or not a synchronization
  • # request is queued.
  • # synchronization_start: The date/time that synchronization
  • # started.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • calix_integrations(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • alarms_change_device_status: Boolean,
  • alarms_create_logs: Boolean,
  • alarms_update_ip_assignment: Boolean,
  • bounce_ports: Boolean,
  • commercial_delinquency_policy_map: String,
  • commercial_delinquency_service_template: String,
  • enable_ont_synchronization: Boolean,
  • government_delinquency_policy_map: String,
  • government_delinquency_service_template: String,
  • last_synchronized: Datetime,
  • org_id: String,
  • residential_delinquency_policy_map: String,
  • residential_delinquency_service_template: String,
  • smx_credentials: String,
  • smx_url: String,
  • smx_version: CalixIntegrationVersion,
  • status: ProvisioningDeviceStatus,
  • status_message: String,
  • subscriber_custom_field_id: Int64Bit,
  • synchronization_queued: Boolean,
  • synchronization_start: Datetime,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CalixIntegrationConnection!
  • # Calix provisioning list.
  • #
  • # Arguments
  • # list_type: The type.
  • # calix_integration_id: Calix Inegartion ID.
  • # inventory_item_id: The ID of an `InventoryItem`.
  • # smx_url: The URL of the SMx server including the SMx API port,
  • # eg. mysmx.org:18443 (SMx uses 18443 as the default API port)
  • # smx_credentials: The basic auth credentials to use with SMx,
  • # username:password
  • # smx_version: The software version of SMx that will be used in
  • # integration
  • # paginator: Provides the ability to paginate through results.
  • calix_provisioning_list(
  • list_type: CalixProvisioningListType,
  • calix_integration_id: Int64Bit,
  • inventory_item_id: Int64Bit,
  • smx_url: String,
  • smx_credentials: String,
  • smx_version: CalixIntegrationVersion,
  • paginator: Paginator
  • ): CalixProvisioningListConnection!
  • # Call Detail Record Import Recipes
  • #
  • # 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.
  • # clean_records: How many records passed validation checks during
  • # import.
  • # errors: Any errors encountered for this import.
  • # failed_records: How many records did not pass validation checks
  • # during import.
  • # flatfile_batch_identifier: The identifier of a unique batch at
  • # Flatfile.
  • # hash: A hash of the data content of an import.
  • # progress: The progress of an import as a percentage.
  • # start_datetime: The start date and time for the import.
  • # status: The status.
  • # user_id: The ID of a User.
  • # voice_provider_id: The ID of a `VoiceProvider`.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • call_detail_record_import_recipes(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • clean_records: Int,
  • errors: Clob,
  • failed_records: Int,
  • flatfile_batch_identifier: String,
  • hash: String,
  • progress: Int,
  • start_datetime: Datetime,
  • status: ImportStatus,
  • user_id: Int64Bit,
  • voice_provider_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CallDetailRecordImportRecipeConnection!
  • # Call Detail Record Imports
  • #
  • # 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.
  • # call_data_record_import_id: The ID of a call data record (CDR)
  • # import.
  • # clean_records: How many records passed validation checks during
  • # import.
  • # errors: Any errors encountered for this import.
  • # failed_records: How many records did not pass validation checks
  • # during import.
  • # status: The status.
  • # voice_provider_id: The ID of a `VoiceProvider`.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • call_detail_record_imports(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • call_data_record_import_id: Int64Bit,
  • clean_records: Int,
  • errors: Text,
  • failed_records: Int,
  • status: AsyncImportStatus,
  • voice_provider_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CallDetailRecordImportConnection!
  • # Call Detail Records
  • #
  • # 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.)
  • # charge_rate: The rate that is charged to a customer.
  • # description: The prefix description for the call detail record
  • # having provider rated prefix.
  • # direction: The direction of the call.
  • # length_in_seconds: The total length of the call in seconds.
  • # matched_prefix: The matched prefix of this call record.
  • # monthly_billing_completion_id: The ID of a
  • # `MonthlyBillingCompletion`.
  • # originating_number: The DID that initiated the call.
  • # prefix_type: The prefix type of this call record.
  • # receiving_number: The DID that received the call.
  • # service_id: The ID of a Service.
  • # started_at: When the call was started.
  • # voice_provider_id: The ID of a `VoiceProvider`.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • call_detail_records(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • amount: Float,
  • charge_rate: Float,
  • description: String,
  • direction: CallDetailRecordDirection,
  • length_in_seconds: Int,
  • matched_prefix: String,
  • monthly_billing_completion_id: Int64Bit,
  • originating_number: String,
  • prefix_type: CallDetailRecordPrefixType,
  • receiving_number: String,
  • service_id: Int64Bit,
  • started_at: Datetime,
  • voice_provider_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CallDetailRecordConnection!
  • # Call Logs for accounts.
  • #
  • # 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.
  • # body: The body.
  • # subject: The subject.
  • # time_in_seconds: The time in seconds.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • call_logs(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • body: Text,
  • subject: String,
  • time_in_seconds: String,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CallLogConnection!
  • # Canned replies.
  • #
  • # 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.
  • # body: The body.
  • # canned_reply_category_id: The ID of a `CannedReplyCategory`.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • canned_replies(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • body: Text,
  • canned_reply_category_id: Int64Bit,
  • name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CannedReplyConnection!
  • # Canned reply categories.
  • #
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • canned_reply_categories(
  • 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,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CannedReplyCategoryConnection!
  • # Canned reply with variable replacement.
  • #
  • # Arguments
  • # canned_reply_id: fields.canned_reply_id
  • # ticket_id: The ID of a `Ticket`.
  • canned_reply_with_variable_replacement(
  • canned_reply_id: Int64Bit!,
  • ticket_id: Int64Bit!
  • ): CannedReply!
  • # Companies that 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • companies(
  • 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,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CompanyConnection!
  • # A contact person.
  • #
  • # 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.
  • # contactable_id: The ID of the entity that owns this contact.
  • # contactable_type: The type of entity that owns this contact.
  • # email_address: An email address.
  • # language: A supported language.
  • # name: A descriptive name.
  • # primary: Whether or not this is the primary type of entity.
  • # role: The role of the contact, e.g. "CEO" or "Network
  • # Engineer".
  • # username: A username, used for authentication.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • contacts(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • contactable_id: Int64Bit,
  • contactable_type: ContactableType,
  • email_address: EmailAddress,
  • language: Language,
  • name: String,
  • primary: Boolean,
  • role: String,
  • username: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ContactConnection!
  • # Contract templates.
  • #
  • # 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.
  • # body: The body.
  • # company_id: The ID of the company that this entity operates
  • # under.
  • # enabled: Whether or not this is enabled.
  • # name: A descriptive name.
  • # term_in_months: The term in months.
  • # ticket_group_id: The ID of a `TicketGroup`.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • contract_templates(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • body: Text,
  • company_id: Int64Bit,
  • enabled: Boolean,
  • name: String,
  • term_in_months: Int,
  • ticket_group_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ContractTemplateConnection!
  • # Contracts.
  • #
  • # 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.
  • # body: The body.
  • # contact_id: The ID of the contact that owns this.
  • # contract_template_id: The ID of a `ContractTemplate`.
  • # custom_message: The custom message.
  • # expiration_date: The expiration date.
  • # handwritten_signature_id: The ID of a `HandwrittenSignature`.
  • # name: A descriptive name.
  • # term_in_months: The term in months.
  • # unique_link_key: Part of the unique URL used for signing.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • contracts(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • body: Text,
  • contact_id: Int64Bit,
  • contract_template_id: Int64Bit,
  • custom_message: Text,
  • expiration_date: Date,
  • handwritten_signature_id: Int64Bit,
  • name: String,
  • term_in_months: Int,
  • unique_link_key: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ContractConnection!
  • # Core credit cards.
  • #
  • # 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.
  • # auto: Whether or not this payment method is enabled for
  • # automatic payments.
  • # credit_card_processor_id: The ID of a CreditCardProcessor.
  • # credit_card_type: The type of a credit card (e.g. Visa,
  • # Mastercard.)
  • # customer_profile_id: The profile ID provided by a credit card
  • # processing service.
  • # expiration_month: The month the credit card expires.
  • # expiration_year: The year the credit card expires.
  • # masked_number: A partial credit card number that can be used
  • # for identification.
  • # name_on_card: The name on the credit card.
  • # token: The tokenized value that represents a credit card,
  • # provided by a credit card processing 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • core_credit_cards(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • auto: Boolean,
  • credit_card_processor_id: Int64Bit,
  • credit_card_type: CreditCardType,
  • customer_profile_id: String,
  • expiration_month: Int,
  • expiration_year: Int,
  • masked_number: String,
  • name_on_card: String,
  • token: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CreditCardConnection!
  • # Core invoices.
  • #
  • # 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.
  • # auto_pay_attempts: The number of times that auto pay has been
  • # attempted.
  • # auto_pay_date: The date that auto pay will be attempted.
  • # child_invoice_remaining_due: The sum of all due amounts on
  • # child invoices.
  • # company_id: The ID of the company that this entity operates
  • # under.
  • # date: A date
  • # delinquency_date: The date that this became delinquent.
  • # delinquent: Whether or not this entity is delinquent.
  • # due_date: The date this invoice is due by.
  • # end_date: The date that this ends.
  • # frozen: If an invoice is frozen, payments will not be
  • # automatically applied to it, and it cannot be modified.
  • # late_fee_applied: Whether or not a late fee has been applied.
  • # late_fee_only: Whether or not the invoice includes only late
  • # fees.
  • # message: The message.
  • # number_of_months: The number of months of service this invoice
  • # was billed for.
  • # parent_invoice_id: The ID of the `Invoice` that is this
  • # `Invoice`s master.
  • # pending_email: Used by system to indicate the invoice has been
  • # marked to be sent to email contacts.
  • # remaining_due: The amount remaining to be paid.
  • # tax_committed: Whether this entity's taxes have been committed
  • # or not.
  • # tax_provider_id: The ID of an `TaxProvider`.
  • # total_debits: The sum of all debits that make up this invoice.
  • # total_taxes: The sum of all taxes on debits that make up this
  • # invoice.
  • # void: Whether or not this entity has been voided.
  • # voided_at: When this was voided.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • core_invoices(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • auto_pay_attempts: Int,
  • auto_pay_date: Date,
  • child_invoice_remaining_due: Int,
  • company_id: Int64Bit,
  • date: Date,
  • delinquency_date: Date,
  • delinquent: Boolean,
  • due_date: Date,
  • end_date: Date,
  • frozen: Boolean,
  • late_fee_applied: Boolean,
  • late_fee_only: Boolean,
  • message: Text,
  • number_of_months: Int,
  • parent_invoice_id: Int64Bit,
  • pending_email: Boolean,
  • remaining_due: Int,
  • tax_committed: Boolean,
  • tax_provider_id: Int64Bit,
  • total_debits: Int,
  • total_taxes: Int,
  • void: Boolean,
  • voided_at: Datetime,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): InvoiceConnection!
  • # Core transactions.
  • #
  • # Arguments
  • # account_id: The ID of an Account.
  • # paginator: Provides the ability to paginate through results.
  • core_transactions(account_id: Int64Bit, paginator: Paginator): TransactionConnection!
  • # Credit card processor credentials.
  • #
  • # 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.
  • # credential: The credential name.
  • # credit_card_processor_id: The ID of a CreditCardProcessor.
  • # value: The value.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • credit_card_processor_credentials(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • credential: CreditCardProviderCredential,
  • credit_card_processor_id: Int64Bit,
  • value: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CreditCardProcessorCredentialConnection!
  • # Credit card processors configured in Sonar.
  • #
  • # 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.
  • # amex: American Express.
  • # dankort: Dankort.
  • # dinersclub: Diner's Club.
  • # discover: Discover.
  • # enabled: Whether or not this is enabled.
  • # forbrugsforeningen: Forbrugsforeningen.
  • # jcb: JCB
  • # maestro: Maestro.
  • # mastercard: MasterCard.
  • # moto_enabled: Enables processor specific `Mail Or Telephone
  • # Order` functionality. Currently only applicable for `Stripe`.
  • # primary: Whether or not this is the primary type of entity.
  • # provider: The company that provides credit card processing
  • # services.
  • # unionpay: Union Pay.
  • # visa: Visa
  • # visaelectron: VISA Electron.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • credit_card_processors(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • amex: Boolean,
  • dankort: Boolean,
  • dinersclub: Boolean,
  • discover: Boolean,
  • enabled: Boolean,
  • forbrugsforeningen: Boolean,
  • jcb: Boolean,
  • maestro: Boolean,
  • mastercard: Boolean,
  • moto_enabled: Boolean,
  • primary: Boolean,
  • provider: CreditCardProvider,
  • unionpay: Boolean,
  • visa: Boolean,
  • visaelectron: Boolean,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CreditCardProcessorConnection!
  • # Credit cards.
  • #
  • # 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.
  • # auto: Whether or not this payment method is enabled for
  • # automatic payments.
  • # credit_card_processor_id: The ID of a CreditCardProcessor.
  • # credit_card_type: The type of a credit card (e.g. Visa,
  • # Mastercard.)
  • # customer_profile_id: The profile ID provided by a credit card
  • # processing service.
  • # expiration_month: The month the credit card expires.
  • # expiration_year: The year the credit card expires.
  • # masked_number: A partial credit card number that can be used
  • # for identification.
  • # name_on_card: The name on the credit card.
  • # token: The tokenized value that represents a credit card,
  • # provided by a credit card processing 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • credit_cards(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • auto: Boolean,
  • credit_card_processor_id: Int64Bit,
  • credit_card_type: CreditCardType,
  • customer_profile_id: String,
  • expiration_month: Int,
  • expiration_year: Int,
  • masked_number: String,
  • name_on_card: String,
  • token: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CreditCardConnection!
  • # Credits applied to invoices.
  • #
  • # 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.)
  • # creditable_id: The ID the transaction that created this credit.
  • # creditable_type: The type of transaction that created this
  • # credit.
  • # invoice_id: The ID of an `Invoice`.
  • # void: Whether or not this entity has been voided.
  • # voided_at: When this was voided.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • credits(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • amount: Int,
  • creditable_id: Int64Bit,
  • creditable_type: CreditableType,
  • invoice_id: Int64Bit,
  • void: Boolean,
  • voided_at: Datetime,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CreditConnection!
  • # Data in custom fields.
  • #
  • # 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.
  • # custom_field_id: The ID of a CustomField that is associated
  • # with this type of entity.
  • # customfielddataable_id: The ID of the entity that owns this
  • # custom field data.
  • # customfielddataable_type: The type of entity that owns this
  • # custom field data.
  • # value: The value.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • custom_field_data(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • custom_field_id: Int64Bit,
  • customfielddataable_id: Int64Bit,
  • customfielddataable_type: CustomfielddataableType,
  • value: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CustomFieldDataConnection!
  • # Custom fields.
  • #
  • # 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.
  • # entity_type: The type of entity this custom field will be
  • # associated with.
  • # enum_options: A list of values that are valid for this field,
  • # if this is a TEXT field. If this is empty, and the field is a TEXT type, then
  • # any value will be allowed.
  • # name: A descriptive name.
  • # required: Whether or not this field is required.
  • # type: The type.
  • # unique: Whether or not the value of this custom field must be
  • # unique throughout the system.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • custom_fields(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • entity_type: CustomfielddataableType,
  • enum_options: [String],
  • name: String,
  • required: Boolean,
  • type: CustomFieldType,
  • unique: Boolean,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CustomFieldConnection!
  • # Aggregate values for a given date.
  • #
  • # 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.
  • # context: Additional context regarding the item.
  • # date: A date
  • # key: Key for a specific value.
  • # value: The value.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • daily_aggregate_values(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • context: Text,
  • date: Date,
  • key: AggregateKey,
  • value: Float,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DailyAggregateValueConnection!
  • # Details related to a 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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_details(
  • 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,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DataServiceDetailConnection!
  • # Data usage.
  • #
  • # Arguments
  • # start_datetime: The date and time that this starts.
  • # end_datetime: The date and time that this ends.
  • # time: The time.
  • # account_id: The ID of an Account.
  • data_usage(
  • start_datetime: Datetime,
  • end_datetime: Datetime,
  • time: Datetime,
  • account_id: Int64Bit!
  • ): [DataUsage]!
  • # Data usage history.
  • #
  • # 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.
  • # billable_in_bytes: The total billable inbound data in bytes.
  • # billable_out_bytes: The total billable outbound data in bytes.
  • # end_time: The end time of this data usage history interval.
  • # free_in_bytes: The total free inbound data in bytes.
  • # free_out_bytes: The total free outbound data in bytes.
  • # policy_cap_at_close_in_bytes: The policy cap when this data
  • # usage history interval was closed.
  • # rollover_available_in_bytes: The total available rollover data
  • # in bytes.
  • # rollover_remainder_bytes: The total remaining rollover data in
  • # bytes.
  • # rollover_unconsumed_bytes: The total unconsumed rollover data
  • # in bytes.
  • # rollover_used_at_close_in_bytes: The rollover used when this
  • # data usage history interval was closed.
  • # start_time: The start time of this data usage history interval.
  • # top_off_total_at_close_in_bytes: The top off total when this
  • # data usage history interval was closed.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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_usage_histories(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • billable_in_bytes: Int64Bit,
  • billable_out_bytes: Int64Bit,
  • end_time: Datetime,
  • free_in_bytes: Int64Bit,
  • free_out_bytes: Int64Bit,
  • policy_cap_at_close_in_bytes: Int64Bit,
  • rollover_available_in_bytes: Int64Bit,
  • rollover_remainder_bytes: Int64Bit,
  • rollover_unconsumed_bytes: Int64Bit,
  • rollover_used_at_close_in_bytes: Int64Bit,
  • start_time: Datetime,
  • top_off_total_at_close_in_bytes: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DataUsageHistoryConnection!
  • # Data usage top offs.
  • #
  • # 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_in_bytes: The amount of top off data in bytes.
  • # data_usage_history_id: The ID of a `DataUsageHistory`.
  • # debit_id: The ID of a `Debit`.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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_usage_top_offs(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • amount_in_bytes: Int64Bit,
  • data_usage_history_id: Int64Bit,
  • debit_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DataUsageTopOffConnection!
  • # Debits.
  • #
  • # 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`.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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,
  • 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,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DebitConnection!
  • # Periods of time in which delinquency is not calculated.
  • #
  • # 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.
  • # day: A day.
  • # month: A month.
  • # name: A descriptive name.
  • # year: A year.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • delinquency_exclusions(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • day: Int,
  • month: Int,
  • name: String,
  • year: Int,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DelinquencyExclusionConnection!
  • # Modes in which a piece of inventory can be deployed.
  • #
  • # 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.
  • # inventory_model_id: The ID of an `InventoryModel`.
  • # name: A descriptive name.
  • # network_monitoring_template_id: The ID of a
  • # `NetworkMonitoringTemplate`.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • deployment_types(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • inventory_model_id: Int64Bit,
  • name: String,
  • network_monitoring_template_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DeploymentTypeConnection!
  • # Deposit slips.
  • #
  • # 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.
  • # bank_account_line: The bank account name/number
  • # date: A date
  • # memo: The memo.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • deposit_slips(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • bank_account_line: String,
  • date: Date,
  • memo: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DepositSlipConnection!
  • # Device interface mappings.
  • #
  • # 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.
  • # description: A human readable description.
  • # inventory_item_id: The ID of an `InventoryItem`.
  • # mac_address: A MAC address.
  • # metadata: The metadata.
  • # speed_mbps_in: The interface in speed in Mbps.
  • # speed_mbps_out: The interface out speed in Mbps.
  • # type: The type.
  • # up: Whether or not this interface is up.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • device_interface_mappings(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • description: String,
  • inventory_item_id: Int64Bit,
  • mac_address: MacAddress,
  • metadata: Text,
  • speed_mbps_in: Int,
  • speed_mbps_out: Int,
  • type: String,
  • up: Boolean,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DeviceInterfaceMappingConnection!
  • # DHCP server credentials.
  • #
  • # 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.
  • # credential: A credential for a `DhcpServer`.
  • # dhcp_server_id: The ID of a `DhcpServer`.
  • # value: The value of a credential for a `DhcpServer`.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • dhcp_server_credentials(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • credential: DhcpServerAuthenticationCredential,
  • dhcp_server_id: Int64Bit,
  • value: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DhcpServerCredentialConnection!
  • # DHCP sever identifiers.
  • #
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • dhcp_server_identifiers(
  • 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,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DhcpServerIdentifierConnection!
  • # DHCP servers.
  • #
  • # 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.
  • # api_key: An API key.
  • # enabled: Whether or not this is enabled.
  • # ip_address: An IPv4/IPv6 address.
  • # last_synchronized: The date and time this device was last
  • # synchronized.
  • # name: A descriptive name.
  • # port: A TCP port.
  • # serves_all_pools: Does this `DhcpServer` provide DHCP for all
  • # IP pools?
  • # status: The status.
  • # status_message: A message describing what caused the current
  • # status of this device.
  • # synchronization_queued: Whether or not a synchronization
  • # request is queued.
  • # synchronization_start: The date/time that synchronization
  • # started.
  • # type: The type.
  • # use_source_mac_address: If this is `true`, then Sonar will use
  • # the MAC address of the DHCP relay rather than the MAC address of the requesting
  • # device when writing a lease. This should generally be disabled unless you have a
  • # specific reason to enable it.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • dhcp_servers(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • api_key: String,
  • enabled: Boolean,
  • ip_address: IP,
  • last_synchronized: Datetime,
  • name: String,
  • port: Port,
  • serves_all_pools: Boolean,
  • status: ProvisioningDeviceStatus,
  • status_message: String,
  • synchronization_queued: Boolean,
  • synchronization_start: Datetime,
  • type: DhcpServerType,
  • use_source_mac_address: Boolean,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DhcpServerConnection!
  • # DID assignment histories.
  • #
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DidAssignmentHistoryConnection!
  • # DID assignments.
  • #
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DidAssignmentConnection!
  • # DID Import Recipes.
  • #
  • # 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.
  • # clean_records: How many records passed validation checks during
  • # import.
  • # errors: Any errors encountered for this import.
  • # failed_records: How many records did not pass validation checks
  • # during import.
  • # flatfile_batch_identifier: The identifier of a unique batch at
  • # Flatfile.
  • # hash: A hash of the data content of an import.
  • # progress: The progress of an import as a percentage.
  • # rate_center_id: The ID of a `RateCenter`.
  • # start_datetime: The start date and time for the import.
  • # status: The status.
  • # user_id: The ID of a User.
  • # voice_provider_id: The ID of a `VoiceProvider`.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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_import_recipes(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • clean_records: Int,
  • errors: Clob,
  • failed_records: Int,
  • flatfile_batch_identifier: String,
  • hash: String,
  • progress: Int,
  • rate_center_id: Int64Bit,
  • start_datetime: Datetime,
  • status: ImportStatus,
  • user_id: Int64Bit,
  • voice_provider_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DidImportRecipeConnection!
  • # DIDs.
  • #
  • # 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.
  • # number: The number.
  • # rate_center_id: The ID of a `RateCenter`.
  • # voice_provider_id: The ID of a `VoiceProvider`.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • dids(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • number: String,
  • rate_center_id: Int64Bit,
  • voice_provider_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DidConnection!
  • # Disconnection logs.
  • #
  • # 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.
  • # disconnected_at: The date and time that the account was
  • # disconnected.
  • # disconnected_by_user_id: The `User` that disconnected the
  • # `Account`.
  • # serviceable_address_id: The ID of the serviceable address to
  • # use for this account.
  • # serviceable_address_reference_record: The deleted address
  • # object, as a formatted single line, that was disconnected. Used for historical
  • # reporting when address is deleted.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • disconnection_logs(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • disconnected_at: Datetime,
  • disconnected_by_user_id: Int64Bit,
  • serviceable_address_id: Int64Bit,
  • serviceable_address_reference_record: Text,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DisconnectionLogConnection!
  • # Discounts.
  • #
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DiscountConnection!
  • # Drive times.
  • #
  • # Arguments
  • # locations: fields.drive_time_locations
  • drive_times(locations: [DriveTimeLocation]!): DriveTimeResultWrapper
  • # Validate contact email address.
  • #
  • # Arguments
  • # email_address: An email address.
  • # check_if_available: If true, this checks if the contact does
  • # not have a username. If this is false, then it will check if the account has a
  • # username.
  • email_address_lookup(
  • email_address: String!,
  • check_if_available: Boolean
  • ): Contact!
  • # Email categories are associated with contacts, and define the types of emails
  • # those contacts receive. The "default" property determines whether or not the
  • # category is added to newly created contacts by default.
  • #
  • # 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.
  • # default: Whether or not this entity is a default entry.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • email_categories(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • default: Boolean,
  • name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): EmailCategoryConnection!
  • # All clicks for each sent email.
  • #
  • # 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.
  • # email_id: The ID of an email.
  • # email_location_id: The ID of a location associated with a
  • # record in EmailClick and EmailOpen.
  • # event_datetime: The date and time of an event sent from
  • # Mandrill
  • # ip: An IPv4/IPv6 address.
  • # url: The URL that a user clicked on in a sent email.
  • # user_agent: The user agent string of a user that opened or
  • # clicked on a sent email.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • email_clicks(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • email_id: Int64Bit,
  • email_location_id: Int64Bit,
  • event_datetime: Datetime,
  • ip: IP,
  • url: URL,
  • user_agent: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): EmailClickConnection!
  • # Email domains.
  • #
  • # 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.
  • # dkim: Whether or not the DKIM record is valid.
  • # dns_requirements: The DNS requirements for domain validation.
  • # domain: A domain name.
  • # provider_domain_id: The domain ID from the email provider.
  • # ready_for_migration: Indicates that the domain has been
  • # verified for migration.
  • # spf: Whether or not the SPF record is valid.
  • # verified: Whether or not the record is verified.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • email_domains(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • dkim: Boolean,
  • dns_requirements: String,
  • domain: DomainName,
  • provider_domain_id: Int64Bit,
  • ready_for_migration: Boolean,
  • spf: Boolean,
  • verified: Boolean,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): EmailDomainConnection!
  • # Get a list of all locations saved for opened and clicked emails.
  • #
  • # 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.
  • # city: A city.
  • # country: A two character country code.
  • # latitude: A decimal latitude.
  • # longitude: A decimal longitude.
  • # postal_code: The zip code of an email location sent by a
  • # Mandrill event.
  • # timezone: The timezone you want times in the system displayed
  • # in.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • email_locations(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • city: String,
  • country: String,
  • latitude: Latitude,
  • longitude: Longitude,
  • postal_code: String,
  • timezone: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): EmailLocationConnection!
  • # Localized email message details for an EmailMessage container.
  • #
  • # 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.
  • # body: The body.
  • # email_message_id: The ID of an EmailMessage.
  • # inbox_preview: A short sentence that will be shown as a preview
  • # in compatible email clients.
  • # language: A supported language.
  • # subject: The subject.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • email_message_contents(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • body: Text,
  • email_message_id: Int64Bit,
  • inbox_preview: String,
  • language: Language,
  • subject: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): EmailMessageContentConnection!
  • # Email message templates.
  • #
  • # 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.
  • # from_email_address: The email address to send from when using
  • # this email message. If `null`, then the system default will be used.
  • # from_name: The name to send from when using this email message.
  • # If `null`, then the system default will be used.
  • # name: A descriptive name.
  • # saved_message_category_id: ID of the Saved Message Category.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • email_messages(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • from_email_address: EmailAddress,
  • from_name: String,
  • name: String,
  • saved_message_category_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): EmailMessageConnection!
  • # All opens for each sent email.
  • #
  • # 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.
  • # email_id: The ID of an email.
  • # email_location_id: The ID of a location associated with a
  • # record in EmailClick and EmailOpen.
  • # event_datetime: The date and time of an event sent from
  • # Mandrill
  • # ip: An IPv4/IPv6 address.
  • # user_agent: The user agent string of a user that opened or
  • # clicked on a sent email.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • email_opens(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • email_id: Int64Bit,
  • email_location_id: Int64Bit,
  • event_datetime: Datetime,
  • ip: IP,
  • user_agent: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): EmailOpenConnection!
  • # Get a list of valid email variables for a specific email trigger.
  • #
  • # Arguments
  • # trigger: The event that triggers a specific `Email`.
  • email_variables(trigger: EmailTrigger): [EmailVariable]
  • # Emails that have been sent.
  • #
  • # 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.
  • # body: The body.
  • # email_address: An email address.
  • # emailable_id: The ID of the entity that this email was sent to.
  • # emailable_type: The type of entity that this email was sent to.
  • # reject_reason: If rejected, the reason for rejection.
  • # status: The status.
  • # subject: The subject.
  • # to_name: The name of the recipient.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • emails(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • body: Text,
  • email_address: EmailAddress,
  • emailable_id: Int64Bit,
  • emailable_type: EmailableType,
  • reject_reason: String,
  • status: EmailStatus,
  • subject: String,
  • to_name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): EmailConnection!
  • # LTE EPCs.
  • #
  • # 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.
  • # identifier: The identifier used by the EPC, this is typically
  • # numeric.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • epcs(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • identifier: String,
  • name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): EpcConnection!
  • # Details related to an 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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_details(
  • 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,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ExpiringServiceDetailConnection!
  • # External marketing provider credentials.
  • #
  • # 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.
  • # external_marketing_provider_id: The ID of an
  • # `ExternalMarketingProvider`.
  • # key: Key for a specific value.
  • # value: The value.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • external_marketing_provider_credentials(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • external_marketing_provider_id: Int64Bit,
  • key: ExternalMarketingProviderAuthCredential,
  • value: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ExternalMarketingProviderCredentialConnection!
  • # External marketing providers.
  • #
  • # 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.
  • # enabled: Whether or not this is enabled.
  • # provider: The `ExternalMarketingProviderType` for 3rd party
  • # external marketing integration.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • external_marketing_providers(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • enabled: Boolean,
  • provider: ExternalMarketingProviderType,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ExternalMarketingProviderConnection!
  • # The generated FCC Form 477 report.
  • #
  • # 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.
  • # date: A date
  • # format: The format of the reporting for FCC Form 477.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • fcc_form_477_reports(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • date: Date,
  • format: FccForm477Format,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): FccForm477ReportConnection!
  • # FiberMap integrations.
  • #
  • # 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.
  • # always_create_new_network_sites: Always create new network
  • # sites
  • # api_token: An API token.
  • # company_id: The ID of the company that this entity operates
  • # under.
  • # enabled: Whether or not this is enabled.
  • # import_accounts_and_contacts: Import plans and contacts
  • # import_serviceable_addresses: Import serviceable addresses
  • # last_synchronized: The date and time this device was last
  • # synchronized.
  • # name: A descriptive name.
  • # status: The status.
  • # status_message: A message describing what caused the current
  • # status of this device.
  • # synchronization_queued: Whether or not a synchronization
  • # request is queued.
  • # synchronization_start: The date/time that synchronization
  • # started.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • fibermap_integrations(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_status_id: Int64Bit,
  • account_type_id: Int64Bit,
  • always_create_new_network_sites: Boolean,
  • api_token: String,
  • company_id: Int64Bit,
  • enabled: Boolean,
  • import_accounts_and_contacts: Boolean,
  • import_serviceable_addresses: Boolean,
  • last_synchronized: Datetime,
  • name: String,
  • status: ProvisioningDeviceStatus,
  • status_message: String,
  • synchronization_queued: Boolean,
  • synchronization_start: Datetime,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): FibermapIntegrationConnection!
  • # FiberMap plans.
  • #
  • # 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.
  • # build: Build
  • # country: A two character country code.
  • # drop: Drop
  • # fibermap_integration_id: FiberMap integration ID
  • # fibermap_plan_id: FiberMap plan ID
  • # fibermap_project_id: Fibermap project ID.
  • # fibermap_project_name: Fibermap project name.
  • # fibermap_updated_at: FiberMap updated at
  • # height_in_meters: Height in meters.
  • # is_visible: is_visible of the information
  • # latitude: A decimal latitude.
  • # longitude: A decimal longitude.
  • # map_overlay_id: The ID of a map overlay.
  • # mapped_at: Mapped at
  • # mapping_user: Mapping user
  • # name: A descriptive name.
  • # network_site_id: Network site id.
  • # subdivision: A state, province, or other country subdivision.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • fibermap_plans(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • build: String,
  • country: String,
  • drop: String,
  • fibermap_integration_id: Int64Bit,
  • fibermap_plan_id: Int64Bit,
  • fibermap_project_id: Int64Bit,
  • fibermap_project_name: String,
  • fibermap_updated_at: Datetime,
  • height_in_meters: Int,
  • is_visible: Boolean,
  • latitude: Latitude,
  • longitude: Longitude,
  • map_overlay_id: Int64Bit,
  • mapped_at: Datetime,
  • mapping_user: String,
  • name: String,
  • network_site_id: Int64Bit,
  • subdivision: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): FibermapPlanConnection!
  • # FiberMap service locations
  • #
  • # 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.
  • # address_id: The ID of the address.
  • # child_properties_json: Child properties JSON
  • # child_vetro_id: Child Vetro ID
  • # fibermap_integration_id: FiberMap integration ID
  • # fibermap_plan_id: FiberMap plan ID
  • # is_visible: is_visible of the information
  • # properties_json: Properties JSON
  • # vetro_id: Vetro ID
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • fibermap_service_locations(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • address_id: Int64Bit,
  • child_properties_json: String,
  • child_vetro_id: String,
  • fibermap_integration_id: Int64Bit,
  • fibermap_plan_id: Int64Bit,
  • is_visible: Boolean,
  • properties_json: Text,
  • vetro_id: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): FibermapServiceLocationConnection!
  • # Files.
  • #
  • # 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.
  • # description: A human readable description.
  • # file_size_in_bytes: The file size, in bytes.
  • # fileable_id: The ID of the entity that owns this file.
  • # fileable_type: The type of entity that owns this file.
  • # filename: The file name.
  • # mime_type: The MIME type of the file.
  • # primary_image: An image file may be set to the primary image.
  • # This will be used as the displayed image for the object that this file is
  • # associated to throughout Sonar.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • files(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • description: String,
  • file_size_in_bytes: Int64Bit,
  • fileable_id: Int64Bit,
  • fileable_type: FileableType,
  • filename: String,
  • mime_type: String,
  • primary_image: Boolean,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): FileConnection!
  • # Find address by fibermap service location.
  • #
  • # Arguments
  • # fibermap_service_location_id: Fibermap service location ID.
  • # country: country
  • find_address_by_fibermap_service_location(
  • fibermap_service_location_id: Int64Bit!,
  • country: String!
  • ): Address!
  • # Fractional debits.
  • #
  • # 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.)
  • # date: A date
  • # debit_id: The ID of a `Debit`.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • fractional_debits(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • amount: Int,
  • date: Date,
  • debit_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): FractionalDebitConnection!
  • # Fractional tax transactions.
  • #
  • # 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.)
  • # amount_taxed: The amount of this `Debit` that was taxed.
  • # date: A date
  • # description: A human readable description.
  • # tax_transaction_id: The ID of a `TaxTransactions`.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • fractional_tax_transactions(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • amount: Int,
  • amount_taxed: Int,
  • date: Date,
  • description: String,
  • tax_transaction_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): FractionalTaxTransactionConnection!
  • # General ledger codes.
  • #
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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_codes(
  • 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,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): GeneralLedgerCodeConnection!
  • # This query provides the ability to perform a general, partial matching search
  • # across various entities at the same time.
  • #
  • # Arguments
  • # paginator: Provides the ability to paginate through results.
  • # entities: fields.general_search_entities
  • # search: fields.general_search_search
  • general_search(
  • paginator: Paginator,
  • entities: [String]!,
  • search: String!
  • ): GeneralSearchConnection!
  • # Generic inventory assignees.
  • #
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • generic_inventory_assignees(
  • 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,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): GenericInventoryAssigneeConnection!
  • # Logs of changes made to generic inventory items.
  • #
  • # 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.
  • # action: The action that was performed.
  • # genericinventoryitemactionloggable_id: The ID of the entity
  • # that this `GenericInventoryItemActionLog` is for.
  • # genericinventoryitemactionloggable_type: The type of entity
  • # that this `GenericInventoryItemActionLog` is for.
  • # inventory_model_id: The ID of an `InventoryModel`.
  • # purchase_price: The purchase price of this item.
  • # quantity: The quantity for this service.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • generic_inventory_item_action_logs(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • action: GenericInventoryItemActionLogAction,
  • genericinventoryitemactionloggable_id: Int64Bit,
  • genericinventoryitemactionloggable_type: InventoryitemableType,
  • inventory_model_id: Int64Bit,
  • purchase_price: Float,
  • quantity: Int,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): GenericInventoryItemActionLogConnection!
  • # Generic inventory items.
  • #
  • # 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.
  • # genericinventoryitemable_id: The type of entity that owns this
  • # generic `InventoryItem`.
  • # genericinventoryitemable_type: The ID of the entity that owns
  • # this generic `InventoryItem`.
  • # inventory_model_id: The ID of an `InventoryModel`.
  • # quantity: The quantity for this 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • generic_inventory_items(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • genericinventoryitemable_id: Int64Bit,
  • genericinventoryitemable_type: InventoryitemableType,
  • inventory_model_id: Int64Bit,
  • quantity: Int,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): GenericInventoryItemConnection!
  • # Geographical tax zones.
  • #
  • # 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.
  • # city: A city.
  • # country: A two character country code.
  • # county: A US county. Only used for US addresses.
  • # name: A descriptive name.
  • # rate: The rate.
  • # subdivision: A state, province, or other country subdivision.
  • # tax_id: The ID of a Tax.
  • # zip: A ZIP or postal code.
  • # zip_partial_match: Whether to match on partial ZIP/postal
  • # codes.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • geo_tax_zones(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • city: String,
  • country: Country,
  • county: UsCounty,
  • name: String,
  • rate: Float,
  • subdivision: Subdivision,
  • tax_id: Int64Bit,
  • zip: String,
  • zip_partial_match: Boolean,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): GeoTaxZoneConnection!
  • # Geofences.
  • #
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • geofences(
  • 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,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): GeofenceConnection!
  • # Get list of vehicles from external GPS tracking provider.
  • #
  • # Arguments
  • # gps_tracking_provider_id: A `GpsTrackingProvider` ID.
  • # filter_assigned: Filter out vehicles already assigned from
  • # external provider list.
  • get_gps_tracking_provider_vehicles(
  • gps_tracking_provider_id: Int64Bit!,
  • filter_assigned: Boolean!
  • ): GetGpsTrackingProviderVehiclesConnection
  • # Returns the next IP address in the IP pool.
  • #
  • # Arguments
  • # ip_pool_id: The ID of an `IpPool`.
  • get_next_ip_address_in_ip_pool(
  • ip_pool_id: Int64Bit!
  • ): NextIpAddress!
  • # Returns the next subnet in the subnet.
  • #
  • # Arguments
  • # subnet_id: The ID of a `Subnet`.
  • # cidr_size: fields.cidr_size
  • get_next_subnet_in_subnet(
  • subnet_id: Int64Bit!,
  • cidr_size: Int!
  • ): NextSubnet!
  • # Returns the next available subnet of the requested size in the supernet.
  • #
  • # Arguments
  • # supernet_id: The ID of a `Supernet`.
  • # cidr_size: fields.cidr_size
  • get_next_subnet_in_supernet(
  • supernet_id: Int64Bit!,
  • cidr_size: Int!
  • ): NextSubnet!
  • # Global inventory model minimums/maximums.
  • #
  • # 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.
  • # inventory_model_id: The ID of an `InventoryModel`.
  • # maximum: Maximum value
  • # minimum: Minimum value
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • global_inventory_model_min_maxes(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • inventory_model_id: Int64Bit,
  • maximum: Int,
  • minimum: Int,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): GlobalInventoryModelMinMaxConnection!
  • # GPS tracking provider credentials.
  • #
  • # 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.
  • # gps_tracking_provider_id: A `GpsTrackingProvider` ID.
  • # key: Key for a specific value.
  • # value: The value.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • gps_tracking_provider_credentials(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • gps_tracking_provider_id: Int64Bit,
  • key: GpsTrackingProviderAuthCredential,
  • value: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): GpsTrackingProviderCredentialConnection!
  • # GPS tracking providers.
  • #
  • # 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.
  • # enabled: Whether or not this is enabled.
  • # oauth_required: Whether OAuth authentication required.
  • # provider: A type of GPS tracking provider.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • gps_tracking_providers(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • enabled: Boolean,
  • oauth_required: Boolean,
  • provider: GpsTrackingProviderType,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): GpsTrackingProviderConnection!
  • # Signatures on signed contracts.
  • #
  • # 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.
  • # contact_email_address: The email address of the contact that
  • # the contract was originally sent to.
  • # contact_name: The name of the contact that the contract was
  • # originally sent to.
  • # contact_role: The role of the contact that the contract was
  • # originally sent to.
  • # signer_ip: The IP address of the contract signatory.
  • # signer_name: The name provided by the contract signatory.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • handwritten_signatures(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • contact_email_address: EmailAddress,
  • contact_name: String,
  • contact_role: String,
  • signer_ip: IP,
  • signer_name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): HandwrittenSignatureConnection!
  • # ICMP results.
  • #
  • # Arguments
  • # start_datetime: The date and time that this starts.
  • # end_datetime: The date and time that this ends.
  • # inventory_item_id: The ID of an `InventoryItem`.
  • icmp_results(
  • start_datetime: Datetime,
  • end_datetime: Datetime,
  • inventory_item_id: Int64Bit!
  • ): IcmpNetworkMonitoringResultConnection!
  • # Details related to an ActiveDirectory identity provider.
  • #
  • # 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.
  • # cert_auth: Whether to use client SSL certificate authentication
  • # or not.
  • # disable_cache: Whether to disable the cache or not.
  • # domain_aliases: The list of domains that can be authenticated.
  • # icon_url: The ActiveDirectory icon URL.
  • # identity_provider_id: The ID of an `IdentityProvider`.
  • # ips: The range of IPs with which to use Windows Integrated Auth
  • # (Kerberos).
  • # kerberos: Whether to use Windows Integrated Auth (Kerberos) or
  • # not.
  • # ticket_url: The ActiveDirectory provisioning ticket URL.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • identity_provider_active_directory_details(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • cert_auth: Boolean,
  • disable_cache: Boolean,
  • domain_aliases: [String],
  • icon_url: URL,
  • identity_provider_id: Int64Bit,
  • ips: [String],
  • kerberos: Boolean,
  • ticket_url: URL,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): IdentityProviderActiveDirectoryDetailConnection!
  • # Details related to a Google identity provider.
  • #
  • # 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.
  • # client_id: The client ID for this identity provider.
  • # client_secret: The client secret for this identity provider.
  • # identity_provider_id: The ID of an `IdentityProvider`.
  • # 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.
  • # general_search_mode: The mode to use for general search
  • # requests.
  • # 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.
  • identity_provider_google_details(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • client_id: String,
  • client_secret: String,
  • identity_provider_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • general_search_mode: GeneralSearchMode,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): IdentityProviderGoogleDetailConnection!
  • # Details related to a Microsoft identity provider.
  • #
  • # 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.
  • # client_id: The client ID for this identity provider.
  • # client_secret: The client secret for this identity provider.
  • # identity_provider_id: The ID of