Skip to main content

documentTagOptions

Returns the tags already used on documents of one record type in the current company, most used first.

Business Rules​

  • Scoped to the company in the X-Company-Id header and to the record type in entityType
  • Only record types that carry documents are accepted: orders, products, purchase orders, supply shipments, suppliers
  • extra carries the number of documents using the tag

Error Scenarios​

  • CompanyContextRequired when no company is in context
  • Validation error for a record type that does not carry documents

Permissions Required​

  • Authentication and company context
documentTagOptions(
  entityType: FileEntityEnum!
  keyword: String
  limit: Int = 20
): [FilterOption!]!

Arguments​

documentTagOptions.entityType ● FileEntityEnum! non-null enum common​

The type of record whose document tags to list.

documentTagOptions.keyword ● String scalar common​

Search tags by name.

documentTagOptions.limit ● Int scalar common​

Maximum number of tags to return.

Type​

FilterOption object common​

Represents a filtering option queries.