startGroupedCollectionProcess
Start a collection process grouped with a previously existing one. Use this when a new collection process (e.g. disconnection) must be linked to an earlier one (e.g. comms) for end-to-end traceability. Callers who do not need grouping should use startCollectionProcess instead.
Arguments
Details to start a grouped collection process.
Returns
StartGroupedCollectionProcessStart a collection process grouped with a previously existing one. Use this when a new collection process (e.g. disconnection) must be linked to an earlier one (e.g. comms) for end-to-end traceability. Callers who do not need grouping should use startCollectionProcess instead.
Possible Errors
- KT-CT-1111: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-11208: Invalid billing document identifier for collection process.
- KT-CT-11209: Collection process configuration does not have published version.
- KT-CT-11210: Active collection process for entity already exists.
- KT-CT-11211: Too many active collection processes for config.
- KT-CT-11212: Invalid collection process config code.
- KT-CT-11308: Previous collection process not found.
- KT-CT-11309: Previous collection process does not belong to the same entity.
- KT-CT-7899: An internal error occurred.
Allowed Viewers
Customer
Partner User
Third party
Required Permissions
Can start collection processQuery Complexity
1Examples
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.
mutation StartGroupedCollectionProcess($input: StartGroupedCollectionProcessInput!) {
startGroupedCollectionProcess(input: $input) {
collectionProcessStarted {
...StartGroupedCollectionProcessOutputFragment
}
}
}
Variables
{
"input": StartGroupedCollectionProcessInput
}
Response
{
"data": {
"startGroupedCollectionProcess": {
"collectionProcessStarted": StartGroupedCollectionProcessOutput
}
}
}