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 |
`` | |||
client |
`` | |||
project |
`` | |||
search |
`` | |||
sort |
`` | |||
updated |
`` | |||
with |
`` |
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 |
|---|---|---|---|---|---|
active |
char |
Active on Project | filters on the platform, writable, active |
||
address |
varchar2 |
Address Distance Unit | filters on the platform, writable, address |
||
address |
int32 |
Address Distance Value | filters on the platform, writable, address |
||
address_ |
varchar2 |
Address Line 1 | filters on the platform, writable, address. |
||
address_ |
varchar2 |
Address Line 2 | filters on the platform, writable, address. |
||
address_ |
varchar2 |
City | filters on the platform, writable, address. |
||
address_ |
varchar2 |
Country | filters on the platform, writable, address. |
||
address_ |
double |
Address Latitude | filters on the platform, writable, address. |
||
address_ |
double |
Address Longitude | filters on the platform, writable, address. |
||
address_ |
varchar2 |
Address Postal Code | filters on the platform, writable, address. |
||
archived |
datetime |
Archived at | filters on the platform, writable, archived |
||
assigned |
varchar2 |
Assigned User ID | filters on the platform, writable, assigned |
||
calculated |
char |
Calculated | filters on the platform, writable, calculated |
||
calculation |
varchar2 |
Calculation Status | filters on the platform, writable, calculation |
||
client |
varchar2 |
Client Contact ID | filters on the platform, writable, client |
||
client |
varchar2 |
Client ID | filters on the platform, writable, client |
||
client |
varchar2 |
Customer Reference | filters on the platform, writable, client |
||
commission |
decimal |
Commission | filters on the platform, writable, commission |
||
commission |
decimal |
Commission Amount | filters on the platform, writable, commission |
||
company |
varchar2 |
Company ID | filters on the platform, writable, company |
||
created |
datetime |
Created at | filters on the platform, writable, created |
||
currency |
varchar2 |
Currency | filters on the platform, writable, currency |
||
date |
datetime |
Date | filters on the platform, writable, date |
||
deadline |
datetime |
Deadline Date | filters on the platform, writable, deadline |
||
deleted |
datetime |
Deleted at | filters on the platform, writable, deleted |
||
end |
varchar2 |
End Client Contact ID | filters on the platform, writable, end |
||
end |
varchar2 |
End Client ID | filters on the platform, writable, end |
||
expire |
datetime |
Expiry Date | filters on the platform, writable, expire |
||
extra |
varchar2 |
Extra Fields | writable | The JSON text of the nested object. | |
follow |
datetime |
Follow-up Date | filters on the platform, writable, follow |
||
footer |
varchar2 |
Footer Text | filters on the platform, writable, footer |
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 |
|
group |
varchar2 |
Group ID | filters on the platform, writable, group |
||
id |
varchar2 |
ID | filters on the platform, writable, id |
||
intro |
varchar2 |
Intro Text | filters on the platform, writable, intro |
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 |
|
locked |
datetime |
Locked at | filters on the platform, writable, locked |
||
logic |
varchar2 |
Logical ID | filters on the platform, writable, logic |
||
margin |
double |
Margin Article Cost | filters on the platform, writable, margin |
||
margin |
double |
Margin Material Cost | filters on the platform, writable, margin |
||
margin |
double |
Margin Other Cost | filters on the platform, writable, margin |
||
margin |
double |
Margin Subcontractor Cost | filters on the platform, writable, margin |
||
margin |
double |
Margin Work Cost | filters on the platform, writable, margin |
||
project |
varchar2 |
Project ID | filters on the platform, writable, project |
||
received |
datetime |
Received Date | filters on the platform, writable, received |
||
statistics_ |
decimal |
Statistics Total Article Cost | filters on the platform, writable, statistics. |
||
statistics_ |
decimal |
Statistics Total Labor Cost | filters on the platform, writable, statistics. |
||
statistics_ |
decimal |
Statistics Total Labor Hours | filters on the platform, writable, statistics. |
||
statistics_ |
decimal |
Statistics Total Material Cost | filters on the platform, writable, statistics. |
||
statistics_ |
decimal |
Statistics Total Subcontractor Cost | filters on the platform, writable, statistics. |
||
status |
varchar2 |
Status | filters on the platform, writable, status |
||
status |
varchar2 |
Status Details Color | filters on the platform, writable, status |
||
status |
varchar2 |
Status Details Name | filters on the platform, writable, status |
||
status |
decimal |
Status Success Percentage | filters on the platform, writable, status |
||
tender |
datetime |
Tender Date | filters on the platform, writable, tender |
||
title |
varchar2 |
Title | filters on the platform, writable, title |
||
total |
decimal |
Total Cost Price | filters on the platform, writable, total |
||
total |
decimal |
Total excluding VAT | filters on the platform, writable, total |
||
total |
decimal |
Total including VAT | filters on the platform, writable, total |
||
total |
decimal |
Total Indirect Costs | filters on the platform, writable, total |
||
total |
decimal |
Total Margin | filters on the platform, writable, total |
||
updated |
datetime |
Updated at | filters on the platform, writable, updated |
Keys
| Key | Column | Refers to | Kind | Description |
|---|---|---|---|---|
Settlements_ |
assigned |
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_ |
client |
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_ |
client |
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_ |
company |
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_ |
end |
Contacts.id |
Key | |
Settlements_ |
end |
Clients.id |
Key | |
Settlements_ |
project |
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
settlementId(Key)
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: