Path: api/v1/jobs
This API is JSON:API compliant.
This endpoint supports the following methods:
GET POST PATCH
The resource type for this endpoint is Job
The identifier is jobno
Supported inclusions are comments,contract,customer,from,ship,stock,labour
The Job resource type attributes are as follows:
Path: api/v1/jobs?filter[Sale]=True&filter[Reserved][-eq]Y&filter[Current]=T&filter[Finish]=T
Supported Filters:
| AccMngNo | Lookup | AssetNo | Lookup | Branch | Lookup | CardGroup | Group | ||
| Company | Lookup | Contract | Text | CurrencyNo | Lookup | Current | Bool | CustJobNo | Text |
| CustNo | Lookup | CustType | Lookup | DateDue | DateRange | DateIn | DateRange | DateOut | DateRange |
| DuedateOverdue | Bool | DueWithin | Text | DueWithinMeasure | Text | eInvNo | Int | Finish | Bool |
| FromNo | Lookup | GLDept | Lookup | HasUnreadEmail | Bool | Inved | Bool | ItemGroup | Group |
| ItemNo | Lookup | JobNo | Int | JobStatus | Text | LastModified | DateRange | Make | Lookup |
| Manf | Bool | Mode | Text | Model | Lookup | Name | Lookup | OrderNo | Int |
| OurRef | Text | PartStatus | Text | Priority | Text | ProjectGroup | Group | ProjectMaster | Lookup |
| ProjectNo | Lookup | ProjectType | Lookup | Quote | Bool | QuoteNo | Int | Ready | Bool |
| Reserved | Bool | Sale | Bool | SerialNo | Text | Serv | Bool | ShipGroup | Group |
| ShipNo | Lookup | Source | Lookup | SourceValue | Text | StatusOverdue | Bool | StockGroup | Group |
| StockNo | Lookup | StockSerialNo | Text | SubBranch | Lookup | TaxPaid | Bool | Type | Text |
Operators:
| = | Equals |
| [-gte] | GreaterThanOrEqual |
| [-lte] | LessThanOrEqual |
| [-ne] | NotEqual |
| [-lt] | LessThan |
| [-gt] | GreaterThan |
| [-eq] | Equal |
| [-like] | Like |
Response:
{
"data": {
"id": "10",
"type": "Job",
"attributes": {
"Status": "FINISH",
"Type": "Normal",
"CustRef": "ASDF",
"GLDeptCode": null,
"TaxInc": true
},
"relationships": {
"customer": {
"data": {
"type": "CardFile",
"id": "3"
}
},
"from": {
"data": {
"type": "CardFile",
"id": "3"
}
},
"ship": {
"data": {
"type": "CardFile",
"id": "3"
}
},
"contract":{
"data":{
"type":"Contract",
"id":"4"
}
},
"asset":{
"data":{
"type":"Asset",
"id":"1"
}
},
"comments": {
"data": [
{
"type": "JobComment",
"id": "10-2"
},
{
"type": "JobComment",
"id": "10-1"
}
]
},
"stock": {
"data": [
{
"type": "JobStock",
"id": "10-1"
},
{
"type": "JobStock",
"id": "10-2"
}
]
}
},
"links": {
"self": "/test/api/v1/jobs/10"
}
},
"included": [
{
"type": "JobStock",
"id": "10-1",
"attributes": {
"serials": [
{
"serialNo": "serial1"
},
{
"serialNo": "serial2"
},
{
"serialNo": "serial3"
}
],
"stockId": 53,
"stockCode": "SERIAL.ONSELL",
"unit": "UNIT",
"qty": "3.0000",
"description": "Serial on sell stock",
"modifyinit": "SYS",
"modifydate": "2021-03-10T11:33:53"
}
},
{
"type": "JobStock",
"id": "10-2",
"attributes": {
"stockAttrs": [
{
"name": "Colour",
"value": "R,Red"
},
{
"name": "Size",
"value": "8,Eight"
}
],
"stockId": 54,
"stockCode": "ATTRIBUTES.ONSELL",
"unit": "UNIT",
"qty": "3.0000",
"description": "Attributes on sell stock",
"modifyinit": "SYS",
"modifydate": "2021-03-10T11:33:53"
}
},
{
"type": "JobStock",
"id": "10-3",
"attributes": {
"serials": [
{
"serialNo": "serial1",
"stockAttrs": [
{
"name": "Colour",
"value": "R,Red"
},
{
"name": "Size",
"value": "8,Eight"
}
]
},
{
"serialNo": "serial2",
"stockAttrs": [
{
"name": "Colour",
"value": "G,Green"
},
{
"name": "Size",
"value": "10,Ten"
}
]
}
],
"stockId": 55,
"stockCode": "SERIAL.AND.ATTRIBUTES.ONSELL",
"unit": "UNIT",
"qty": "2.0000",
"description": "Serials and Attributes on sell stock",
"modifyinit": "SYS",
"modifydate": "2021-03-10T11:33:53"
}
},
{
"type": "JobComment",
"id": "10-2",
"attributes": {
"include": true,
"status": "FINISH",
"comment": "",
"modifyinit": "SYS",
"modifydate": "2021-03-10T11:34:13"
}
},
{
"type": "JobComment",
"id": "10-1",
"attributes": {
"include": false,
"status": "Booked",
"comment": "",
"modifyinit": "SYS",
"modifydate": "2021-03-10T11:33:41"
}
}
]
}
Path: api/v1/jobs/10?include=stock,comments
Response:
{
"data": {
"id": "10",
"type": "Job",
"attributes": {
"Status": "FINISH",
"Type": "Normal",
"CustRef": "ASDF",
"GLDeptCode": null,
"TaxInc": true
},
"relationships": {
"customer": {
"data": {
"type": "CardFile",
"id": "3"
}
},
"from": {
"data": {
"type": "CardFile",
"id": "3"
}
},
"ship": {
"data": {
"type": "CardFile",
"id": "3"
}
},
"comments": {
"data": [
{
"type": "JobComment",
"id": "10-2"
},
{
"type": "JobComment",
"id": "10-1"
}
]
},
"stock": {
"data": [
{
"type": "JobStock",
"id": "10-1"
},
{
"type": "JobStock",
"id": "10-2"
}
]
}
},
"links": {
"self": "/test/api/v1/jobs/10"
}
},
"included": [
{
"type": "JobStock",
"id": "10-1",
"attributes": {
"serials": [
{
"serialNo": "serial1"
},
{
"serialNo": "serial2"
},
{
"serialNo": "serial3"
}
],
"stockId": 53,
"stockCode": "SERIAL.ONSELL",
"unit": "UNIT",
"qty": "3.0000",
"description": "Serial on sell stock",
"modifyinit": "SYS",
"modifydate": "2021-03-10T11:33:53"
}
},
{
"type": "JobStock",
"id": "10-2",
"attributes": {
"stockAttrs": [
{
"name": "Colour",
"value": "R,Red"
},
{
"name": "Size",
"value": "8,Eight"
}
],
"stockId": 54,
"stockCode": "ATTRIBUTES.ONSELL",
"unit": "UNIT",
"qty": "3.0000",
"description": "Attributes on sell stock",
"modifyinit": "SYS",
"modifydate": "2021-03-10T11:33:53"
}
},
{
"type": "JobStock",
"id": "10-3",
"attributes": {
"serials": [
{
"serialNo": "serial1",
"stockAttrs": [
{
"name": "Colour",
"value": "R,Red"
},
{
"name": "Size",
"value": "8,Eight"
}
]
},
{
"serialNo": "serial2",
"stockAttrs": [
{
"name": "Colour",
"value": "G,Green"
},
{
"name": "Size",
"value": "10,Ten"
}
]
}
],
"stockId": 55,
"stockCode": "SERIAL.AND.ATTRIBUTES.ONSELL",
"unit": "UNIT",
"qty": "2.0000",
"description": "Serials and Attributes on sell stock",
"modifyinit": "SYS",
"modifydate": "2021-03-10T11:33:53"
}
},
{
"type": "JobComment",
"id": "10-2",
"attributes": {
"include": true,
"status": "FINISH",
"comment": "",
"modifyinit": "SYS",
"modifydate": "2021-03-10T11:34:13"
}
},
{
"type": "JobComment",
"id": "10-1",
"attributes": {
"include": false,
"status": "Booked",
"comment": "",
"modifyinit": "SYS",
"modifydate": "2021-03-10T11:33:41"
}
}
]
}
Path: api/v1/jobs
Request:
{
"data": {
"relationships": {
"customer": {
"data": {
"type": "CardFile",
"id": "1"
}
},
"ship": {
"data": {
"type": "CardFile",
"id": "1"
}
},
"stock": {
"data": [
{
"type": "JobStock",
"lid": "guid1"
}
]
}
},
"type": "Job",
"attributes": {
"Status": "Proceed",
"CustRef": "SA",
"OurRef": "",
"Priority": "Normal",
"FaultDesc": "Test Job",
"ItemDesc": "Sale",
"DateDue": "2024-06-24T14:05:00",
"Type": "Normal",
"TaxInc": true
}
},
"included": [
{
"type": "JobStock",
"lid": "guid1",
"attributes": {
"code": "T.SA.ON.SELL",
"qty": 1,
"serials": [
{
"serialNo": "serial1",
"stockAttrs": [
{
"name": "Colour",
"value": "R,Red"
},
{
"name": "Size",
"value": "8,Eight"
}
]
}
]
}
}
]
}
Response:
{
"data": {
"id": "10",
"type": "Job",
"attributes": {
"Status": "Proceed",
"CustRef": "SA",
"OurRef": "",
"Priority": "Normal",
"FaultDesc": "Test Job",
"InvoiceDesc": null,
"ItemDesc": "Sale",
"SubBranchCode": null,
"BranchCode": null,
"dateIn": "2025-03-26T18:10:50.65",
"DateDue": "2010-06-10T14:05:00",
"StatusDue": "2025-03-27T09:00:00+11:00",
"Type": "Normal",
"priceLevel": "Dealer",
"taxPaid": true,
"serial": null,
"currencyCode": "AUD",
"source": null,
"sourceValue": null,
"companyCode": "",
"exchangeRate": 1.0,
"rateLocked": true,
"prevJobNo": null,
"quoteNo": null,
"invoiceGroupNo": null,
"GLDeptCode": null,
"TaxInc": true,
"manufacturing": null,
"jobDetails": {
"customer": {
"attn": null,
"name": null,
"isAddressResidential": null,
"streetAddress": null,
"suburb": null,
"state": null,
"postCode": null,
"country": null,
"orderNo": null
},
"ship": {
"attn": null,
"name": null,
"isAddressResidential": null,
"streetAddress": null,
"suburb": null,
"state": null,
"postCode": null,
"country": null
},
"freight": {
"dispatch": {
"shipVia": null,
"shipRef": null
},
"amount": 0.0,
"tax": 0.0,
"taxCode": null,
"noOfCartons": null
}
}
},
"relationships": {
"customer": {
"data": {
"type": "CardFile",
"id": "1"
}
},
"from": {
"data": {
"type": "CardFile",
"id": "1"
}
},
"ship": {
"data": {
"type": "CardFile",
"id": "1"
}
},
"name": {
"data": {
"type": "Name",
"id": "7"
}
},
"invoice": {
"data": {
"type": "Invoice",
"id": "-1"
}
},
"comments": {
"data": [
{
"type": "JobComment",
"id": "10-2"
},
{
"type": "JobComment",
"id": "10-1"
}
]
},
"stock": {
"data": [
{
"type": "JobStock",
"id": "10-1"
}
]
}
},
"links": {
"self": "/api/v1/jobs/10"
}
}
}
Path: api/v1/jobs/10
Request:
{
"data": {
"id":"10",
"type": "Job",
"attributes": {
"Status": "Proceed",
"CustRef": "SA",
"OurRef": "",
"Priority": "Normal",
"FaultDesc": "Test Job",
"ItemDesc": "Sale",
"DateDue": "2024-06-24T14:05:00",
"Type": "Normal",
"TaxInc": true
}
}
}
Response:
{
"data": {
"id": "10",
"type": "Job",
"attributes": {
"Status": "Proceed",
"CustRef": "SA",
"OurRef": "",
"Priority": "Normal",
"FaultDesc": "Test Job",
"InvoiceDesc": null,
"ItemDesc": "Sale",
"SubBranchCode": null,
"BranchCode": null,
"dateIn": "2025-03-26T18:22:50.953",
"DateDue": "2024-06-24T14:05:00",
"StatusDue": "2025-03-27T09:00:00",
"Type": "Normal",
"priceLevel": "Dealer",
"taxPaid": true,
"serial": null,
"currencyCode": "AUD",
"source": null,
"sourceValue": null,
"companyCode": "",
"exchangeRate": 1.0000,
"rateLocked": true,
"prevJobNo": null,
"quoteNo": null,
"invoiceGroupNo": null,
"GLDeptCode": null,
"TaxInc": true,
"jobDetails": {
"customer": {
"attn": "Test",
"name": "System administrator",
"isAddressResidential": null,
"streetAddress": "street line 1\r\nstreet line 2",
"suburb": "the burbs",
"state": "STA",
"postCode": "9876",
"country": "Australia",
"orderNo": ""
},
"ship": {
"attn": "Test",
"name": "System administrator",
"isAddressResidential": null,
"streetAddress": "del street line 1\r\nstreet line 2",
"suburb": "del the burbs",
"state": "DEL",
"postCode": "8765",
"country": "Australia"
},
"freight": {
"dispatch": {
"shipVia": "",
"shipRef": null
},
"amount": 0.0,
"tax": 0.0,
"taxCode": null,
"noOfCartons": null
}
}
},
"relationships": {
"customer": {
"data": {
"type": "CardFile",
"id": "1"
}
},
"from": {
"data": {
"type": "CardFile",
"id": "1"
}
},
"ship": {
"data": {
"type": "CardFile",
"id": "1"
}
},
"name": {
"data": {
"type": "Name",
"id": "7"
}
},
"invoice": {
"data": {
"type": "Invoice",
"id": "-1"
}
},
"comments": {
"data": [
{
"type": "JobComment",
"id": "10-2"
},
{
"type": "JobComment",
"id": "10-1"
}
]
}
},
"links": {
"self": "/api/v1/jobs/10"
}
}
}