Add Work Order | ComplyFlow Help Center

POST [ work-order ]

Production Endpoint:
Test Endpoint: https://test.complyflow.com.au/app/public/index.php/api/work-order

Overview

This endpoint adds Work Order data to the ComplyFlow system.

Authentication instructions

Refer to the Authentication method for Authentication Methods (for Login and Logout).

Permissions Required

The user should possess the permissions below:

API User
User is Staff
Users have Access to View and Edit Supplier Permission

Please also refer to the Permissions Overview guide.

Body properties/Payload

FIELD	TYPE	DESCRIPTION	REQUIRED
`WOOrigin`	`string`	Origin of a Work Order
`WONumber`	`string`	Number of a Work Order
`WorkRef`	`string`	Reference of a Work Order
`Type`	`string`	Work Order Type
`Description`	`string`	Work Order Description
`Priority`	`string`	Work Order Priority Only 4 options: Low Medium High Urgent
`Site`	`string`	Work Order Site assigned
`BuildingName`	`string`	Site Building name
`Tenancy`	`string`	Site Tenancy
`Level`	`string`	Site Level
`ContactName`	`string`	Contact Name
`ContactPhone`	`string`	Contact Phone
`ContactEmail`	`string`	Contact Email
`SupplierABN`	`string`	Supplier’s ABN
`ThirdPartyContractorID`	`string`	Supplier’s ID
`ThirdPartyContractorName`	`string`	Supplier’s Name
`Status`	`integer`	Work Order Status only 4 options: 0 → Pending 1 → New 2 → In Progress 4 → Completed 7 → Cancelled
`ExpectedStartDate`	`date`	Work Order expected start date
`StartDate`	`date`	Work Order actual start date
`ExpectedCompletionDate`	`date`	Work Order expected completion date
`CompletionDate`	`date`	Work Order actual completion date
`InvoiceNumber`	`string`	Invoice Number

Request Example

curl --location 'https://test.complyflow.com.au//app/public/index.php/api/work-order' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--header 'Cookie: [...]' \
--data-raw '{
  "WOOrigin": "Postman", 
  "WONumber": "Postman2", 
  "WorkRef": "Postman2", 
  "Type": "Maintenance", 
  "Description": "Brief description of the work order", 
  "Priority": "Low", 
  "Site": "a", 
  "BuildingName": "Main Building", 
  "Tenancy": "Base Building", 
  "Level": "Ground Level", 
  "ContactName": "John Doe", 
  "ContactPhone": "1234567890", 
  "ContactEmail": "john.doe@example.com", 
  "SupplierABN": "11 610 619 951", 
  "ThirdPartyContractorID": "1564", 
  "ThirdPartyContractorName": "ABC Contractors", 
  "Status": "0", 
  "ExpectedStartDate": "2024-01-01", 
  "StartDate": "2024-06-01", 
  "ExpectedCompletionDate": "2025-02-01", 
  "CompletionDate": "2025-01-01", 
  "InvoiceNumber": "INV-12345" 
}'

Response Example

{
    "token": "",
    "data": {
        "StatusCode": 201,
        "CFWorkOrderID": 257,
        "ContractorMatch": true,
        "SiteMatch": true
    }
}