QIMA Logo
API Reference

8 categories • 44 endpoints

  • All APIs

    44

    • Quick Actions
    Getting StartedDocumentation
    Audit
    v1.0.0

    Search audit reports

    Request
    Query Parameters
    NameTypeLocationRequiredDescription
    userIdstringpathYesQIMA client user login ID.
    startstringqueryNoFilter start date for the audit date range, in `YYYY-MM-DD` format (e.g., `2016-12-01`).
    endstringqueryNoFilter end date for the audit date range, in `YYYY-MM-DD` format (e.g., `2016-12-01`).
    keywordstringqueryNoKeyword to search against the audit order number or related references.
    pageintegerqueryNoPage number to show
    page-sizeintegerqueryNoPage size in search results
    allstringqueryNoSend 'true' to fetch all sub-master account list under super-master account
    sortFieldstringqueryNoSortField should be one of return columns name
    sortTypestringqueryNoDESC or ASC
    startSendDatestringqueryNoFilter start or end date for the report send/resend date range, in `YYYY-MM-DD` format (e.g., `2016-12-01`).
    endSendDatestringqueryNoFilter start or end date for the report send/resend date range, in `YYYY-MM-DD` format (e.g., `2016-12-01`).
    Responses
    200
    Paginated list of audit reports returned successfully.

    Content-Type: application/json

    pageNo
    integer
    FieldTypeDescription
    pageNointegerCurrent page number in search results
    FieldTypeDescription
    totalPageNumintegerCount of pages in search results
    FieldTypeDescription
    totalSizeintegerTotal results count in search results
    FieldTypeDescription
    orderIdstringInternal audit order ID. Pass this as `reportId` to Get Audit Report Details.
    auditDatestringDate the audit was performed.
    orderNumberstringClient-facing QIMA order number, for example "R-Cloud-PP-23002497".
    statusstringNumeric order status code.
    auditTypestringText audit type, for example "EA" (Ethical Audit). See also `serviceType`.
    divisionsstring
    showDivisionstring
    auditProgramstringClient's audit program name.
    generalCommentsstring
    serviceTypestringNumeric service type code, for example "9" (Ethical Audit).
    sicNamestring
    manDaystringNumber of person-days spent on the audit.
    isKeyAccountstring
    isReInspectionstring
    clientNamestringName of the client account.
    frozenDatestring
    dateConfirmedstring
    inspectorsNamesListarray
    numberOfWorkersstring
    factoryNamestring
    factoryIdstring
    factoryIdCodestring
    factoryProvincestring
    countryNamestring
    chargenumber
    supplierNamestring
    supplierIdCodestring
    supplierProvincestring
    supplierCitystring
    bookingDatestringDate the audit order was booked.
    updateTimestring
    clientReferencestringClient's own reference number for this order, if provided.
    orderPlacerstringInternal code identifying who placed/processed the order.
    aiOfficestringQIMA office handling the order.
    statusTextstring
    subServiceTypestring
    reportCoverOverAllScorenumberOverall audit score shown on the report cover.
    riskIndicatorstringRisk rating derived from the audit result, for example "Green".
    gpsXstring
    gpsYstring
    factoryAddressstring
    factoryCitystring
    lockerstring
    lockTimestring
    lockStatusinteger
    clientRatingstring
    clientFeedbackstring
    readboolean
    factoryClientCodestring
    poNumberstringClient's own PO number for this order, if provided.
    productNamestring
    validityDatestringDate the audit report remains valid until, if applicable.
    supervisorstring
    sendReportTimeintegerUnix timestamp (ms) the report was sent to the client.
    sendReportTimeFormatstringFormatted date/time the report was sent to the client.
    {
  "message": null,
  "content": {
    "pageNo": 1,
    "totalPageNum": 11,
    "totalSize": 214,
    "pageItems": [
      {
        "orderId": "35E6D48021774ED1999C34C78C0543BE",
        "auditDate": "27-Mar-2023",
        "orderNumber": "R-Cloud-PP-23002497",
        "status": "30",
        "auditType": "EA",
        "auditProgram": "Big Lots",
        "serviceType": "9",
        "manDay": "1",
        "isReInspection": "YES",
        "clientName": "AuditApp-Automation",
        "dateConfirmed": "Yes",
        "inspectorsNamesList": [
          "Sam Wang"
        ],
        "numberOfWorkers": "1",
        "factoryName": "FactoryTest40087",
        "factoryProvince": "Guangdong",
        "countryName": "China",
        "charge": 681.45,
        "supplierName": "SupplierTest64309",
        "supplierProvince": "Zhejiang",
        "bookingDate": "2023-03-14",
        "updateTime": "2023-03-14 02:03:47",
        "orderPlacer": "SP1126",
        "aiOffice": "Shenzhen office",
        "reportCoverOverAllScore": 8.3,
        "riskIndicator": "Green",
        "factoryAddress": "Address test",
        "factoryCity": "Shenzhen",
        "lockStatus": 0,
        "read": false,
        "poNumber": "EA PO No 1",
        "clientReference": "EA Internal Ref No 1",
        "validityDate": "2024-03-20",
        "supervisor": "Sam Wang",
        "sendReportTime": 1678775496577,
        "sendReportTimeFormat": "14-Mar-2023 14:31:36"
      }
    ],
    "countByFields": null
  }
}
    GET
    /user/{userId}/audit-reports
    Request samples

    application/json

    {}
    Response samples

    application/json

    { "message": null, "content": { "pageNo": 1, "totalPageNum": 11, "totalSize": 214, "pageItems": [ { "orderId": "35E6D48021774ED1999C34C78C0543BE", "auditDate": "27-Mar-2023", "orderNumber": "R-Cloud-PP-23002497", "status": "30", "auditType": "EA", "auditProgram": "Big Lots", "serviceType": "9", "manDay": "1", "isReInspection": "YES", "clientName": "AuditApp-Automation", "dateConfirmed": "Yes", "inspectorsNamesList": [ "Sam Wang" ], "numberOfWorkers": "1", "factoryName": "FactoryTest40087", "factoryProvince": "Guangdong", "countryName": "China", "charge": 681.45, "supplierName": "SupplierTest64309", "supplierProvince": "Zhejiang", "bookingDate": "2023-03-14", "updateTime": "2023-03-14 02:03:47", "orderPlacer": "SP1126", "aiOffice": "Shenzhen office", "reportCoverOverAllScore": 8.3, "riskIndicator": "Green", "factoryAddress": "Address test", "factoryCity": "Shenzhen", "lockStatus": 0, "read": false, "poNumber": "EA PO No 1", "clientReference": "EA Internal Ref No 1", "validityDate": "2024-03-20", "supervisor": "Sam Wang", "sendReportTime": 1678775496577, "sendReportTimeFormat": "14-Mar-2023 14:31:36" } ], "countByFields": null } }