OBJECT

Vendor

A third party vendor of inventory models.

link GraphQL Schema definition

  • type Vendor implements AddressableInterface, ContactableInterface, NoteableInterface, FileableInterface, 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!
  • # Archived vendors may not be used for creating new Purchase Orders or Product
  • # Requests.
  • archived: Boolean!
  • # Determines if approved purchase orders for this vendor should automatically
  • # dispatch an email to the vendor.
  • automate_approved_purchase_orders: Boolean!
  • # The currency used for all transactions with this vendor.
  • currency: Currency!
  • # A descriptive name.
  • name: String!
  • # The terms of payment for deliveries from this vendor.
  • payment_terms: PaymentTerm!
  • # The ID of the tax that should be applied to each item sold by this vendor.
  • tax_id: Int64Bit
  • # A tax.
  • #
  • # 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.
  • # application: Whether this `Tax` is applied as a percentage of
  • # the `Service` charge, or as a flat rate.
  • # name: A descriptive name.
  • # rate: The rate for a tax. For a percentage based tax, this is a
  • # percentage. For a flat tax, it is a currency value in the smallest currency unit
  • # (e.g. cents, pence, pesos.)
  • # type: Whether this tax is applied based on the account being in
  • # a specific geography, or whether it is applied to all accounts.
  • # 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.
  • tax(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • application: TaxApplication,
  • name: String,
  • rate: Float,
  • type: TaxType,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): Tax
  • # A geographical address.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # addressable_id: The ID of the entity that owns this address.
  • # addressable_type: The type of entity that owns this address.
  • # avalara_pcode: Avalara PCode.
  • # city: A city.
  • # country: A two character country code.
  • # county: A US county. Only used for US addresses.
  • # fips: Only used in the USA, this is the census tract
  • # information used for calculating things like FCC Form 477.
  • # latitude: A decimal latitude.
  • # line1: Address line 1.
  • # line2: Address line 2.
  • # longitude: A decimal longitude.
  • # serviceable: Whether or not the address is serviceable, and can
  • # be used for new accounts.
  • # subdivision: A state, province, or other country subdivision.
  • # type: The type.
  • # zip: A ZIP or postal code.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • addresses(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • addressable_id: Int64Bit,
  • addressable_type: AddressableType,
  • avalara_pcode: String,
  • city: String,
  • country: Country,
  • county: UsCounty,
  • fips: String,
  • latitude: Latitude,
  • line1: String,
  • line2: String,
  • longitude: Longitude,
  • serviceable: Boolean,
  • subdivision: Subdivision,
  • type: AddressType,
  • zip: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AddressConnection!
  • # A contact person.
  • #
  • # 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.
  • # contactable_id: The ID of the entity that owns this contact.
  • # contactable_type: The type of entity that owns this contact.
  • # email_address: An email address.
  • # language: A supported language.
  • # name: A descriptive name.
  • # primary: Whether or not this is the primary type of entity.
  • # role: The role of the contact, e.g. "CEO" or "Network
  • # Engineer".
  • # username: A username, used for authentication.
  • # 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.
  • contacts(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • contactable_id: Int64Bit,
  • contactable_type: ContactableType,
  • email_address: EmailAddress,
  • language: Language,
  • name: String,
  • primary: Boolean,
  • role: String,
  • username: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): ContactConnection!
  • # A note.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # message: The message.
  • # noteable_id: The ID of the entity that owns this note.
  • # noteable_type: The type of entity that owns this note.
  • # priority: The priority of this item.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • notes(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • message: Text,
  • noteable_id: Int64Bit,
  • noteable_type: NoteableType,
  • priority: NotePriority,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): NoteConnection!
  • # A file.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # description: A human readable description.
  • # file_size_in_bytes: The file size, in bytes.
  • # fileable_id: The ID of the entity that owns this file.
  • # fileable_type: The type of entity that owns this file.
  • # filename: The file name.
  • # mime_type: The MIME type of the file.
  • # primary_image: An image file may be set to the primary image.
  • # This will be used as the displayed image for the object that this file is
  • # associated to throughout Sonar.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • files(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • description: String,
  • file_size_in_bytes: Int64Bit,
  • fileable_id: Int64Bit,
  • fileable_type: FileableType,
  • filename: String,
  • mime_type: String,
  • primary_image: Boolean,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): FileConnection!
  • # A log entry.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # current: Current data.
  • # legacy: Whether or not this log was transferred from a Sonar v1
  • # instance. If so, the formatting will not match current version logs.
  • # legacy_title: A title which is only populated on logs that were
  • # imported from Sonar v1.
  • # level: The severity level.
  • # loggable_id: The ID of the entity that this log is attached to.
  • # loggable_type: The type of entity that this log is attached to.
  • # logged_entity_id: The entity ID that triggered the log.
  • # logged_entity_type: The entity that triggered the log.
  • # message: The message.
  • # previous: Previous data.
  • # relation_data: Data from objects related to this change.
  • # type: The type.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • logs(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • current: Text,
  • legacy: Boolean,
  • legacy_title: String,
  • level: LogLevel,
  • loggable_id: Int64Bit,
  • loggable_type: String,
  • logged_entity_id: Int64Bit,
  • logged_entity_type: String,
  • message: Text,
  • previous: Text,
  • relation_data: Text,
  • type: LogType,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): LogConnection!
  • # 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!
  • # An item that can be purchased from a particular vendor.
  • #
  • # 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.
  • # archived: Archived vendor items may not be used for creating
  • # new purchase orders or product requests.
  • # name: A descriptive name.
  • # part_number: Part number used by the vendor to identify this
  • # vendor item.
  • # price: The purchase price of this item from the vendor.
  • # quantity_per_unit: Number of inventory models that are included
  • # in a single unit of this vendors product.
  • # retail_item: Flag for vendor items that should create a
  • # one-time service for retail sale to customers.
  • # retail_item_price: The price of the one-time service created
  • # for this vendor item
  • # retail_item_service_id: The ID of the one-time service created
  • # when this vendor item was created.
  • # vendor_id: The ID of the vendor that sells this item
  • # vendoritemable_id: The ID of the entity that is referred to by
  • # this vendor item.
  • # vendoritemable_type: The type of entity that is referred to by
  • # this vendor item.
  • # 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.
  • vendor_items(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • archived: Boolean,
  • name: String,
  • part_number: String,
  • price: Int,
  • quantity_per_unit: Int,
  • retail_item: Boolean,
  • retail_item_price: Int,
  • retail_item_service_id: Int64Bit,
  • vendor_id: Int64Bit,
  • vendoritemable_id: Int64Bit,
  • vendoritemable_type: VendoritemableType,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): VendorItemConnection!
  • # A purchase order for items from a third party vendor.
  • #
  • # 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.
  • # approved_by_user_id: The ID of the user that approved this
  • # purchase order.
  • # canceled_at: The date/time that this purchase order was
  • # cancelled.
  • # canceled_by_user_id: The ID of the user that cancelled this
  • # purchase order.
  • # company_id: The ID of the company that will be used in the
  • # header of this purchase order.
  • # created_by_user_id: The ID of the user that created this
  • # purchase order.
  • # currency: The currency the system displays money in.
  • # external_message: A message to be included on purchase orders
  • # when sent to vendors.
  • # inventory_location_id: The source of the shipping address for a
  • # purchase order.
  • # last_status_change: The date and time that the inventory item
  • # status last changed.
  • # order_group_id: The ID of an order group related to this
  • # purchase order.
  • # order_number: A unique number identifying an approved purchase
  • # order.
  • # payment_terms: The terms of payment for deliveries from this
  • # vendor.
  • # status: The current status of this purchase order.
  • # tax_id: The ID of the tax that should be applied to each item
  • # sold by this vendor.
  • # vendor_id: The ID of a vendor.
  • # vendor_name: The name of a vendor.
  • # 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.
  • purchase_orders(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • approved_by_user_id: Int64Bit,
  • canceled_at: Datetime,
  • canceled_by_user_id: Int64Bit,
  • company_id: Int64Bit,
  • created_by_user_id: Int64Bit,
  • currency: Currency,
  • external_message: String,
  • inventory_location_id: Int64Bit,
  • last_status_change: Datetime,
  • order_group_id: Int64Bit,
  • order_number: Int,
  • payment_terms: PaymentTerm,
  • status: PurchaseOrderStatus,
  • tax_id: Int64Bit,
  • vendor_id: Int64Bit,
  • vendor_name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): PurchaseOrderConnection!
  • }