OBJECT

Debit

A debit.

link GraphQL Schema definition

  • type Debit implements TaxtransactionableInterface, LoggableInterface, TransactionInterface {
  • # 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!
  • # The amount, in the smallest currency value (e.g. cents, pence, pesos.)
  • amount: Int!
  • # The ID of the company that this entity operates under.
  • company_id: Int64Bit!
  • # A human readable description.
  • description: String
  • # A general ledger code.
  • general_ledger_code: String
  • # A general ledger code description.
  • general_ledger_code_description: String
  • # The ID of an `Invoice`.
  • invoice_id: Int64Bit
  • # The number of months of service this invoice was billed for.
  • number_of_months: Int!
  • # The date this transaction was prorated from.
  • prorated_from: Date
  • # The date this transaction was prorated to.
  • prorated_to: Date
  • # The quantity for this service.
  • quantity: Int!
  • # The quantity the associated service had before the quantity was changed and
  • # prorated.
  • quantity_prorated_from: Int
  • # The quantity the associated service was changed to when the quantity was changed
  • # and prorated.
  • quantity_prorated_to: Int
  • # Whether or not this has been reversed.
  • reversed: Boolean!
  • # When this was reversed.
  • reversed_at: Datetime
  • # The ID of a Service.
  • service_id: Int64Bit!
  • # The name of a service.
  • service_name: String!
  • # The type.
  • type: ServiceType!
  • # The ID of the user who created this transaction.
  • user_id: Int64Bit
  • # 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.
  • # 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.
  • # service_id: The ID of a Service.
  • # service_name: The name of a service.
  • # 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.
  • discount(
  • 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,
  • prorated_from: Date,
  • prorated_to: Date,
  • quantity: Int,
  • quantity_prorated_from: Int,
  • quantity_prorated_to: Int,
  • reversed: Boolean,
  • reversed_at: Datetime,
  • service_id: Int64Bit,
  • service_name: String,
  • type: ServiceType,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): Discount
  • # 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_off(
  • 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]
  • ): DataUsageTopOff
  • # 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.
  • # company_id: The ID of the company that this entity operates
  • # under.
  • # geopoint: A geo-point.
  • # name: A descriptive name.
  • # next_bill_date: The next date this service will bill. If this
  • # is null, it will bill on the next account billing date.
  • # 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,
  • company_id: Int64Bit,
  • geopoint: Geopoint,
  • name: String,
  • next_bill_date: Date,
  • 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.
  • # 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,
  • 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 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.
  • # 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.
  • 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
  • # 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.
  • # 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.
  • # remaining_due: The amount remaining to be paid.
  • # 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.
  • invoice(
  • 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,
  • message: Text,
  • number_of_months: Int,
  • parent_invoice_id: Int64Bit,
  • remaining_due: Int,
  • 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]
  • ): Invoice
  • # A user that can login to Sonar.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # completed_setup: Whether or not the user has completed the
  • # setup process.
  • # email_address: An email address.
  • # enabled: Whether or not this is enabled.
  • # is_sonar_staff: Whether or not this user is a Sonar employee.
  • # language: A supported language.
  • # mobile_number: A mobile phone number. This will be used to send
  • # SMS messages.
  • # name: A descriptive name.
  • # public_name: The publicly viewable name of this user.
  • # role_id: The ID of a Role.
  • # super_admin: Super admins receive all system permissions
  • # automatically, regardless of their role.
  • # 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.
  • user(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • completed_setup: Boolean,
  • email_address: EmailAddress,
  • enabled: Boolean,
  • is_sonar_staff: Boolean,
  • language: Language,
  • mobile_number: Numeric,
  • name: String,
  • public_name: String,
  • role_id: Int64Bit,
  • super_admin: Boolean,
  • username: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): User
  • # A tax transaction.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # amount: The amount, in the smallest currency value (e.g. cents,
  • # pence, pesos.)
  • # amount_taxed: The amount of this `Debit` that was taxed.
  • # description: A human readable description.
  • # taxtransactionable_id: The ID of the entity this tax
  • # transaction is related to.
  • # taxtransactionable_type: The type of entity this tax
  • # transaction is related to.
  • # 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_transactions(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • amount: Int,
  • amount_taxed: Int,
  • description: Text,
  • taxtransactionable_id: Int64Bit,
  • taxtransactionable_type: TaxtransactionableType,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): TaxTransactionConnection!
  • # 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!
  • }