startCollectionProcess
Start a collection process.
Arguments
Details to start collection process for.
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-7899: An internal error occurred.
Allowed Viewers
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 StartCollectionProcess($input: StartCollectionProcessInput!) {
startCollectionProcess(input: $input) {
collectionProcessStarted {
...StartCollectionProcessOutputFragment
}
}
}
Variables
{
"input": StartCollectionProcessInput
}
Response
{
"data": {
"startCollectionProcess": {
"collectionProcessStarted": StartCollectionProcessOutput
}
}
}