Skip to main content

BenefitWorkItem

A work item scoped to a single benefit.

This is a subtask of SingleClientWorkItem.

type BenefitWorkItem implements WorkItem {
  benefit: BenefitPosition!
  benefitValue: BenefitValue
  billableMinutes: Int
  deviations: [Deviation!]!
  id: ID!
  maxMinutes: MaxMinutesLimit
  reason: String
  state: WorkItemState!
}

Fields​

BenefitWorkItem.benefit ● BenefitPosition! non-null object​

Related benefit.

BenefitWorkItem.benefitValue ● BenefitValue union​

The value of the provided benefit. Mandatory only for single client work items with benefits with a non-default benefit variant type.

BenefitWorkItem.billableMinutes ● Int scalar​

The minutes billed for this benefit in this visit, the only source for billing a time-based benefit. Null if none were entered yet, and always null for a benefit not billed by time unit.

BenefitWorkItem.deviations ● [Deviation!]! non-null enum​

Shows all possible deviations, if available

BenefitWorkItem.id ● ID! non-null scalar​

Unique identifier of this benefit work item.

BenefitWorkItem.maxMinutes ● MaxMinutesLimit object​

The max minutes of this benefit, if it has them. bookedMinutes leaves out this visit, so the caller adds the minutes being entered.

BenefitWorkItem.reason ● String scalar​

Reason why this work item is rejected. Only available if state is REJECTED.

BenefitWorkItem.state ● WorkItemState! non-null enum​

Current state of the work item.

Interfaces​

WorkItem interface​

Work items are tasks an employee can perform during his shift.

Currently it's implemented by

  • ActivityWorkItem
  • ClientPoolWorkItem
  • SingleClientWorkItem which have the following sub tasks:
  • BenefitWorkItem
  • ClientWorkItem

Member Of​

SingleClientWorkItem object