ROBAWS API Data Model

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Print Topic
Send Mail Feedback
Share This Topic
Save Permalink URL

Navigation: Schema: Clients > Tables

Clients: Customers

Contents Previous Home Next More

https://cloud.invantive.com/robaws/Sql

Catalog: Robaws

Schema: Clients

Label: Customers

Select: true

Insert: true

Update: true

Delete: true

Select Service URL (OData-specific): /api/v1/clients

Insert Service URL (OData-specific): /api/v1/clients

Update Service URL (OData-specific): /api/v1/clients

Delete Service URL (OData-specific): /api/v1/clients

Field Selection Method (OData-specific): NotRequired

Base Path (OData-specific): content[*]

Select Operation (Swagger-specific): get /api/v1/clients

Insert Operation (Swagger-specific): post /api/v1/clients

Update Operation (Swagger-specific): put /api/v1/clients/{id}

Delete Operation (Swagger-specific): delete /api/v1/clients/{id}

Table Function Parameters

The following parameters can be used to control the behaviour of the table function Clients. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name	Data Type	Required	Documentation
btwNr	string	☐	btwNr
fromDate	datetime	☐	fromDate
logicId	string	☐	logicId
name	string	☐	name
notId	int64	☐	notId
offset	int64	☐
paged	boolean	☐
pageNumber	int32	☐
sort.sorted	boolean	☐
sort.unsorted	boolean	☐
text	string	☐	text
toDate	datetime	☐	toDate
unpaged	boolean	☐
updatedFrom	datetime	☐	updatedFrom

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 or update.

Name	Data Type	Label	Required
accountNr	string	Account Number	☐
address_city	string	City	☐
address_country	string	Country	☐
address_latLng_defined	boolean		☐
address_latLng_lat	double		☐
address_latLng_lng	double		☐
address_street	string	Street	☐
address_streetBase	string		☐
address_streetExtra	string		☐
address_streetNumber	string		☐
address_zipcode	string	ZIP Code	☐
addressString	string	Address	☐
assignee_email	string	Assignee Email	☐
assignee_employeeId	int64		☐
assignee_fullname	string	Assignee Full Name	☐
assignee_id	int64	Assignee ID	☐
assignee_schema	string	Assignee Schema	☐
assignee_signature	string	Assignee Signature	☐
assignee_useEmailAccount	boolean		☐
assignee_username	string		☐
assignee_userRole_id	int64		☐
assignee_userRole_name	string		☐
assignee_userRole_version	int64		☐
assignee_userRoleString	string		☐
assignee_version	int64	Assignee Version	☐
assigneeName	string	Assignee Name	☐
bank	string	Bank	☐
contactMedium	string	Contact Medium	☐
creditDate	datetime	Credit Date	☐
creditInfo	string	Credit Information	☐
creditLimit	double	Credit Limit	☐
creditStatus	string	Credit Status	☐
currencySymbol	string	Currency Symbol	☐
email	string	Email	☐
emailPermissionDate	datetime	Email Permission Date	☐
emailPermissionFrom	string	Email Permission from	☐
expireDate_expireDatePeriodType	string	Expire Date Period Type	☐
expireDate_id	int64	Expire Date ID	☐
expireDate_name	string	Expire Date Name	☐
expireDate_plusDays	int32		☐
expireDate_version	int64		☐
externalId	string	External ID	☐
fax	string	Fax	☐
finalAddress_city	string		☐
finalAddress_country	string		☐
finalAddress_latLng_defined	boolean		☐
finalAddress_latLng_lat	double		☐
finalAddress_latLng_lng	double		☐
finalAddress_street	string		☐
finalAddress_streetBase	string		☐
finalAddress_streetExtra	string		☐
finalAddress_streetNumber	string		☐
finalAddress_zipcode	string		☐
followUpDate	datetime	Follow-up Date	☐
gsm	string	Mobile	☐
id	int64	ID	☐
invoiceAddress_city	string		☐
invoiceAddress_country	string		☐
invoiceAddress_latLng_defined	boolean		☐
invoiceAddress_latLng_lat	double		☐
invoiceAddress_latLng_lng	double		☐
invoiceAddress_street	string		☐
invoiceAddress_streetBase	string		☐
invoiceAddress_streetExtra	string		☐
invoiceAddress_streetNumber	string		☐
invoiceAddress_zipcode	string		☐
invoiceEmail	string	Invoice Email	☐
invoiceRemarks	string	Invoice Remarks	☐
language	string	Language	☐
legalForm_hasVat	boolean	Legal Format Has VAT	☐
legalForm_id	int64	Legal Form ID	☐
legalForm_name	string	Legal Form Name	☐
legalForm_pdfName	string	Legal Format PDF Name	☐
legalForm_version	int64	Version	☐
legalName	string	Legal Name	☐
logicId	string	Logical ID	☐
name	string	Name	☐
priceGroup_id	int64		☐
priceGroup_name	string		☐
priceGroup_version	int64		☐
seperateInvoicePage	boolean	Separate Invoice Page	☐
status	string	Status	☐
tel	string	Phone	☐
title	string	Title	☐
useInvoiceAddress	boolean	Use Invoice Address	☐
usePeppol	boolean	Use PEPPOL	☐
vat_ublSchemeId	string	VAT UBL Scheme ID	☐
vat_vatCode	string	VAT Code	☐
vat_vatCountry	string	VAT Country	☐
vat_vatValid	boolean	VAT Number Valid	☐
vatNr	string	VAT Number	☐
vatTarif	string	VAT Code	☐
version	int64	Version	☐
website	string	Website	☐
withRespectTo	string	With Respect To	☐

17-11-2020 16:0920.1.279-BETA+2990

Please enable JavaScript to view this site.

ROBAWS API Data Model

Clients: Customers

Table Function Parameters

Table Columns