← All resources

Resource

supplier

A supplier entity representing a vendor or service provider

GraphQL reference →

Configuration

nameString!Required

Supplier name (required)

codeStringOptional

Short code

categorySupplierCategory!Optional

Supplier category

Allowed values

SUBSTRATE — Substrate supplier

INK — Ink supplier

CONSUMABLES — Consumables supplier

OUTSOURCE — Outsource partner

EQUIPMENT — Equipment supplier

LOGISTICS — Logistics provider

OTHER — Other supplier category

externalIdStringOptional

External system reference

contactNameStringOptional

Primary contact person name

emailStringOptional

Contact email address

phoneStringOptional

Contact phone number

websiteStringOptional

Supplier website URL

accountNumberStringOptional

Account number

paymentTermsStringOptional

Payment terms

currencyCurrencyISOOptional

Default currency code

leadTimeDaysIntOptional

Typical lead time in days

isActiveBoolean!Optional

Whether the supplier is active

notesStringOptional

General notes

tags[String!]Optional

Tags for categorisation

Read-only values

Show values
idSupplierID!Read only

Unique identifier

computed by the platform

externalUrlStringRead only

External URL for the calling integration, or the primary identity for unscoped callers.

computed by the platform

externalIdentities[RecordExternalIdentity!]!Read only

All linked external identities, including identities belonging to other integrations.

computed by the platform

createdByIntegrationIdIntegrationInstanceIDRead only

Integration instance that originally created this record, when known.

References integration_instance

computed by the platform

createdByStackIdIaCStackIDRead only

IaC stack that originally created this record, when known.

computed by the platform

managedByStackIdIaCStackIDRead only

IaC stack currently managing this record's configuration and deletion.

computed by the platform

createdAtString!Read only

Creation timestamp (ISO8601)

computed by the platform

updatedAtString!Read only

Last update timestamp (ISO8601)

computed by the platform

Lifecycle

The CLI can create this resource. The platform assigns its id.

When replacement is needed, the existing resource is removed before its replacement is created.