QIMA Logo
API Reference

8 categories • 44 endpoints

  • All APIs

    44

    • Quick Actions
    Getting StartedDocumentation
    Audit
    v1.0.0

    Get audit report details

    Request
    Query Parameters
    NameTypeLocationRequiredDescription
    userIdstringpathYesQIMA client user login ID.
    reportIdstringpathYesThis is the audit order ID, not a separate report identifier. Use the `orderId` value returned by Search Audit Reports or Create Audit Order.
    Responses
    200
    Audit report details returned successfully.

    Content-Type: application/json

    orderId
    string
    FieldTypeDescription
    orderIdstringInternal audit order ID. Matches the `reportId` value passed in the request path.
    FieldTypeDescription
    orderNumberstringClient-facing QIMA order number, for example "R-Cloud-PP-23002494".
    FieldTypeDescription
    orderPlacerstringInternal code identifying who placed/processed the order.
    FieldTypeDescription
    orderStatusstringNumeric order status code.
    FieldTypeDescription
    serviceTypestringNumeric service type code, for example "9" (Ethical Audit).
    FieldTypeDescription
    auditTypestringHuman-readable audit type, for example "Ethical Audit".
    FieldTypeDescription
    auditReportStatusstringReport review status.
    FieldTypeDescription
    auditStatusstringDescribes the audit's nature/stage rather than the order workflow status, for example "Follow-Up Audit".
    FieldTypeDescription
    previousOrderNumberstringOrder number of the original audit, used together with `initialAuditNumber` / `initialAuditType` for follow-up/re-audits.
    FieldTypeDescription
    mandaystringNumber of person-days spent on the audit.
    FieldTypeDescription
    bookingDatestringDate the audit order was booked.
    FieldTypeDescription
    auditDatestringDate the audit was actually performed.
    FieldTypeDescription
    clientNamestringName of the client account.
    FieldTypeDescription
    clientRefstringClient's own reference number for the order.
    FieldTypeDescription
    factoryCodestringFactory's identification code in the client's system. `null` when the factory was not created with a client-side code.
    FieldTypeDescription
    factoryNamestring
    FieldTypeDescription
    factoryAddressstring
    FieldTypeDescription
    factoryCitystring
    FieldTypeDescription
    factoryProvincestring
    FieldTypeDescription
    factoryCountrystring
    FieldTypeDescription
    supplierCodestringSupplier's identification code in the client's system. `null` when the supplier was not created with a client-side code.
    FieldTypeDescription
    supplierNamestring
    FieldTypeDescription
    supplierAddressstring
    FieldTypeDescription
    supplierCitystring
    FieldTypeDescription
    supplierProvincestring
    FieldTypeDescription
    supplierCountrystring
    FieldTypeDescription
    overallScorestringOverall audit score, for example "8.3".
    FieldTypeDescription
    riskIndicatorstringRisk rating derived from the audit result, for example "Green".
    FieldTypeDescription
    initialAuditNumberstringOrder number of the initial audit, if this report relates to a follow-up.
    FieldTypeDescription
    initialAuditTypestringAudit type of the initial audit, if applicable.
    FieldTypeDescription
    checkpointSectionstringSection of the audit checklist this finding belongs to.
    checkpointSubSectionstringSub-section of the audit checklist this finding belongs to, if applicable.
    commonFindingNamestringName of the common finding checkpoint.
    commonFindingCategorystringCategory the common finding belongs to, for example "QIMA Standard Ethical Common Findings".
    checkpointResultstringResult for this checkpoint, for example "Pass" or "Not Compliant".
    capDetailsstringCorrective Action Plan (CAP) details related to this finding, when a CAP has been raised. `null` when not applicable.
    checkpointCommentsstringFree-text comments added by the auditor for this checkpoint. `null` when not provided.
    statusstringWhether the finding is "Open" or "Closed".
    desktopReviewCommentstringFree-text comment added during desktop review, if applicable. `null` when not applicable.
    FieldTypeDescription
    sequenceinteger
    fieldKeystring
    fieldValuestring
    {
  "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
      }
    ],
    "customizedFields": null,
    "initialAuditNumber": "R-Cloud-PP-23002492",
    "initialAuditType": "Ethical Audit"
  }
}
    GET
    /user/{userId}/audit-reports/{reportId}
    Request samples

    application/json

    {}
    Response samples

    application/json

    { "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 } ], "customizedFields": null, "initialAuditNumber": "R-Cloud-PP-23002492", "initialAuditType": "Ethical Audit" } }