Work Orders (GJZJ18J)

The GJZJ18J function creates new Work Orders

User security

(one of the following)

  • System Administration > Jonas Template Uploads > Service Billing & S/C > Work Order Upload (Standard)
  • Service Billing > W/Os & Dispatch > Service Calls - Work Orders
WebMethod
GJZJ18J
6 sample payloads

Options overview

OptionPurpose
templateAn empty Work Order template you can populate and send back with Option: update.
downloadAn existing Work Order exported via Option: download.
scanValidate a Work Order payload before committing. The error response lists which rows and fields failed.
updateOnce the scan is clean, switch Option to update to create or update the records.

Template

An empty Work Order template you can populate and send back with Option: update.

Work Order TemplateJSON payload
{
  "WebMethod": "GJZJ18J",
  "Option": "template",
  "CompanyCode": "",
  "ARSubledgerCode": "",
  "WO_Headers_tbl": [
    {
      "WorkOrderNumber": "",
      "CustomerCode": "",
      "WorkOrderCategory": "1",
      "SalesCategoryCode": "",
      "BillType": "B",
      "WO_DescriptionOfWork_tbl": [
        {
          "WorkDescription": ""
        }
      ],
      "DispatchPriority": "",
      "WOStatusCode": "",
      "NewPurchaseOrderNumber": "",
      "PhoneNumber": "",
      "JobAddressLine1": "",
      "JobAddressLine2": "",
      "JobAddressLine3": "",
      "ScheduledDate": "",
      "OrderDate": "",
      "ContactName": "",
      "TechnicianID": "",
      "ReferenceNumber": "",
      "DispatchEstimatedHours": 0,
      "ServiceContractNumber": "",
      "CompletelyBilled": "N",
      "BillingDate": "",
      "InvoiceNumber": "",
      "QuotedPrice": 0,
      "TerritoryMap": "",
      "JobNumber": "",
      "CostItem": "",
      "FlatRateBook": "",
      "PriceLevel": "",
      "BillToCode": "",
      "Spare1": "",
      "Spare2": "",
      "Spare3": "",
      "Spare4": "",
      "Spare5": "",
      "Spare6": "",
      "Spare7": "",
      "Spare8": "",
      "Spare9": "",
      "Spare10": "",
      "TerritorySalespersonCode": "",
      "TakenBy": ""
    }
  ]
}

Download

An existing Work Order exported via Option: download.

Work Order DownloadSOAP envelope
<?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Body><JonasAPIResponse xmlns="jonas.jonasportal.com/"><JonasAPIResult>{"isAuthenticated":true,"isValid":true,"Data: {"WebMethod":"GJZJ18J","Option":"download","CompanyCode":"JC","ARSubledgerCode":"G1","WO_Headers_tbl":[{"WorkOrderNumber":"0000000005","CustomerCode":"TESTCUST02","WorkOrderCategory":"1","SalesCategoryCode":"","BillType":"B","WO_DescriptionOfWork_tbl":[{"WorkDescription":"Testing"},{"WorkDescription":""},{"WorkDescription":""},{"WorkDescription":""},{"WorkDescription":""},{"WorkDescription":""}],"DispatchPriority":" 5","WOStatusCode":"O","NewPurchaseOrderNumber":"","PREFIX_WO":"W/O","JobAddressLine1":"123 Fourth Street","JobAddressLine2":"Suite 5","JobAddressLine3":" M4R7Y6","ScheduledDate":"2014-07-14T00:00:00Z","OrderDate":"2014-07-14T00:00:00Z","ContactName":"jonas","TechnicianID":"","ReferenceNumber":"","DispatchEstimatedHours":0.00,"ServiceContractNumber":"","CompletelyBilled":"","BillingDate":"N/A","InvoiceNumber":"","QuotedPrice":0,"TerritoryMap":"CENTRAL"}]}</JonasAPIResult></JonasAPIResponse></soap:Body></soap:Envelope>

Scan

Validate a Work Order payload before committing. The error response lists which rows and fields failed.

Work Order Scan CallSOAP envelope
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:jon="jonas.jonasportal.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <jon:JonasAPI>
         <!--Optional:-->
         <jon:securityToken>fe02f84b459a4a317dd6080678bd8140</jon:securityToken>
         <!--Optional:-->
         <jon:username>****</jon:username>
         <!--Optional:-->
         <jon:password>****</jon:password>
         <!--Optional:-->
         <jon:apiParams><![CDATA[
         		{"WebMethod":"GJZJ18J","Option":"scan","CompanyCode":"ET","ARSubledgerCode":"G1","WO_Headers_tbl":[{"WorkOrderNumber":"0000000005","CustomerCode":"TESTCUST02","WorkOrderCategory":"1","SalesCategoryCode":"","BillType":"B","WO_DescriptionOfWork_tbl":[{"WorkDescription":"Testing"},{"WorkDescription":""},{"WorkDescription":""},{"WorkDescription":""},{"WorkDescription":""},{"WorkDescription":""}],"DispatchPriority":" 5","WOStatusCode":"O","NewPurchaseOrderNumber":"","PREFIX_WO":"W/O","JobAddressLine1":"123 Fourth Street","JobAddressLine2":"Suite 5","JobAddressLine3":" M4R7Y6","ScheduledDate":"2014-07-14T00:00:00Z","OrderDate":"2014-07-14T00:00:00Z","ContactName":"jonas","TechnicianID":"","ReferenceNumber":"","DispatchEstimatedHours":0.00,"ServiceContractNumber":"","CompletelyBilled":"","BillingDate":"N/A","InvoiceNumber":"","QuotedPrice":0,"TerritoryMap":"CENTRAL"}]}
         ]]></jon:apiParams>
      </jon:JonasAPI>
   </soapenv:Body>
</soapenv:Envelope>
Work Order Scan Call Error ResponseSOAP envelope
<?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Body><JonasAPIResponse xmlns="jonas.jonasportal.com/"><JonasAPIResult>{"isAuthenticated":true,"isValid":true,"Data: {"WebMethod":"GJZJ18J","Option":"scan","CompanyCode":"ET","ARSubledgerCode":"G1","errors":["Invalid CompanyCode"]}</JonasAPIResult></JonasAPIResponse></soap:Body></soap:Envelope>

Import

Once the scan is clean, switch Option to update to import and create or update the records.

Note: Only the following fields can be modified on an existing WorkOrder: TerritorySalespersonCode, TakenBy, and Spare1 through Spare10. The WorkDescription can only be appended to.

Work Order ImportSOAP envelope
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:jon="jonas.jonasportal.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <jon:JonasAPI>
         <!--Optional:-->
         <jon:securityToken>fe02f84b459a4a317dd6080678bd8140</jon:securityToken>
         <!--Optional:-->
         <jon:username>****</jon:username>
         <!--Optional:-->
         <jon:password>****</jon:password>
         <!--Optional:-->
         <jon:apiParams><![CDATA[
         		{"WebMethod":"GJZJ18J","Option":"update","CompanyCode":"JC","ARSubledgerCode":"G1","WO_Headers_tbl":[{"WorkOrderNumber":"0000000099","CustomerCode":"TESTCUST02","WorkOrderCategory":"1","SalesCategoryCode":"1","BillType":"B","WO_DescriptionOfWork_tbl":[{"WorkDescription":"Testing"},{"WorkDescription":""},{"WorkDescription":""},{"WorkDescription":""},{"WorkDescription":""},{"WorkDescription":""}],"DispatchPriority":" 5","WOStatusCode":"O","NewPurchaseOrderNumber":"","PREFIX_WO":"W/O","JobAddressLine1":"123 Fourth Street","JobAddressLine2":"Suite 5","JobAddressLine3":" M4R7Y6","ScheduledDate":"2014-07-14T00:00:00Z","OrderDate":"2014-07-14T00:00:00Z","ContactName":"jonas","TechnicianID":"","ReferenceNumber":"","DispatchEstimatedHours":0.00,"ServiceContractNumber":"","CompletelyBilled":"","BillingDate":"N/A","InvoiceNumber":"","QuotedPrice":0,"TerritoryMap":"CENTRAL"}]}
         ]]></jon:apiParams>
      </jon:JonasAPI>
   </soapenv:Body>
</soapenv:Envelope>
Work Order Import ResponseSOAP envelope
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<JonasAPIResponse xmlns="jonas.jonasportal.com/">
<JonasAPIResult>{"message":"Login Successful : UserID GJSYSTEM (User 7/10) ","data":"{\"WebMethod\":\"GJZJ18J\",\"Option\":\"update\",\"CompanyCode\":\"JC\",\"ARSubledgerCode\":\"G1\",\"RecordsProcessed\":\"1\",\"ErrorsFound\":\"0\"}","isValid":true,"isAuthenticated":true}
</JonasAPIResult>
</JonasAPIResponse>
</soap:Body>
</soap:Envelope>