Fields

contractReferences : ContractReferencesType

Contract identifiers associated with this join supplier process.
currentProcessData : JoinSupplierProcessDataType

The current process data associated with the Join Supplier process.
id : ID

The ID or the primary key of the lifecycle process.
ledgerAssignments : JoinSupplierLedgerAssignmentConnectionTypeConnection

The ledgers associated with the supply points in the process.
Arguments
after : String
before : String
first : Int
last : Int
number : String

The unique identifier of the process.
stage : String

Current stage of the join supplier journey.
supplyPoints : SupplyPointConnectionTypeConnection! required

The supply points associated with the process.
Deprecation
The 'supplyPoints' field is deprecated.

Please use 'supplyPointsInterface' instead. It returns SupplyPointInterfaceConnection, whose node is CommonSupplyPointInterface, and supports inline fragments (e.g. `... on WaterSupplyPointType`, `... on ElectricitySupplyPointType`).

- Marked as deprecated on 2026-07-23.
- Scheduled for removal on or after 2027-01-23.
Arguments
after : String
before : String
first : Int
last : Int
supplyPointsInterface : SupplyPointInterfaceConnection! required

The supply points associated with the process. Node type is the CommonSupplyPointInterface; use inline fragments (e.g. ... on WaterSupplyPointType, ... on ElectricitySupplyPointType) to access concrete types.
Arguments
after : String
before : String
first : Int
last : Int
triggeredLeaveProcesses : [LeaveSupplierProcessType]

Leave supplier processes triggered by this join supplier process, e.g. from a house move.
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

{ "contractReferences": ContractReferencesType, "currentProcessData": JoinSupplierProcessDataType, "id": "10701611", "ledgerAssignments": JoinSupplierLedgerAssignmentConnectionTypeConnection, "number": "tax-floor-himself-oil-try", "stage": "hundred-they-serve-charge-trial", "status": "PENDING", "subtype": "address-certain-professor-arm-here", "supplyPointsInterface": SupplyPointInterfaceConnection, "triggeredLeaveProcesses": [LeaveSupplierProcessType] }