Ver.No: {{=response.verNo}}
The Nervatura Data Interface (NDI) is made for those who want to query or transmit data to a Nervatura customer database. The purpose of functions is to give an easily operable, perspicuous and safe tool to manage while the real data storage layer is covered:
The set of functions of NDI supports the following operations:
Functions can be called by http/https GET request.
All three functions offer the possibility to enter further data and
refinements in three parameters in which information is stored with
"|" sign separator in the character strings.
code:
empty or its value is the request (base64) or else it contains
information of coding of both directions (base64all). At NAS
options also encryption settings can be added.
params: it contains identification information just as the
processing type and method.
data,filters: the data itself (data), possibly filtration,
formatting, return format information (filters) is located here
according to the given function.
In all cases the functions have a return value which after successful data processing with a prefix "OK|" is the identifier of processed objects or in data query function is the defined return format. In case of handled error the message comes after "Error|" prefix. The current database performs the verification of the data type, the syntax of filter terms or given sql queries, in case of error this message is transferred.
Valid fieldname and type values in params
Name | Type | Comment |
---|---|---|
database* | text | Required, the name of the database |
username* | text | Required (remote access must be enabled!) |
password* | text | Required, optional MD5 encoded |
datatype* | text | Required. See valid datatype values |
use_deleted | no value | Optional. Show (getData) or use (updateData) the deleted data. Used for data backup/restore. |
insert_row | no value | Optional, only in case of request for updateData. If used and no unique identifier corresponding to the object is set while updating the data, then the function will create it automatically in case it has not existed yet. Also new object will be created even if the given unique identifier did not exist before. Without adding this parameter both mentioned cases would result in error messages. |
insert_field | no value | Optional, only in case of request for updateData. If used, and the field name given at data update has not existed before, it will automatically be created and the value assigned to it. The field type will always be set to text. The description of the field is identical to the name of the field. If other field type is needed than text it should be defined beforehand in deffield object. Without adding this parameter the mentioned case would result in error message. |
Valid filters parameter values (getData)
Name | Type | Comment |
---|---|---|
output* | text | Required. Valid values: text, html, xml, excel. If not set, the default value: text. |
header | text | Optional, only if the value output html and excel. Replaces the table column headings. The new values should be given separated by a comma. |
columns | text | Optional. Only the specified columns, in a particular order will be shown. Results in error if the column name is invalid. The new values should be given separated by a comma. |
where | text | Optional. A valid SQL WHERE condition. Results in error if the column name is invalid or wrong type syntax. |
orderby | text | Optional. Results in error if the column name is invalid. The new values should be given separated by a comma. |
show_id | no value | Optional. If specified, the primary key will be shown. |
no_deffield | no value | Optional. Does not show the additional data. |
The use of NDI functions can be prohibited or permitted through the surface of Nervatura Application Server (NAS) in dedicated customer database or we can give further limitations as well:
Regardless to the setting of NAS in certain customer databases user data access is also limited. NDI takes into consideration the given options for group access, also full access of a user and/or group can be prohibited.
Datatype | Primary key / unique value | Fields | Comment |
---|---|---|---|
address | nervatype/refnumber~rownumber | See ADDRESS | |
barcode | code | See BARCODE | |
contact | nervatype/refnumber~rownumber | See CONTACT | |
currency | curr | See CURRENCY | |
customer | custnumber | See CUSTOMER | |
deffield | fieldname | See DEFFIELD | Create your own data fields for Nervatura objects |
employee | empnumber | See EMPLOYEE | |
event | calnumber | See EVENT | Specific date or time interval associated with event data |
fieldvalue | refnumber~~fieldname~rownumber | See FIELDVALUE | Set the value of the object |
groups | groupname~groupvalue | See GROUPS | |
item | refnumber~rownumber | See ITEM | |
link | nervatype1~refnumber1~~nervatype2~refnumber2 | See LINK | Create a relationship between two objects. |
log | empnumber~crdate | See LOG | Values are automatically generated. |
movement | refnumber~rownumber | See MOVEMENT | |
numberdef | numberkey | See NUMBERDEF | |
pattern | description | See PATTERN | Transaction footer template |
payment | refnumber~rownumber | See PAYMENT | |
place | planumber | See PLACE | |
price | partnumber~pricetype~validfrom~curr~qty | See PRICE | |
product | partnumber | See PRODUCT | |
project | pronumber | See PROJECT | |
rate | ratetype~ratedate~curr~planumber | See RATE | |
tax | taxcode | See TAX | |
tool | serial | See TOOL | |
trans | transnumber | See TRANS | Transaction header data. |
sql | A valid SQL query. Unsupported, use at your own risk! |
1. Enter two new customers in one request: customer name, VAT
number and eye colour. If the eye colour customer feature does not
exist, it will be automatically generated. We give customer number
to the first but we do not to the second. To the second it generates
one automatically and as a response it gives back. If the customer
number already existed to the first then it overwrites the data.
http://127.0.0.1:8000/nerva2py/ndi/updateData?code=¶ms=database=demo|username=demo|password=|datatype=customer|insert_row|insert_field&
data=custnumber=DOC/00001|custname=NDIDoc Sample 1.|taxnumber=12345678-1-12|eye colour=blue
||custname=NDIDoc Sample 2.|taxnumber=87654321-1-21|eye colour=brown
2. A new customer feature generated by type. We generate the
customer weight data that can only be a number.
http://127.0.0.1:8000/nerva2py/ndi/updateData?code=¶ms=database=demo|username=demo|password=|datatype=deffield|insert_row|insert_field&
data=fieldname=customer_weight|nervatype=customer|fieldtype=float|description=Weight
3. For the customer generated in the point 1. we can set the
weight by customer number.
http://127.0.0.1:8000/nerva2py/ndi/updateData?code=¶ms=database=demo|username=demo|password=|datatype=customer|insert_row|insert_field&
data=custnumber=DOC/00001|customer_weight=92
or
http://127.0.0.1:8000/nerva2py/ndi/updateData?code=¶ms=database=demo|username=demo|password=|datatype=fieldvalue|insert_row&
data=fieldname=customer_weight|refnumber=DOC/00001|value=92
4. For the customer generated in the point 1. we give new address data.
http://127.0.0.1:8000/nerva2py/ndi/updateData?code=¶ms=database=demo|username=demo|password=|datatype=address|insert_row|insert_field&
data=nervatype=customer|refnumber=DOC/00001|rownumber=1|country=Anywhere|zipcode=ZIP1234|city=BigCity|street=BlueStreet 3.
5. For the customer generated in the point 1. we give a new event.
http://127.0.0.1:8000/nerva2py/ndi/updateData?code=¶ms=database=demo|username=demo|password=|datatype=event|insert_row|insert_field&
data=nervatype=customer|refnumber=DOC/00001|eventgroup=meeting|fromdate=2013-01-13 13:00:00|todate=2013-01-13 15:00:00|subject=Customer meeting
6. We delete the address generated in the point 4.
http://127.0.0.1:8000/nerva2py/ndi/deleteData?code=¶ms=database=demo|username=demo|password=|datatype=address&
data=nervatype=customer|refnumber=DOC/00001|rownumber=1
7. Querying data from a client
http://127.0.0.1:8000/nerva2py/ndi/getData?code=¶ms=database=demo|username=demo|password=|datatype=customer&
filters=output=html|where=custnumber='DOC/00001'
More Examples: Data Interface Wizard, Server side DEMO, MS Excel Data Loader, Google Spreadsheet Data Loader
ADDRESS fieldname and type values:
Name | Type | Comment |
---|---|---|
nervatype* | text | Required. Valid values: customer, employee, event, place, product, project, tool, trans. |
refnumber* | text | Required. Valid values: custnumber (CUSTOMER), empnumber (EMPLOYEE), calnumber (EVENT), planumber (PLACE), partnumber (PRODUCT), pronumber (PROJECT), serial (TOOL), transnumber (TRANS). |
rownumber* | integer | Required. If 0, add new address. |
country | text | |
state | text | |
zipcode | text | |
city | text | |
street | text | |
notes | text | |
additional data | by definition or text | Valid for any additional fieldname already defined
(in DEFFIELD) or insert_field params option will automatically
create it. The part after the ~ sign will be set in the notes (other data) field, the part before in the value field. If the same field name is used more times in an object the [fieldname~index]=[value~notes] format can be used to set the value. The "~index" and "~notes" section is optional and may be omitted. |
BARCODE fieldname and type values:
Name | Type | Comment |
---|---|---|
code* | text | Required. |
partnumber* | text | Required in case of new value entry. |
barcodetype* | text | Required in case of new value entry. Valid values: all groupvalue from GROUPS, where groupname equal barcodetype. (Default values: code128a, code128b, code128c, code25, code25i, code39, code93, ean13, ean8, postnet, upca, upce) |
description | text | |
qty | real | Barcode quantity. Default value: 0. |
defcode | boolean | Default barcode for product. Boolean type, valid TRUE values: TRUE,true,T,t,Y,y,YES,yes,ON,on,1 or FALSE. Default value: FALSE. |
additional data | by definition or text | Valid for any additional fieldname already defined
(in DEFFIELD) or insert_field params option will automatically
create it. The part after the ~ sign will be set in the notes (other data) field, the part before in the value field. If the same field name is used more times in an object the [fieldname~index]=[value~notes] format can be used to set the value. The "~index" and "~notes" section is optional and may be omitted. |
CONTACT fieldname and type values:
Name | Type | Comment |
---|---|---|
nervatype* | text | Required. Valid values: customer, employee, event, place, product, project, tool, trans. |
refnumber* | text | Required. Valid values: custnumber (CUSTOMER), empnumber (EMPLOYEE), calnumber (EVENT), planumber (PLACE), partnumber (PRODUCT), pronumber (PROJECT), serial (TOOL), transnumber (TRANS). |
rownumber* | integer | Required. If 0, add new contact. |
firstname | text | |
surname | text | |
status | text | |
phone | text | |
fax | text | |
mobil | text | |
text | ||
notes | text | |
additional data | by definition or text | Valid for any additional fieldname already defined
(in DEFFIELD) or insert_field params option will automatically
create it. The part after the ~ sign will be set in the notes (other data) field, the part before in the value field. If the same field name is used more times in an object the [fieldname~index]=[value~notes] format can be used to set the value. The "~index" and "~notes" section is optional and may be omitted. |
CURRENCY fieldname and type values:
Name | Type | Comment |
---|---|---|
curr* | text | Required. |
description* | text | Required in case of new value entry. |
digit | integer | The extent of rounding in calculations. Default value: 0 |
cround | integer | Cash value of the minimum delivery. Default value: 0 |
defrate | real | Default rate as for the base currency. Default value: 0. Base currency setting: default_currency |
additional data | by definition or text | Valid for any additional fieldname already defined
(in DEFFIELD) or insert_field params option will automatically
create it. The part after the ~ sign will be set in the notes (other data) field, the part before in the value field. If the same field name is used more times in an object the [fieldname~index]=[value~notes] format can be used to set the value. The "~index" and "~notes" section is optional and may be omitted. |
CUSTOMER fieldname and type values:
Name | Type | Comment |
---|---|---|
custnumber* | text | Add new, if not set, the function retrieves the next value |
custtype | text | Valid values: company, private, other. Default value: company. |
custname* | text | Required in case of new value entry. |
taxnumber | text | |
account | text | |
notax | boolean | Boolean type, valid TRUE values: TRUE,true,T,t,Y,y,YES,yes,ON,on,1 or FALSE. Default value: FALSE. |
terms | integer | Default value: 0. |
creditlimit | real | Default value: 0. |
discount | real | Default value: 0. |
notes | text | |
inactive | boolean | Boolean type, valid TRUE values: TRUE,true,T,t,Y,y,YES,yes,ON,on,1 or FALSE. Default value: FALSE. |
additional data | by definition or text | Valid for any additional fieldname already defined
(in DEFFIELD) or insert_field params option will automatically
create it. The part after the ~ sign will be set in the notes (other data) field, the part before in the value field. If the same field name is used more times in an object the [fieldname~index]=[value~notes] format can be used to set the value. The "~index" and "~notes" section is optional and may be omitted. |
DEFFIELD fieldname and type values:
Name | Type | Comment |
---|---|---|
fieldname* | text | Required |
nervatype* | text | Required in case of new value entry. Valid values: address, barcode, contact, currency, customer, employee, event, item, link, log, movement, payment, price, place, product, project, rate, tax, tool, trans, setting. |
subtype | text | Valid values: all groupvalue from GROUPS, where groupname equal custtype (CUSTOMER) or groupname equal placetype (PLACE) or groupname equal protype (PRODUCT) or groupname equal toolgroup (TOOL) or groupname equal transtype (TRANS). |
fieldtype* | text | Required in case of new value entry. Valid values: bool, date, float, integer, string, valuelist, notes, urlink, password, customer, tool, transitem, transmovement, transpayment, product, project, employee, place |
description | text | |
valuelist | text | If fieldtype=valuelist: valid values are listed, separated by ~ |
addnew | boolean | Boolean type, valid TRUE values: TRUE,true,T,t,Y,y,YES,yes,ON,on,1 or FALSE. Default value: FALSE. |
visible | boolean | Boolean type, valid TRUE values: TRUE,true,T,t,Y,y,YES,yes,ON,on,1 or FALSE. Default value: TRUE. |
readonly | boolean | Boolean type, valid TRUE values: TRUE,true,T,t,Y,y,YES,yes,ON,on,1 or FALSE. Default value: FALSE. |
EMPLOYEE fieldname and type values:
Name | Type | Comment |
---|---|---|
empnumber* | text | Add new, if not set, the function retrieves the next value. |
usergroup* | text | Required in case of new value entry. Valid values: all groupvalue from GROUPS, where groupname equal usergroup. |
startdate | date | |
enddate | date | |
department | text | Valid values: all groupvalue from GROUPS, where groupname equal department. |
password | text | MD5 string |
registration_key | text | |
inactive | boolean | Boolean type, valid TRUE values: TRUE,true,T,t,Y,y,YES,yes,ON,on,1 or FALSE. Default value: FALSE. |
additional data | by definition or text | Valid for any additional fieldname already defined
(in DEFFIELD) or insert_field params option will automatically
create it. The part after the ~ sign will be set in the notes (other data) field, the part before in the value field. If the same field name is used more times in an object the [fieldname~index]=[value~notes] format can be used to set the value. The "~index" and "~notes" section is optional and may be omitted. |
EVENT fieldname and type values:
Name | Type | Comment |
---|---|---|
calnumber* | text | Add new, if not set, the function retrieves the next value. |
nervatype* | text | Required in case of new value entry. Valid values: customer, employee, place, product, project, tool, trans. |
refnumber* | text | Required in case of new value entry. Valid values: custnumber (CUSTOMER), empnumber (EMPLOYEE), planumber (PLACE), partnumber (PRODUCT), pronumber (PROJECT), serial (TOOL), transnumber (TRANS). |
uid | text | |
eventgroup | text | Valid values: all groupvalue from GROUPS, where groupname equal department. If the value specified does not exist, it is created automatically. |
fromdate* | datetime | Required in case of new value entry. Valid datetime format: YYYY-MM-DD HH:MM:SS |
todate | datetime | Valid datetime format: YYYY-MM-DD HH:MM:SS |
subject | text | |
place | text | |
description | text | |
additional data | by definition or text | Valid for any additional fieldname already defined
(in DEFFIELD) or insert_field params option will automatically
create it. The part after the ~ sign will be set in the notes (other data) field, the part before in the value field. If the same field name is used more times in an object the [fieldname~index]=[value~notes] format can be used to set the value. The "~index" and "~notes" section is optional and may be omitted. |
FIELDVALUE fieldname and type values:
Name | Type | Comment |
---|---|---|
fieldname* | text | Required. |
refnumber* | text | If nervatype=setting will be omitted. |
rownumber | integer | Optional. Default value: 1. |
value* | by definition or text | Required. |
notes | text | |
nervatype | text | Readonly value! (from DEFFIELD) |
description | text | Readonly value! (from DEFFIELD) |
fieldtype | text | Readonly value! (from DEFFIELD) |
GROUPS fieldname and type values:
Name | Type | Comment |
---|---|---|
groupname* | text | Required. |
groupvalue* | text | Required. |
description | text | |
inactive | boolean | Boolean type, valid TRUE values: TRUE,true,T,t,Y,y,YES,yes,ON,on,1 or FALSE. Default value: FALSE. |
ITEM fieldname and type values:
Name | Type | Comment |
---|---|---|
transnumber* | text | Required. Valid transnumber (TRANS) |
rownumber* | integer | Required. If 0, add new item. |
inputmode | text | Optional. If you specify the input mode, the corresponding values are calculated automatically. Valid values: fxprice, netamount, amount. |
inputvalue | real | Optional. Base amount of inputmode. |
partnumber* | text | Required in case of new value entry. Valid partnumber (PRODUCT). |
unit | text | Default value: unit of PRODUCT. |
taxcode | text | Default value: taxcode of PRODUCT. |
description | text | Default value: description of PRODUCT. |
qty | real | Quantity. Default value: 0. |
fxprice | real | Unit price. Default value: 0. |
netamount | real | Default value: 0. |
discount | real | Percent. Valid values: 0-100. Default value: 0. |
vatamount | real | Default value: 0. |
amount | real | Gross amount. Default value: 0. |
deposit | boolean | Boolean type, valid TRUE values: TRUE,true,T,t,Y,y,YES,yes,ON,on,1 or FALSE. Default value: FALSE. |
actionprice | boolean | Boolean type, valid TRUE values: TRUE,true,T,t,Y,y,YES,yes,ON,on,1 or FALSE. Default value: FALSE. |
ownstock | real | Default value: 0. |
additional data | by definition or text | Valid for any additional fieldname already defined
(in DEFFIELD) or insert_field params option will automatically
create it. The part after the ~ sign will be set in the notes (other data) field, the part before in the value field. If the same field name is used more times in an object the [fieldname~index]=[value~notes] format can be used to set the value. The "~index" and "~notes" section is optional and may be omitted. |
LINK items fieldname and type values:
Name | Type | Comment |
---|---|---|
nervatype1* | text | Required. |
refnumber1* | text | Required. |
nervatype2* | text | Required. |
refnumber2* | text | Required. |
linktype | integer | Default value: 0. |
additional data | by definition or text | Valid for any additional fieldname already defined
(in DEFFIELD) or insert_field params option will automatically
create it. The part after the ~ sign will be set in the notes (other data) field, the part before in the value field. If the same field name is used more times in an object the [fieldname~index]=[value~notes] format can be used to set the value. The "~index" and "~notes" section is optional and may be omitted. |
LOG items fieldname and type values:
Name | Type | Comment |
---|---|---|
empnumber | text | |
crdate | datetime | Valid datetime format: YYYY-MM-DD HH:MM:SS Default: current datetime. |
nervatype | text | |
refnumber | text | |
logstate* | text | Required. Valid values: all groupvalue from GROUPS, where groupname equal logstate: update, closed, deleted, print, login, logout. |
additional data | by definition or text | Valid for any additional fieldname already defined
(in DEFFIELD) or insert_field params option will automatically
create it. The part after the ~ sign will be set in the notes (other data) field, the part before in the value field. If the same field name is used more times in an object the [fieldname~index]=[value~notes] format can be used to set the value. The "~index" and "~notes" section is optional and may be omitted. |
MOVEMENT fieldname and type values:
Name | Type | Comment |
---|---|---|
transnumber* | text | Required. Valid transnumber (TRANS) |
rownumber* | integer | Required. |
movetype* | text | Required in case of new value entry and can not be changed later. Valid values: inventory, store, tool, plan, head. |
partnumber* | text | Required in case of new value entry for movetype, inventory, store, plan or head. Valid partnumber (PRODUCT). |
serial* | text | Required in case of new value entry for movetype, tool. Valid serial (TOOL). |
planumber* | text | Required in case of new value entry for movetype, inventory or store. Valid planumber (PLACE). |
shippingdate | datetime | Valid datetime format: YYYY-MM-DD HH:MM:SS Default: current date. |
qty | real | PRODUCT quantity. Default value: 0 |
shared | boolean | Optional, if movetype plan. Boolean type, valid TRUE values: TRUE,true,T,t,Y,y,YES,yes,ON,on,1 or FALSE. Default value: FALSE. |
notes | text | |
additional data | by definition or text | Valid for any additional fieldname already defined
(in DEFFIELD) or insert_field params option will automatically
create it. The part after the ~ sign will be set in the notes (other data) field, the part before in the value field. If the same field name is used more times in an object the [fieldname~index]=[value~notes] format can be used to set the value. The "~index" and "~notes" section is optional and may be omitted. |
NUMBERDEF fieldname and type values:
Name | Type | Comment |
---|---|---|
numberkey* | text | Required. |
prefix | text | |
curvalue | integer | Default value: 0. |
isyear | boolean | Boolean type, valid TRUE values: TRUE,true,T,t,Y,y,YES,yes,ON,on,1 or FALSE. Default value: FALSE. |
sep | text | Default value: /. |
len | integer | The length of the display, left side is zero filled. Default value: 5. |
description | text | |
visible | boolean | Boolean type, valid TRUE values: TRUE,true,T,t,Y,y,YES,yes,ON,on,1 or FALSE. Default value: FALSE. |
readonly | boolean | Boolean type, valid TRUE values: TRUE,true,T,t,Y,y,YES,yes,ON,on,1 or FALSE. Default value: FALSE. |
orderby | integer | Default value: 0. |
PATTERN fieldname and type values:
Name | Type | Comment |
---|---|---|
description* | text | Required. |
transtype* | text | Required in case of new value entry. Valid values: all groupvalue from GROUPS, where groupname equal transtype (TRANS) |
notes | text | |
defpattern | boolean | Boolean type, valid TRUE values: TRUE,true,T,t,Y,y,YES,yes,ON,on,1 or FALSE. Default value: FALSE. |
PAYMENT fieldname and type values:
Name | Type | Comment |
---|---|---|
transnumber* | text | Required. Valid transnumber (TRANS) |
rownumber* | integer | Required. |
paiddate | date | Valid date format: YYYY-MM-DD. Default: current date. |
amount | real | Default: 0. |
notes | text | |
additional data | by definition or text | Valid for any additional fieldname already defined
(in DEFFIELD) or insert_field params option will automatically
create it. The part after the ~ sign will be set in the notes (other data) field, the part before in the value field. If the same field name is used more times in an object the [fieldname~index]=[value~notes] format can be used to set the value. The "~index" and "~notes" section is optional and may be omitted. |
PLACE fieldname and type values:
Name | Type | Comment |
---|---|---|
planumber* | text | Required. Add new, if not set, the function retrieves the next value. |
placetype* | text | Required in case of new value entry, not editable. Valid values: all groupvalue from GROUPS, where groupname equal placetype (bank, cash, warehouse, store). |
description* | text | Required in case of new value entry. |
curr* | text | Required in case of new value entry, if placetype equals bank or cash. Valid currency code from CURRENCY. |
defplace | boolean | Boolean type, valid TRUE values: TRUE,true,T,t,Y,y,YES,yes,ON,on,1 or FALSE. Default value: FALSE. |
notes | text | |
inactive | boolean | Boolean type, valid TRUE values: TRUE,true,T,t,Y,y,YES,yes,ON,on,1 or FALSE. Default value: FALSE. |
additional data | by definition or text | Valid for any additional fieldname already defined
(in DEFFIELD) or insert_field params option will automatically
create it. The part after the ~ sign will be set in the notes (other data) field, the part before in the value field. If the same field name is used more times in an object the [fieldname~index]=[value~notes] format can be used to set the value. The "~index" and "~notes" section is optional and may be omitted. |
PRICE fieldname and type values:
Name | Type | Comment |
---|---|---|
partnumber* | text | Required. Valid product number value. |
pricetype* | text | Required. Valid values: price or discount. |
validfrom* | date | Required. Valid date format: YYYY-MM-DD |
curr | text | Valid currency code from CURRENCY. If not set, default currency. |
qty | real | Limit quantity. Default value: 0. |
validto | date | Valid date format: YYYY-MM-DD |
pricevalue | real | Price value, if type = price, or limit value, if type = discount. Default value: 0. |
discount | real | Discount value, if type = discount. |
calcmode | text | If type = discount. Valid values: all groupvalue from GROUPS, where groupname equal calcmode. |
vendorprice | boolean | Boolean type, valid TRUE values: TRUE,true,T,t,Y,y,YES,yes,ON,on,1 or FALSE. Default value: FALSE. |
additional data | by definition or text | Valid for any additional fieldname already defined
(in DEFFIELD) or insert_field params option will automatically
create it. The part after the ~ sign will be set in the notes (other data) field, the part before in the value field. If the same field name is used more times in an object the [fieldname~index]=[value~notes] format can be used to set the value. The "~index" and "~notes" section is optional and may be omitted. |
PRODUCT fieldname and type values:
Name | Type | Comment |
---|---|---|
partnumber* | text | Add new, if not set, the function retrieves the next value. |
description* | text | Required in case of new value entry. |
protype | text | Valid values: item, service. Default value: item. |
unit | text | Default value: default_unit. |
taxcode | text | Valid value: taxcode from TAX. Default value: default_taxcode. |
notes | text | |
webitem | boolean | Boolean type, valid TRUE values: TRUE,true,T,t,Y,y,YES,yes,ON,on,1 or FALSE. Default value: FALSE. |
inactive | boolean | Boolean type, valid TRUE values: TRUE,true,T,t,Y,y,YES,yes,ON,on,1 or FALSE. Default value: FALSE. |
additional data | by definition or text | Valid for any additional fieldname already defined
(in DEFFIELD) or insert_field params option will automatically
create it. The part after the ~ sign will be set in the notes (other data) field, the part before in the value field. If the same field name is used more times in an object the [fieldname~index]=[value~notes] format can be used to set the value. The "~index" and "~notes" section is optional and may be omitted. |
PROJECT fieldname and type values:
Name | Type | Comment |
---|---|---|
pronumber* | text | Add new, if not set, the function retrieves the next value. |
description* | text | Required in case of new value entry. |
custnumber | text | Valid value: custnumber from CUSTOMER. |
startdate | datetime | Valid date format: YYYY-MM-DD |
enddate | datetime | Valid date format: YYYY-MM-DD |
notes | text | |
inactive | boolean | Boolean type, valid TRUE values: TRUE,true,T,t,Y,y,YES,yes,ON,on,1 or FALSE. Default value: FALSE. |
additional data | by definition or text | Valid for any additional fieldname already defined
(in DEFFIELD) or insert_field params option will automatically
create it. The part after the ~ sign will be set in the notes (other data) field, the part before in the value field. If the same field name is used more times in an object the [fieldname~index]=[value~notes] format can be used to set the value. The "~index" and "~notes" section is optional and may be omitted. |
RATE fieldname and type values:
Name | Type | Comment |
---|---|---|
ratetype* | text | Valid values: all groupvalue from GROUPS, where groupname equal calcmode(rate, buy, sell, average). |
ratedate* | text | Valid date format: YYYY-MM-DD. |
curr* | text | Valid currency code from CURRENCY. |
planumber* | text | Valid planumber code from PLACE. |
rategroup | text | Valid values: all groupvalue from GROUPS, where groupname equal rategroup. |
ratevalue | real | Default value: 0. |
additional data | by definition or text | Valid for any additional fieldname already defined
(in DEFFIELD) or insert_field params option will automatically
create it. The part after the ~ sign will be set in the notes (other data) field, the part before in the value field. If the same field name is used more times in an object the [fieldname~index]=[value~notes] format can be used to set the value. The "~index" and "~notes" section is optional and may be omitted. |
TAX fieldname and type values:
Name | Type | Comment |
---|---|---|
taxcode* | text | Required. |
description* | text | Required in case of new value entry. |
rate | real | Default value: 0. |
inactive | boolean | Boolean type, valid TRUE values: TRUE,true,T,t,Y,y,YES,yes,ON,on,1 or FALSE. Default value: FALSE. |
additional data | by definition or text | Valid for any additional fieldname already defined
(in DEFFIELD) or insert_field params option will automatically
create it. The part after the ~ sign will be set in the notes (other data) field, the part before in the value field. If the same field name is used more times in an object the [fieldname~index]=[value~notes] format can be used to set the value. The "~index" and "~notes" section is optional and may be omitted. |
TOOL fieldname and type values:
Name | Type | Comment |
---|---|---|
serial* | text | |
description | text | |
partnumber* | text | Required in case of new value entry.Valid partnumber code from PRODUCT. |
toolgroup | text | Valid values: all groupvalue from GROUPS, where groupname equal toolgroup. |
notes | text | |
inactive | boolean | Boolean type, valid TRUE values: TRUE,true,T,t,Y,y,YES,yes,ON,on,1 or FALSE. Default value: FALSE. |
additional data | by definition or text | Valid for any additional fieldname already defined
(in DEFFIELD) or insert_field params option will automatically
create it. The part after the ~ sign will be set in the notes (other data) field, the part before in the value field. If the same field name is used more times in an object the [fieldname~index]=[value~notes] format can be used to set the value. The "~index" and "~notes" section is optional and may be omitted. |
TRANS fieldname and type values:
Name | Type | Comment |
---|---|---|
transnumber* | text | Add new, if not set, the function retrieves the next value. |
transtype* | text | Required in case of new value entry, or readonly. Valid values: all groupvalue from GROUPS, where groupname equals transtype. |
direction* | text | Required in case of new value entry, or readonly. Valid values: in, out, transfer. |
ref_transnumber | text | Read only: customer invoice, vendor invoice, receipt. Other: any ref. value |
crdate | date | Created date. Valid date format: YYYY-MM-DD. Default value: current date. |
transdate | date | Transaction date or startdate(rent, worksheet). Valid date format: YYYY-MM-DD. Default value: current date. |
duedate | datetime | Due date(invoice), validity date(offer), shipping date(order) or enddate(rent, worksheet). Valid datetime format: YYYY-MM-DD HH:MM:SS. Not used: inventory |
custnumber* | text | Required in case of new value entry, exception: receipt. Valid values: custnumber (CUSTOMER). |
empnumber | text | Valid values: empnumber (EMPLOYEE) |
department | text | Valid values: all groupvalue from GROUPS, where groupname equal department. |
pronumber | text | Valid values: pronumber (PROJECT). |
planumber | text | Valid planumber (PLACE). |
paidtype | text | Valid values: all groupvalue from GROUPS, where groupname equal paidtype. If not set, default paidtype. |
curr | text | Valid currency code from CURRENCY. If not set, default currency. Not used: invoice_stock. |
notax | boolean | Boolean type, valid TRUE values: TRUE,true,T,t,Y,y,YES,yes,ON,on,1 or FALSE. Default value: FALSE. Not used: invoice_stock. |
paid | boolean | Boolean type, valid TRUE values: TRUE,true,T,t,Y,y,YES,yes,ON,on,1 or FALSE. Default value: FALSE. Not used: invoice_stock. |
acrate | real | Accounting rate. Default value: 0. Not used: invoice_stock. |
notes | text | |
intnotes | text | |
fnote | text | |
transstate | text | Valid values: all groupvalue from GROUPS, where groupname equal transstate. Default value: ok |
closed | boolean | Boolean type, valid TRUE values: TRUE,true,T,t,Y,y,YES,yes,ON,on,1 or FALSE. Default value: FALSE. |
username | text | Read only |
additional data | by definition or text | Valid for any additional fieldname already defined
(in DEFFIELD) or insert_field params option will automatically
create it. The part after the ~ sign will be set in the notes (other data) field, the part before in the value field. If the same field name is used more times in an object the [fieldname~index]=[value~notes] format can be used to set the value. The "~index" and "~notes" section is optional and may be omitted. |