---
title: "WorkOrders (Robaws)"
description: "Work Orders"
language: en
source_language: en
translation_state: complete
canonical: https://documentation.invantive.eu/en/datamodels/robaws/Robaws.WorkOrders.WorkOrders
original: https://documentation.invantive.eu/en/datamodels/robaws/Robaws.WorkOrders.WorkOrders
updated: 2026-11-03T19:00:36Z
license: https://documentation.invantive.eu/en/
---

# WorkOrders: Robaws Work Orders

`insert` `update` `delete` `REST`

- Catalog: `Robaws`
- Schema: `WorkOrders`
- Primary Keys: `id`
- Label: Work Orders

Search

Can retrieve data and change data using `insert`, `update` and `delete`.

## API Source

- Endpoint: `/api/v2/work-orders`
- Operation: `get /api/v2/work-orders`

## Performance Characteristics

| Characteristic | Value |
|---|---:|
| Average access latency (ms) | 98 |
| Full scan rows per minute | 36,539 |
| Point query rows per minute | 955 |
| Write rows per minute | 539 |

The result can be cached on the client.

## Parameters

| Name | Data Type | Required | Default | Documentation |
|---|---|:---:|---|---|
| `articleId` | `` | [ ] |  |  |
| `assignedUserId` | `` | [ ] |  |  |
| `clientId` | `` | [ ] |  |  |
| `date` | `` | [ ] |  | An ISO date, ex. 2024-03-04. For backwards compatibility reasons a date-time can also be provided. |
| `dayPlanningItemId` | `` | [ ] |  |  |
| `employeeId` | `` | [ ] |  |  |
| `fromDate` | `` | [ ] |  | An ISO date, ex. 2024-03-04. For backwards compatibility reasons a date-time can also be provided. |
| `materialId` | `` | [ ] |  |  |
| `projectId` | `` | [ ] |  |  |
| `salesInvoiceId` | `` | [ ] |  |  |
| `salesOrderId` | `` | [ ] |  |  |
| `searchText` | `` | [ ] |  |  |
| `sort` | `` | [ ] |  |  |
| `supplyOrderId` | `` | [ ] |  |  |
| `toDate` | `` | [ ] |  | An ISO date, ex. 2024-03-04. For backwards compatibility reasons a date-time can also be provided. |
| `updatedFrom` | `` | [ ] |  |  |
| `withArchived` | `` | [ ] |  |  |

## Table Columns

The columns of the table `WorkOrders` are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

| Name | Data Type | Label | Required | Marks | Documentation |
|---|---|---|:---:|---|---|
| `address_addressLine1` | `varchar2` | Address Line 1 | [ ] | filters on the platform, writable, `address.addressLine1` |  |
| `address_addressLine2` | `varchar2` | Address Line 2 | [ ] | filters on the platform, writable, `address.addressLine2` |  |
| `address_city` | `varchar2` | City | [ ] | filters on the platform, writable, `address.city` |  |
| `address_country` | `varchar2` | Country | [ ] | filters on the platform, writable, `address.country` |  |
| `address_latitude` | `double` | Address Latitude | [ ] | filters on the platform, writable, `address.latitude` |  |
| `address_longitude` | `double` | Address Longitude | [ ] | filters on the platform, writable, `address.longitude` |  |
| `address_postalCode` | `varchar2` | Address Postal Code | [ ] | filters on the platform, writable, `address.postalCode` |  |
| `archivedAt` | `datetime` | Archived at | [ ] | filters on the platform, writable, `archivedAt` |  |
| `assignedUserId` | `varchar2` | Assigned User ID | [ ] | filters on the platform, writable, `assignedUserId` |  |
| `clientId` | `varchar2` | Client ID | [ ] | filters on the platform, writable, `clientId` |  |
| `clientReference` | `varchar2` | Customer Reference | [ ] | filters on the platform, writable, `clientReference` |  |
| `companyId` | `varchar2` | Company ID | [ ] | filters on the platform, writable, `companyId` |  |
| `createdAt` | `datetime` | Created at | [ ] | filters on the platform, writable, `createdAt` |  |
| `date` | `datetime` | Date | [ ] | filters on the platform, writable, `date` |  |
| `deletedAt` | `datetime` | Deleted at | [ ] | filters on the platform, writable, `deletedAt` |  |
| `endClientId` | `varchar2` | End Client ID | [ ] | filters on the platform, writable, `endClientId` |  |
| `extraFields` | `varchar2` | Extra Fields | [ ] | writable | The JSON text of the nested object. |
| `hasSignature` | `char` | Has Signature | [ ] | filters on the platform, writable, `hasSignature` |  |
| `id` | `varchar2` | ID | [ ] | filters on the platform, writable, `id` |  |
| `lockedAt` | `datetime` | Locked at | [ ] | filters on the platform, writable, `lockedAt` |  |
| `logicId` | `varchar2` | Logical ID | [ ] | filters on the platform, writable, `logicId` |  |
| `origin` | `varchar2` | Origin | [ ] | filters on the platform, writable, `origin` |  |
| `planningItemId` | `varchar2` | Planning Item ID | [ ] | filters on the platform, writable, `planningItemId` |  |
| `projectId` | `varchar2` | Project ID | [ ] | filters on the platform, writable, `projectId` |  |
| `remark` | `varchar2` | Remark | [ ] | filters on the platform, writable, `remark` |  |
| `rentalInvoicingPeriodId` | `varchar2` | Rental Invoicing Period ID | [ ] | filters on the platform, writable, `rentalInvoicingPeriodId` |  |
| `salesOrderId` | `varchar2` | Sales Order ID | [ ] | filters on the platform, writable, `salesOrderId` |  |
| `signatureId` | `varchar2` | Signature ID | [ ] | filters on the platform, writable, `signatureId` |  |
| `signatureName` | `varchar2` | Signature Name | [ ] | filters on the platform, writable, `signatureName` |  |
| `status` | `varchar2` | Status | [ ] | filters on the platform, writable, `status` |  |
| `statusDetails_color` | `varchar2` | Status Details Color | [ ] | filters on the platform, writable, `statusDetails.color` |  |
| `statusDetails_name` | `varchar2` | Status Details Name | [ ] | filters on the platform, writable, `statusDetails.name` |  |
| `supplyOrderId` | `varchar2` | Supply Order ID | [ ] | filters on the platform, writable, `supplyOrderId` |  |
| `supplyOrder_archivedAt` | `datetime` | Supply Order Archived At | [ ] | filters on the platform, writable, `supplyOrder.archivedAt` |  |
| `supplyOrder_assignedUserId` | `varchar2` | Supply Order Assigned User ID | [ ] | filters on the platform, writable, `supplyOrder.assignedUserId` |  |
| `supplyOrder_companyId` | `varchar2` | Supply Order Company ID | [ ] | filters on the platform, writable, `supplyOrder.companyId` |  |
| `supplyOrder_completed` | `char` | Supply Order Completed | [ ] | filters on the platform, writable, `supplyOrder.completed` |  |
| `supplyOrder_completionPercentage` | `decimal` | Supply Order Completion Percentage | [ ] | filters on the platform, writable, `supplyOrder.completionPercentage` |  |
| `supplyOrder_createdAt` | `datetime` | Supply Order Created At | [ ] | filters on the platform, writable, `supplyOrder.createdAt` |  |
| `supplyOrder_deletedAt` | `datetime` | Supply Order Deleted At | [ ] | filters on the platform, writable, `supplyOrder.deletedAt` |  |
| `supplyOrder_extraFields` | `varchar2` | Supply Order Extra Fields | [ ] | writable | The JSON text of the nested object. |
| `supplyOrder_footerText` | `varchar2` | Supply Order Footer Text | [ ] | filters on the platform, writable, `supplyOrder.footerText` | When reading, only present if requested via 'include' query parameter, otherwise null. HTML content. Embedded images are resolved to URLs based on the 'x-robaws-html-image-mode' request header: TEMPORARY_URL (default) returns time-limited presigned URLs that require no authentication; PERMANENT_URL returns stable URLs that require an authenticated session; NONE returns the stored HTML, where each image is an <img> with a data-robaws-id and an empty src — keep that tag and its data-robaws-id when writing the HTML back, or the image is lost. Any other value (e.g. BASE64_INLINE) returns 400 Bad Request. When writing, omit it or send null to keep the current text; send an empty string to clear it. |
| `supplyOrder_id` | `varchar2` | Supply Order ID | [ ] | filters on the platform, writable, `supplyOrder.id` |  |
| `supplyOrder_introText` | `varchar2` | Supply Order Intro Text | [ ] | filters on the platform, writable, `supplyOrder.introText` | When reading, only present if requested via 'include' query parameter, otherwise null. HTML content. Embedded images are resolved to URLs based on the 'x-robaws-html-image-mode' request header: TEMPORARY_URL (default) returns time-limited presigned URLs that require no authentication; PERMANENT_URL returns stable URLs that require an authenticated session; NONE returns the stored HTML, where each image is an <img> with a data-robaws-id and an empty src — keep that tag and its data-robaws-id when writing the HTML back, or the image is lost. Any other value (e.g. BASE64_INLINE) returns 400 Bad Request. When writing, omit it or send null to keep the current text; send an empty string to clear it. |
| `supplyOrder_lockedAt` | `datetime` | Supply Order Locked At | [ ] | filters on the platform, writable, `supplyOrder.lockedAt` |  |
| `supplyOrder_logicId` | `varchar2` | Supply Order Logic ID | [ ] | filters on the platform, writable, `supplyOrder.logicId` |  |
| `supplyOrder_reference` | `varchar2` | Supply Order Reference | [ ] | filters on the platform, writable, `supplyOrder.reference` |  |
| `supplyOrder_remark` | `varchar2` | Supply Order Remark | [ ] | filters on the platform, writable, `supplyOrder.remark` |  |
| `supplyOrder_status` | `varchar2` | Supply Order Status | [ ] | filters on the platform, writable, `supplyOrder.status` |  |
| `supplyOrder_totalExclVat` | `decimal` | Supply Order Total Excluding VAT | [ ] | filters on the platform, writable, `supplyOrder.totalExclVat` |  |
| `supplyOrder_totalInclVat` | `decimal` | Supply Order Total Including VAT | [ ] | filters on the platform, writable, `supplyOrder.totalInclVat` |  |
| `supplyOrder_type` | `varchar2` | Supply Order Type | [ ] | filters on the platform, writable, `supplyOrder.type` |  |
| `supplyOrder_updatedAt` | `datetime` | Supply Order Updated At | [ ] | filters on the platform, writable, `supplyOrder.updatedAt` |  |
| `ticketNumber` | `varchar2` | Ticket Number | [ ] | filters on the platform, writable, `ticketNumber` |  |
| `timeAndMaterial` | `char` | Time and Material | [ ] | filters on the platform, writable, `timeAndMaterial` |  |
| `title` | `varchar2` | Title | [ ] | filters on the platform, writable, `title` |  |
| `totalCostExclVat` | `decimal` | Total Cost excluding VAT | [ ] | filters on the platform, writable, `totalCostExclVat` |  |
| `totalExclVat` | `decimal` | Total excluding VAT | [ ] | filters on the platform, writable, `totalExclVat` |  |
| `updatedAt` | `datetime` | Updated at | [ ] | filters on the platform, writable, `updatedAt` |  |

## Keys

| Key | Column | Refers to | Kind | Description |
|---|---|---|---|---|
| `WorkOrders_assignedUserId_txt` | `assignedUserId` | [Users](Robaws.Users.Users)`.id` | Textual | The referenced row, for as long as Robaws still lists it: a deleted or purged row is no longer listed, and a document may keep referring to it. |
| `WorkOrders_clientId_txt` | `clientId` | [Clients](Robaws.Clients.Clients)`.id` | Textual | The referenced row, for as long as Robaws still lists it: a deleted or purged row is no longer listed, and a document may keep referring to it. |
| `WorkOrders_companyId_fk` | `companyId` | [Companies](Robaws.Companies.Companies)`.id` | Key |  |
| `WorkOrders_endClientId_fk` | `endClientId` | [Clients](Robaws.Clients.Clients)`.id` | Key |  |
| `WorkOrders_salesOrderId_fk` | `salesOrderId` | [SalesOrders](Robaws.SalesOrders.SalesOrders)`.id` | Key |  |

## Referenced By

- [SalesInvoiceLineItems](Robaws.SalesInvoiceLineItems.SalesInvoiceLineItems) `workOrderId` (Key)
- [StockChanges](Robaws.StockChanges.StockChanges) `workOrderId` (Textual)
- [WorkOrderCommuteEntries](Robaws.WorkOrderCommuteEntries.WorkOrderCommuteEntries) `workOrderId` (Key)
- [WorkOrderLineItems](Robaws.WorkOrderLineItems.WorkOrderLineItems) `workOrderId` (Key)
- [WorkOrderMaterialEntries](Robaws.WorkOrderMaterialEntries.WorkOrderMaterialEntries) `workOrderId` (Key)
- [WorkOrderTimeEntries](Robaws.WorkOrderTimeEntries.WorkOrderTimeEntries) `workOrderId` (Key)



## Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver:

- [ROBAWS](/en/release-notes/drivers?driver=robaws)

