Skip to main content

Input fields

collectionProcessNumber : String! required

The collection process record number to instigate a leave supplier for.

disconnectionAction : CollectionProcessDisconnectionAction default: TERMINATE

The disconnection action. Defaults to final termination.

requestedSupplyEndDate : Date

The requested last day of supply for the disconnection. Omit or pass null to request disconnection as soon as possible.

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

{ "collectionProcessNumber": "specific-nor-career-investment-entire", "disconnectionAction": "TERMINATE", "requestedSupplyEndDate": "1975-06-26" }