workOrderLine resource type

Represents a Work Order Line in SOFT4Spaces.

Note

For information about enabling APIs for Business Central see Overview.

 

 

API endpoint

 

API Path
workOrderLines https://{{businesscentralPrefix}}/{{APIGroup}}/{{version}}/companies({{companyId}})/workOrderLines

 

Methods

 

Method Return Type Description
GET workOrderLines workOrderLines Gets a work order line object.
DELETE workOrderLines none Deletes a work order line object.
POST workOrderLines workOrderLines Creates a work order line object.
PATCH workOrderLines workOrderLines Updates a work order line object.

 

GET workOrderLines

Description

Retrieves an existing work order line record from Business Central.

HTTP Request

GET

https://{{businesscentralPrefix}}/api/soft4/soft4spaces/v3.0/companies({{companyId}})/workOrderLines?$filter=workOrderNo eq ‘{{workOrder_no}}’

Request Headers

Header Value
Authorization NTLM, OAuth2. Required.
Accept application/json

Request Body

None.

Response

Returns a 200 OK status code and JSON object representing the work order line record.

Example Response

JSON

{
   "id": "99b6110c-d238-f111-889f-e5dbb3e633b4",
   "workOrderNo": "WO00001",
   "leaseUnitNo": "SAMPLE",
   "lineNo": 10000,
   "type": "Resource",
   "no": "KATHERINE",
   "description": "Katherine Hull",
   "quantity": 3,
   "shortcutDimension1Code": "",
   "shortcutDimension2Code": "",
   "unitPrice": 6.3,
   "unitCost": 6.3,
   "lineAmount": 18.9,
   "costAmount": 18.9,
   "workTypeCode": "",
   "supplierNo": "",
   "poNo": "",
   "poLineNo": 0,
   "poStatus": "Open",
   "poDate": "0001-01-01",
   "poDeliveryDate": "0001-01-01",
   "poResponsiblePerson": "",
   "piNo": "",
   "piLineNo": 0,
   "siNo": "",
   "siLineNo": 0,
   "InvoicedToCustomer": false,
   "qtyPerUnitOfMeasure": 1,
   "unitOfMeasureCode": "HOUR",
   "quantityBase": 3,
   "systemCreatedAt": "2026-04-15T13:50:23.207Z",
   "systemCreatedBy": "d74e8f2b-15c7-470c-8c02-f3ec2c0050dc",
   "systemModifiedAt": "2026-04-15T13:50:23.207Z",
   "systemModifiedBy": "d74e8f2b-15c7-470c-8c02-f3ec2c0050dc"
}

 

POST workOrderLine

Description

Creates a new work order line in Business Central.

HTTP Request

POST

https://{{businesscentralPrefix}}/api/soft4/soft4spaces/v3.0/companies({{companyId}})/workOrderLines

Request Headers

Header Value
Authorization NTLM, OAuth2. Required.
Accept application/json

Request Body

Provide a JSON object with work order line data.

JSON

{
   "workOrderNo": "WO00001",
   "leaseUnitNo": "SAMPLE",
   "lineNo": 20000,
   "type": "Resource",
   "no": "KATHERINE",
   "description": "Katherine Hull",
   "quantity": 3,
   "shortcutDimension1Code": "",
   "shortcutDimension2Code": "",
   "unitPrice": 6.3,
   "unitCost": 6.3,
   "lineAmount": 18.9,
   "costAmount": 18.9
}

Response

Returns a 201 Created status code and the created work order line object.

Properties

 

Property Type Description
id GUID The unique ID of the work order line. Non-editable.
workOrderNo string Specifies the number of the work order.
leaseUnitNo string Specifies the lease unit number.
lineNo integer Specifies the number of work order line.
type string Specifies the type of the work order line. It can be “G/L Account”, “Item”, “Resource”, “Fixed Asset”, “Charge (Item)”, “Service”.
no string Specifies the number of the type that will be required for a specific work order.
description string Specifies the work order line description.
quantity decimal Specifies the quantity value.
shortcutDimension1Code string Specifies the shortcut dimension 1 value.
shortcutDimension2Code string Specifies the shortcut dimension 2 value.
unitPrice decimal Specifies the unit price.
unitCost decimal Specifies the unit cost.
lineAmount decimal Specifies the line amount.
costAmount decimal Specifies the cost amount.
workTypeCode string Specifies the work type code if “Type” is a “Resource”.
supplierNo string Specifies the supplier number. 
poNo string Specifies purchase order number.
poLineNo integer Specifies purchase order line number.
poStatus string Specifies purchase order status. It can be: “Open”, “Released”, “Pending Approval”, “Pending Prepayment”.
poDate date Specifies purchase order date.
poDeliveryDate date Specifies purchase order delivery date.
poResponsiblePerson string Specifies purchase order responsible person.
piNo string Specifies purchase invoice number.
piLineNo integer Specifies purchase invoice line number.
siNo string Specifies sales invoice number.
siLineNo integer Specifies sales invoice line number.
InvoicedToCustomer boolean Specifies whether amounts were issued to the customer.
qtyPerUnitOfMeasure integer Specifies quantity per unit of measure.
unitOfMeasureCode string Specifies unit of measure code.
quantityBase decimal Specifies quantity by default unit measure.
systemCreatedAt datetime The datetime the document was created. 
systemCreatedBy GUID The ID of the user who created the document.
systemModifiedAt datetime The last datetime the document was modified. 
systemModifiedBy GUID The ID of the user who last modified the document.

 

JSON Representation

{
      "id": GUID,
   "workOrderNo": string,
   "leaseUnitNo": string,
   "lineNo": integer,
   "type": string,
   "no": string,
   "description": string,
   "quantity": decimal,
   "shortcutDimension1Code": string,
   "shortcutDimension2Code": string,
   "unitPrice": decimal,
   "unitCost": decimal,
   "lineAmount": decimal,
   "costAmount": decimal,
   "workTypeCode": string,
   "supplierNo": string,
   "poNo": string,
   "poLineNo": integer,
   "poStatus": string,
   "poDate": date,
   "poDeliveryDate": date,
   "poResponsiblePerson": string,
   "piNo": string,
   "piLineNo": integer,
   "siNo": string,
   "siLineNo": integer,
   "InvoicedToCustomer": boolean,
   "qtyPerUnitOfMeasure": integer,
   "unitOfMeasureCode": string,
   "quantityBase": decimal,
   "systemCreatedAt": datetime,
   "systemCreatedBy": GUID,
   "systemModifiedAt": datetime,
   "systemModifiedBy": GUID
}