OBJECT

ContractTemplate

A contract template.

link GraphQL Schema definition

  • type ContractTemplate implements NoteableInterface, 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!
  • # The body.
  • body: Text!
  • # The ID of the company that this entity operates under.
  • company_id: Int64Bit
  • # Whether or not this is enabled.
  • enabled: Boolean!
  • # A descriptive name.
  • name: String!
  • # The term in months.
  • term_in_months: Int
  • # The ID of a `TicketGroup`.
  • ticket_group_id: Int64Bit
  • # A company you do business as.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # checks_payable_to: On an enabled remittance slip, who should
  • # checks be made payable to?
  • # country: A two character country code.
  • # customer_portal_url: The URL to your customer portal.
  • # default: Whether or not this entity is a default entry.
  • # enabled: Whether or not this is enabled.
  • # name: A descriptive name.
  • # phone_number: A telephone number.
  • # primary_color: The primary color to use in Sonar.
  • # secondary_color: The secondary color to use in Sonar.
  • # show_remittance_slip: Whether or not to include a detachable
  • # remittance slip on the invoice.
  • # tax_identification: A tax identification number. Should only be
  • # entered if you are required to share some type of tax identification information
  • # with your customers.
  • # website_address: The address of the company website.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • company(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • checks_payable_to: String,
  • country: Country,
  • customer_portal_url: URL,
  • default: Boolean,
  • enabled: Boolean,
  • name: String,
  • phone_number: Numeric,
  • primary_color: HtmlHexColor,
  • secondary_color: HtmlHexColor,
  • show_remittance_slip: Boolean,
  • tax_identification: String,
  • website_address: URL,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): Company
  • # A ticket group.
  • #
  • # 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.
  • # private: If a group is private, only members of the group can
  • # view emails within it.
  • # 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.
  • ticket_group(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • enabled: Boolean,
  • name: String,
  • private: Boolean,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): TicketGroup
  • # A contract.
  • #
  • # 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.
  • # body: The body.
  • # contact_id: The ID of the contact that owns this.
  • # contract_template_id: The ID of a `ContractTemplate`.
  • # custom_message: The custom message.
  • # expiration_date: The expiration date.
  • # handwritten_signature_id: The ID of a `HandwrittenSignature`.
  • # name: A descriptive name.
  • # term_in_months: The term in months.
  • # unique_link_key: Part of the unique URL used for signing.
  • # 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.
  • contracts(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_id: Int64Bit,
  • body: Text,
  • contact_id: Int64Bit,
  • contract_template_id: Int64Bit,
  • custom_message: Text,
  • expiration_date: Date,
  • handwritten_signature_id: Int64Bit,
  • name: String,
  • term_in_months: Int,
  • unique_link_key: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ContractConnection!
  • # 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`.
  • # 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`.
  • # 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`.
  • # 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.
  • job_types(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_status_id_completion: Int64Bit,
  • account_status_id_failure: Int64Bit,
  • all_companies: Boolean,
  • allow_completion_with_incomplete_tasks: Boolean,
  • color: HtmlHexColor,
  • contract_template_id: Int64Bit,
  • default_length_in_minutes: Int,
  • enabled: Boolean,
  • icon: Icon,
  • name: String,
  • task_template_id: Int64Bit,
  • ticket_group_id_completion: Int64Bit,
  • ticket_group_id_failure: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): JobTypeConnection!
  • # 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!
  • }