Please enable JavaScript to view this site.

ROBAWS API Data Model

Navigation: Schema: Clients > Tables

ClientById: Customer by ID

 Contents Previous Home Next More

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

get

Catalog: Robaws

Schema: Clients

Label: Customer by ID

Select: true

Insert: false

Update: false

Delete: false

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

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

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

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

Field Selection Method (OData-specific): NotRequired

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

Table Function Parameters

The following parameters can be used to control the behaviour of the table function ClientById. 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

Default Value

Documentation

id

int64

☑

 

id

 

Table Columns

The columns of the table ClientById are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

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

☐

 

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

☐

 

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

☐

 

legalName

string

Legal Name

☐

 

logicId

string

Logical ID

☐

 

name

string

Name

☐

 

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