OBJECT

Account

A customer account.

link GraphQL Schema definition

  • type Account implements SearchableInterface, AddressableInterface, ContactableInterface, EmailableInterface, IpassignmentableInterface, IpassignmenthistoryableInterface, TicketableInterface, JobbableInterface, CustomfielddataableInterface, NoteableInterface, TaskableInterface, FileableInterface, RecentitemableInterface, LoggableInterface, AccessloggableInterface {
  • # The ID of the entity.
  • id: Int64Bit!
  • # An ID that uniquely identifies this entity across the whole Sonar system.
  • sonar_unique_id: ID!
  • # The date and time this entity was created.
  • created_at: Datetime!
  • # The last date and time this entity was modified.
  • updated_at: Datetime!
  • # A string that shows the version of this entity. It will be incremented whenever
  • # the entity is modified.
  • _version: String!
  • # The ID of an AccountStatus.
  • account_status_id: Int64Bit!
  • # The ID of an AccountType.
  • account_type_id: Int64Bit!
  • # The date an account was first activated.
  • activation_date: Date
  • # The time an account was first activated.
  • activation_time: Time
  • # The ID of the company that this entity operates under.
  • company_id: Int64Bit!
  • # The percentage of the data usage cap that this account has consumed this month,
  • # taking into account any data usage top offs.
  • data_usage_percentage: Int
  • # A geo-point.
  • geopoint: Geopoint
  • # Whether or not this account is delinquent.
  • is_delinquent: Boolean!
  • # A descriptive name.
  • name: String!
  • # The next date this service will bill. If this is null, it will bill on the next
  • # account billing date.
  • next_bill_date: Date
  • # 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.
  • next_recurring_charge_amount: Int
  • # The ID of the `Account` that is this `Account`s master.
  • parent_account_id: Int64Bit
  • # Parameters that define the billing settings for 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_id: The ID of an Account.
  • # aggregate_invoice_taxes: Whether or not to aggregate invoice
  • # taxes instead of printing with each charge.
  • # aggregate_linked_debits: Whether or not to aggregate linked
  • # debits on Anchor invoices.
  • # anchor_delinquency_logic: Determines if delinquency settings on
  • # an Anchor default is applied only to the Anchor account or the Linked accounts
  • # as well.
  • # 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.
  • # billing_default_id: The ID of a BillingDefault.
  • # 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_for: Determines if the billing parameters apply by
  • # account type or for anchor / linked types.
  • # 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.
  • # 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_parameter(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • aggregate_invoice_taxes: Boolean,
  • aggregate_linked_debits: Boolean,
  • anchor_delinquency_logic: AnchorDelinquencyLogic,
  • auto_pay_day: BillingParameterDayOption,
  • auto_pay_days: Int,
  • bill_day: Int,
  • bill_day_mode: BillDayModeOption,
  • bill_mode: BillMode,
  • billing_default_id: Int64Bit,
  • days_of_delinquency_for_status_switch: Int,
  • default_for: BillingDefaultFor,
  • 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,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccountBillingParameter
  • # The status of 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.
  • # 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.
  • # 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_status(
  • 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,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccountStatus
  • # The account type.
  • #
  • # 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.
  • # 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_type(
  • 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,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccountType
  • # The `Account` that is a parent of this `Account`.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # account_status_id: The ID of an AccountStatus.
  • # account_type_id: The ID of an AccountType.
  • # activation_date: The date an account was first activated.
  • # activation_time: The time an account was first activated.
  • # company_id: The ID of the company that this entity operates
  • # under.
  • # data_usage_percentage: The percentage of the data usage cap
  • # that this account has consumed this month, taking into account any data usage
  • # top offs.
  • # geopoint: A geo-point.
  • # is_delinquent: Whether or not this account is delinquent.
  • # name: A descriptive name.
  • # next_bill_date: The next date this service will bill. If this
  • # is null, it will bill on the next account billing date.
  • # next_recurring_charge_amount: The next recurring charge amount
  • # for an account. This is the sum of data, expiring, recurring, and voice services
  • # of an account for this billing cycle, including tax.
  • # parent_account_id: The ID of the `Account` that is this
  • # `Account`s master.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • parent_account(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_status_id: Int64Bit,
  • account_type_id: Int64Bit,
  • activation_date: Date,
  • activation_time: Time,
  • company_id: Int64Bit,
  • data_usage_percentage: Int,
  • geopoint: Geopoint,
  • is_delinquent: Boolean,
  • name: String,
  • next_bill_date: Date,
  • next_recurring_charge_amount: Int,
  • parent_account_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): Account
  • # A company you do business as.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # checks_payable_to: On an enabled remittance slip, who should
  • # checks be made payable to?
  • # country: A two character country code.
  • # customer_portal_url: The URL to your customer portal.
  • # default: Whether or not this entity is a default entry.
  • # enabled: Whether or not this is enabled.
  • # isp_type: The ISP type of this `Company`.
  • # name: A descriptive name.
  • # phone_number: A telephone number.
  • # primary_color: The primary color to use in Sonar.
  • # secondary_color: The secondary color to use in Sonar.
  • # show_remittance_slip: Whether or not to include a detachable
  • # remittance slip on the invoice.
  • # tax_identification: A tax identification number. Should only be
  • # entered if you are required to share some type of tax identification information
  • # with your customers.
  • # website_address: The address of the company website.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • company(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • checks_payable_to: String,
  • country: Country,
  • customer_portal_url: URL,
  • default: Boolean,
  • enabled: Boolean,
  • isp_type: IspType,
  • name: String,
  • phone_number: Numeric,
  • primary_color: HtmlHexColor,
  • secondary_color: HtmlHexColor,
  • show_remittance_slip: Boolean,
  • tax_identification: String,
  • website_address: URL,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): Company
  • # A geographical address.
  • #
  • # 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.
  • # anchor_address_id: The address ID for the Anchor address
  • # avalara_pcode: Avalara PCode.
  • # billing_default_id: The ID of a BillingDefault.
  • # 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.
  • # is_anchor: Whether or not this address is an anchor
  • # 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.
  • # 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,
  • anchor_address_id: Int64Bit,
  • avalara_pcode: String,
  • billing_default_id: Int64Bit,
  • census_year: Int,
  • city: String,
  • country: Country,
  • county: UsCounty,
  • fips: String,
  • is_anchor: Boolean,
  • 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,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AddressConnection!
  • # 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.
  • # 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,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ContactConnection!
  • # An 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.
  • # 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.
  • # 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,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): EmailConnection!
  • # An IP address assignment.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # description: A human readable description.
  • # ip_pool_id: The ID of an `IpPool`.
  • # ipassignmentable_id: The ID of the owner of this
  • # `IpAssignment`.
  • # ipassignmentable_type: The owner of this `IpAssignment`.
  • # reference: Some reference data regarding this IP assignment.
  • # soft: If this IP was assigned automatically (e.g. via DHCP or
  • # RADIUS) then it will be marked as a soft assignment.
  • # subnet: An IPv4/IPv6 subnet.
  • # subnet_id: The ID of a `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.
  • # 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.
  • ip_assignments(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • description: String,
  • ip_pool_id: Int64Bit,
  • ipassignmentable_id: Int64Bit,
  • ipassignmentable_type: IpassignmentableType,
  • reference: Text,
  • soft: Boolean,
  • subnet: SubnetScalar,
  • subnet_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): IpAssignmentConnection!
  • # A historical record of an IP assignment.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # assigned_datetime: The date and time of assignment.
  • # description: A human readable description.
  • # ip_assignment_id: The ID of an `IpAssignment`.
  • # ipassignmentable_id: The ID of the owner of this
  • # `IpAssignment`.
  • # ipassignmentable_type: The owner of this `IpAssignment`.
  • # ipassignmenthistoryable_id: The ID of the entity that the IP
  • # address was assigned to.
  • # ipassignmenthistoryable_type: The parent entity that the IP
  • # address was assigned to (e.g. `Account`, `NetworkSite`.)
  • # reference: Some reference data regarding this IP assignment.
  • # removed_datetime: The date and time of removal.
  • # soft: If this IP was assigned automatically (e.g. via DHCP or
  • # RADIUS) then it will be marked as a soft assignment.
  • # subnet: An IPv4/IPv6 subnet.
  • # unique_identifier: Some unique identifier that was related to
  • # the IP (e.g. a MAC address, IMSI, RADIUS username.)
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • ip_assignment_histories(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • assigned_datetime: Datetime,
  • description: String,
  • ip_assignment_id: Int64Bit,
  • ipassignmentable_id: Int64Bit,
  • ipassignmentable_type: IpassignmentableType,
  • ipassignmenthistoryable_id: Int64Bit,
  • ipassignmenthistoryable_type: IpassignmenthistoryableType,
  • reference: Text,
  • removed_datetime: Datetime,
  • soft: Boolean,
  • subnet: SubnetScalar,
  • unique_identifier: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): IpAssignmentHistoryConnection!
  • # A ticket.
  • #
  • # 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.
  • # global_updated_at: The last date and time this entity was
  • # updated, or was the subject of a log.
  • # closed_at: The time this was closed at.
  • # closed_by_user_id: The ID of the `User` that closed this.
  • # description: A human readable description.
  • # due_date: The date this invoice is due by.
  • # inbound_mailbox_id: The ID of an `InboundMailbox`.
  • # parent_ticket_id: The ID of the `Ticket` that this `Ticket` is
  • # a child of.
  • # priority: The priority of this item.
  • # spam_score: Mail processor's spam rating for whether or not
  • # this is spam.
  • # status: The status.
  • # subject: The subject.
  • # ticket_group_id: The ID of a `TicketGroup`.
  • # ticketable_id: The ID of the entity that this `Ticket` is
  • # associated with.
  • # ticketable_type: The type of entity that this `Ticket` is
  • # associated with.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • tickets(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • global_updated_at: Datetime,
  • closed_at: Datetime,
  • closed_by_user_id: Int64Bit,
  • description: Text,
  • due_date: Date,
  • inbound_mailbox_id: Int64Bit,
  • parent_ticket_id: Int64Bit,
  • priority: TicketPriority,
  • spam_score: Float,
  • status: TicketStatus,
  • subject: String,
  • ticket_group_id: Int64Bit,
  • ticketable_id: Int64Bit,
  • ticketable_type: TicketableType,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): TicketConnection!
  • # A job, typically in the field.
  • #
  • # 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.
  • # complete: Whether or not this is complete.
  • # completed_by_user_id: The `User` that completed this.
  • # completed_successfully: Whether this `Job` was completed
  • # successfully or not.
  • # completion_datetime: The date and time this `Job` was
  • # completed.
  • # completion_notes: Any notes entered when this `Job` was
  • # completed.
  • # job_type_id: The ID of a `JobType`.
  • # jobbable_id: The ID of the entity that this `Job` is associated
  • # with.
  • # jobbable_type: The type of entity that this `Job` is associated
  • # with.
  • # length_in_minutes: The length in minutes for this `Job`.
  • # scheduled_datetime: The date and time this `Job` is scheduled
  • # for.
  • # skips_validation: Indicates this entity has skipped the
  • # validations which would normally apply.
  • # ticket_id: The ID of a `Ticket`.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • jobs(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • complete: Boolean,
  • completed_by_user_id: Int64Bit,
  • completed_successfully: Boolean,
  • completion_datetime: Datetime,
  • completion_notes: Text,
  • job_type_id: Int64Bit,
  • jobbable_id: Int64Bit,
  • jobbable_type: JobbableType,
  • length_in_minutes: Int,
  • scheduled_datetime: Datetime,
  • skips_validation: Boolean,
  • ticket_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): JobConnection!
  • # Data entered into a `CustomField`.
  • #
  • # 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.
  • # 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,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CustomFieldDataConnection!
  • # A note.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # message: The message.
  • # noteable_id: The ID of the entity that owns this note.
  • # noteable_type: The type of entity that owns this note.
  • # priority: The priority of this item.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • notes(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • message: Text,
  • noteable_id: Int64Bit,
  • noteable_type: NoteableType,
  • priority: NotePriority,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): NoteConnection!
  • # A task.
  • #
  • # 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.
  • # completable_id: The ID of the entity that completes or
  • # completed this task.
  • # completable_type: The type of entity that completes this task.
  • # complete: Whether or not this is complete.
  • # completed_at: The date and time this was completed.
  • # completed_by_user_id: The `User` that completed this.
  • # completion_type: How this task gets marked as completed.
  • # due: The date on which the task is due.
  • # list_order: The order this item is shown in a list.
  • # task: The task to be performed.
  • # taskable_id: The ID of the entity that the task is associated
  • # with.
  • # taskable_type: The entity that the task is associated with.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • tasks(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • completable_id: Int64Bit,
  • completable_type: CompletableType,
  • complete: Boolean,
  • completed_at: Datetime,
  • completed_by_user_id: Int64Bit,
  • completion_type: TaskCompletionType,
  • due: Date,
  • list_order: Int,
  • task: Text,
  • taskable_id: Int64Bit,
  • taskable_type: TaskableType,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): TaskConnection!
  • # A file.
  • #
  • # 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.
  • # 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,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): FileConnection!
  • # A log entry.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # current: Current data.
  • # legacy: Whether or not this log was transferred from a Sonar v1
  • # instance. If so, the formatting will not match current version logs.
  • # legacy_title: A title which is only populated on logs that were
  • # imported from Sonar v1.
  • # level: The severity level.
  • # loggable_id: The ID of the entity that this log is attached to.
  • # loggable_type: The type of entity that this log is attached to.
  • # logged_entity_id: The entity ID that triggered the log.
  • # logged_entity_type: The entity that triggered the log.
  • # message: The message.
  • # previous: Previous data.
  • # relation_data: Data from objects related to this change.
  • # type: The type.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • logs(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • current: Text,
  • legacy: Boolean,
  • legacy_title: String,
  • level: LogLevel,
  • loggable_id: Int64Bit,
  • loggable_type: String,
  • logged_entity_id: Int64Bit,
  • logged_entity_type: String,
  • message: Text,
  • previous: Text,
  • relation_data: Text,
  • type: LogType,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): LogConnection!
  • # An access log history on an entity.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # access_datetime: The date and time that this entity was
  • # accessed.
  • # accessloggable_id: The ID of the entity that this access log
  • # belongs to.
  • # accessloggable_type: The entity that this access log belongs
  • # to.
  • # entity_id: The ID of the entity that this access log belongs
  • # to.
  • # entity_name: The entity that this access log belongs to.
  • # user_id: The ID of the user that accessed this entity.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • access_logs(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • access_datetime: Datetime,
  • accessloggable_id: Int64Bit,
  • accessloggable_type: String,
  • entity_id: Int64Bit,
  • entity_name: String,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccessLogConnection!
  • # An account group.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # name: A descriptive name.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • account_groups(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccountGroupConnection!
  • # A geographical tax zone.
  • #
  • # 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.
  • # 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,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): GeoTaxZoneConnection!
  • # The data cap `TriggeredMessages` sent to this `Account` for the current billing
  • # cycle.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # allow_children: Whether or not child accounts are allowed.
  • # count: The count associated with this `TriggeredMessage`. This
  • # is defined by the trigger, and could be something like a number of days, months,
  • # gigabytes, etc.
  • # email_message_id: The ID of an EmailMessage.
  • # enabled: Whether or not this is enabled.
  • # job_type_id: The ID of a `JobType`.
  • # name: A descriptive name.
  • # protected: If an item is protected, it cannot be modified or
  • # deleted.
  • # signature_id: The ID of a signature.
  • # sms_message_id: The ID of the SMS message.
  • # trigger: The trigger for this message.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • usage_triggered_messages(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • allow_children: Boolean,
  • count: Int,
  • email_message_id: Int64Bit,
  • enabled: Boolean,
  • job_type_id: Int64Bit,
  • name: String,
  • protected: Boolean,
  • signature_id: Int64Bit,
  • sms_message_id: Int64Bit,
  • trigger: MessageTrigger,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): TriggeredMessageConnection!
  • # A credit card.
  • #
  • # 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.
  • # 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,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CreditCardConnection!
  • # A payment.
  • #
  • # 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 payment, in the smallest currency
  • # value.
  • # amount_remaining: The amount remaining that can be used.
  • # bank_account_id: The ID of a BankAccount.
  • # company_id: The ID of the company that this entity operates
  • # under.
  • # creation_token: A token sent to the payment provider during
  • # payment creation.
  • # credit_card_id: The ID of a CreditCard.
  • # deposit_slip_id: The deposit slip ID.
  • # description: A description of the payment, used for internal
  • # reference.
  • # fee: The fee for this transaction.
  • # fractional_fee: The fee for this transaction in fractional
  • # cents
  • # full_processor_response: The entire response back from the
  • # company that processed the transaction. Not typically human readable.
  • # payment_datetime: The date and time the payment was made.
  • # payment_tracker_id: The unique tracking ID for this payment.
  • # payment_type: The type of payment (e.g. cash, credit card.)
  • # processor_message: The message returned back from the company
  • # that processed the transaction.
  • # processor_status: The status of the payment provided by the
  • # payment processor.
  • # reference: A payment reference like a check number, or wire
  • # transfer confirmation number.
  • # successful: Whether or not this was successful.
  • # transaction_id: The transaction ID from the credit card
  • # provider.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • payments(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • amount: Int,
  • amount_remaining: Int,
  • bank_account_id: Int64Bit,
  • company_id: Int64Bit,
  • creation_token: String,
  • credit_card_id: Int64Bit,
  • deposit_slip_id: Int64Bit,
  • description: String,
  • fee: Int,
  • fractional_fee: Int,
  • full_processor_response: String,
  • payment_datetime: Datetime,
  • payment_tracker_id: String,
  • payment_type: PaymentType,
  • processor_message: String,
  • processor_status: String,
  • reference: String,
  • successful: Boolean,
  • transaction_id: String,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): PaymentConnection!
  • # A debit.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # account_id: The ID of an Account.
  • # amount: The amount, in the smallest currency value (e.g. cents,
  • # pence, pesos.)
  • # company_id: The ID of the company that this entity operates
  • # under.
  • # description: A human readable description.
  • # general_ledger_code: A general ledger code.
  • # general_ledger_code_description: A general ledger code
  • # description.
  • # invoice_id: The ID of an `Invoice`.
  • # linked_debit_id: The ID of the Debit which is linked to the
  • # current Debit.
  • # minutes: The total number of minutes.
  • # number_of_months: The number of months of service this invoice
  • # was billed for.
  • # prorated_from: The date this transaction was prorated from.
  • # prorated_to: The date this transaction was prorated to.
  • # quantity: The quantity for this service.
  • # quantity_prorated_from: The quantity the associated service had
  • # before the quantity was changed and prorated.
  • # quantity_prorated_to: The quantity the associated service was
  • # changed to when the quantity was changed and prorated.
  • # reversed: Whether or not this has been reversed.
  • # reversed_at: When this was reversed.
  • # reversed_by_user_id: The user ID that reversed this.
  • # service_id: The ID of a Service.
  • # service_name: The name of a service.
  • # service_transaction_type: The type of transaction on this
  • # service.
  • # type: The type.
  • # user_id: The ID of the user who created this transaction.
  • # voice_service_generic_parameter_id: The ID of a voice service
  • # configuration parameter.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • debits(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • amount: Int,
  • company_id: Int64Bit,
  • description: String,
  • general_ledger_code: String,
  • general_ledger_code_description: String,
  • invoice_id: Int64Bit,
  • linked_debit_id: Int64Bit,
  • minutes: Float,
  • number_of_months: Int,
  • prorated_from: Date,
  • prorated_to: Date,
  • quantity: Int,
  • quantity_prorated_from: Int,
  • quantity_prorated_to: Int,
  • reversed: Boolean,
  • reversed_at: Datetime,
  • reversed_by_user_id: Int64Bit,
  • service_id: Int64Bit,
  • service_name: String,
  • service_transaction_type: ServiceTransactionType,
  • type: ServiceType,
  • user_id: Int64Bit,
  • voice_service_generic_parameter_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DebitConnection!
  • # A discount.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # account_id: The ID of an Account.
  • # amount: The amount of the `Discount`.
  • # amount_remaining: The amount remaining that can be used.
  • # company_id: The ID of the company that this entity operates
  • # under.
  • # debit_id: If this discount was created due to reversal of a
  • # `Debit`, this field will link to the reversed `Debit`.
  • # description: A human readable description.
  • # general_ledger_code: A general ledger code.
  • # general_ledger_code_description: A general ledger code
  • # description.
  • # minutes: The total number of minutes.
  • # prorated_from: The date this transaction was prorated from.
  • # prorated_to: The date this transaction was prorated to.
  • # quantity: The quantity for this service.
  • # quantity_prorated_from: The quantity the associated service had
  • # before the quantity was changed and prorated.
  • # quantity_prorated_to: The quantity the associated service was
  • # changed to when the quantity was changed and prorated.
  • # reversed: Whether or not this has been reversed.
  • # reversed_at: When this was reversed.
  • # reversed_by_user_id: The user ID that reversed this.
  • # service_id: The ID of a Service.
  • # service_name: The name of a service.
  • # service_transaction_type: The type of transaction on this
  • # service.
  • # tax_committed: Whether this entity's taxes have been committed
  • # or not.
  • # tax_provider_id: The ID of an `TaxProvider`.
  • # type: The type.
  • # user_id: The ID of the user who created this transaction.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • discounts(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • amount: Int,
  • amount_remaining: Int,
  • company_id: Int64Bit,
  • debit_id: Int64Bit,
  • description: String,
  • general_ledger_code: String,
  • general_ledger_code_description: String,
  • minutes: Float,
  • prorated_from: Date,
  • prorated_to: Date,
  • quantity: Int,
  • quantity_prorated_from: Int,
  • quantity_prorated_to: Int,
  • reversed: Boolean,
  • reversed_at: Datetime,
  • reversed_by_user_id: Int64Bit,
  • service_id: Int64Bit,
  • service_name: String,
  • service_transaction_type: ServiceTransactionType,
  • tax_committed: Boolean,
  • tax_provider_id: Int64Bit,
  • type: ServiceType,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DiscountConnection!
  • # An invoice.
  • #
  • # 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.
  • # status: The phase of the invoice moving through creation.
  • # 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.
  • # 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.
  • 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,
  • status: String,
  • 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,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): InvoiceConnection!
  • # The application of a `Discount` or `Payment` against an `Invoice`.
  • #
  • # 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.
  • # 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,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CreditConnection!
  • # The relationship between an `Account` and a `Service`.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # account_id: The ID of an Account.
  • # addition_prorate_date: If this service was prorated when added,
  • # this is the date it was prorated from.
  • # data_usage_last_calculated_date: The date data usage was last
  • # calculated.
  • # name_override: Overriding the service name will alter the
  • # service name printed on an invoice.
  • # next_bill_date: The next date this service will bill. If this
  • # is null, it will bill on the next account billing date.
  • # number_of_times_billed: The number of times this particular
  • # service has been billed to the customer. This is only used for expiring
  • # services.
  • # package_id: The ID of a `Package`.
  • # price_override: The amount that this service price has been
  • # overridden to. If this is null, then the service price is used.
  • # price_override_reason: The reason that the price of a service
  • # has been overridden.
  • # quantity: The quantity for this service.
  • # service_id: The ID of a Service.
  • # unique_package_relationship_id: A unique ID that describes this
  • # unique instance of a `Package` assignment.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • account_services(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • addition_prorate_date: Date,
  • data_usage_last_calculated_date: Date,
  • name_override: String,
  • next_bill_date: Date,
  • number_of_times_billed: Int,
  • package_id: Int64Bit,
  • price_override: Int,
  • price_override_reason: String,
  • quantity: Int,
  • service_id: Int64Bit,
  • unique_package_relationship_id: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccountServiceConnection!
  • # A list of `Account`s that this `Account` is a parent of.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # account_status_id: The ID of an AccountStatus.
  • # account_type_id: The ID of an AccountType.
  • # activation_date: The date an account was first activated.
  • # activation_time: The time an account was first activated.
  • # company_id: The ID of the company that this entity operates
  • # under.
  • # data_usage_percentage: The percentage of the data usage cap
  • # that this account has consumed this month, taking into account any data usage
  • # top offs.
  • # geopoint: A geo-point.
  • # is_delinquent: Whether or not this account is delinquent.
  • # name: A descriptive name.
  • # next_bill_date: The next date this service will bill. If this
  • # is null, it will bill on the next account billing date.
  • # next_recurring_charge_amount: The next recurring charge amount
  • # for an account. This is the sum of data, expiring, recurring, and voice services
  • # of an account for this billing cycle, including tax.
  • # parent_account_id: The ID of the `Account` that is this
  • # `Account`s master.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • child_accounts(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_status_id: Int64Bit,
  • account_type_id: Int64Bit,
  • activation_date: Date,
  • activation_time: Time,
  • company_id: Int64Bit,
  • data_usage_percentage: Int,
  • geopoint: Geopoint,
  • is_delinquent: Boolean,
  • name: String,
  • next_bill_date: Date,
  • next_recurring_charge_amount: Int,
  • parent_account_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccountConnection!
  • # A bank 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_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.
  • # 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,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): BankAccountConnection!
  • # A RADIUS 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_id: The ID of an Account.
  • # password: A password.
  • # 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.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • radius_accounts(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • password: Text,
  • username: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): RadiusAccountConnection!
  • # A MAC address that is not recorded in the inventory system.
  • #
  • # 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.
  • # mac_address: A MAC address.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • uninventoried_mac_addresses(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • mac_address: MacAddress,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): UninventoriedMacAddressConnection!
  • # An `Account` event that is run at a specific time.
  • #
  • # 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.)
  • # complete: Whether or not this is complete.
  • # datetime: A date and time
  • # description: A human readable description.
  • # event: An event.
  • # primary_event_object_id: The ID of an object described by the
  • # `event` field.
  • # prorate: Whether or not to prorate the transaction.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • scheduled_events(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • amount: Int,
  • complete: Boolean,
  • datetime: Datetime,
  • description: String,
  • event: ScheduledEventEvent,
  • primary_event_object_id: String,
  • prorate: Boolean,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ScheduledEventConnection!
  • # A contract.
  • #
  • # 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.
  • # 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,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ContractConnection!
  • # A record of a monthly billing cycle.
  • #
  • # 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.
  • # date: A date
  • # invoice_id: The ID of an `Invoice`.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • monthly_billing_completions(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • date: Date,
  • invoice_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): MonthlyBillingCompletionConnection!
  • # An override to the default taxation rate.
  • #
  • # 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.
  • # rate: The rate.
  • # tax_id: The ID of a Tax.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • tax_overrides(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • rate: Float,
  • tax_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): TaxOverrideConnection!
  • # A tax exemption.
  • #
  • # 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.
  • # jurisdictions: The jurisdictions of this `TaxExemption`.
  • # name: A descriptive name.
  • # tax_provider_id: The ID of an `TaxProvider`.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • tax_exemptions(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • jurisdictions: [TaxJurisdiction],
  • name: String,
  • tax_provider_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): TaxExemptionConnection!
  • # A call log.
  • #
  • # 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.
  • # 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,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CallLogConnection!
  • # The `Account` disconnections log.
  • #
  • # 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.
  • # 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,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DisconnectionLogConnection!
  • # A `ServiceableAddressAccountAssignmentHistory` for accounts and 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.
  • # account_id: The ID of an Account.
  • # address_id: The ID of the address.
  • # end_date: The date that this ends.
  • # start_date: The start date for this `ScheduleAvailability`.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • serviceable_address_account_assignment_histories(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • address_id: Int64Bit,
  • end_date: Date,
  • start_date: Date,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ServiceableAddressAccountAssignmentHistoryConnection!
  • # A data usage history entry.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # 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.
  • # 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,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DataUsageHistoryConnection!
  • # A data usage top off.
  • #
  • # 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.
  • # 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,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DataUsageTopOffConnection!
  • # A direct inward dial (DID) assignment.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # account_id: The ID of an Account.
  • # did_id: The ID of a `Did`.
  • # service_id: The ID of a Service.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • did_assignments(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • did_id: Int64Bit,
  • service_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DidAssignmentConnection!
  • # A historical record of a direct inward dial (DID) assignment.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # account_id: The ID of an Account.
  • # assigned_datetime: The date and time of assignment.
  • # did_assignment_id: The ID of a `DidAssignment`.
  • # did_id: The ID of a `Did`.
  • # removed_datetime: The date and time of removal.
  • # service_id: The ID of a Service.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • did_assignment_histories(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • assigned_datetime: Datetime,
  • did_assignment_id: Int64Bit,
  • did_id: Int64Bit,
  • removed_datetime: Datetime,
  • service_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): DidAssignmentHistoryConnection!
  • # A call detail record (CDR).
  • #
  • # 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.
  • # 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,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CallDetailRecordConnection!
  • # A tracked event that has occurred for 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_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.
  • # 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,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccountEventConnection!
  • }