Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

FieldValue typeMandatoryDescriptionExample
IDJobTypestring
Status
colourRed
titleYes
ID of the job type being created. Job type information can be retrieved from here.7090fad1-c4da-4488-9ceb-55ee9847edcc
IDLeadSourcestring ID of the lead source. A list of Lead source ID's can be retrieved by calling a help web service here.926a4185-6cb3-4a2a-a8ec-1fadc1cf4caa
IDStatusstring ID of the job status. Job statuses can be retries from here  .926a4185-6cb3-4a2a-a8ec-1fadc1cf4caa
IDSitestring
Status
colourRed
titleYes
ID of the site the job belongs to.20058233-7388-418b-9193-6b57e28604f9
IDCustomerstringEither IDCustomer and/or IDContact is RequiredID of the customer. More information on the API for customers can be found here.c0fd94f3-2ddd-4eea-bc24-40189480d10f
IDContactstringEither IDCustomer and/or IDContact is RequiredID of the contact. More information on the API for contacts can be found here.20058233-7388-418b-9193-6b57e28604f9
DueDatestring UTC date in ISO 8601 format2010-08-20T15:00:00Z
FollowUpDatestring UTC date in ISO 8601 format. If omitted the follow up time will default to the current time.2010-08-20T15:00:00Z
ChargeAmountdecimal Amount to charge for the job. If omitted the default charge amount will be used as configured in the job type.20.52
StartDatestring UTC date in ISO 8601 format. Omit this values if the job has not started.2010-08-20T15:00:00Z
FinishDatestring UTC date in ISO 8601 format. Omit this values if the job has not finished.2010-08-20T15:00:00Z
Durationint Duration of job in minutes20
AddressAddress Object  Address of the job.

See Address Object

AddressDeliveryAddress Object  Delivery address if the job has a start and a destination. This address will be displayed if the job type has been configured to use a delivery address.See Address Object
CustFieldsArray of custom fields objects An array of all custom field data for the job. Custom field attributes are described below. 
NotesArray of Notes Object Notes for the job.See Notes Object
ItemsArray of Items objects Inventory items used on the job. These items can be items from the inventory information in Crittah or free text line items. 

...

Code Block
 {
  "IDJob": "c1ed6b2c-40c2-4d98-8445-148ae1890b67",
  "IDShift": "00000000-0000-0000-0000-000000000000",
  "JobOrder": 0,
  "JobReference": "AHC817040595",
  "IDJobType": "49b86bf8-a610-4594-baea-30b76c21974d",
  "JobType": "AdHoc",
  "Colour": "#f5c9cb",
  "IDStatus": "a610305a-1a34-4c3d-b271-d710ba6b3be3",
  "IDLeadSource": "a610305a-1a34-4c3d-b271-d710ba6b3be3",
  "Status": "New",
  "Customer": {
    "IDCustomer": "5f3f2135-d0f5-47a4-906e-7274b0128054",
    "IDSite": "20058233-7388-418b-9193-6b57e28604f9",
    "Site": "SYD",
    "Types": [
      {
        "IDType": "4d819963-731c-41fd-9378-fd7a10199b78",
        "Type": "Associates"
      },
      {
        "IDType": "27ec5309-9426-4a05-b51c-532f8582c436",
        "Type": "Financial"
      },
      {
        "IDType": "21a952eb-089e-467a-98bf-f8cb9a0ebd88",
        "Type": "Producer"
      }
    ],
    "IDStatus": "926a4185-6cb3-4a2a-a8ec-1fadc1cf4caa",
    "Status": "Active",
    "Parent": null,
    "CompanyName": "North Bunting Supplies",
    "CompanyNo": "111 222 3333",
    "CustomerRef": "7193032",
    "Phone": "9575 545",
    "Mobile": "0414 656 654",
    "Fax": "654 654 124",
    "Council": "Sydney",
    "WebSite": "http:\/\/www.buntingsupplies.com.au",
    "AddressBilling": {
      "IDAddress": "368321fe-de7e-4f38-80a7-e7ea8e34fe26",
      "AddressLine1": "99 Castlereagh Street",
      "AddressLine2": null,
      "City": "NORTH SYDNEY",
      "State": "NSW",
      "IDCountry": 1013,
      "Country": "Australia",
      "PostCode": "2001",
      "LocRef": {
        "IDLocation": "6db14940-f906-4c20-949a-e332f6798336",
        "LatLng": {
          "Lat": -33.869738,
          "Lng": 151.209448
        }
      }
    },
    "Address": {
      "IDAddress": "2d69c03b-5b57-46b4-8d67-43d2f27d225a",
      "AddressLine1": "91 Castlereagh Street",
      "AddressLine2": null,
      "City": "NORTH SYDNEY",
      "State": "NSW",
      "IDCountry": 1013,
      "Country": "Australia",
      "PostCode": "2000",
      "LocRef": {
        "IDLocation": "e97c85a5-62c0-4e13-bb63-ed8a43050360",
        "LatLng": {
          "Lat": -33.869738,
          "Lng": 151.209448
        }
      }
    },
    "AccountOwner": "00000000-0000-0000-0000-000000000000",
    "Notes": [
      {
        "IDNote": "05629a9b-2869-4197-82af-b6f975be93c8",
        "IDEntity": "5f3f2135-d0f5-47a4-906e-7274b0128054",
        "IDNoteType": "77d5d244-eb29-4b5b-8b14-87d92b4215ea",
        "Type": "General",
        "NoteInfo": "Contact the front desk for assistance"
      },
      {
        "IDNote": "cf67b514-3ba2-44d9-82f0-c0d5f8d57816",
        "IDEntity": "5f3f2135-d0f5-47a4-906e-7274b0128054",
        "IDNoteType": "77d5d244-eb29-4b5b-8b14-87d92b4215ea",
        "Type": "General",
        "NoteInfo": "Entry is via 120 King st - last driveway on right before Castlereagh st."
      }
    ]
  },
  "Contact": {
    "IDContact": "cd62aad8-9e0d-408a-827b-c620ff9b3598",
    "ContactRef": "4713828",
    "IDSite": "20058233-7388-418b-9193-6b57e28604f9",
    "Site": "SYD",
    "Types": [
      
    ],
    "Salutation": "Mr",
    "FirstName": "John",
    "LastName": "Peterson",
    "Email": "j.peterson@gmal.com",
    "Phone": "(02) 9506 3560",
    "Mobile": "0412 544 654",
    "Fax": "9567 680",
    "BirthDate": null,
    "Position": "",
    "Department": "",
    "IDStatus": "926a4185-6cb3-4a2a-a8ec-1fadc1cf4caa",
    "Status": "Active",
    "Customer": {
      "IDCustomer": "5f3f2135-d0f5-47a4-906e-7274b0128054",
      "IDSite": "20058233-7388-418b-9193-6b57e28604f9",
      "Site": "SYD",
      "Types": [
        {
          "IDType": "4d819963-731c-41fd-9378-fd7a10199b78",
          "Type": "Associates"
        },
        {
          "IDType": "27ec5309-9426-4a05-b51c-532f8582c436",
          "Type": "Financial"
        },
        {
          "IDType": "21a952eb-089e-467a-98bf-f8cb9a0ebd88",
          "Type": "Producer"
        }
      ],
      "IDStatus": "926a4185-6cb3-4a2a-a8ec-1fadc1cf4caa",
      "Status": "Active",
      "Parent": null,
      "CompanyName": "North Bunting Supplies",
      "CompanyNo": "111 222 3333",
      "CustomerRef": "7193032",
      "Phone": "9575 545",
      "Mobile": "0414 656 654",
      "Fax": "654 654 124",
      "Council": "Sydney",
      "WebSite": "http:\/\/www.buntingsupplies.com.au",
      "AddressBilling": {
        "IDAddress": "368321fe-de7e-4f38-80a7-e7ea8e34fe26",
        "AddressLine1": "99 Castlereagh Street",
        "AddressLine2": null,
        "City": "NORTH SYDNEY",
        "State": "NSW",
        "IDCountry": 1013,
        "Country": "Australia",
        "PostCode": "2001",
        "LocRef": {
          "IDLocation": "6db14940-f906-4c20-949a-e332f6798336",
          "LatLng": {
            "Lat": -33.869738,
            "Lng": 151.209448
          }
        }
      },
      "Address": {
        "IDAddress": "2d69c03b-5b57-46b4-8d67-43d2f27d225a",
        "AddressLine1": "91 Castlereagh Street",
        "AddressLine2": null,
        "City": "NORTH SYDNEY",
        "State": "NSW",
        "IDCountry": 1013,
        "Country": "Australia",
        "PostCode": "2000",
        "LocRef": {
          "IDLocation": "e97c85a5-62c0-4e13-bb63-ed8a43050360",
          "LatLng": {
            "Lat": -33.869738,
            "Lng": 151.209448
          }
        }
      },
      "AccountOwner": "00000000-0000-0000-0000-000000000000",
      "Notes": [
        {
          "IDNote": "05629a9b-2869-4197-82af-b6f975be93c8",
          "IDEntity": "5f3f2135-d0f5-47a4-906e-7274b0128054",
          "IDNoteType": "77d5d244-eb29-4b5b-8b14-87d92b4215ea",
          "Type": "General",
          "NoteInfo": "Contact the front desk for assistance"
        },
        {
          "IDNote": "cf67b514-3ba2-44d9-82f0-c0d5f8d57816",
          "IDEntity": "5f3f2135-d0f5-47a4-906e-7274b0128054",
          "IDNoteType": "77d5d244-eb29-4b5b-8b14-87d92b4215ea",
          "Type": "General",
          "NoteInfo": "Entry is via 120 King st - last driveway on right before Castlereagh st."
        }
      ]
    },
    "Address": {
      "IDAddress": "b8ec4614-cbcc-4a20-9bc3-64ab2ba89fda",
      "AddressLine1": "26 Wolongong ROad",
      "AddressLine2": null,
      "City": "ARNCLIFFE",
      "State": "NSW",
      "IDCountry": 1013,
      "Country": "Australia",
      "PostCode": "2205",
      "LocRef": {
        "IDLocation": "2be70140-b953-4935-b075-02660288bb1e",
        "LatLng": {
          "Lat": -33.934813,
          "Lng": 151.146104
        }
      }
    },
    "Notes": [
      {
        "IDNote": "5b4dac63-e226-4270-99d3-17e289115ba7",
        "IDEntity": "cd62aad8-9e0d-408a-827b-c620ff9b3598",
        "IDNoteType": "2b11efc3-2a43-4c03-92ac-923e77f821a2",
        "Type": "Important",
        "NoteInfo": "Maincontact for organisation"
      }
    ]
  },
  "DueDate": "2014-10-06T10:55:00Z",
  "Address": {
    "IDAddress": "362eb124-d124-4a47-ba94-6585e8bf4426",
    "AddressLine1": "91 Castlereagh Street",
    "AddressLine2": null,
    "City": "NORTH SYDNEY",
    "State": "NSW",
    "IDCountry": 1013,
    "Country": "Australia",
    "PostCode": "2000",
    "LocRef": {
      "IDLocation": "3ac45077-b768-4264-b085-506892b46691",
      "LatLng": {
        "Lat": -33.869738,
        "Lng": 151.209448
      }
    }
  },
  "AddressDelivery": {
    "IDAddress": "9f446daf-c80f-4112-9e1f-c8d867632e38",
    "AddressLine1": "91 Castlereagh Street",
    "AddressLine2": null,
    "City": "NORTH SYDNEY",
    "State": "NSW",
    "IDCountry": 1013,
    "Country": "Australia",
    "PostCode": "2000",
    "LocRef": {
      "IDLocation": "4e878177-7de5-431e-b843-3ecdc4b6e8f0",
      "LatLng": {
        "Lat": -33.869738,
        "Lng": 151.209448
      }
    }
  },
  "CustFields": {
    "CF": [
      {
        "Order": 1,
        "IDCF": "ac0a7cf2-2496-4147-a8e0-f679a538f3bc",
        "Name": "# Containers",
        "Type": "Number",
        "Descr": "Number of containers required",
        "DV": "0",
        "DP": 0,
        "AddV": 1,
        "Mand": true,
        "ML": 0,
        "Abrev": "NCNT",
        "VDate": "",
        "VDec": 22,
        "VStr": "",
        "VID": null
      },
      {
        "Order": 2,
        "IDCF": "55535646-a0d5-48d9-b718-e5abdc792192",
        "Name": "Fruit\/Veg\/Salad",
        "Type": "Measurement",
        "Descr": "Fruit, Vegetables and Salad",
        "DV": "0",
        "DP": 0,
        "AddV": 1,
        "Mand": true,
        "ML": 0,
        "Abrev": "FVS",
        "VDate": "",
        "VDec": 1,
        "VStr": "",
        "VID": null
      },
      {
        "Order": 3,
        "IDCF": "d4602f75-d0b1-46b4-968b-549cfac7ef79",
        "Name": "Cooked Meals",
        "Type": "Measurement",
        "Descr": "Cooked Meals",
        "DV": "0",
        "DP": 0,
        "AddV": 1,
        "Mand": true,
        "ML": 0,
        "Abrev": "CM",
        "VDate": "",
        "VDec": 2,
        "VStr": "",
        "VID": null
      },
      {
        "Order": 4,
        "IDCF": "122727dc-b753-4a39-8fb2-921a2b483523",
        "Name": "Sandwiches",
        "Type": "Measurement",
        "Descr": "Sandwiches",
        "DV": "0",
        "DP": 0,
        "AddV": 1,
        "Mand": true,
        "ML": 0,
        "Abrev": "S",
        "VDate": "",
        "VDec": 3,
        "VStr": "",
        "VID": null
      },
      {
        "Order": 5,
        "IDCF": "b980cf94-c37c-49fe-bcc1-ff63c552923f",
        "Name": "Dairy",
        "Type": "Measurement",
        "Descr": "Dairy",
        "DV": "0",
        "DP": 0,
        "AddV": 1,
        "Mand": true,
        "ML": 0,
        "Abrev": "D",
        "VDate": "",
        "VDec": 45,
        "VStr": "",
        "VID": null
      },
      {
        "Order": 6,
        "IDCF": "9edc2d59-36d9-40ce-87d0-cb0250098787",
        "Name": "Raw Meat",
        "Type": "Measurement",
        "Descr": "Raw Meat",
        "DV": "0",
        "DP": 0,
        "AddV": 1,
        "Mand": true,
        "ML": 0,
        "Abrev": "RM",
        "VDate": "",
        "VDec": 6,
        "VStr": "",
        "VID": null
      },
      {
        "Order": 7,
        "IDCF": "fa609e1c-4775-414f-af6c-e957cff27eaf",
        "Name": "Raw Meat Used By",
        "Type": "Date",
        "Descr": "Raw Meat Used By date. The date in which the raw meat expires.",
        "DV": "",
        "DP": 0,
        "AddV": 1,
        "Mand": false,
        "ML": 0,
        "Abrev": "RME",
        "VDate": "",
        "VDec": 0,
        "VStr": "",
        "VID": null
      },
      {
        "Order": 8,
        "IDCF": "313c714f-2f8d-4638-98f2-b18be1155e1d",
        "Name": "Deserts and Pastries",
        "Type": "Measurement",
        "Descr": "Deserts and Pastries",
        "DV": "0",
        "DP": 0,
        "AddV": 1,
        "Mand": true,
        "ML": 0,
        "Abrev": "DP",
        "VDate": "",
        "VDec": 0,
        "VStr": "",
        "VID": null
      },
      {
        "Order": 9,
        "IDCF": "e24167b0-6bb0-4cc6-8e03-ee85ee233d52",
        "Name": "Bread",
        "Type": "Measurement",
        "Descr": "Bread",
        "DV": "0",
        "DP": 0,
        "AddV": 1,
        "Mand": true,
        "ML": 0,
        "Abrev": "B",
        "VDate": "",
        "VDec": 0,
        "VStr": "",
        "VID": null
      },
      {
        "Order": 10,
        "IDCF": "3013af25-b9c8-4c5d-b74d-a6c9bddf2120",
        "Name": "Dry Stock",
        "Type": "Measurement",
        "Descr": "Dry Stock",
        "DV": "0",
        "DP": 0,
        "AddV": 1,
        "Mand": true,
        "ML": 0,
        "Abrev": "DS",
        "VDate": "",
        "VDec": 0,
        "VStr": "",
        "VID": null
      },
      {
        "Order": 11,
        "IDCF": "7c8039fe-681d-4ffe-a0c6-1b58c2c5c635",
        "Name": "Dry Stock Used By",
        "Type": "Date",
        "Descr": "Dry Stock used by date",
        "DV": "",
        "DP": 0,
        "AddV": 1,
        "Mand": false,
        "ML": 0,
        "Abrev": "DSU",
        "VDate": "",
        "VDec": 0,
        "VStr": "",
        "VID": null
      },
      {
        "Order": 12,
        "IDCF": "6117a168-bfc3-482a-b0ef-74edb8b85ca8",
        "Name": "Drinks",
        "Type": "Measurement",
        "Descr": "Drinks",
        "DV": "0",
        "DP": 0,
        "AddV": 1,
        "Mand": true,
        "ML": 0,
        "Abrev": "DRINK",
        "VDate": "",
        "VDec": 0,
        "VStr": "",
        "VID": null
      }
    ]
  },
  "Notes": [
    
  ],
  "Items": [
    
  ]
}

...