OBJECT
JobType
The type of a Job
.
link GraphQL Schema definition
- type JobType implements NoteableInterface, 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! :
- # 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`.
- Int64Bit :
- # 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`.
- Int64Bit :
- # Completion ticket action.
- JobTypeAction! :
- # Failure ticket action.
- JobTypeAction! :
- # Whether or not this `JobType` is valid for all `Companies`.
- Boolean! :
- # Whether `Job`s associated with this `JobType` should be able to be completed
- # with incomplete tasks.
- Boolean! :
- # Color.
- HtmlHexColor! :
- # The ID of a `ContractTemplate`.
- Int64Bit :
- # The default length for a `Job` created using this `JobType`.
- Int! :
- # 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`.
- Boolean :
- # Whether or not this is enabled.
- Boolean! :
- # An icon.
- Icon! :
- # A descriptive name.
- String! :
- # The ID of a `TaskTemplate`.
- Int64Bit :
- # If this is set, any `Job` using this `JobType` that is completed successfully
- # will create a `Ticket` and assign it to this `TicketGroup`.
- Int64Bit :
- # If this is set, any `Job` using this `JobType` that is completed unsuccessfully
- # will create a `Ticket` and assign it to this `TicketGroup`.
- Int64Bit :
- # Ticket status on completion.
- TicketStatus! :
- # Ticket status on failure.
- TicketStatus! :
- # 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 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.
- (
- Int64Bit, :
- ID, :
- Datetime, :
- Datetime, :
- String, :
- Time, :
- Time, :
- String, :
- Country, :
- URL, :
- Boolean, :
- Boolean, :
- IspType, :
- String, :
- Numeric, :
- HtmlHexColor, :
- HtmlHexColor, :
- Boolean, :
- String, :
- URL, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): CompanyConnection!
- # Availability for `Job`s to be scheduled.
- #
- # 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.
- # available: Whether this `ScheduleAvailability` creates
- # available time, or blocks available time.
- # geofence_id: The ID of a `Geofence`.
- # infinite_repetitions: Whether this repeats forever or not.
- # name: A descriptive name.
- # repetitions: The number of times this repeats.
- # start_date: The start date for this `ScheduleAvailability`.
- # weeks_between_repetitions: The number of weeks between
- # repetitions.
- # 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, :
- Int64Bit, :
- Boolean, :
- String, :
- Int, :
- Date, :
- Int, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): ScheduleAvailabilityConnection!
- # The status that an `Account` will be changed to upon successful completion.
- #
- # 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.
- # activates_account: Whether or not this status activates the
- # account.
- # color: Color.
- # icon: An icon.
- # name: A descriptive name.
- # 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, :
- HtmlHexColor, :
- Icon, :
- String, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): AccountStatus
- # The status that an `Account` will be changed to upon unsuccessful completion.
- #
- # 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.
- # activates_account: Whether or not this status activates the
- # account.
- # color: Color.
- # icon: An icon.
- # name: A descriptive name.
- # 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, :
- HtmlHexColor, :
- Icon, :
- String, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): AccountStatus
- # The `TicketGroup` for a `Ticket` created upon successful completion.
- #
- # 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.
- (
- Int64Bit, :
- ID, :
- Datetime, :
- Datetime, :
- String, :
- Boolean, :
- String, :
- Boolean, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): TicketGroup
- # The `TicketGroup` for a `Ticket` created upon unsuccessful completion.
- #
- # 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.
- (
- Int64Bit, :
- ID, :
- Datetime, :
- Datetime, :
- String, :
- Boolean, :
- String, :
- Boolean, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): TicketGroup
- # 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] : [
- ): ContractTemplate
- # A `task 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.
- # name: A descriptive name.
- # 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, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): TaskTemplate
- # A job, typically in the 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.
- # address_on_completion: The serviceable address where this job
- # was completed.
- # complete: Whether or not this is complete.
- # completed_by_user_id: The `User` that completed this.
- # completed_successfully: Whether this `Job` was completed
- # successfully or not.
- # completion_datetime: The date and time this `Job` was
- # completed.
- # completion_notes: Any notes entered when this `Job` was
- # completed.
- # job_type_id: The ID of a `JobType`.
- # jobbable_id: The ID of the entity that this `Job` is associated
- # with.
- # jobbable_type: The type of entity that this `Job` is associated
- # with.
- # length_in_minutes: The length in minutes for this `Job`.
- # scheduled_datetime: The date and time this `Job` is scheduled
- # for.
- # serviceable_address_account_assignment_future_id: The ID of the
- # serviceable address account assignment future.
- # skips_validation: Indicates this entity has skipped the
- # validations which would normally apply.
- # ticket_id: The ID of a `Ticket`.
- # 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, :
- Boolean, :
- Int64Bit, :
- Boolean, :
- Datetime, :
- Text, :
- Int64Bit, :
- Int64Bit, :
- JobbableType, :
- Int, :
- Datetime, :
- Int64Bit, :
- Boolean, :
- Int64Bit, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): JobConnection!
- # A message that is sent when a specific event occurs.
- #
- # 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.
- # allow_children: Whether or not child accounts are allowed.
- # count: The count associated with this `TriggeredMessage`. This
- # is defined by the trigger, and could be something like a number of days, months,
- # gigabytes, etc.
- # email_message_id: The ID of an EmailMessage.
- # enabled: Whether or not this is enabled.
- # job_type_id: The ID of a `JobType`.
- # name: A descriptive name.
- # protected: If an item is protected, it cannot be modified or
- # deleted.
- # signature_id: The ID of a signature.
- # sms_message_id: The ID of the SMS message.
- # trigger: The trigger for this message.
- # 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, :
- Int, :
- Int64Bit, :
- Boolean, :
- Int64Bit, :
- String, :
- Boolean, :
- Int64Bit, :
- Int64Bit, :
- MessageTrigger, :
- Paginator, :
- Sorter], : [
- Search], : [
- String, :
- Aggregator], : [
- ReverseRelationFilter] : [
- ): TriggeredMessageConnection!
- # 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 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!
- }