OBJECT

AccountBillingParameter

Parameters that define the billing settings for an Account.

link GraphQL Schema definition

  • type AccountBillingParameter implements 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 Account.
  • account_id: Int64Bit!
  • # Whether or not to aggregate invoice taxes instead of printing with each charge.
  • aggregate_invoice_taxes: Boolean!
  • # Whether or not to aggregate linked debits on Anchor invoices.
  • aggregate_linked_debits: Boolean!
  • # Determines if delinquency settings on an Anchor default is applied only to the
  • # Anchor account or the Linked accounts as well.
  • anchor_delinquency_logic: AnchorDelinquencyLogic
  • # 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_day: BillingParameterDayOption!
  • # The number of days after `auto_pay_day` that autopay runs for an invoice.
  • auto_pay_days: Int!
  • # The day that billing runs.
  • bill_day: Int
  • # 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_day_mode: BillDayModeOption!
  • # The type of bill this account receives.
  • bill_mode: BillMode!
  • # The ID of a BillingDefault.
  • billing_default_id: Int64Bit
  • # If `switch_status_after_delinquency` is `true`, then this is the number of days
  • # of delinquency to allow before the status switch.
  • days_of_delinquency_for_status_switch: Int
  • # Determines if the billing parameters apply by account type or for anchor /
  • # linked types.
  • default_for: BillingDefaultFor!
  • # 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_account_status_id: Int64Bit
  • # 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.
  • delinquency_removal_account_status_id: Int64Bit
  • # The number of days after the invoice date that it is due.
  • due_days: Int!
  • # If `invoice_day` is not null, this allows you to select whether `due_days` is
  • # calculated from the billing day, or the invoice day.
  • due_days_day: BillingParameterDayOption!
  • # The number of days after the invoice due date that the invoice is marked
  • # delinquent.
  • grace_days: Int!
  • # A temporary override that stops the account becoming delinquent until this date.
  • grace_until: Date
  • # The day that automatic billing invoices are generated for. If this is `null`,
  • # then `bill_day` is used.
  • invoice_day: Int
  • # Whether or not this account participates in the federal Lifeline program.
  • lifeline: Boolean!
  • # The number of months to bill at a time.
  • months_to_bill: Int!
  • # Whether this account receives a printed invoice.
  • print_invoice: Boolean!
  • # Whether or not this account should be moved into another status after being
  • # delinquent for a preset period.
  • switch_status_after_delinquency: Boolean!
  • # Whether or not this account is tax exempt.
  • tax_exempt: Boolean!
  • # The status that an `Account` is moved into after a certain length of
  • # delinquency.
  • #
  • # 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.
  • delinquency_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 `AccountStatus` an account is moved back into after no longer being
  • # delinquent, if it is currently in the delinquency account status defined on the
  • # `AccountBillingParameter`.
  • #
  • # 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.
  • delinquency_removal_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
  • # A customer account.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # account_status_id: The ID of an AccountStatus.
  • # account_type_id: The ID of an AccountType.
  • # activation_date: The date an account was first activated.
  • # activation_time: The time an account was first activated.
  • # company_id: The ID of the company that this entity operates
  • # under.
  • # data_usage_percentage: The percentage of the data usage cap
  • # that this account has consumed this month, taking into account any data usage
  • # top offs.
  • # geopoint: A geo-point.
  • # is_delinquent: Whether or not this account is delinquent.
  • # name: A descriptive name.
  • # next_bill_date: The next date this service will bill. If this
  • # is null, it will bill on the next account billing date.
  • # next_recurring_charge_amount: The next recurring charge amount
  • # for an account. This is the sum of data, expiring, recurring, and voice services
  • # of an account for this billing cycle, including tax.
  • # parent_account_id: The ID of the `Account` that is this
  • # `Account`s master.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • 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
  • # Default billing settings that are applied to some accounts on creation.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # account_type_id: The ID of an AccountType.
  • # aggregate_invoice_taxes: Whether or not to aggregate invoice
  • # taxes instead of printing with each charge.
  • # aggregate_linked_debits: Whether or not to aggregate linked
  • # debits on Anchor invoices.
  • # anchor_default_id: The ID of a BillingDefault acting as an
  • # Anchor default.
  • # 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
  • # autopay runs for an invoice.
  • # bill_day: The day that billing runs.
  • # bill_day_mode: Whether the account bill and invoice day are
  • # fixed, the account activation day is used as bill day, or the account activation
  • # day is used as the invoice day.
  • # bill_mode: The type of bill this account receives.
  • # days_of_delinquency_for_status_switch: If
  • # `switch_status_after_delinquency` is `true`, then this is the number of days of
  • # delinquency to allow before the status switch.
  • # default: If this is `true`, then this is the default billing
  • # default that is used, if there is no more specific billing default option for an
  • # account.
  • # 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.
  • # fixed_bill_day: Whether or not to use a fixed bill day, versus
  • # anniversary day billing. Use `bill_day_mode` for further customization.
  • # grace_days: The number of days after the invoice due date that
  • # the invoice is marked delinquent.
  • # invoice_day: The day that automatic billing invoices are
  • # generated for. If this is `null`, then `bill_day` is used.
  • # lifeline: Whether or not this account participates in the
  • # federal Lifeline program.
  • # months_to_bill: The number of months to bill at a time.
  • # name: A descriptive name.
  • # print_invoice: Whether this account receives a printed invoice.
  • # switch_status_after_delinquency: Whether or not this account
  • # should be moved into another status after being delinquent for a preset period.
  • # tax_exempt: Whether or not this account is tax exempt.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • billing_default(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_type_id: Int64Bit,
  • aggregate_invoice_taxes: Boolean,
  • aggregate_linked_debits: Boolean,
  • anchor_default_id: Int64Bit,
  • anchor_delinquency_logic: AnchorDelinquencyLogic,
  • auto_pay_day: BillingParameterDayOption,
  • auto_pay_days: Int,
  • bill_day: Int,
  • bill_day_mode: BillDayModeOption,
  • bill_mode: BillMode,
  • days_of_delinquency_for_status_switch: Int,
  • default: Boolean,
  • default_for: BillingDefaultFor,
  • delinquency_account_status_id: Int64Bit,
  • delinquency_removal_account_status_id: Int64Bit,
  • due_days: Int,
  • due_days_day: BillingParameterDayOption,
  • fixed_bill_day: Boolean,
  • grace_days: Int,
  • invoice_day: Int,
  • lifeline: Boolean,
  • months_to_bill: Int,
  • name: String,
  • print_invoice: Boolean,
  • switch_status_after_delinquency: Boolean,
  • tax_exempt: Boolean,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): BillingDefault
  • # 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!
  • }