Clients: Robaws Customers
insert update delete REST
- Catalog:
Robaws - Schema:
Clients - Primary Keys:
id - Label: Customers
Search
Can retrieve data and change data using insert, update and delete.
API Source
- Endpoint:
/api/v2/clients - Operation:
get /api/v2/clients
Performance Characteristics
| Characteristic | Value |
|---|---|
| Average access latency (ms) | 102 |
| Full scan rows per minute | 24,036 |
| Point query rows per minute | 765 |
| Write rows per minute | 539 |
The result can be cached on the client.
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
email |
`` | |||
logic |
`` | |||
search |
`` | |||
sort |
`` | |||
updated |
`` | |||
vat |
`` | |||
with |
`` |
Table Columns
The columns of the table Clients 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_ |
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 |
||
belgian |
varchar2 |
Belgian Company Number | filters on the platform, writable, belgian |
||
client |
datetime |
Client Since | filters on the platform, writable, client |
||
contact |
varchar2 |
Contact Medium | filters on the platform, writable, contact |
||
counter |
int32 |
Counter Account Code | filters on the platform, writable, counter |
||
created |
datetime |
Created at | filters on the platform, writable, created |
||
credit |
decimal |
Credit Limit | filters on the platform, writable, credit |
||
credit |
varchar2 |
Credit Status | filters on the platform, writable, credit |
||
currency |
varchar2 |
Currency | filters on the platform, writable, currency |
||
deleted |
datetime |
Deleted at | filters on the platform, writable, deleted |
||
email |
varchar2 |
filters on the platform, writable, email |
|||
external |
varchar2 |
External ID | filters on the platform, writable, external |
||
extra |
varchar2 |
Extra Fields | writable | The JSON text of the nested object. | |
fax |
varchar2 |
Fax | filters on the platform, writable, fax |
||
follow |
datetime |
Follow-up Date | filters on the platform, writable, follow |
||
gaccount_ |
char |
G-Account Is Active | filters on the platform, writable, gaccount. |
||
general |
varchar2 |
General Ledger Account ID | filters on the platform, writable, general |
||
global |
varchar2 |
Global Location Number | filters on the platform, writable, global |
||
gsm |
varchar2 |
Mobile | filters on the platform, writable, gsm |
||
id |
varchar2 |
ID | filters on the platform, writable, id |
||
invoice |
varchar2 |
Invoice Address Line 1 | filters on the platform, writable, invoice |
||
invoice |
varchar2 |
Invoice Address Line 2 | filters on the platform, writable, invoice |
||
invoice |
varchar2 |
Invoice Address City | filters on the platform, writable, invoice |
||
invoice |
varchar2 |
Invoice Address Country | filters on the platform, writable, invoice |
||
invoice |
double |
Invoice Address Latitude | filters on the platform, writable, invoice |
||
invoice |
double |
Invoice Address Longitude | filters on the platform, writable, invoice |
||
invoice |
varchar2 |
Invoice Address Postal Code | filters on the platform, writable, invoice |
||
invoice |
varchar2 |
Invoice Email | filters on the platform, writable, invoice |
||
invoice |
varchar2 |
Invoice Remarks | filters on the platform, writable, invoice |
||
kvk |
varchar2 |
Chamber of Commerce | filters on the platform, writable, kvk |
||
language |
varchar2 |
Language | filters on the platform, writable, language |
||
legal |
varchar2 |
Legal Form ID | filters on the platform, writable, legal |
||
leitweg |
varchar2 |
Leitweg ID | filters on the platform, writable, leitweg |
||
locked |
datetime |
Locked at | filters on the platform, writable, locked |
||
name |
varchar2 |
Name | filters on the platform, writable, name |
||
on |
char |
On Peppol Network | filters on the platform, writable, on |
||
payment |
varchar2 |
Payment Condition ID | filters on the platform, writable, payment |
||
preferred |
varchar2 |
Preferred Peppol Participant ID | filters on the platform, writable, preferred |
||
price |
varchar2 |
Price Group ID | filters on the platform, writable, price |
||
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 |
||
steuernummer |
varchar2 |
German Tax Number | filters on the platform, writable, steuernummer |
||
tel |
varchar2 |
Phone | filters on the platform, writable, tel |
||
title |
varchar2 |
Title | filters on the platform, writable, title |
||
updated |
datetime |
Updated at | filters on the platform, writable, updated |
||
use |
char |
Use Invoice Address | filters on the platform, writable, use |
||
vat |
varchar2 |
VAT ID Number | filters on the platform, writable, vat |
||
vat |
varchar2 |
VAT Tariff ID | filters on the platform, writable, vat |
||
website |
varchar2 |
Website | filters on the platform, writable, website |
||
with |
varchar2 |
With Respect To | filters on the platform, writable, with |
Keys
| Key | Column | Refers to | Kind | Description |
|---|---|---|---|---|
Clients_ |
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. |
Clients_ |
legal |
LegalForms.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. |
Clients_ |
payment |
PaymentConditions.id |
Key | |
Clients_ |
price |
PriceGroups.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. |
Clients_ |
vat |
VatTariffs.id |
Key |
Referenced By
- DeliveryNotes
clientId(Key) - Installations
assignedClientId(Textual) - Materials
assignedClientId(Key) - Offers
clientId(Textual) - Offers
endClientId(Key) - PlanningItems
clientId(Key) - PlanningItems
endClientId(Key) - Projects
clientId(Textual) - Projects
endClientId(Textual) - SalesInvoices
clientId(Textual) - SalesOrders
clientId(Textual) - SalesOrders
endClientId(Key) - Settlements
clientId(Textual) - Settlements
endClientId(Key) - StockChanges
toClientId(Textual) - Subscriptions
clientId(Textual) - Subscriptions
endClientId(Key) - TimeRegistrations
clientId(Textual) - Transports
clientId(Key) - WorkOrders
clientId(Textual) - WorkOrders
endClientId(Key)
Sample Queries
select cnt.address_city city
, count(*) client_count
from Robaws.Clients.Clients cnt
group
by cnt.address_city
select inv.logicId
, inv.date
, inv.expireDate
, inv.openTotal
, cnt.name client_name
from Robaws.SalesInvoices.SalesInvoices inv
join Robaws.Clients.Clients cnt
on cnt.id = inv.clientId
where inv.openTotal > 0
select prj.logicId
, prj.date
, prj.siteAddress_city site_city
, cnt.name client_name
from Robaws.Projects.Projects prj
join Robaws.Clients.Clients cnt
on cnt.id = prj.clientId
where prj.archivedAt is null
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: