OBJECT
Company
A company you do business as.
link GraphQL Schema definition
- type Company implements AddressableInterface, NoteableInterface, FileableInterface, 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 daily end time of the period during which billing communication e.g. new
- # invoices, delinquency, etc. will not be sent.
- Time :
- # The daily start time of the period during which billing communication e.g. new
- # invoices, delinquency, etc. will not be sent.
- Time :
- # On an enabled remittance slip, who should checks be made payable to?
- String :
- # A two character country code.
- Country! :
- # The URL to your customer portal.
- URL :
- # Whether or not this entity is a default entry.
- Boolean! :
- # Whether or not this is enabled.
- Boolean! :
- # The ISP type of this `Company`.
- IspType :
- # A descriptive name.
- String! :
- # A telephone number.
- Numeric :
- # The primary color to use in Sonar.
- HtmlHexColor! :
- # The secondary color to use in Sonar.
- HtmlHexColor! :
- # Whether or not to include a detachable remittance slip on the invoice.
- Boolean! :
- # A tax identification number. Should only be entered if you are required to share
- # some type of tax identification information with your customers.
- String :
- # The address of the company website.
- 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.
- # creation_token: A token sent to the payment provider during
- # payment creation.
- # 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.
- # fee: The fee for this transaction.
- # fractional_fee: The fee for this transaction in fractional
- # cents
- # full_processor_response: The entire response back from the
- # company that processed the transaction. Not typically human readable.
- # passed_3ds_check: Whether or not this payment passed the 3DS
- # security check.
- # passed_avs_check: Whether or not this payment passed the AVS
- # security check.
- # passed_cvv_check: Whether or not this payment passed the CVV
- # security check.
- # payment_datetime: The date and time the payment was made.
- # payment_tracker_id: The unique tracking ID for this payment.
- # payment_type: The type of payment (e.g. cash, credit card.)
- # processor_message: The message returned back from the company
- # that processed the transaction.
- # processor_status: The status of the payment provided by the
- # payment processor.
- # reference: A payment reference like a check number, or wire
- # transfer confirmation number.
- # status: The status.
- # 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.
- (
- Int64Bit, :
- ID, :
- Datetime, :
- Datetime, :
- String, :
- Int64Bit, :
- Int, :
- Int, :
- Int64Bit, :
- Int64Bit, :
- String, :
- Int64Bit, :
- Int64Bit, :
- String, :
- Int, :
- Int, :
- String, :
- Boolean, :
- Boolean, :
- Boolean, :
- Datetime, :
- String, :
- PaymentType, :
- String, :
- String, :
- String, :
- PaymentStatus, :
- Boolean, :
- String, :
- Int64Bit, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- 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.
- # 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.
- (
- Int64Bit, :
- ID, :
- Datetime, :
- Datetime, :
- String, :
- Int64Bit, :
- Int64Bit, :
- Date, :
- Time, :
- Int64Bit, :
- Int, :
- Geopoint, :
- Boolean, :
- String, :
- Date, :
- Int, :
- Int64Bit, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- 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`.
- # 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.
- (
- Int64Bit, :
- ID, :
- Datetime, :
- Datetime, :
- String, :
- Int64Bit, :
- Int, :
- Int64Bit, :
- String, :
- String, :
- String, :
- Int64Bit, :
- Int64Bit, :
- Float, :
- Int, :
- Date, :
- Date, :
- Int, :
- Int, :
- Int, :
- Boolean, :
- Datetime, :
- Int64Bit, :
- Int64Bit, :
- String, :
- ServiceTransactionType, :
- ServiceType, :
- Int64Bit, :
- Int64Bit, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- 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 autopay has been
- # attempted.
- # auto_pay_date: The date that autopay 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.
- # invoice_template_version_id: The ID of the Invoice Template
- # Version which was active when this invoice was generated.
- # late_fee_applied: Whether or not a late fee has been applied.
- # late_fee_only: Whether or not the invoice includes only late
- # fees.
- # 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.
- # pending_email: Used by system to indicate the invoice has been
- # marked to be sent to email contacts.
- # remaining_due: The amount remaining to be paid.
- # status: The phase of the invoice moving through creation.
- # tax_committed: Whether this entity's taxes have been committed
- # or not.
- # tax_provider_id: The ID of an `TaxProvider`.
- # 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.
- (
- Int64Bit, :
- ID, :
- Datetime, :
- Datetime, :
- String, :
- Int64Bit, :
- Int, :
- Date, :
- Int, :
- Int64Bit, :
- Date, :
- Date, :
- Boolean, :
- Date, :
- Date, :
- Boolean, :
- Int64Bit, :
- Boolean, :
- Boolean, :
- Text, :
- Int, :
- Int64Bit, :
- Boolean, :
- Int, :
- String, :
- Boolean, :
- Int64Bit, :
- Int, :
- Int, :
- Boolean, :
- Datetime, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- 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.
- # 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] : [
- ): 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.
- (
- Int64Bit, :
- ID, :
- Datetime, :
- Datetime, :
- String, :
- Text, :
- Int64Bit, :
- Boolean, :
- String, :
- Int, :
- Int64Bit, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): ContractTemplateConnection!
- # The type of a `Job`.
- #
- # 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_completion: If this is set, any `Job` using
- # this `JobType` that is completed successfully while associated with an `Account`
- # will change the `Account` to this `AccountStatus`.
- # account_status_id_failure: If this is set, any `Job` using this
- # `JobType` that is completed unsuccessfully while associated with an `Account`
- # will change the `Account` to this `AccountStatus`.
- # action_on_completion: Completion ticket action.
- # action_on_failure: Failure ticket action.
- # all_companies: Whether or not this `JobType` is valid for all
- # `Companies`.
- # allow_completion_with_incomplete_tasks: Whether `Job`s
- # associated with this `JobType` should be able to be completed with incomplete
- # tasks.
- # color: Color.
- # contract_template_id: The ID of a `ContractTemplate`.
- # default_length_in_minutes: The default length for a `Job`
- # created using this `JobType`.
- # disconnects_account: If this is set, any `Job` using this
- # `JobType` that is completed successfully while associated with an `Account` will
- # trigger the disconnection of the `Account`.
- # enabled: Whether or not this is enabled.
- # icon: An icon.
- # name: A descriptive name.
- # task_template_id: The ID of a `TaskTemplate`.
- # ticket_group_id_completion: If this is set, any `Job` using
- # this `JobType` that is completed successfully will create a `Ticket` and assign
- # it to this `TicketGroup`.
- # ticket_group_id_failure: If this is set, any `Job` using this
- # `JobType` that is completed unsuccessfully will create a `Ticket` and assign it
- # to this `TicketGroup`.
- # ticket_status_on_completion: Ticket status on completion.
- # ticket_status_on_failure: Ticket status on failure.
- # 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, :
- Int64Bit, :
- JobTypeAction, :
- JobTypeAction, :
- Boolean, :
- Boolean, :
- HtmlHexColor, :
- Int64Bit, :
- Int, :
- Boolean, :
- Boolean, :
- Icon, :
- String, :
- Int64Bit, :
- Int64Bit, :
- Int64Bit, :
- TicketStatus, :
- TicketStatus, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): JobTypeConnection!
- # 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.
- # minutes: The total number of minutes.
- # 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.
- # tax_committed: Whether this entity's taxes have been committed
- # or not.
- # tax_provider_id: The ID of an `TaxProvider`.
- # 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.
- (
- Int64Bit, :
- ID, :
- Datetime, :
- Datetime, :
- String, :
- Int64Bit, :
- Int, :
- Int, :
- Int64Bit, :
- Int64Bit, :
- String, :
- String, :
- String, :
- Float, :
- Date, :
- Date, :
- Int, :
- Int, :
- Int, :
- Boolean, :
- Datetime, :
- Int64Bit, :
- Int64Bit, :
- String, :
- ServiceTransactionType, :
- Boolean, :
- Int64Bit, :
- ServiceType, :
- Int64Bit, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): DiscountConnection!
- # A department in a company.
- #
- # 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.
- # company_id: The ID of the company that this entity operates
- # under.
- # country: A two character country code for this phone number.
- # department_id: The ID of a department.
- # email_address: An email address.
- # extension: The extension.
- # number: The number.
- # number_formatted: A phone number formatted for human
- # readability.
- # 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, :
- Country, :
- Int64Bit, :
- EmailAddress, :
- Numeric, :
- Numeric, :
- String, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): CompanyDepartmentConnection!
- # An external reference to a dynamic template at SendGrid.
- #
- # 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.
- # company_id: The ID of the company that this entity operates
- # under.
- # email_message_content_id: The ID of an `EmailMessageContent`.
- # sendgrid_identifier: The external identifier of a dynamic
- # template at SendGrid.
- # triggered_message_id: The ID of a `TriggeredMessage`.
- # 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, :
- Int64Bit, :
- String, :
- Int64Bit, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): SendgridDynamicTemplateExternalReferenceConnection!
- # 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.
- # address_status_id: Address status ID.
- # addressable_id: The ID of the entity that owns this address.
- # addressable_type: The type of entity that owns this address.
- # anchor_address_id: The address ID for the Anchor address
- # attainable_download_speed: The attainable download speed in
- # kilobits per second.
- # attainable_upload_speed: The attainable upload speed in
- # kilobits per second.
- # avalara_pcode: Avalara PCode.
- # billing_default_id: The ID of a BillingDefault.
- # census_year: The year used for calculating fips and census
- # tract information.
- # 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.
- # is_anchor: Whether or not this address is an anchor
- # 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.
- # timezone: The timezone you want times in the system displayed
- # in.
- # 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.
- (
- Int64Bit, :
- ID, :
- Datetime, :
- Datetime, :
- String, :
- Int64Bit, :
- Int64Bit, :
- AddressableType, :
- Int64Bit, :
- Int, :
- Int, :
- String, :
- Int64Bit, :
- Int, :
- String, :
- Country, :
- UsCounty, :
- String, :
- Boolean, :
- Latitude, :
- String, :
- String, :
- Longitude, :
- Boolean, :
- Subdivision, :
- Timezone, :
- AddressType, :
- String, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- 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.
- (
- Int64Bit, :
- ID, :
- Datetime, :
- Datetime, :
- String, :
- Text, :
- Int64Bit, :
- NoteableType, :
- NotePriority, :
- Int64Bit, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- 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.
- (
- Int64Bit, :
- ID, :
- Datetime, :
- Datetime, :
- String, :
- String, :
- Int64Bit, :
- Int64Bit, :
- FileableType, :
- String, :
- String, :
- Boolean, :
- Int64Bit, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- 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.
- (
- 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!
- # 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.
- (
- Int64Bit, :
- ID, :
- Datetime, :
- Datetime, :
- String, :
- CustomfielddataableType, :
- String], : [
- String, :
- Boolean, :
- CustomFieldType, :
- Boolean, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): CustomFieldConnection!
- # A company that processes `CreditCard` transactions.
- #
- # 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.
- # amex: American Express.
- # dankort: Dankort.
- # dinersclub: Diner's Club.
- # discover: Discover.
- # enabled: Whether or not this is enabled.
- # forbrugsforeningen: Forbrugsforeningen.
- # jcb: JCB
- # maestro: Maestro.
- # mastercard: MasterCard.
- # moto_enabled: Enables processor specific `Mail Or Telephone
- # Order` functionality. Currently only applicable for `Stripe`.
- # primary: Whether or not this is the primary type of entity.
- # provider: The company that provides credit card processing
- # services.
- # unionpay: Union Pay.
- # visa: Visa
- # visaelectron: VISA Electron.
- # 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, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- Boolean, :
- CreditCardProvider, :
- Boolean, :
- Boolean, :
- Boolean, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): CreditCardProcessorConnection!
- # A processor or method of processing bank account payments.
- #
- # 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.
- # primary: Whether or not this is the primary type of entity.
- # provider: The provider for this processor.
- # 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, :
- Boolean, :
- Boolean, :
- BankAccountProvider, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): BankAccountProcessorConnection!
- # A template for generating 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.
- # enabled: Whether or not this is enabled.
- # name: A descriptive name.
- # protected: If an item is protected, it cannot be modified or
- # deleted.
- # with_remittance: The content of an Invoice Template which
- # includes a remittance slip.
- # without_remittance: The content of an Invoice Template which
- # does not include a remittance slip.
- # 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, :
- Boolean, :
- String, :
- Boolean, :
- String, :
- String, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): InvoiceTemplateConnection!
- }
link Require by
- AccountA customer account.
- AdtranMosaicSettingAn Adtran Mosaic settings record.
- CalixCloudSettingA Calix Cloud setting.
- CompanyConnectionThe connection wrapper around the `CompanyConnection` type.
- CompanyDepartmentA department in a company.
- ContractTemplateA contract template.
- DebitA debit.
- DiscountA discount.
- InvoiceAn invoice.
- Mutationnull
- PackageA collection of `Service`s.
- PaymentA payment.
- PurchaseOrderA purchase order for items from a third party vendor.
- SendgridDynamicTemplateExternalReferenceAn external reference to a dynamic template at SendGrid.
- ServiceA service.