OBJECT

CustomField

A user defined field.

link GraphQL Schema definition

  • type CustomField implements CompletableInterface, NoteableInterface, LoggableInterface, AccessloggableInterface {
  • # 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 type of entity this custom field will be associated with.
  • entity_type: CustomfielddataableType!
  • # 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.
  • enum_options: [String]
  • # A descriptive name.
  • name: String!
  • # Whether or not this field is required.
  • required: Boolean!
  • # The type.
  • type: CustomFieldType!
  • # Whether or not the value of this custom field must be unique throughout the
  • # system.
  • unique: Boolean!
  • # Data entered into a `CustomField`.
  • #
  • # 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.
  • # custom_field_id: The ID of a CustomField that is associated
  • # with this type of entity.
  • # customfielddataable_id: The ID of the entity that owns this
  • # custom field data.
  • # customfielddataable_type: The type of entity that owns this
  • # custom field data.
  • # value: The value.
  • # 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_field_data(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • custom_field_id: Int64Bit,
  • customfielddataable_id: Int64Bit,
  • customfielddataable_type: CustomfielddataableType,
  • value: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): CustomFieldDataConnection!
  • # 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.
  • companies(
  • 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]
  • ): CompanyConnection!
  • # A task.
  • #
  • # 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.
  • # completable_id: The ID of the entity that completes or
  • # completed this task.
  • # completable_type: The type of entity that completes this task.
  • # complete: Whether or not this is complete.
  • # completed_at: The date and time this was completed.
  • # completed_by_user_id: The `User` that completed this.
  • # completion_type: How this task gets marked as completed.
  • # due: The date on which the task is due.
  • # list_order: The order this item is shown in a list.
  • # task: The task to be performed.
  • # taskable_id: The ID of the entity that the task is associated
  • # with.
  • # taskable_type: The entity that the task is associated with.
  • # 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.
  • tasks(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • completable_id: Int64Bit,
  • completable_type: CompletableType,
  • complete: Boolean,
  • completed_at: Datetime,
  • completed_by_user_id: Int64Bit,
  • completion_type: TaskCompletionType,
  • due: Date,
  • list_order: Int,
  • task: Text,
  • taskable_id: Int64Bit,
  • taskable_type: TaskableType,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): TaskConnection!
  • # A `task template item`.
  • #
  • # 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.
  • # completable_id: The ID of the entity that completes or
  • # completed this task.
  • # completable_type: The type of entity that completes this task.
  • # completion_type: How this task gets marked as completed.
  • # list_order: The order this item is shown in a list.
  • # task: The task to be performed.
  • # task_template_id: The ID of a `TaskTemplate`.
  • # 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.
  • task_template_items(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • completable_id: Int64Bit,
  • completable_type: CompletableType,
  • completion_type: TaskCompletionType,
  • list_order: Int,
  • task: String,
  • task_template_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): TaskTemplateItemConnection!
  • # 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 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!
  • }