Index

api/v1/jobs

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:

{
"Status":string
"CustRef":string
"OurRef":string
"Priority":string
"FaultDesc":string
"InvoiceDesc":string
"ItemDesc":string
"SubBranchCode":string
"BranchCode":string
optional
"DateDue":string (DateTime in ISO format)
optional
"StatusDue":string (DateTime in ISO format)
"Type":string
"GLDeptCode":string
"TaxInc":boolean
}

Example GET

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"
          }
        ]
      }
    },
    "links": { "self": "/test/api/v1/jobs/10" }
  },
  "included": [
    {
      "type": "JobStock",
      "id": "10-1",
      "attributes": {
        "stockId": 53,
        "stockCode": "SERAL.ONSELL",
        "unit": "UNIT",
        "qty": "3.0000",
        "description": "Serial 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"
      }
    }
  ]
}