Input fields

futureBillingAddress : RichAddressInput

Future billing address.
idempotencyKey : String

Optional idempotency key to prevent duplicate journey creation on retry.
isHouseMove : Boolean

Whether this leave supplier is part of a house move.
leaveSupplierProcessId : NonEmptyID

The ID of the LeaveSupplier process to update.
Deprecation
The 'leaveSupplierProcessId' field is deprecated.

Process IDs are deprecated, please use 'number' instead.

- Marked as deprecated on 2025-08-06.
- Scheduled for removal on or after 2025-09-30.
number : NonEmptyID

The number of the LeaveSupplier process to update.
requestedSupplyEndDate : Date! required

The requested last day of supply.
subtype : LeaveSupplierSubType

The type of leave supplier process to initiate.
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

{ "futureBillingAddress": RichAddressInput, "idempotencyKey": "model-bed-effort-big-say", "isHouseMove": true, "marketData": LeaveSupplierMarketInputType, "number": "21236699", "requestedSupplyEndDate": "2024-04-15", "subtype": "MOVE_OUT" }