OBJECT

BillingSetting

Billing configuration settings.

link GraphQL Schema definition

  • type BillingSetting implements LoggableInterface {
  • # 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!
  • # How often the accounting period automatically closes.
  • accounting_period_auto_close: AccountingPeriodCloseOption!
  • # The date that the accounting period was closed.
  • accounting_period_close_date: Date
  • # Whether or not to apply a late fee to past due invoices.
  • apply_late_fees: Boolean!
  • # Whether late fees should be applied to child invoices.
  • apply_late_fees_to_child_invoices: Boolean!
  • # The number of times to attempt a bank account automatic payment.
  • autopay_bank_account_attempts: Int!
  • # The number of days between retries for bank account automatic payments.
  • autopay_bank_account_retry_interval_in_days: Int!
  • # The number of times to attempt a credit card automatic payment.
  • autopay_credit_card_attempts: Int!
  • # The number of days between retries for credit card automatic payments.
  • autopay_credit_card_retry_interval_in_days: Int!
  • # Whether the automatic payment process should just run the invoice amount, or the
  • # entire amount due on the account.
  • autopay_runs_entire_amount_due: Boolean!
  • # Whether or not the daily billing process is enabled.
  • daily_billing: Boolean!
  • # The number of days after the due date on a delinquent invoice for a late fee to
  • # be applied.
  • days_after_invoice_due_for_late_fee_application: Int
  • # Whether or not to delete expired credit cards from Sonar.
  • delete_expired_credit_cards: Boolean!
  • # Friday.
  • delinquency_check_day_friday: Boolean!
  • # Monday.
  • delinquency_check_day_monday: Boolean!
  • # Saturday.
  • delinquency_check_day_saturday: Boolean!
  • # Sunday.
  • delinquency_check_day_sunday: Boolean!
  • # Thursday.
  • delinquency_check_day_thursday: Boolean!
  • # Tuesday.
  • delinquency_check_day_tuesday: Boolean!
  • # Wednesday.
  • delinquency_check_day_wednesday: Boolean!
  • # The `AccountStatus` for disconnected accounts.
  • disconnect_account_status_id: Int64Bit!
  • # Whether to exclude inactive accounts from late fee application.
  • exclude_inactive_accounts_from_late_fees: Boolean!
  • # Generate an invoice on an account when it is first activated, if there are any
  • # uninvoiced debits.
  • generate_invoice_on_initial_activation: Boolean!
  • # Whether to invoice and email late fees immediately, or add them to the next
  • # invoice.
  • invoice_and_email_late_fees_immediately: Boolean!
  • # The minimum amount an invoice must be past due for a late fee to be applied.
  • late_fee_minimum_delinquency_amount: Int
  • # The mode for late fee application.
  • late_fee_mode: LateFeeMode!
  • # If late fees are applied as a percentage, the percentage of the past due balance
  • # to apply.
  • late_fee_percentage: Float
  • # The ID of a one time `Service` to use for late fee application.
  • late_fee_service_id: Int64Bit
  • # The minimum account an invoice must be delinquent for before being flagged
  • # delinquent.
  • minimum_amount_due_for_delinquency: Int!
  • # The smallest bank account payment amount allowed.
  • minimum_bank_account_payment: Int!
  • # The smallest credit card payment amount allowed.
  • minimum_credit_card_payment: Int!
  • # The service ID of a one time `Service` to charge for accounts with
  • # `print_invoice` enabled in their `AccountBillingParameter`.
  • printed_invoice_fee_service_id: Int64Bit
  • # Whether or not changing the status from an active to inactive status is prorated
  • # by default.
  • prorate_account_status_change: Boolean!
  • # Whether or not changing an account bill day is prorated by default.
  • prorate_billing_day_change: Boolean!
  • # Whether or not service quantity changes are prorated by default.
  • prorate_service_quantity: Boolean!
  • # Whether or not service addition and removal is prorated by default.
  • prorate_services: Boolean!
  • # Whether or not to round prorated transactions to the nearest major unit (e.g. to
  • # the nearest dollar, euro, pound, etc.)
  • round_prorated_amounts: Boolean!
  • # The service used for late fee application.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # amount: The amount, in the smallest currency value (e.g. cents,
  • # pence, pesos.)
  • # application: How this is applied.
  • # company_id: The ID of the company that this entity operates
  • # under.
  • # enabled: Whether or not this is enabled.
  • # general_ledger_code_id: The ID of a GeneralLedgerCode.
  • # 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.
  • late_fee_service(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • amount: Int,
  • application: ServiceApplication,
  • company_id: Int64Bit,
  • enabled: Boolean,
  • general_ledger_code_id: Int64Bit,
  • name: String,
  • type: ServiceType,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): Service
  • # The service used for printed invoices.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # amount: The amount, in the smallest currency value (e.g. cents,
  • # pence, pesos.)
  • # application: How this is applied.
  • # company_id: The ID of the company that this entity operates
  • # under.
  • # enabled: Whether or not this is enabled.
  • # general_ledger_code_id: The ID of a GeneralLedgerCode.
  • # 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.
  • printed_invoice_service(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • amount: Int,
  • application: ServiceApplication,
  • company_id: Int64Bit,
  • enabled: Boolean,
  • general_ledger_code_id: Int64Bit,
  • name: String,
  • type: ServiceType,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): Service
  • # The account status used when moving accounts into the post-delinquency state.
  • #
  • # 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.
  • disconnect_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_types(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • color: HtmlHexColor,
  • icon: Icon,
  • invoice_message_id: Int64Bit,
  • name: String,
  • type: AccountTypeEnum,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccountTypeConnection!
  • # 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!
  • }