invantive documentation
Invantive Support ForumsLog In / Sign Up

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 ``
logicId ``
searchText ``
sort ``
updatedFrom ``
vatIdNumber ``
withArchived ``

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_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
belgianCompanyNumber varchar2 Belgian Company Number filters on the platform, writable, belgianCompanyNumber
clientSince datetime Client Since filters on the platform, writable, clientSince
contactMedium varchar2 Contact Medium filters on the platform, writable, contactMedium
counterAccountCode int32 Counter Account Code filters on the platform, writable, counterAccountCode
createdAt datetime Created at filters on the platform, writable, createdAt
creditLimit decimal Credit Limit filters on the platform, writable, creditLimit
creditStatus varchar2 Credit Status filters on the platform, writable, creditStatus
currency varchar2 Currency filters on the platform, writable, currency
deletedAt datetime Deleted at filters on the platform, writable, deletedAt
email varchar2 Email filters on the platform, writable, email
externalId varchar2 External ID filters on the platform, writable, externalId
extraFields varchar2 Extra Fields writable The JSON text of the nested object.
fax varchar2 Fax filters on the platform, writable, fax
followUpDate datetime Follow-up Date filters on the platform, writable, followUpDate
gaccount_isActive char G-Account Is Active filters on the platform, writable, gaccount.isActive
generalLedgerAccountId varchar2 General Ledger Account ID filters on the platform, writable, generalLedgerAccountId
globalLocationNumber varchar2 Global Location Number filters on the platform, writable, globalLocationNumber
gsm varchar2 Mobile filters on the platform, writable, gsm
id varchar2 ID filters on the platform, writable, id
invoiceAddress_addressLine1 varchar2 Invoice Address Line 1 filters on the platform, writable, invoiceAddress.addressLine1
invoiceAddress_addressLine2 varchar2 Invoice Address Line 2 filters on the platform, writable, invoiceAddress.addressLine2
invoiceAddress_city varchar2 Invoice Address City filters on the platform, writable, invoiceAddress.city
invoiceAddress_country varchar2 Invoice Address Country filters on the platform, writable, invoiceAddress.country
invoiceAddress_latitude double Invoice Address Latitude filters on the platform, writable, invoiceAddress.latitude
invoiceAddress_longitude double Invoice Address Longitude filters on the platform, writable, invoiceAddress.longitude
invoiceAddress_postalCode varchar2 Invoice Address Postal Code filters on the platform, writable, invoiceAddress.postalCode
invoiceEmail varchar2 Invoice Email filters on the platform, writable, invoiceEmail
invoiceRemarks varchar2 Invoice Remarks filters on the platform, writable, invoiceRemarks
kvk varchar2 Chamber of Commerce filters on the platform, writable, kvk
language varchar2 Language filters on the platform, writable, language
legalFormId varchar2 Legal Form ID filters on the platform, writable, legalFormId
leitwegId varchar2 Leitweg ID filters on the platform, writable, leitwegId
lockedAt datetime Locked at filters on the platform, writable, lockedAt
name varchar2 Name filters on the platform, writable, name
onPeppolNetwork char On Peppol Network filters on the platform, writable, onPeppolNetwork
paymentConditionId varchar2 Payment Condition ID filters on the platform, writable, paymentConditionId
preferredPeppolParticipantId varchar2 Preferred Peppol Participant ID filters on the platform, writable, preferredPeppolParticipantId
priceGroupId varchar2 Price Group ID filters on the platform, writable, priceGroupId
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
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
updatedAt datetime Updated at filters on the platform, writable, updatedAt
useInvoiceAddress char Use Invoice Address filters on the platform, writable, useInvoiceAddress
vatIdNumber varchar2 VAT ID Number filters on the platform, writable, vatIdNumber
vatTariffId varchar2 VAT Tariff ID filters on the platform, writable, vatTariffId
website varchar2 Website filters on the platform, writable, website
withRespectTo varchar2 With Respect To filters on the platform, writable, withRespectTo

Keys

Key Column Refers to Kind Description
Clients_assignedUserId_txt assignedUserId 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_legalFormId_txt legalFormId 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_paymentConditionId_fk paymentConditionId PaymentConditions.id Key
Clients_priceGroupId_txt priceGroupId 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_vatTariffId_fk vatTariffId VatTariffs.id Key

Referenced By

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: