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: Invoices > Tables

InvoiceById: Invoice by ID

Contents Previous Home Next More

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

get

Catalog: Robaws

Schema: Invoices

Label: Invoice by ID

Select: true

Insert: false

Update: false

Delete: false

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

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

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

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

Field Selection Method (OData-specific): NotRequired

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

Table Function Parameters

The following parameters can be used to control the behaviour of the table function InvoiceById. 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 InvoiceById are shown below. Each column has an SQL data type.

Name	Data Type	Label	Required
advanceDiscountPercentage	double		☐
advancePayment	boolean	Advance Payment	☐
advancePercentage	double	Advance (%)	☐
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_userRoleString	string		☐
assignee_version	int64	Assignee Version	☐
assigneeName	string	Assignee Name	☐
body	string	Body	☐
booked	boolean	Booked	☐
client_accountNr	string		☐
client_address_city	string		☐
client_address_country	string		☐
client_address_latLng_defined	boolean		☐
client_address_latLng_lat	double		☐
client_address_latLng_lng	double		☐
client_address_street	string		☐
client_address_streetBase	string		☐
client_address_streetExtra	string		☐
client_address_streetNumber	string		☐
client_address_zipcode	string		☐
client_addressString	string		☐
client_assigneeName	string		☐
client_bank	string	Client Bank	☐
client_contactMedium	string		☐
client_creditDate	datetime		☐
client_creditInfo	string		☐
client_creditLimit	double		☐
client_creditStatus	string		☐
client_currencySymbol	string		☐
client_email	string	Client Email	☐
client_emailPermissionDate	datetime		☐
client_emailPermissionFrom	string		☐
client_expireDate_expireDatePeriodType	string		☐
client_expireDate_id	int64		☐
client_expireDate_name	string		☐
client_expireDate_plusDays	int32		☐
client_expireDate_version	int64		☐
client_externalId	string		☐
client_fax	string	Client Fax	☐
client_finalAddress_city	string		☐
client_finalAddress_country	string		☐
client_finalAddress_latLng_defined	boolean		☐
client_finalAddress_latLng_lat	double		☐
client_finalAddress_latLng_lng	double		☐
client_finalAddress_street	string		☐
client_finalAddress_streetBase	string		☐
client_finalAddress_streetExtra	string		☐
client_finalAddress_streetNumber	string		☐
client_finalAddress_zipcode	string		☐
client_followUpDate	datetime		☐
client_gsm	string	Client Mobile	☐
client_id	int64	Client ID	☐
client_invoiceAddress_city	string		☐
client_invoiceAddress_country	string		☐
client_invoiceAddress_latLng_defined	boolean		☐
client_invoiceAddress_latLng_lat	double		☐
client_invoiceAddress_latLng_lng	double		☐
client_invoiceAddress_street	string		☐
client_invoiceAddress_streetBase	string		☐
client_invoiceAddress_streetExtra	string		☐
client_invoiceAddress_streetNumber	string		☐
client_invoiceAddress_zipcode	string		☐
client_invoiceEmail	string		☐
client_invoiceRemarks	string		☐
client_language	string		☐
client_legalForm_hasVat	boolean		☐
client_legalForm_id	int64		☐
client_legalForm_name	string		☐
client_legalForm_pdfName	string		☐
client_legalForm_version	int64		☐
client_legalName	string		☐
client_logicId	string		☐
client_name	string		☐
client_priceGroup_id	int64		☐
client_priceGroup_name	string		☐
client_priceGroup_version	int64		☐
client_seperateInvoicePage	boolean		☐
client_status	string		☐
client_tel	string		☐
client_title	string		☐
client_useInvoiceAddress	boolean		☐
client_usePeppol	boolean		☐
client_vat_ublSchemeId	string		☐
client_vat_vatCode	string		☐
client_vat_vatCountry	string		☐
client_vat_vatValid	boolean		☐
client_vatNr	string		☐
client_vatTarif	string		☐
client_version	int64		☐
client_website	string		☐
client_withRespectTo	string		☐
clientLegalName	string	Customer Legal Name	☐
clientName	string	Customer Name	☐
clientReference	string	Customer Reference	☐
contactPersonName	string	Contact Person Name	☐
conversion	double	Conversion	☐
creditLimitDays	int32	Credit Limit Days	☐
creditLimitEnabled	boolean	Credit Limit Enabled	☐
creditLimitPercent	double	Credit Limit (%)	☐
credLimit	double	Credit Limit	☐
currencySymbol	string	Currency Symbol	☐
date	datetime	Date	☐
diary	string	Diary	☐
discount	double	Discount	☐
expireDate	datetime	Expiry Date	☐
finalPayment	boolean	Final Payment	☐
financialDiscountDays	int32	Financial Discount (days)	☐
financialDiscountEnabled	boolean	Financial Discount Enabled	☐
financialDiscountPercent	double	Financial Discount (%)	☐
formattedPaymentInstructionId_present	boolean		☐
id	int64	ID	☐
invoiceType	string	Invoice Type	☐
logicId	string	Logical ID	☐
openTotal	double	Open Total	☐
paidOn	datetime	Paid on	☐
paidTotal	double	Paid Total	☐
paymentInstructionId	string		☐
peppolSentDate	datetime		☐
poNumber	string	PO Number	☐
projectInfo	string	Project Information	☐
remark	string	Remark	☐
sentToAccountant	boolean	Sent to Accountant	☐
status	string	Status	☐
totalBTW	double	Total VAT	☐
totalExcBTW	double	Total excl. VAT	☐
totalIncBTW	double	Total incl. VAT	☐
version	int64	Version	☐
withRespectTo	string	With Respect To	☐
yardLeaders	string		☐
year	int32	Year	☐
yearNumber	int32	Year	☐

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

Please enable JavaScript to view this site.

ROBAWS API Data Model

InvoiceById: Invoice by ID

Table Function Parameters

Table Columns