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

# Settlements: Robaws Settlements

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

- Catalog: `Robaws`
- Schema: `Settlements`
- Primary Keys: `id`
- Label: Settlements

Search

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

## API Source

- Endpoint: `/api/v2/settlements`
- Operation: `get /api/v2/settlements`

## Performance Characteristics

| Characteristic | Value |
|---|---:|
| Average access latency (ms) | 135 |
| Full scan rows per minute | 16,530 |
| Point query rows per minute | 711 |
| Write rows per minute | 539 |

The result can be cached on the client.

## Parameters

| Name | Data Type | Required | Default | Documentation |
|---|---|:---:|---|---|
| `calculated` | `` | [ ] |  |  |
| `clientId` | `` | [ ] |  |  |
| `projectId` | `` | [ ] |  |  |
| `searchText` | `` | [ ] |  |  |
| `sort` | `` | [ ] |  |  |
| `updatedFrom` | `` | [ ] |  |  |
| `withArchived` | `` | [ ] |  |  |

## Table Columns

The columns of the table `Settlements` 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 |
|---|---|---|:---:|---|---|
| `activeOnProject` | `char` | Active on Project | [ ] | filters on the platform, writable, `activeOnProject` |  |
| `addressDistance_unit` | `varchar2` | Address Distance Unit | [ ] | filters on the platform, writable, `addressDistance.unit` |  |
| `addressDistance_value` | `int32` | Address Distance Value | [ ] | filters on the platform, writable, `addressDistance.value` |  |
| `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` |  |
| `calculated` | `char` | Calculated | [ ] | filters on the platform, writable, `calculated` |  |
| `calculationStatus` | `varchar2` | Calculation Status | [ ] | filters on the platform, writable, `calculationStatus` |  |
| `clientContactId` | `varchar2` | Client Contact ID | [ ] | filters on the platform, writable, `clientContactId` |  |
| `clientId` | `varchar2` | Client ID | [ ] | filters on the platform, writable, `clientId` |  |
| `clientReference` | `varchar2` | Customer Reference | [ ] | filters on the platform, writable, `clientReference` |  |
| `commission` | `decimal` | Commission | [ ] | filters on the platform, writable, `commission` |  |
| `commissionAmount` | `decimal` | Commission Amount | [ ] | filters on the platform, writable, `commissionAmount` |  |
| `companyId` | `varchar2` | Company ID | [ ] | filters on the platform, writable, `companyId` |  |
| `createdAt` | `datetime` | Created at | [ ] | filters on the platform, writable, `createdAt` |  |
| `currency` | `varchar2` | Currency | [ ] | filters on the platform, writable, `currency` |  |
| `date` | `datetime` | Date | [ ] | filters on the platform, writable, `date` |  |
| `deadlineDate` | `datetime` | Deadline Date | [ ] | filters on the platform, writable, `deadlineDate` |  |
| `deletedAt` | `datetime` | Deleted at | [ ] | filters on the platform, writable, `deletedAt` |  |
| `endClientContactId` | `varchar2` | End Client Contact ID | [ ] | filters on the platform, writable, `endClientContactId` |  |
| `endClientId` | `varchar2` | End Client ID | [ ] | filters on the platform, writable, `endClientId` |  |
| `expireDate` | `datetime` | Expiry Date | [ ] | filters on the platform, writable, `expireDate` |  |
| `extraFields` | `varchar2` | Extra Fields | [ ] | writable | The JSON text of the nested object. |
| `followUpDate` | `datetime` | Follow-up Date | [ ] | filters on the platform, writable, `followUpDate` |  |
| `footerText` | `varchar2` | Footer Text | [ ] | filters on the platform, writable, `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. |
| `groupId` | `varchar2` | Group ID | [ ] | filters on the platform, writable, `groupId` |  |
| `id` | `varchar2` | ID | [ ] | filters on the platform, writable, `id` |  |
| `introText` | `varchar2` | Intro Text | [ ] | filters on the platform, writable, `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. |
| `lockedAt` | `datetime` | Locked at | [ ] | filters on the platform, writable, `lockedAt` |  |
| `logicId` | `varchar2` | Logical ID | [ ] | filters on the platform, writable, `logicId` |  |
| `marginArticleCost` | `double` | Margin Article Cost | [ ] | filters on the platform, writable, `marginArticleCost` |  |
| `marginMaterialCost` | `double` | Margin Material Cost | [ ] | filters on the platform, writable, `marginMaterialCost` |  |
| `marginOtherCost` | `double` | Margin Other Cost | [ ] | filters on the platform, writable, `marginOtherCost` |  |
| `marginSubcontractorCost` | `double` | Margin Subcontractor Cost | [ ] | filters on the platform, writable, `marginSubcontractorCost` |  |
| `marginWorkCost` | `double` | Margin Work Cost | [ ] | filters on the platform, writable, `marginWorkCost` |  |
| `projectId` | `varchar2` | Project ID | [ ] | filters on the platform, writable, `projectId` |  |
| `receivedDate` | `datetime` | Received Date | [ ] | filters on the platform, writable, `receivedDate` |  |
| `statistics_totalArticleCost` | `decimal` | Statistics Total Article Cost | [ ] | filters on the platform, writable, `statistics.totalArticleCost` |  |
| `statistics_totalLaborCost` | `decimal` | Statistics Total Labor Cost | [ ] | filters on the platform, writable, `statistics.totalLaborCost` |  |
| `statistics_totalLaborHours` | `decimal` | Statistics Total Labor Hours | [ ] | filters on the platform, writable, `statistics.totalLaborHours` |  |
| `statistics_totalMaterialCost` | `decimal` | Statistics Total Material Cost | [ ] | filters on the platform, writable, `statistics.totalMaterialCost` |  |
| `statistics_totalSubcontractorCost` | `decimal` | Statistics Total Subcontractor Cost | [ ] | filters on the platform, writable, `statistics.totalSubcontractorCost` |  |
| `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` |  |
| `statusSuccessPercentage` | `decimal` | Status Success Percentage | [ ] | filters on the platform, writable, `statusSuccessPercentage` |  |
| `tenderDate` | `datetime` | Tender Date | [ ] | filters on the platform, writable, `tenderDate` |  |
| `title` | `varchar2` | Title | [ ] | filters on the platform, writable, `title` |  |
| `totalCostPrice` | `decimal` | Total Cost Price | [ ] | filters on the platform, writable, `totalCostPrice` |  |
| `totalExclVat` | `decimal` | Total excluding VAT | [ ] | filters on the platform, writable, `totalExclVat` |  |
| `totalInclVat` | `decimal` | Total including VAT | [ ] | filters on the platform, writable, `totalInclVat` |  |
| `totalIndirectCosts` | `decimal` | Total Indirect Costs | [ ] | filters on the platform, writable, `totalIndirectCosts` |  |
| `totalMargin` | `decimal` | Total Margin | [ ] | filters on the platform, writable, `totalMargin` |  |
| `updatedAt` | `datetime` | Updated at | [ ] | filters on the platform, writable, `updatedAt` |  |

## Keys

| Key | Column | Refers to | Kind | Description |
|---|---|---|---|---|
| `Settlements_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. |
| `Settlements_clientContactId_txt` | `clientContactId` | [Contacts](Robaws.Contacts.Contacts)`.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. |
| `Settlements_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. |
| `Settlements_companyId_txt` | `companyId` | [Companies](Robaws.Companies.Companies)`.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. |
| `Settlements_endClientContactId_fk` | `endClientContactId` | [Contacts](Robaws.Contacts.Contacts)`.id` | Key |  |
| `Settlements_endClientId_fk` | `endClientId` | [Clients](Robaws.Clients.Clients)`.id` | Key |  |
| `Settlements_projectId_txt` | `projectId` | [Projects](Robaws.Projects.Projects)`.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. |

## Referenced By

- [SettlementLineItems](Robaws.SettlementLineItems.SettlementLineItems) `settlementId` (Key)



## Release Notes

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

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

