Documents
Audit Report Detail Guide
Latest Update Time: 2026-07-01 00:00:00
Use the audit report detail API to retrieve the full details of a specific audit report.
See the Audit Introduction for base URL, authentication, and required headers.
Endpoint
GET https://ppapi.qima.com/user/{userId}/audit-reports/{reportId}
Prerequisites
In addition to the required headers and authentication setup:
- Permission to view audit reports for the target client
- An audit order ID obtained from the Audit Reports Search Guide (
pageItems[].orderId) or from Create Audit Order (orderGeneralInfo.orderId)
Path Parameters
| Parameter | Required | Description |
|---|---|---|
userId | Yes | QIMA client user login ID. |
reportId | Yes | This is the audit order ID, not a separate report identifier — despite the parameter name, pass the same orderId value returned by Search Audit Reports or Create Audit Order. |
Request Example
curl --location --request GET 'https://ppapi.qima.com/user/<qima-user-id>/audit-reports/<report-id>' \
--header 'Ai-Api-Access-Token: {your api access token}' \
--header 'Ai-User-Id: {your user ID}' \
--header 'Authorization: Bearer {your token}' \
--header 'Referer: https://preprodmy.qima.com/'
Successful Response
HTTP 200 OK means the report details were retrieved successfully.
{
"message": null,
"content": {
"orderId": "2CC460D63A554EF2AE175A34A3095F59",
"orderNumber": "R-Cloud-PP-23002494",
"orderPlacer": "SP1126",
"orderStatus": "30",
"serviceType": "9",
"auditType": "Ethical Audit",
"auditReportStatus": "Invalid",
"auditStatus": "Follow-Up Audit",
"previousOrderNumber": "R-Cloud-PP-25000911",
"manday": "1",
"bookingDate": "2023-03-14",
"auditDate": "2023-03-22",
"clientName": "AuditApp-Automation",
"clientRef": "EA Internal Ref No 1",
"factoryCode": null,
"factoryName": "FactoryTest41087",
"factoryAddress": "Address test",
"factoryCity": "Shenzhen",
"factoryProvince": "Guangdong",
"factoryCountry": "China",
"supplierCode": null,
"supplierName": "SupplierTest65857",
"supplierAddress": "Address test",
"supplierCity": "Hangzhou",
"supplierProvince": "Zhejiang",
"supplierCountry": "China",
"overallScore": "8.3",
"riskIndicator": "Green",
"commonFindings": [
{
"checkpointSection": "Records of Findings",
"checkpointSubSection": null,
"commonFindingName": "Wages and Benefits - Social Insurance",
"commonFindingCategory": "QIMA Standard Ethical Common Findings",
"checkpointResult": "Pass",
"capDetails": null,
"checkpointComments": null,
"status": "Closed",
"desktopReviewComment": null
},
{
"checkpointSection": "Records of Findings",
"checkpointSubSection": null,
"commonFindingName": "Health and Safety - Fire Exits",
"commonFindingCategory": "QIMA Standard Ethical Common Findings",
"checkpointResult": "Not Compliant",
"capDetails": null,
"checkpointComments": null,
"status": "Open",
"desktopReviewComment": null
},
{
"checkpointSection": "Records of Findings",
"checkpointSubSection": null,
"commonFindingName": "Working Hours - Overtime (beyond local law)",
"commonFindingCategory": "QIMA Standard Ethical Common Findings",
"checkpointResult": "Not Compliant",
"capDetails": null,
"checkpointComments": null,
"status": "Open",
"desktopReviewComment": null
}
],
"customizedFields": null,
"initialAuditNumber": "R-Cloud-PP-23002492",
"initialAuditType": "Ethical Audit"
}
}
Response Field Notes
| Field | Notes |
|---|---|
orderId | Internal audit order ID. Matches the reportId value you passed in the request path. |
orderNumber | Client-facing QIMA order number, for example R-Cloud-PP-23002494. |
orderPlacer | Internal code identifying who placed/processed the order, for example SP1126. |
orderStatus | Numeric order status code, for example 30. |
serviceType | Numeric service type code, for example 9 (Ethical Audit) — matches orderGeneralInfo.serviceType in the create-order response. |
auditType | Human-readable audit type, for example Ethical Audit. |
auditReportStatus | Report review status. One of Invalid, Pending CAP Review, or Valid. This field is not currently listed in the OpenAPI schema. |
auditStatus | Describes the audit's nature/stage rather than the order workflow status, for example Follow-Up Audit. |
previousOrderNumber / initialAuditNumber / initialAuditType | Used together for follow-up/re-audits: reference back to the original audit order number and its type. |
manday | Number of person-days spent on the audit. |
bookingDate | Date the audit order was booked. |
auditDate | Date the audit was actually performed. |
clientName | Name of the client account. |
clientRef | Client's own reference number for the order. |
factoryCode / factoryName / factoryAddress / factoryCity / factoryProvince / factoryCountry | Factory identification and location. factoryCode is null when the factory was not created with a client-side code. |
supplierCode / supplierName / supplierAddress / supplierCity / supplierProvince / supplierCountry | Supplier identification and location. supplierCode is null when the supplier was not created with a client-side code. |
overallScore | Overall audit score, for example 8.3. |
riskIndicator | Risk rating derived from the audit result, for example Green. |
commonFindings[].checkpointResult | Result for this checkpoint, for example Pass or Not Compliant. |
commonFindings[].status | Whether the finding is Open or Closed. |
commonFindings[].capDetails | Corrective Action Plan (CAP) details related to this finding, when a CAP has been raised. null when not applicable. Not currently listed in the OpenAPI schema. |
commonFindings[].checkpointComments | Free-text comments added by the auditor for this checkpoint. null when not provided. Not currently listed in the OpenAPI schema. |
commonFindings[].desktopReviewComment | Free-text comment added during desktop review, if applicable. null when not applicable. |
customizedFields | List of client-specific custom fields (fieldKey / fieldValue pairs). null when not configured for the account. |
Common Errors
See common authentication errors for 401 and 403 responses.
Next Steps
- Use
previousOrderNumber/initialAuditNumberto trace related or follow-up audits, if applicable.
