OBJECT

Company

A company you do business as.

link GraphQL Schema definition

  • type Company implements AddressableInterface, NoteableInterface, FileableInterface, 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!
  • # On an enabled remittance slip, who should checks be made payable to?
  • checks_payable_to: String
  • # A two character country code.
  • country: Country!
  • # The URL to your customer portal.
  • customer_portal_url: URL
  • # Whether or not this entity is a default entry.
  • default: Boolean!
  • # Whether or not this is enabled.
  • enabled: Boolean!
  • # A descriptive name.
  • name: String!
  • # A telephone number.
  • phone_number: Numeric
  • # The primary color to use in Sonar.
  • primary_color: HtmlHexColor!
  • # The secondary color to use in Sonar.
  • secondary_color: HtmlHexColor!
  • # Whether or not to include a detachable remittance slip on the invoice.
  • show_remittance_slip: Boolean!
  • # A tax identification number. Should only be entered if you are required to share
  • # some type of tax identification information with your customers.
  • tax_identification: String
  • # The address of the company website.
  • website_address: URL
  • # A payment.
  • #
  • # 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 payment, in the smallest currency
  • # value.
  • # amount_remaining: The amount remaining that can be used.
  • # bank_account_id: The ID of a BankAccount.
  • # company_id: The ID of the company that this entity operates
  • # under.
  • # credit_card_id: The ID of a CreditCard.
  • # deposit_slip_id: The deposit slip ID.
  • # description: A description of the payment, used for internal
  • # reference.
  • # full_processor_response: The entire response back from the
  • # company that processed the transaction. Not typically human readable.
  • # payment_datetime: The date and time the payment was made.
  • # payment_type: The type of payment (e.g. cash, credit card.)
  • # processor_message: The message returned back from the company
  • # that processed the transaction.
  • # reference: A payment reference like a check number, or wire
  • # transfer confirmation number.
  • # successful: Whether or not this was successful.
  • # transaction_id: The transaction ID from the credit card
  • # provider.
  • # 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.
  • payments(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • amount: Int,
  • amount_remaining: Int,
  • bank_account_id: Int64Bit,
  • company_id: Int64Bit,
  • credit_card_id: Int64Bit,
  • deposit_slip_id: Int64Bit,
  • description: String,
  • full_processor_response: String,
  • payment_datetime: Datetime,
  • payment_type: PaymentType,
  • processor_message: String,
  • reference: String,
  • successful: Boolean,
  • transaction_id: String,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): PaymentConnection!
  • # 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.
  • accounts(
  • 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]
  • ): AccountConnection!
  • # 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`.
  • # 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.
  • # 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.
  • debits(
  • 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,
  • 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,
  • 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]
  • ): DebitConnection!
  • # 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.
  • invoices(
  • 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]
  • ): InvoiceConnection!
  • # 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.
  • services(
  • 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]
  • ): ServiceConnection!
  • # A contract template.
  • #
  • # 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.
  • # body: The body.
  • # company_id: The ID of the company that this entity operates
  • # under.
  • # enabled: Whether or not this is enabled.
  • # name: A descriptive name.
  • # term_in_months: The term in months.
  • # ticket_group_id: The ID of a `TicketGroup`.
  • # 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.
  • contract_templates(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • body: Text,
  • company_id: Int64Bit,
  • enabled: Boolean,
  • name: String,
  • term_in_months: Int,
  • ticket_group_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ContractTemplateConnection!
  • # A geographical address.
  • #
  • # 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.
  • # addressable_id: The ID of the entity that owns this address.
  • # addressable_type: The type of entity that owns this address.
  • # city: A city.
  • # country: A two character country code.
  • # county: A US county. Only used for US addresses.
  • # fips: Only used in the USA, this is the census tract
  • # information used for calculating things like FCC Form 477.
  • # latitude: A decimal latitude.
  • # line1: Address line 1.
  • # line2: Address line 2.
  • # longitude: A decimal longitude.
  • # serviceable: Whether or not the address is serviceable, and can
  • # be used for new accounts.
  • # subdivision: A state, province, or other country subdivision.
  • # type: The type.
  • # zip: A ZIP or postal code.
  • # 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.
  • addresses(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • addressable_id: Int64Bit,
  • addressable_type: AddressableType,
  • city: String,
  • country: Country,
  • county: UsCounty,
  • fips: String,
  • latitude: Latitude,
  • line1: String,
  • line2: String,
  • longitude: Longitude,
  • serviceable: Boolean,
  • subdivision: Subdivision,
  • type: AddressType,
  • zip: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AddressConnection!
  • # A note.
  • #
  • # 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.
  • # message: The message.
  • # noteable_id: The ID of the entity that owns this note.
  • # noteable_type: The type of entity that owns this note.
  • # priority: The priority of this item.
  • # 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.
  • notes(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • message: Text,
  • noteable_id: Int64Bit,
  • noteable_type: NoteableType,
  • priority: NotePriority,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): NoteConnection!
  • # A file.
  • #
  • # 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.
  • # description: A human readable description.
  • # file_size_in_bytes: The file size, in bytes.
  • # fileable_id: The ID of the entity that owns this file.
  • # fileable_type: The type of entity that owns this file.
  • # filename: The file name.
  • # mime_type: The MIME type of the file.
  • # primary_image: An image file may be set to the primary image.
  • # This will be used as the displayed image for the object that this file is
  • # associated to throughout Sonar.
  • # 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.
  • files(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • description: String,
  • file_size_in_bytes: Int64Bit,
  • fileable_id: Int64Bit,
  • fileable_type: FileableType,
  • filename: String,
  • mime_type: String,
  • primary_image: Boolean,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): FileConnection!
  • # 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!
  • # A user defined field.
  • #
  • # 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.
  • # entity_type: The type of entity this custom field will be
  • # associated with.
  • # enum_options: A list of values that are valid for this field,
  • # if this is a TEXT field. If this is empty, and the field is a TEXT type, then
  • # any value will be allowed.
  • # name: A descriptive name.
  • # required: Whether or not this field is required.
  • # type: The type.
  • # unique: Whether or not the value of this custom field must be
  • # unique throughout the system.
  • # 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.
  • custom_fields(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • entity_type: CustomfielddataableType,
  • enum_options: [String],
  • name: String,
  • required: Boolean,
  • type: CustomFieldType,
  • unique: Boolean,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CustomFieldConnection!
  • }