developer notes

Create Job Order

The JobOrderCreate API allows you to create a new Job Order. The request body includes job order, service zone, order owner, and other relevant information.

Method	API Endpoint
POST	`{{endpoint}}/api/ext/job-orders`

‍

Headers

‍

Key	Value
Content-Type	`application/json`
Authorization	`Bearer {{token}}`

‍

Example Request

‍

{
    "jobOrder": {
        "joName": null,
        "customer": {
            "customerExternalId": "cext1"  
        },
        "serviceZone": {
            "code": "cext1"  
        },
        "jobOrderType": {
            "name": "cext1"  
        },
        "orderOwner": {
            "id": 1
        },
        "uncompleatedJobOrder": null,
        "status": "OPEN",
        "showServiceChecklist": false,
        "showHandoverCertificate": false,
        "showCustomerServiceReport": false,
        "serviceChecklistRequired": false,
        "customerServiceReportRequired": false,
        "handoverCertificateRequired": false,
        "systemValue": "",
        "redFlag": false,
        "medicalRecordNumber": null,
        "origExt": null,
        "ward": null,
        "bed": null,
        "onCode": null,
        "onCodeMessage": null,
        "offCode": null,
        "offCodeMessage": null,
        "ipAddress": null,
        "fault": null,
        "ableToFix": null,
        "additionalFaults": null,
        "additionalResolutions": null,
        "openingDays": null,
        "workNotDoneReason": null,
        "resolution": null,
        "resolutionComments": null,
        "workNotDoneOther": null,
        "physicalDamage": false,
        "physicalDamageDescription": null,
        "bedStatus": null,
        "hospitalCode": null,
        "billable": false,
        "jobOrderName": "",
        "jobExternalId": null,
        "jobSfExternalId": "null",
        "customerExternalId": null,
        "installationDate": "2023-10-05",
        "installationTime": "2023-10-05T06:42:48.409Z",
        "assetUnderWarranty": false,
        "invoiceNumber": null,
        "completionDateTime": null,
        "valueFault": null,
        "additionalValueFaults": null,
        "valueResolution": null,
        "additionalValueResolutions": null,
        "completionTime": null
    },
    "jobOrderProductList": [],
    "maintenanceItem": null
}

‍

Example Response

‍

// status - 201
{
    "jobOrderProductList": [],
    "attachmentList": null,
    "jobOrder": {
        "id": 35402,
        "jobOrderNumber": "JO-035402",
        "jobOrderName": "",
        "installationDate": "2023-10-05",
        "installationTime": "2023-10-05T06:42:48.409Z",
        "completionDate": null,
        "status": "OPEN",
        "completionTime": null,
        "jobExternalId": null,
        "orderAmount": null,
        "jobSfExternalId": null,
        "contactPersonName": null,
        "contactPersonEmail": null,
        "contactPersonPhone": null,
        "resolution": null,
        "description": null,
        "jobDescription": null,
        "installationStreet": null,
        "installationCity": null,
        "installationState": null,
        "installationPostalCode": null,
        "installationCountry": null,
        "createdDateTime": "2023-11-27T06:05:55.076Z",
        "modifiedDateTime": "2023-11-27T06:05:55.073Z",
        "placeId": null,
        "isDeleted": false,
        "includePrice": false,
        "showServiceChecklist": false,
        "showCustomerServiceReport": false,
        "showHandoverCertificate": false,
        "serviceChecklistRequired": false,
        "customerServiceReportRequired": false,
        "handoverCertificateRequired": false,
        "systemValue": "",
        "redFlag": false,
        "medicalRecordNumber": null,
        "origExt": null,
        "ward": null,
        "bed": null,
        "onCode": null,
        "onCodeMessage": null,
        "offCode": null,
        "offCodeMessage": null,
        "ipAddress": null,
        "hospitalCode": null,
        "fault": null,
        "pmvId": null,
        "checklistRecordId": null,
        "additionalFaultsValue": null,
        "faultDetails": null,
        "resolutionValue": null,
        "additionalResolutionsValue": null,
        "resolutionComments": null,
        "openingDays": null,
        "workNotDoneReasonValue": null,
        "workNotDoneOther": null,
        "physicalDamage": false,
        "physicalDamageDescription": null,
        "bedStatus": null,
        "ableToFix": null,
        "recommendation": null,
        "billable": false,
        "daysCategory": null,
        "notifyCustomer": false,
        "checkInDuration": null,
        "totalDistance": null,
        "travelDuration": null,
        "invoiceNumber": null,
        "assetUnderWarranty": false,
        "completionDateTime": null,
        "installationLatitude": null,
        "installationLongitude": null,
        "uuid": "0934bc06-f26f-4248-94dc-698486551f4e",
        "createdByExternal": "load.tech1@trial.custella.com",
        "modifiedByExternal": "load.tech1@trial.custella.com",
        "createdBy": {
            "createdBy": "load.test1@trial.custella.com",
            "createdDate": "2023-05-02T09:45:27Z",
            "lastModifiedBy": "load.tech1@trial.custella.com",
            "lastModifiedDate": "2023-11-27T03:55:12Z",
            "id": 3,
            "login": "load.tech1@trial.custella.com",
            "firstName": "Technician",
            "lastName": "User",
            "email": "preeti@fieldex.com",
            "activated": true,
            "status": "ACTIVE",
            "emailNotifications": false,
            "smsNotifications": false,
            "firstTimeLogin": false,
            "isOnline": false,
            "phone": "0122468589",
            "calendarStatus": null,
            "langKey": "en",
            "imageUrl": null,
            "resetDate": "2023-05-04T00:00:00Z",
            "dateOfBirth": null,
            "joiningDate": null,
            "position": null,
            "location": null,
            "locationLattitude": 7.257747,
            "locationLongitude": 80.445915,
            "gender": null,
            "skill": "GENERAL",
            "timezone": "Asia/Kuala_Lumpur",
            "buffer": 15.0,
            "alertForTaskTime": 10.0,
            "isTaskAlert": false,
            "startBuffer": 15.0,
            "endBuffer": 15.0,
            "maxShiftHousrsPerDay": 8.0,
            "shiftWorking": 0,
            "saleforceAccessToken": null,
            "saleforceRefreshToken": null,
            "saleforceInstanceId": null,
            "dateFormatString": "dd-MM-yyyy",
            "isUserStateActive": false,
            "defaultDashboard": "Pending Job Order",
            "employeeNo": null,
            "authorityString": "...", // Truncated for brevity
            "offlineEnable": null,
            "roleId": null,
            "roleName": null,
            "profileId": null,
            "profileName": null,
            "superVisor": null,
            "geoFence": null,
            "userType": null,
            "defaultDepot": null,
            "tenantId": 41,
            "passwordText": null,
            "allDays": false,
            "maxShiftHousrType": "DAY",
            "myFullName": "Technician User",
            "online": false,
            "fullName": "Technician User"
        },
        "salesOrder": null,
        "orderOwner": {
            "createdBy": null,
            "createdDate": "2023-11-27T06:05:55Z",
            "lastModifiedBy": null,
            "lastModifiedDate": "2023-11-27T06:05:55Z",
            "id": 1,
            "login": null,
            "firstName": null,
            "lastName": null,
            "email": null,
            "activated": false,
            "status": null,
            "emailNotifications": false,
            "smsNotifications": false,
            "firstTimeLogin": true,
            "isOnline": false,
            "phone": null,
            "calendarStatus": null,
            "langKey": null,
            "imageUrl": null,
            "resetDate": null,
            "dateOfBirth": null,
            "joiningDate": null,
            "position": null,
            "location": null,
            "locationLattitude": null,
            "locationLongitude": null,
            "gender": null,
            "skill": null,
            "timezone": null,
            "buffer": null,
            "alertForTaskTime": 10.0,
            "isTaskAlert": false,
            "startBuffer": null,
            "endBuffer": null,
            "maxShiftHousrsPerDay": 8.0,
            "shiftWorking": 0,
            "saleforceAccessToken": null,
            "saleforceRefreshToken": null,
            "saleforceInstanceId": null,
            "dateFormatString": null,
            "isUserStateActive": null,
            "defaultDashboard": null,
            "employeeNo": null,
            "authorityString": null,
            "offlineEnable": null,
            "roleId": null,
            "roleName": null,
            "profileId": null,
            "profileName": null,
            "superVisor": null,
            "geoFence": null,
            "userType": null,
            "defaultDepot": null,
            "tenantId": null,
            "passwordText": null,
            "allDays": false,
            "maxShiftHousrType": "DAY",
            "myFullName": "",
            "online": false,
            "fullName": "null null"
        },
        "modifiedBy": {
            "id": 3,
            "login": "load.tech1@trial.custella.com",
            "firstName": "Technician",
            "lastName": "User",
            "fullName": "Technician User"
            // ... truncated
        },
        "customer": null,
        "customerPurchaseHistory": null,
        "jobOrderType": null,
        "jobOrderFaultType": null,
        "serviceZone": null,
        "customerPurchaseHistoryPickListLites": [],
        "taskList": null,
        "products": [],
        "uncompleatedJobOrder": null,
        "assets": null,
        "valueFault": null,
        "valueResolution": null,
        "site": null,
        "project": null,
        "additionalValueFaults": null,
        "additionalValueResolutions": null,
        "customerServiceReport": null,
        "serviceChecklist": null,
        "handoverCertificate": null,
        "ticket": null,
        "additionalFaults": null,
        "additionalResolutions": null,
        "workNotDoneReason": null,
        "hpForm": null,
        "createdByExternalUser": null,
        "modifiedByExternalUser": null,
        "deleted": false,
        "journeyStatusActive": false
    },
    "jobOrderCompletionRecordVm": null,
    "violatingSoonSla": null,
    "maintenanceItem": null,
    "alert": null,
    "totalTimeTaken": null,
    "signedJoAttachment": null,
    "slastatus": null
}

‍