OBJECT
Discount

A discount.
GraphQL Schema definition

type Discount implements TaxtransactionableInterface, CreditableInterface, LoggableInterface, AccessloggableInterface, 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 of the `Discount`.
amount: Int! 
#   The amount remaining that can be used.
amount_remaining: Int! 
#   The ID of the company that this entity operates under.
company_id: Int64Bit! 
#   If this discount was created due to reversal of a `Debit`, this field will link 
#   to the reversed `Debit`.
debit_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 total number of minutes.
minutes: Float 
#   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 user ID that reversed this.
reversed_by_user_id: Int64Bit 
#   The ID of a Service.
service_id: Int64Bit! 
#   The name of a service.
service_name: String! 
#   The type of transaction on this service.
service_transaction_type: ServiceTransactionType 
#   Whether this entity's taxes have been committed or not.
tax_committed: Boolean! 
#   The ID of an `TaxProvider`.
tax_provider_id: Int64Bit 
#   The type.
type: ServiceType! 
#   The ID of the user who created this transaction.
user_id: Int64Bit 
#   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 
#   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.
#   billing_communication_delay_end_local_time: The daily end time 
#   of the period during which billing communication e.g. new invoices, delinquency, 
#   etc. will not be sent.
#   billing_communication_delay_start_local_time: The daily start 
#   time of the period during which billing communication e.g. new invoices, 
#   delinquency, etc. will not be sent.
#   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,
billing_communication_delay_end_local_time: Time,
billing_communication_delay_start_local_time: Time,
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 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.
service(
id: Int64Bit,
sonar_unique_id: ID,
created_at: Datetime,
updated_at: Datetime,
_version: String,
amount: Int,
application: ServiceApplication,
company_id: Int64Bit,
display_if_zero: Boolean,
enabled: Boolean,
general_ledger_code_id: Int64Bit,
name: String,
reverse_tax_definition_id: Int64Bit,
tax_definition_id: Int64Bit,
type: ServiceType,
paginator: Paginator,
sorter: [Sorter],
search: [Search],
general_search: String,
aggregation: [Aggregator],
reverse_relation_filters: [ReverseRelationFilter]
): Service 
#   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 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.
debit(
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]
): Debit 
#   A tax provider.
# 
# 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.
#   enabled: Whether or not this is enabled.
#   name: A descriptive name.
#   subdivisions: The list of subdivisions where this tax provider 
#   will collect taxes.
#   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.
tax_provider(
id: Int64Bit,
sonar_unique_id: ID,
created_at: Datetime,
updated_at: Datetime,
_version: String,
enabled: Boolean,
name: String,
subdivisions: [Subdivision],
type: TaxProviderType,
paginator: Paginator,
sorter: [Sorter],
search: [Search],
general_search: String,
aggregation: [Aggregator],
reverse_relation_filters: [ReverseRelationFilter]
): TaxProvider 
#   The user that caused a reversal.
# 
# 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.
reversed_by_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.
#   tax_provider_id: The ID of an `TaxProvider`.
#   taxdefinitionable_id: The ID of entity this tax definition is 
#   related to.
#   taxdefinitionable_type: The type of entity this tax definition 
#   is related to.
#   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,
tax_provider_id: Int64Bit,
taxdefinitionable_id: Int64Bit,
taxdefinitionable_type: TaxdefinitionableType,
taxtransactionable_id: Int64Bit,
taxtransactionable_type: TaxtransactionableType,
paginator: Paginator,
sorter: [Sorter],
search: [Search],
general_search: String,
aggregation: [Aggregator],
reverse_relation_filters: [ReverseRelationFilter]
): TaxTransactionConnection! 
#   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! 
#   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! 
}
Discount

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
