OBJECT
BillingService
The service items and overrides for linked billing defaults.
link GraphQL Schema definition
- type BillingService implements LoggableInterface, AccessloggableInterface {
- # The ID of the entity.
- : Int64Bit!
- # An ID that uniquely identifies this entity across the whole Sonar system.
- : ID!
- # The date and time this entity was created.
- : Datetime!
- # The last date and time this entity was modified.
- : Datetime!
- # A string that shows the version of this entity. It will be incremented whenever
- # the entity is modified.
- : String!
- # The amount of the service that will be invoiced to the anchor account. Cannot
- # exceed price provided.
- : Int
- # The ID of a BillingDefault.
- : Int64Bit!
- # The ID of a BillingPackage.
- : Int64Bit
- # Overriding the service name will alter the service name printed on an invoice.
- : String
- # The price per unit of this item.
- : Int
- # The ID of a Service.
- : Int64Bit!
- # 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.
- # service_period_duration: The length of the service period in
- # days when using a Flexible Bill Day Mode.
- # service_period_offset: The offset between the service period
- # and the billing period in days when using a Flexible Bill Day Mode.
- # 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.
- (
- : Int64Bit,
- : ID,
- : Datetime,
- : Datetime,
- : String,
- : Int64Bit,
- : Boolean,
- : Boolean,
- : Int64Bit,
- : AnchorDelinquencyLogic,
- : BillingParameterDayOption,
- : Int,
- : Int,
- : BillDayModeOption,
- : BillMode,
- : Int,
- : Boolean,
- : BillingDefaultFor,
- : Int64Bit,
- : Int64Bit,
- : Int,
- : BillingParameterDayOption,
- : Boolean,
- : Int,
- : Int,
- : Boolean,
- : Int,
- : String,
- : Boolean,
- : Int,
- : Int,
- : Boolean,
- : Boolean,
- : Paginator,
- : [Sorter],
- : [Search],
- : String,
- : [Aggregator],
- : [ReverseRelationFilter]
- ): BillingDefault
- # A billing package.
- #
- # Arguments
- # id: The ID of the entity.
- # sonar_unique_id: An ID that uniquely identifies this entity
- # across the whole Sonar system.
- # created_at: The date and time this entity was created.
- # updated_at: The last date and time this entity was modified.
- # _version: A string that shows the version of this entity. It
- # will be incremented whenever the entity is modified.
- # billing_default_id: The ID of a BillingDefault.
- # name_override: Overriding the service name will alter the
- # service name printed on an invoice.
- # package_id: The ID of a `Package`.
- # rollup_services_override: Overriding the setting to indicate if
- # services in this package should be rolled up into a package total when this
- # package is displayed.
- # 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.
- (
- : Int64Bit,
- : ID,
- : Datetime,
- : Datetime,
- : String,
- : Int64Bit,
- : String,
- : Int64Bit,
- : Boolean,
- : Paginator,
- : [Sorter],
- : [Search],
- : String,
- : [Aggregator],
- : [ReverseRelationFilter]
- ): BillingPackage
- # 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.
- # 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.
- # display_if_zero: If the amount for this service is zero, it
- # will still display on invoices.
- # enabled: Whether or not this is enabled.
- # general_ledger_code_id: The ID of a GeneralLedgerCode.
- # name: A descriptive name.
- # reverse_tax_definition_id: The ID of a tax definition on a
- # reversed transaction.
- # tax_definition_id: The ID of a tax definition on a transaction.
- # 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.
- (
- : Int64Bit,
- : ID,
- : Datetime,
- : Datetime,
- : String,
- : Int,
- : ServiceApplication,
- : Int64Bit,
- : Boolean,
- : Boolean,
- : Int64Bit,
- : String,
- : Int64Bit,
- : Int64Bit,
- : ServiceType,
- : Paginator,
- : [Sorter],
- : [Search],
- : String,
- : [Aggregator],
- : [ReverseRelationFilter]
- ): Service
- # 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.
- (
- : Int64Bit,
- : ID,
- : Datetime,
- : Datetime,
- : String,
- : Text,
- : Boolean,
- : String,
- : LogLevel,
- : Int64Bit,
- : String,
- : Int64Bit,
- : String,
- : Text,
- : Text,
- : Text,
- : LogType,
- : Int64Bit,
- : Paginator,
- : [Sorter],
- : [Search],
- : String,
- : [Aggregator],
- : [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.
- (
- : Int64Bit,
- : ID,
- : Datetime,
- : Datetime,
- : String,
- : Datetime,
- : Int64Bit,
- : String,
- : Int64Bit,
- : String,
- : Int64Bit,
- : Paginator,
- : [Sorter],
- : [Search],
- : String,
- : [Aggregator],
- : [ReverseRelationFilter]
- ): AccessLogConnection!
- }