How to reconcile respondents for invoice adjustments
Cint offers a reconciliation process that lets you change response statuses from complete to terminated, or vice versa. You can submit a reconciliation when the target group is in a live, paused, or complete status.
The following guide provides information on how to perform a reconciliation.
Prerequisites:
- Obtain your service client information from Cint to connect to the API.
- Identify the specific response IDs (RIDs) you want to reconcile.
- Review and understand Cint's reconciliation policy.
There are two ways you can perform a reconciliation. You can either:
- Provide all the RIDs that you consider good quality responses (i.e. the RIDs you approve of). Here you would provide just the RIDs that you want to keep as completes for your survey. This type of submission is labeled approved completes.
- Provide any RIDs and the target status you'd like to convert them to (i.e. the RIDs that you are rejecting their current status). Here you would provide any RIDs whose status you are looking to change from complete to terminate or terminate to complete. This type of submission is labeled rejected completes.
Before you begin (optional)
Before submitting a reconciliation, you can use the following endpoints to identify which RIDs and target groups are eligible.
Get RIDs eligible for reconciliation
You can get a list of RIDs that are eligible for reconciliation using the reports API. Pass reconciliation-eligible-rids as the report_type in the endpoint.
You can generate this report for one project at a time. It will extract all the RIDs (completes or non-completes) from all the target groups in that project that are still within the reconciliation window as of the current date.
You can also generate this report at the target group level by providing target group IDs as filter_ids.
Get target groups eligible for reconciliation
If you want to know all the target groups within an account that have sessions eligible for reconciliation within the current month, use the endpoint below.
By default, this endpoint returns all target groups that have sessions expiring in the current month. The API can also return a list of target groups with sessions expiring next month by including next_month in the due_month query parameter.
For more details, refer to the List target groups eligible for reconciliation reference page.
Steps to reconcile
Pick one of the following options:
- Approved completes
- Rejected completes
1. Prepare your list of good completes
You'll need the project ID before you submit the request. The approved complete workflow requires a project ID.
Example of a list of RIDs for this endpoint:
30AA2CCB-9668-4E56-94E2-C0E279EFAE6B
923AC8C0-BD60-4236-AAB2-B6E723402400
8445F477-77D3-47F9-A900-CEAEA885BF0E
You can submit up to 100,000 RIDs in a single submission.
2. Submit your reconciliation request
You can reconcile the RIDs to a postive state by calling the /completes endpoint.
- Path Parameters:
account_id: Your unique account ID.project_id: The ID of the project you are submitting reconciliations for.
- Query Parameters:
name: A non-unique human readable label for the group of RIDs you are submitting.
1. Prepare your list of rejected completes
You must use a valid reconciliation reason code to change a complete to terminated or vice versa. You can call the reconciliation reason codes endpoint to find Cint's accepted reason codes.
Example of a list of RIDs for this endpoint:
30AA2CCB-9668-4E56-94E2-C0E279EFAE6B, 932
923AC8C0-BD60-4236-AAB2-B6E723402400, 933
8445F477-77D3-47F9-A900-CEAEA885BF0E, 932
You can submit up to 100,000 RIDs in a single submission.
2. Submit your reconciliation request
You can reconcile the RIDs to a terminated state by calling the reconciliations endpoint.
- Path Parameters:
account_id: Your unique account ID.
- Query Parameters:
name: A non-unique human readable label for the group of RIDs you are submitting.
Both endpoints will return a 202 Accepted response indicating that the RIDs has been successfully queued for processing. You can use the request_id returned in the response body to track the status of the job.
3. Verify the status of a specific reconciliation request
You can check the processing status of a particular reconciliation submission by using its unique request ID.
Call the endpoint below, using the request_id returned from the submission response.
- Path Parameters:
account_id: Your unique account ID.request_id: The unique ID of the reconciliation request you want to check.
To see all reconciliation requests submitted in the account, use the endpoint below. It returns all reconciliation requests submitted in the last 90 days.
4. Download the files generated in the reconciliation process
If you want to review the submitted RIDs for a reconciliation submission, view the RIDs that are expired (out of the reconciliation window) from your submission, or view RIDs that were invalid due to reasons like incorrect format, not belonging to the account, or already being in the desired status, you can use the download endpoint.
- Path Parameters:
account_id: Your unique account ID.request_id: The unique ID of the reconciliation request.download_type: The type of file to download.
You can view all of the download types available by click API Reference in the above code block.
Troubleshooting common submission issues
- Reconciliation deadline: Remember the trailing-month deadline. RIDs achieved in a given month can only be reconciled until the 25th of the following month. Submissions for RIDs past this deadline will be rejected.
- CSV file formatting: Your RID and reason code must be comma-separated.
- File size exceeded: If your CSV file exceeds 100,000 IDs, you'll need to split it into multiple smaller CSV groups and submit each one separately.
- RID or reason code invalid: Verify that the RID you are trying to reconcile is correct, belongs to one of your completes, and falls within the reconciliation policy guidelines. Also verify that you are using the correct reason codes.
- RID shown as invalid (TG not found): It takes approximately 20–30 minutes for completes to reach all the backend systems used by reconciliation. Even though the RID is valid, if it has not yet reached the reconciliation database, it will be flagged as invalid.