# JobOrder

Retrieve one job order object by provided GUID

Endpoint: GET /rest/api/standard/v1/JobOrder/{jobOrderGuid}
Version: 1.0.0
Security: basicAuth

## Path parameters:

  - `jobOrderGuid` (string, required)

## Response 200 fields (application/json):

  - `jobId` (integer)

  - `jobGuid` (string)
    Unique identifier, visible to developers and Aimsio admins.
A new object must include either  property or  property or both.

  - `jobNumber` (string, required)
    Unique identifier, visible to end users.
A new object must include either  property or  property or both

  - `jobName` (string, required)

  - `jobDescription` (string)

  - `jobStatus` (string, required)
    If the job has an assignee, the status is automatically set to , else it's default to .
For POST requests, the only applicable value is  for existing jobs.
    Enum: "Unassigned", "Assigned", "Active", "Finished", "Cancelled", "Deleted"

  - `jobTypeUname` (string)

  - `jobClientCode` (string, required)
    Must be an existing customer code

  - `jobClientGuid` (string)

  - `jobClientName` (string)

  - `jobPriceBookName` (string, required)
    Must be an existing pricebook name

  - `jobPriceBookGuid` (string)

  - `jobStartDate` (integer, required)
    Timestamp in epoch millseconds

  - `jobEndDate` (integer)
    Timestamp in epoch millseconds. Must be equal or after

  - `jobCreatedAt` (integer)
    Timestamp in epoch millseconds

  - `jobUpdatedAt` (integer)
    Timestamp in epoch millseconds

  - `jobShowInDispatching` (boolean)

  - `jobAssigneeEmployeeNumber` (string)
    Must be an existing employee number

  - `jobAssigneeFullName` (string)

  - `jobAssigneeUserName` (string)

  - `jobAddress` (string)

  - `jobLocationCode` (string)
    Must be an existing location code

  - `jobLocationName` (string)

  - `jobLocationLat` (number)

  - `jobLocationLong` (number)

  - `jobDirection` (string)

  - `jobWBSSchedule` (object)

  - `jobWBSSchedule.jobScheduleGuid` (string)

  - `jobWBSSchedule.jobScheduleBudgetEntryOption` (string)
    Enum: "PerDetailedBreakDown", "PerWBS", "PerBillableItem"

  - `jobWBSSchedule.jobScheduleContractValueEntryOption` (string)
    Enum: "PerJob", "PerWBS"

  - `jobWBSSchedule.jobScheduleChangeSettingOption` (string)
    Enum: "Manual", "AutomatedFromChangeOrder"

  - `jobWBSSchedule.jobScheduleConversionRules` (array)

  - `jobWBSSchedule.jobScheduleIsDeleted` (boolean)

  - `jobWBSSchedule.jobScheduleIncludeNRBInNonBillableCalculation` (boolean)

  - `jobWBSSchedule.jobScheduleActualsWithNoWBS` (array)

  - `jobWBSSchedule.jobScheduleActualsWithNoWBS.wbsActivityBreakdownGuid` (string)

  - `jobWBSSchedule.jobScheduleActualsWithNoWBS.wbsActivityBreakdownParentActivityGuid` (string)

  - `jobWBSSchedule.jobScheduleActualsWithNoWBS.wbsActivityBreakdownBillableTypeUname` (string)
    Enum: "labour", "equipment", "material", "service", "unit_billing", "per_diem", "accommodation", "mileage", "surcharge"

  - `jobWBSSchedule.jobScheduleActualsWithNoWBS.wbsActivityBreakdownBillableTypeName` (string)

  - `jobWBSSchedule.jobScheduleActualsWithNoWBS.wbsActivityBreakdownBudgetQty` (number)

  - `jobWBSSchedule.jobScheduleActualsWithNoWBS.wbsActivityBreakdownBudgetRevenue` (number)

  - `jobWBSSchedule.jobScheduleActualsWithNoWBS.wbsActivityBreakdownActualQtyUsed` (number)

  - `jobWBSSchedule.jobScheduleActualsWithNoWBS.wbsActivityBreakdownActualQtyExtra` (number)

  - `jobWBSSchedule.jobScheduleActualsWithNoWBS.wbsActivityBreakdownActualTotalUsed` (number)

  - `jobWBSSchedule.jobScheduleActualsWithNoWBS.wbsActivityBreakdownActualTotalExtra` (number)

  - `jobWBSSchedule.jobScheduleRootActivity` (object)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityGuid` (string)
    Unique identifier, visible to developers and Aimsio admins. A new object must include either guid property or number property or both.

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivitySubCode` (string, required)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivitySubCostCode` (string)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityName` (string, required)
    WBS activity name

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityCode` (string)
    Concatenation of parent WBS Activity code + current WBS Activity's subcode

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityCostCode` (string)
    Concatenation of parent WBS Activity cost code + current WBS Activity's sub cost code

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityCodeAndName` (string)
    Combined code and name for display

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivitySharedIdentifier` (string, required)
    External system ID

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityPath` (string)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityPlannedStartDate` (integer, required)
    Timestamp in epoch milliseconds

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityPlannedEndDate` (integer, required)
    Timestamp in epoch milliseconds

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityRevisedStartDate` (integer)
    Timestamp in epoch milliseconds

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityRevisedEndDate` (integer)
    Timestamp in epoch milliseconds

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityActualStartDate` (integer)
    Timestamp in epoch milliseconds

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityActualLastDate` (integer)
    Timestamp in epoch milliseconds

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityHierarchicalOrder` (string, required)
    Position in the WBS hierarchy

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityUoM` (string)
    Unit of measure

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityContractValue` (number)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityOriginalContractValue` (number)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityChangesToContractValue` (number)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityPlannedUnitCost` (number)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityContractUnitRate` (number)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityRevenueUnitRate` (number)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityCostUnitRate` (number)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityEarnedValue` (number)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityEarnedRevenue` (number)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityOriginalQuantity` (number)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityChangesToQuantity` (number)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityRemainingQuantity` (number)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityBudget` (number)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityBudgetOverride` (number)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityRemainingBudget` (number)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityRemainingSpend` (string)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityCommittedPO` (number)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityCost` (number)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityTimecardHours` (number)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityEAC` (string)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityEACMethod` (string)
    Enum: "TREND_BASED", "PERFORMANCE_ADJUSTED", "BOTTOM_UP"

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityCPI` (string)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityForecastedRemainingCPI` (string)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityEstimateToComplete` (string)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityMargin` (number)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityPlannedMarginPercentage` (number)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityMarginPercentage` (number)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityTotal` (number, required)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityCurrent` (number)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityProgress` (number)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityWeight` (integer)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityInvoiced` (number)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityActualDollarBillable` (number)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityActualDollarNonBillable` (number)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityNotes` (string)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityDetailedBreakdown` (any)

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityChildrenCount` (integer)
    Number of child activities

  - `jobWBSSchedule.jobScheduleRootActivity.wbsActivityChildren` (array)
    Child WBSActivity

  - `jobWBSSchedule.jobScheduleBudgetNonBillablePriceBookGuid` (string)

  - `jobWBSSchedule.jobScheduleBudgetNonBillablePriceBookName` (string)

  - `jobWBSSchedule.jobScheduleCreatedAt` (integer)

  - `jobWBSSchedule.jobScheduleUpdatedAt` (integer)

  - `jobWBSScheduleGuid` (string)

  - `jobNRBs` (array)

  - `jobNRBs.nrbGuid` (string)
    Unique identifier and is automatically generated by Aimsio system. This is only used to update existing object

  - `jobNRBs.nrbExternalId` (string, required)
    Recommended property to uniquely identify a new or existing object.

  - `jobNRBs.nrbOriginReference` (string)
    This property can be used to uniquely identify a new or existing object.

  - `jobNRBs.nrbJobOrderNumber` (string, required)
    Must be an existing job number

  - `jobNRBs.nrbWBSGuid` (string)

  - `jobNRBs.nrbWBSSharedIdentifier` (string)
    If provided, must be a valid WBS shared identifier under the NRB's job

  - `jobNRBs.nrbPONumber` (string)

  - `jobNRBs.nrbPurchaseOrderGuid` (string)

  - `jobNRBs.nrbPurchaseOrderCostItemOriginReference` (string)

  - `jobNRBs.nrbInvoiceNumber` (string)

  - `jobNRBs.nrbInvoiceDate` (integer)
    Timestamp in epoch millseconds

  - `jobNRBs.nrbName` (string, required)

  - `jobNRBs.nrbTypeUname` (string)
    For new objects, either  or  is required

  - `jobNRBs.nrbTypeName` (string, required)
    For new objects, either  or  is required

  - `jobNRBs.nrbDocumentType` (string)
    Enum: "RECEIPT_AP_INVOICE", "RECEIPT_PACKING_SLIP", "RECEIPT_FIELD_TICKET", "RECEIPT_BOL"

  - `jobNRBs.nrbAccountType` (string, required)
    Enum: "Billable", "Not Billable"

  - `jobNRBs.nrbIsBillable` (boolean, required)

  - `jobNRBs.nrbVendorGuid` (string)

  - `jobNRBs.nrbVendorCode` (string, required)
    Must be a valid existing company code that doesn't belong to "Client" type

  - `jobNRBs.nrbRate` (number, required)

  - `jobNRBs.nrbQuantity` (number, required)

  - `jobNRBs.nrbVendorTax` (number)

  - `jobNRBs.nrbUpcharge` (number)

  - `jobNRBs.nrbMarkupAppliesOn` (string)
    Enum: "SUB_TOTAL", "SUB_TOTAL_AND_VENDOR_TAX"

  - `jobNRBs.nrbTotalAfterMarkup` (number)
    Calculated by the system.
 x  (+  if markup applies to vendor tax)
x

  - `jobNRBs.nrbIsExported` (boolean)

  - `jobNRBs.isInternal` (boolean)

  - `jobNRBs.nrbShouldReconcileWithPO` (boolean)
    If this flag is set to ,  and  are required

  - `jobNRBs.nrbBilledInGuid` (string)

  - `jobNRBs.nrbBilledInName` (string)

  - `jobNRBs.nrbFileName` (string)

  - `jobNRBs.nrbNotes` (string)

  - `jobNRBs.nrbCreatedAt` (integer)
    Timestamp in epoch milliseconds

  - `jobNRBs.nrbCreatedByUserName` (string)

  - `jobNRBs.nrbCreatedByFullName` (string)

  - `jobNRBs.nrbUpdatedAt` (integer)
    Timestamp in epoch milliseconds

  - `jobNRBs.nrbLineItems` (array)

  - `jobNRBs.nrbLineItems.nrbLineGuid` (string)

  - `jobNRBs.nrbLineItems.nrbLineOriginReference` (string, required)
    This property can be used to uniquely identify a new or existing NRB line item.

  - `jobNRBs.nrbLineItems.nrbLineName` (string, required)

  - `jobNRBs.nrbLineItems.nrbLineQuantity` (number, required)

  - `jobNRBs.nrbLineItems.nrbLineRate` (number, required)

  - `jobNRBs.nrbLineItems.nrbLineNotes` (string)

  - `jobNRBs.nrbLineItems.nrbLinePurchaseOrderGuid` (string)

  - `jobNRBs.nrbLineItems.nrbLinePurchaseOrderCostItemGuid` (string)

  - `jobNRBs.nrbParentGuid` (string)
    The parent NRB guid if this is a child NRB

  - `jobNRBs.nrbParentExternalId` (string)
    The parent NRB external ID if this is a child NRB

  - `jobNRBs.nrbChildren` (array)
    Children NRB items. Only appicable if  = . Children  must not be

  - `jobCrewRecords` (array)

  - `jobCrewRecords.crewRecordId` (integer)

  - `jobCrewRecords.crewRecordEmployeeGuid` (string)

  - `jobCrewRecords.crewRecordEmployeeNumber` (string)

  - `jobCrewRecords.crewRecordEmployeeFullName` (string)

  - `jobCrewRecords.crewRecordTrade` (string)

  - `jobCrewRecords.crewRecordStatus` (string)
    Enum: "New", "WaitingForConfirmation", "Confirmed", "Fired"

  - `jobCrewRecords.crewRecordJobNumber` (string, required)
    Must be an existing job number with ,  or  status

  - `jobCrewRecords.crewRecordStartDate` (integer)
    Timestamp in epoch milliseconds

  - `jobCrewRecords.crewRecordEndDate` (integer)
    Timestamp in epoch milliseconds

  - `jobCrewRecords.crewRecordLocation` (string)

  - `jobCrewRecords.crewRecordNotes` (string)

  - `jobCrewRecords.crewRecordGroup` (string)

  - `jobEquipmentRecords` (array)

  - `jobEquipmentRecords.equipmentRecordGuid` (string)

  - `jobEquipmentRecords.equipmentRecordEquipmentGuid` (string)

  - `jobEquipmentRecords.equipmentRecordEquipmentCode` (string)

  - `jobEquipmentRecords.equipmentRecordEquipmentDescription` (string)

  - `jobEquipmentRecords.equipmentRecordJobNumber` (string, required)
    Must be an existing job number with ,  or  status

  - `jobEquipmentRecords.equipmentRecordStartDate` (integer)
    Timestamp in epoch milliseconds

  - `jobEquipmentRecords.equipmentRecordEndDate` (integer)
    Timestamp in epoch milliseconds

  - `jobEquipmentRecords.equipmentRecordLocation` (string)

  - `jobEquipmentRecords.equipmentRecordNotes` (string)

  - `jobEquipmentRecords.equipmentRecordGroup` (string)

  - `jobOrderFormData` (object)
    Read-only schema used in GET requests to display object's custom fields data. For POST requests, refer to

  - `jobOrderFormData.formDataFormTypeUname` (string)

  - `jobOrderFormData.formDataGuid` (string)

  - `jobOrderFormData.formDataFieldDataList` (array)

  - `jobOrderFormData.formDataFieldDataList.fieldDataFieldTypeDataType` (string)

  - `jobOrderFormData.formDataFieldDataList.fieldDataFieldTypeUname` (string)

  - `jobOrderFormData.formDataFieldDataList.fieldDataFieldTypeLabel` (string)

  - `jobOrderFormData.formDataFieldDataList.fieldDataStringValue` (string)

  - `jobOrderFormData.formDataFieldDataList.fieldDataReferenceValue` (string)