Skip to main content

Supplier

A supplier.

type Supplier {
  address: SupplierAddress
  amenities: [Amenity!]
  billingAddress: SupplierAddress
  billingDetails: SupplierBillingDetails
  brand: SupplierBrand
  chain: SupplierChain
  contactDetails: SupplierContactDetails
  createdAt: DateTime!
  createdBy: String
  customFields(
    input: CustomFieldSearchFilterInput! = [object Object]
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [CustomField!]! @deprecated
  customFieldsPaged(
    filterInput: CustomFieldAdvancedSearchFilterInput! = [object Object]
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): CustomFieldPage!
  description: String
  id: ID!
  isDeactivated: Boolean!
  isPreferred: Boolean!
  lastModifiedAt: DateTime!
  lastModifiedBy: String
  name: String!
  notes: String
  taxCodes: String
  type: SupplierType!
  uniqueCode: String
}

Fields​

Supplier.address ● SupplierAddress object​

The address of the supplier. Optional.

Supplier.amenities ● [Amenity!] list object​

The amenities available for the supplier when the supplier type is HOTEL. Optional.

Supplier.billingAddress ● SupplierAddress object​

The billing address of the supplier. Optional.

Supplier.billingDetails ● SupplierBillingDetails object​

The billing details of the supplier. Optional.

Supplier.brand ● SupplierBrand object​

The brand of the supplier. Optional.

Supplier.chain ● SupplierChain object​

The chain of the supplier. Optional.

Supplier.contactDetails ● SupplierContactDetails object​

The details on the main contact of the supplier. Optional.

Supplier.createdAt ● DateTime! non-null scalar​

The date and time the record was created.

Supplier.createdBy ● String scalar​

UTF-8 string value that represents the username of the user who created the record. Optional.

Supplier.customFields ● [CustomField!]! deprecated non-null object​

DEPRECATED

Use customFieldsPaged instead. It returns the same custom fields together with pagination metadata (total count, has-next-page) and exposes a richer filter input supporting both inclusion and exclusion semantics (eq, ne, in, notIn). This field will be removed in a future release.

The list of custom field values associated with this supplier.

CustomFields and CustomFieldDefinitions can be matched through the definitionId and id fields, respectively.

See CustomFieldSearchFilterInput for details on how the optional input argument can be used to filter custom fields.

Optionally, the offset and limit arguments can be used to page through multiple items:

  • offset must be a non-negative integer (defaults to 0).
  • limit must be a positive integer from 1 to 2000 (defaults to 100).
Supplier.customFields.input ● CustomFieldSearchFilterInput! non-null input​
Supplier.customFields.limit ● PaginationLimit! non-null scalar​
Supplier.customFields.offset ● NonNegativeInt! non-null scalar​

Supplier.customFieldsPaged ● CustomFieldPage! non-null object​

Custom fields associated with this record that match the filter criteria specified in the optional filterInput argument, returned together with pagination metadata.

See CustomFieldAdvancedSearchFilterInput for details on how the filterInput argument can be used. The filter supports both inclusion and exclusion semantics (eq, ne, in, notIn).

Optionally, the offset and limit arguments can be used to page through multiple items:

  • offset must be a non-negative integer (defaults to 0).
  • limit must be a positive integer from 1 to 2000 (defaults to 100).

Throws an error with code:

  • BAD_USER_INPUT if all fields in the filterInput argument have a combined total number of values exceeding 1,000.
Supplier.customFieldsPaged.filterInput ● CustomFieldAdvancedSearchFilterInput! non-null input​
Supplier.customFieldsPaged.limit ● PaginationLimit! non-null scalar​
Supplier.customFieldsPaged.offset ● NonNegativeInt! non-null scalar​

Supplier.description ● String scalar​

A UTF-8 string that represents the description of the supplier. Optional.

Supplier.id ● ID! non-null scalar​

The identifier of the supplier.

Supplier.isDeactivated ● Boolean! non-null scalar​

A flag that indicates whether the supplier is deactivated.

Supplier.isPreferred ● Boolean! non-null scalar​

A flag that indicates whether the supplier is a preferred supplier.

Supplier.lastModifiedAt ● DateTime! non-null scalar​

The date and time the record was last modified.

Supplier.lastModifiedBy ● String scalar​

UTF-8 string value that represents the username of the user who last modified the record. Optional.

Supplier.name ● String! non-null scalar​

A UTF-8 string that represents the name of the supplier.

Supplier.notes ● String scalar​

A UTF-8 string that represents the notes for the supplier. Optional.

Supplier.taxCodes ● String scalar​

A UTF-8 string that represents the tax codes for the supplier. Optional.

Supplier.type ● SupplierType! non-null enum​

The type of the supplier.

Supplier.uniqueCode ● String scalar​

A customer supplied, UTF-8 string value that represents a unique code for the supplier. Optional.

The value must be unique across all suppliers.

Returned By​

suppliers query