Input fields

address : AddressInput

Address of the property where the appointment is taking place.
agentId : String! required

The market ID of the agent that carried out the work. This should be an electricity market participant ID or gas market code.
appointmentDate : Date! required

The scheduled date of the appointment. Required if the appointment is not already booked.
appointmentReference : String! required

The unique appointment reference of the agent.
commsStrategy : CommsStrategy default: SEND_ALL

Determines which communications will be sent to customers for the appointment. The default is to send all available messages (e.g. appointment confirmed, job completed).
electricityMeters : [MeterInput]

A list of electricity meters that the work applies to.
Deprecation
The 'electricityMeters' field is deprecated.

Please use the 'electricity_meters' field within 'mpans_with_meters' field instead.

- Marked as deprecated on 2025-03-04.
- Scheduled for removal on or after 2026-01-01.
electricitySupplyType : ElectricitySupplyType
engineerName : String

Name of engineer currently assigned to the appointment.
fuelType : FuelType! required

The categories of meter the work applies to.
futurePaymentMode : PaymentMode

The payment mode for the new meters. If not provided it will default to the payment mode for the current meters.
gasMeters : [MeterInput]

A list of electricity meters that the work applies to.
Deprecation
The 'gasMeters' field is deprecated.

Please use the 'gas_meters' field within 'mprns_with_meters' field instead.

- Marked as deprecated on 2025-03-04.
- Scheduled for removal on or after 2026-01-01.
gasSupplyType : GasSupplyType
isEmergency : Boolean

Boolean flag to indicate an emergency appointment.
jobNotes : String

Free text comments about the appointment.
mpan : String

Required if fuel_type is ELECTRICITY or DUAL_FUEL.
Deprecation
The 'mpan' field is deprecated.

Please use the 'mpans_with_meters' field instead.

- Marked as deprecated on 2025-02-01.
- Scheduled for removal on or after 2026-01-01.
mpansWithMeters : [MpanInput]

List of MPANs with optional electricity meters. Required if fuel_type is ELECTRICITY or DUAL_FUEL.
mprn : String

Required if fuel_type is GAS or DUAL_FUEL.
Deprecation
The 'mprn' field is deprecated.

Please use the 'mprns_with_meters' field instead.

- Marked as deprecated on 2025-02-01.
- Scheduled for removal on or after 2026-01-01.
mprnsWithMeters : [MprnInput]

List of MPRNs with optional gas meters. Required if fuel_type is GAS or DUAL_FUEL.
newMeterCategory : NewMeterCategory

If applicable, the category of new meters installed.
status : AppointmentStatus! required

The status of the appointment.
statusReason : String

Extra context to a change in status such as abort or cancellation reason.
timeSlotEnd : Time

The end time of the slot during which the engineer is scheduled at the property.
timeSlotStart : Time! required

The start time of the slot during which the engineer is scheduled at the property.
workType : String

The type of work the appointment has been booked for.
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "address": AddressInput, "agentId": "91350058", "appointmentDate": "2024-04-28", "appointmentReference": "number-computer-economy-design-now", "commsStrategy": "SEND_ALL", "electricitySupplyType": "SINGLE_PHASE", "engineerName": "serious-appear-race-response-girl", "fuelType": "ELECTRICITY", "futurePaymentMode": "PREPAY", "gasSupplyType": "STANDARD", "isEmergency": true, "jobNotes": "middle-close-role-American-wonder", "mpansWithMeters": MpanInput, "mprnsWithMeters": MprnInput, "newMeterCategory": "SMETS1", "status": "REQUIRES_TIMESLOT", "statusReason": "space-pick-environment-tree-where", "timeSlotEnd": "05:46:37.428312", "timeSlotStart": "03:08:51.431066", "workType": "success-process-red-knowledge-under" }