# PlanningMaterials: ROBAWS Planning Materials
Search
This is a read-only table function. The ROBAWS API may not support modifying the data, or the Invantive SQL driver for ROBAWS does not support it. In the latter case, use the table NativePlatformScalarRequests to upload data to the ROBAWS API.
- Catalog: `Robaws`
- Schema: `PlanningItems`
- Label: Planning Materials
## Parameters of Table Function
| Name | Data Type | Required | Default Value | Documentation |
|---|:---:|:---:|:---:|---|
| `employeeId` | `string` | ☐ | | |
| `fromDate` | `datetime` | ☐ | | |
| `projectId` | `string` | ☐ | | |
| `searchText` | `string` | ☐ | | |
| `sort` | `string` | ☐ | | |
| `toDate` | `datetime` | ☐ | | |
| `updatedFrom` | `datetime` | ☐ | | |
| `withArchived` | `boolean` | ☐ | | |
## Columns
The columns of the table `PlanningMaterials` are shown below. Each column has an SQL data type.
| Name | Data Type | Label | Required | Documentation |
|---|:---:|---|:---:|---|
| `address_addressLine1` | `string` | Address Line 1 | ☐ | |
| `address_addressLine2` | `string` | Address Line 2 | ☐ | |
| `address_city` | `string` | City | ☐ | |
| `address_country` | `string` | Country | ☐ | |
| `address_latitude` | `double` | | ☐ | |
| `address_longitude` | `double` | | ☐ | |
| `address_postalCode` | `string` | | ☐ | |
| `archivedAt_1` | `datetime` | Archived at | ☐ | |
| `archivedAt` | `datetime` | Archived at | ☐ | |
| `articleId` | `string` | Item ID | ☐ | |
| `assignedClientId` | `string` | Assigned Customer ID | ☐ | |
| `assignedEmployeeId` | `string` | Assigned Employee ID | ☐ | |
| `assignedProjectId` | `string` | Assigned Project ID | ☐ | |
| `assignedSubcontractorId` | `string` | Assigned Subcontractor ID | ☐ | |
| `basePlanningItem_archivedAt` | `datetime` | | ☐ | |
| `basePlanningItem_basePlanningItemId` | `string` | | ☐ | |
| `basePlanningItem_clientId` | `string` | | ☐ | |
| `basePlanningItem_contactId` | `string` | | ☐ | |
| `basePlanningItem_createdAt` | `datetime` | | ☐ | |
| `basePlanningItem_deletedAt` | `datetime` | | ☐ | |
| `basePlanningItem_description` | `string` | | ☐ | |
| `basePlanningItem_endDate` | `datetime` | | ☐ | |
| `basePlanningItem_executionPhaseDetail` | `string` | | ☐ | |
| `basePlanningItem_executionPhaseId` | `string` | | ☐ | |
| `basePlanningItem_externalId` | `string` | | ☐ | |
| `basePlanningItem_extraFields` | `string` | | ☐ | |
| `basePlanningItem_id` | `string` | | ☐ | |
| `basePlanningItem_lockedAt` | `datetime` | | ☐ | |
| `basePlanningItem_numberOfWorkOrders` | `int32` | | ☐ | When reading, only present if requested via 'include' query parameter, otherwise null. |
| `basePlanningItem_phaseId` | `string` | | ☐ | |
| `basePlanningItem_planningTypeId` | `string` | | ☐ | |
| `basePlanningItem_projectId` | `string` | | ☐ | |
| `basePlanningItem_recurrenceEndDate` | `datetime` | | ☐ | |
| `basePlanningItem_recurrenceRule` | `string` | | ☐ | |
| `basePlanningItem_recurring` | `boolean` | | ☐ | |
| `basePlanningItem_recurringMode` | `string` | | ☐ | Deprecated, use recurrenceType instead. |
| `basePlanningItem_startDate` | `datetime` | | ☐ | |
| `basePlanningItem_summary` | `string` | | ☐ | |
| `basePlanningItem_timeAndMaterial` | `boolean` | | ☐ | |
| `basePlanningItem_transportId` | `string` | | ☐ | |
| `basePlanningItem_unavailableReason` | `string` | | ☐ | |
| `basePlanningItem_updatedAt` | `datetime` | | ☐ | |
| `basePlanningItemId` | `string` | Base Planning Item ID | ☐ | |
| `brand` | `string` | Brand | ☐ | |
| `c_metadata_description` | `string` | | ☐ | |
| `c_metadata_href` | `string` | | ☐ | |
| `c_metadata_resource` | `string` | | ☐ | |
| `c_metadata_resourceTypeId` | `string` | | ☐ | |
| `client_archivedAt` | `datetime` | | ☐ | |
| `client_assignedUserId` | `string` | | ☐ | |
| `client_createdAt` | `datetime` | | ☐ | |
| `client_creditStatus` | `string` | | ☐ | |
| `client_deletedAt` | `datetime` | | ☐ | |
| `client_email` | `string` | Customer Email | ☐ | |
| `client_extraFields` | `string` | | ☐ | |
| `client_fax` | `string` | Customer Fax | ☐ | |
| `client_followUpDate` | `datetime` | | ☐ | |
| `client_generalLedgerAccountId` | `string` | | ☐ | |
| `client_gsm` | `string` | Customer Mobile | ☐ | |
| `client_id` | `string` | Client ID | ☐ | |
| `client_invoiceEmail` | `string` | | ☐ | |
| `client_language` | `string` | | ☐ | |
| `client_legalFormId` | `string` | | ☐ | |
| `client_lockedAt` | `datetime` | | ☐ | |
| `client_name` | `string` | | ☐ | |
| `client_paymentConditionId` | `string` | | ☐ | |
| `client_priceGroupId` | `string` | | ☐ | |
| `client_status` | `string` | | ☐ | |
| `client_tel` | `string` | | ☐ | |
| `client_title` | `string` | | ☐ | |
| `client_updatedAt` | `datetime` | | ☐ | |
| `client_vatIdNumber` | `string` | | ☐ | |
| `client_vatTariffId` | `string` | | ☐ | |
| `client_website` | `string` | | ☐ | |
| `clientId` | `string` | Customer ID | ☐ | |
| `contact_archivedAt` | `datetime` | | ☐ | |
| `contact_createdAt` | `datetime` | | ☐ | |
| `contact_deletedAt` | `datetime` | | ☐ | |
| `contact_email` | `string` | | ☐ | |
| `contact_extraFields` | `string` | | ☐ | |
| `contact_gsm` | `string` | | ☐ | |
| `contact_id` | `string` | | ☐ | |
| `contact_lockedAt` | `datetime` | | ☐ | |
| `contact_name` | `string` | | ☐ | |
| `contact_position` | `string` | | ☐ | |
| `contact_surname` | `string` | | ☐ | |
| `contact_tel` | `string` | | ☐ | |
| `contact_title` | `string` | | ☐ | |
| `contact_updatedAt` | `datetime` | | ☐ | |
| `contactId` | `string` | Contact ID | ☐ | |
| `createdAt_1` | `datetime` | Created at | ☐ | |
| `createdAt` | `datetime` | Created at | ☐ | |
| `deletedAt_1` | `datetime` | Deleted at | ☐ | |
| `deletedAt` | `datetime` | Deleted at | ☐ | |
| `description` | `string` | Description | ☐ | |
| `endDate` | `datetime` | End Date | ☐ | |
| `executionPhase_archivedAt` | `datetime` | | ☐ | |
| `executionPhase_createdAt` | `datetime` | | ☐ | |
| `executionPhase_deletedAt` | `datetime` | | ☐ | |
| `executionPhase_extraFields` | `string` | | ☐ | |
| `executionPhase_id` | `string` | | ☐ | |
| `executionPhase_lockedAt` | `datetime` | | ☐ | |
| `executionPhase_name` | `string` | | ☐ | |
| `executionPhase_planningGroup` | `string` | | ☐ | |
| `executionPhase_updatedAt` | `datetime` | | ☐ | |
| `executionPhaseDetail` | `string` | Execution Phase Detail | ☐ | |
| `executionPhaseId` | `string` | Execution Phase ID | ☐ | |
| `externalId` | `string` | External ID | ☐ | |
| `extraFields_1` | `string` | Extra fields | ☐ | |
| `extraFields` | `string` | Extra fields | ☐ | |
| `id_1` | `string` | ID | ☐ | |
| `id` | `string` | ID | ☐ | |
| `installation` | `boolean` | Installation | ☐ | |
| `lockedAt_1` | `datetime` | Closed at | ☐ | |
| `lockedAt` | `datetime` | Closed at | ☐ | |
| `name` | `string` | Name | ☐ | |
| `numberOfWorkOrders` | `int32` | Number of Work Orders | ☐ | When reading, only present if requested via 'include' query parameter, otherwise null. |
| `phase_archivedAt` | `datetime` | | ☐ | |
| `phase_createdAt` | `datetime` | | ☐ | |
| `phase_deletedAt` | `datetime` | | ☐ | |
| `phase_endDate` | `datetime` | | ☐ | |
| `phase_extraFields` | `string` | | ☐ | |
| `phase_id` | `string` | | ☐ | |
| `phase_lockedAt` | `datetime` | | ☐ | |
| `phase_name` | `string` | | ☐ | |
| `phase_offerId` | `string` | | ☐ | Only present when obtained via offer bulk endpoint |
| `phase_projectId` | `string` | | ☐ | Only present when obtained via project bulk endpoint |
| `phase_settlementId` | `string` | | ☐ | Only present when obtained via settlements bulk endpoint |
| `phase_startDate` | `datetime` | | ☐ | |
| `phase_updatedAt` | `datetime` | | ☐ | |
| `phase_workingDays` | `int32` | | ☐ | |
| `phaseId` | `string` | Phase ID | ☐ | |
| `planningType_archivedAt` | `datetime` | | ☐ | |
| `planningType_color` | `string` | | ☐ | |
| `planningType_createdAt` | `datetime` | | ☐ | |
| `planningType_deletedAt` | `datetime` | | ☐ | |
| `planningType_extraFields` | `string` | | ☐ | |
| `planningType_id` | `string` | | ☐ | |
| `planningType_lockedAt` | `datetime` | | ☐ | |
| `planningType_name` | `string` | | ☐ | |
| `planningType_updatedAt` | `datetime` | | ☐ | |
| `planningTypeId` | `string` | Planning Type ID | ☐ | |
| `project_archivedAt` | `datetime` | | ☐ | |
| `project_checkInAtWork` | `string` | | ☐ | |
| `project_clientContactId` | `string` | | ☐ | |
| `project_clientId` | `string` | | ☐ | |
| `project_clientReference` | `string` | | ☐ | |
| `project_companyId` | `string` | | ☐ | |
| `project_createdAt` | `datetime` | | ☐ | |
| `project_date` | `datetime` | | ☐ | |
| `project_deletedAt` | `datetime` | | ☐ | |
| `project_distance` | `int32` | | ☐ | |
| `project_endClientContactId` | `string` | | ☐ | |
| `project_endClientId` | `string` | | ☐ | |
| `project_extraFields` | `string` | | ☐ | |
| `project_geofence` | `string` | | ☐ | |
| `project_id` | `string` | | ☐ | |
| `project_lockedAt` | `datetime` | | ☐ | |
| `project_logicId` | `string` | | ☐ | |
| `project_nssoDeclarationOfWorks` | `string` | | ☐ | |
| `project_planningGroup` | `string` | | ☐ | |
| `project_planningName` | `string` | | ☐ | |
| `project_siteManagerId` | `string` | | ☐ | |
| `project_siteNssoIdNumber` | `string` | | ☐ | |
| `project_status` | `string` | | ☐ | |
| `project_updatedAt` | `datetime` | | ☐ | |
| `projectId` | `string` | Project ID | ☐ | |
| `recurrenceEndDate` | `datetime` | Recurrence End Date | ☐ | |
| `recurrenceRule` | `string` | Recurrence Rule | ☐ | |
| `recurring` | `boolean` | Recurring | ☐ | |
| `recurringMode` | `string` | Recurrence Mode | ☐ | Deprecated, use recurrenceType instead. |
| `serialNumber` | `string` | Serial Number | ☐ | |
| `startDate` | `datetime` | Start Date | ☐ | |
| `status` | `string` | Status | ☐ | |
| `stockLocationId` | `string` | Stock Location ID | ☐ | |
| `summary` | `string` | Summary | ☐ | |
| `supplierId` | `string` | Supplier ID | ☐ | |
| `timeAndMaterial` | `boolean` | Time and Materials | ☐ | |
| `transportId` | `string` | Transport ID | ☐ | |
| `unavailableReason` | `string` | Unavailable Reason | ☐ | |
| `updatedAt_1` | `datetime` | Updated On | ☐ | |
| `updatedAt` | `datetime` | Updated On | ☐ | |