Skip to main content

Nervatura gRPC API

Nervatura gRPC specification. For more examples, see

Method NameRequest TypeResponse TypeDescription
UserLoginRequestUserLoginResponseUserLoginLogs in user by username and password
UserPasswordRequestUserPasswordResponseEmptyUser (employee or customer) password change.
TokenLoginRequestEmptyResponseTokenLoginJWT token auth.
TokenRefreshRequestEmptyResponseTokenRefreshRefreshes JWT token by checking at database whether refresh token exists.
TokenDecodeRequestTokenDecodeResponseTokenDecodeDecoded JWT token but doesn't validate the signature.
GetRequestGetResponseGetGet returns one or more records
UpdateRequestUpdateResponseUpdateAdd/update one or more items
DeleteRequestDeleteResponseEmptyDelete an item
ViewRequestViewResponseViewRun raw SQL queries in safe mode
FunctionRequestFunctionResponseFunctionCall a server-side function
ReportRequestReportResponseReportCreate and download a Nervatura Report
ReportListRequestReportListResponseReportListList all available Nervatura Report. Admin user group membership required.
ReportInstallRequestReportInstallResponseReportInstallInstall a report to the database. Admin user group membership required.
ReportDeleteRequestReportDeleteResponseEmptyDelete a report from the database. Admin user group membership required.
DatabaseCreateRequestDatabaseCreateResponseDatabaseCreateCreate a new Nervatura database


Table of Contents



Messages

Address#

RequestUpdate Key->ID keys:

  • id: Value is a generated unique key identifier: {nervatype}/{refnumber}~{rownumber}. The rownumber is the order of multiple {nervatype}/{refnumber} keys. For example: customer/DMCUST/00001~1

  • nervatype: Valid values: customer, employee, event, place, product, project, tool, trans

  • ref_id: Valid values: customer/{custnumber}, employee/{empnumber}, event/{calnumber}, place/{planumber}, product/{partnumber}, project/{pronumber}, tool/{serial}, trans/{transnumber}

FieldTypeDescription
id int64
nervatype int64Reference to Groups.id (only where groupname = 'nervatype')
ref_id int64Reference to Customer.id, Employee.id, Event.id, Place.id, Product.id, Project.id, Tool.id, Trans.id
country string
state string
zipcode string
city string
street string
notes string
metadatarepeated MetaDataAddress meta data

Barcode#

RequestUpdate Key->ID keys:

  • id: Barcode code

  • barcodetype: Valid values: CODE_128, CODE_39, EAN_13, EAN_8, QR

  • product_id: Product partnumber

FieldTypeDescription
id int64
code stringEach product can be connected to any number of bar codes, but the code must remain unique to ensure that the product is clearly identifiable.
product_id int64Reference to Product.id
description stringComment related to the barcode. Informal, has no role in identification.
barcodetype int64Reference to Groups.id (only where groupname = 'barcodetype').
qty doubleThe actual amount of the products identified by the barcode. For example can be used for packaged goods, tray packaging.
defcode boolIf more than one bar code is assigned, this will be the default. Because of the uniqueness of the barcode the product is always clearly identifiable, but in reverse case (eg. in case the barcode should be printed on a document) we must assign one being the default for that product.

Contact#

RequestUpdate Key->ID keys:

  • id: The value is a generated constant key identifier: {nervatype}/{refnumber}~{rownumber}. The rownumber is the order of multiple {nervatype}/{refnumber} keys.

  • nervatype: Valid values: customer, employee, event, place, product, project, tool, trans

  • ref_id: Valid values: customer/{custnumber}, employee/{empnumber}, event/{calnumber}, place/{planumber}, product/{partnumber}, project/{pronumber}, tool/{serial}, trans/{transnumber}

FieldTypeDescription
id int64
nervatype int64Reference to Groups.id (only where groupname = 'nervatype')
ref_id int64Reference to Customer.id, Employee.id, Event.id, Place.id, Product.id, Project.id, Tool.id, Trans.id
firstname string
surname string
status string
phone string
fax string
mobil string
email string
notes string
metadatarepeated MetaDataContact meta data

Currency#

RequestUpdate Key->ID keys:

  • id: Currency curr
FieldTypeDescription
id int64
curr stringThe ISO 4217 code of the currency.
description stringThe name of the currency.
digit int64The number of decimal places used for recording and rounding by the program. Default: 2
defrate doubleDefault Rate. You can specify an exchange rate vs. the default currency, which will be used by the reports.
cround int64Rounding value for cash. Could be used in case the smallest banknote in circulation for that certain currency is not 1.
metadatarepeated MetaDataCurrency meta data

Customer#

RequestUpdate Key->ID keys:

  • id: Customer custnumber

  • custtype: Valid values: own, company, private, other

FieldTypeDescription
id int64
custtype int64Reference to Groups.id (only where groupname = 'custtype')
custnumber stringUnique ID. If you set it to numberdef, it will be generated at the first data save. The format and value of the next data in row is taken from the numberdef (numberkey = custnumber) data series.
custname stringFull name of the customer
taxnumber string
account string
notax boolTax-free
terms int64Payment per.
creditlimit doubleCustomer's credit limit. Data is used by financial reports.
discount doubleIf new product line is added (offer, order, invoice etc.) all products will receive the discount percentage specified in this field. If the product has a separate customer price, the value specified here will not be considered by the program.
notes string
inactive bool
metadatarepeated MetaDataCustomer meta data

Deffield#

RequestUpdate Key->ID keys:

  • id: Deffield fieldname

  • nervatype: Valid values: address, barcode, contact, currency, customer, employee, event, item, link, log, movement, payment, price, place, product, project, rate, tax, tool, trans, setting

  • subtype: All groupvalue from Groups, where groupname equal custtype, placetype, protype, toolgroup, transtype

  • fieldtype: Valid values: bool, date, time, float, integer, string, valuelist, notes, urlink, password, customer, tool, transitem, transmovement, transpayment, product, project, employee, place

FieldTypeDescription
id int64
fieldname string
nervatype int64Reference to Groups.id (only where groupname = 'nervatype')
oneof _subtype.subtypeoptional int64Reference to Groups.id (where groupname in ('custtype','placetype',' protype','toolgroup','transtype'))
fieldtype int64Reference to Groups.id (only where groupname = 'fieldtype')
description string
valuelist stringIf fieldtype=valuelist: valid values are listed, separated by ~
addnew boolWhen selected, the attribute in case of adding a new element (eg a new customer or employee is created) will automatically be created with the default value according to its type and also will be attached to the new element.
visible boolCan appear or not (hidden value) on the entry forms
readonly boolThe value of the attribute can not be changed in the program interface

Employee#

RequestUpdate Key->ID keys:

  • id: Employee empnumber

  • usergroup: All groupvalue from Groups, where groupname equal usergroup

  • department: All groupvalue from Groups, where groupname equal department

FieldTypeDescription
id int64
empnumber stringUnique ID. If you set it to numberdef, it will be generated at the first data save. The format and value of the next data in row is taken from the numberdef (numberkey = empnumber) data series.
oneof _username.usernameoptional stringDatabase login name. Should be unique on database level.
usergroup int64Reference to Groups.id (only where groupname = 'usergroup')
oneof _startdate.startdateoptional string
oneof _enddate.enddateoptional string
oneof _department.departmentoptional int64Reference to Groups.id (only where groupname = 'department')
registration_key string
inactive bool
metadatarepeated MetaDataEmployee meta data

Event#

RequestUpdate Key->ID keys:

  • id: Event calnumber

  • nervatype: Valid values: customer, employee, place, product, project, tool, trans

  • ref_id: Valid values: customer/{custnumber}, employee/{empnumber}, place/{planumber}, product/{partnumber}, project/{pronumber}, tool/{serial}, trans/{transnumber}

  • eventgroup: All groupvalue from Groups, where groupname equal eventgroup

FieldTypeDescription
id int64
calnumber stringUnique ID. If you set it to numberdef, it will be generated at the first data save. The format and value of the next data in row is taken from the numberdef (numberkey = calnumber) data series.
nervatype int64Reference to Groups.id (only where groupname = 'nervatype')
ref_id int64Reference to Customer.id, Employee.id, Place.id, Product.id, Project.id, Tool.id, Trans.id
uid string
oneof _eventgroup.eventgroupoptional int64Reference to Groups.id (only where groupname = 'eventgroup')
fromdate stringDatetime
oneof _todate.todateoptional stringDatetime
subject string
place string
description string
metadatarepeated MetaDataEvent meta data

Fieldvalue#

RequestUpdate Key->ID keys:

  • id: The value is a generated constant key identifier: {refnumber}~~{fieldname}~{rownumber}. The rownumber is the order of multiple {refnumber}~~{fieldname} keys.

  • ref_id: Valid values: {nervatype}/{refnumber}

FieldTypeDescription
id int64
fieldname stringReference to Deffield.fieldname.
oneof _ref_id.ref_idoptional int64Reference to any type.id where type = Deffield.nervatype. If it is null then nervatype = setting.
value string
notes string

Groups#

RequestUpdate Key->ID keys:

  • id: Group groupname~groupvalue
FieldTypeDescription
id int64
groupname string
groupvalue string
description string
inactive bool

Item#

RequestUpdate Key->ID keys:

  • id: Trans and Item transnumber~rownumber

  • trans_id: Trans transnumber

  • product_id: Product partnumber

  • tax_id: Tax taxcode

FieldTypeDescription
id int64
trans_id int64Reference to trans.id
product_id int64Reference to product.id
unit string
qty double
fxprice double
netamount double
discount double
tax_id int64Reference to Tax.id
vatamount double
amount double
description string
deposit bool
ownstock double
actionprice bool
metadatarepeated MetaDataItem meta data

Link#

RequestUpdate Key->ID keys:

  • id: {nervatype_1}~{refnumber_1}~~{nervatype_2}~{refnumber_2}

  • nervatype_1: All groupvalue from Groups, where groupname equal nervatype

  • ref_id_1: {nervatype_1}/{refnumber_1}

  • nervatype_2: All groupvalue from Groups, where groupname equal nervatype

FieldTypeDescription
id int64
nervatype_1 int64Reference to Groups.id (only where groupname = 'nervatype')
ref_id_1 int64Reference to {nervatype}.id
nervatype_2 int64Reference to Groups.id (only where groupname = 'nervatype')
ref_id_2 int64Reference to {nervatype}.id
metadatarepeated MetaDataLink meta data

Log#

RequestUpdate Key->ID keys:

  • id: {empnumber}~{crdate}'

  • employee_id: Employee empnumber

  • ref_id: {nervatype}/{refnumber}

  • nervatype: All groupvalue from Groups, where groupname equal nervatype

  • logstate: Valid values: update, closed, deleted, print, login, logout

FieldTypeDescription
id int64
employee_id int64Reference to Employee.id
crdate stringDate-time
oneof _nervatype.nervatypeoptional int64Reference to Groups.id (only where groupname = 'nervatype')
oneof _ref_id.ref_idoptional int64Reference to {nervatype}.id
logstate int64Reference to Groups.id (only where groupname = 'logstate')
metadatarepeated MetaDataLog meta data

MetaData#

FieldTypeDescription
id int64
fieldname stringReference to Deffield.fieldname.
fieldtype stringReference to Deffield.fieldtype.
value string
notes string

Movement#

RequestUpdate Key->ID keys:

  • id: Trans and Item transnumber~rownumber

  • trans_id: Trans transnumber

  • product_id: Product partnumber

  • movetype: Valid values: inventory, tool, plan, head

  • tool_id: Tool serial

  • place_id: Place planumber

FieldTypeDescription
id int64
trans_id int64Reference to Trans.id
shippingdate stringDate-time
movetype int64Reference to Groups.id (only where groupname = 'movetype')
oneof _product_id.product_idoptional int64Reference to Product.id
oneof _tool_id.tool_idoptional int64Reference to Tool.id
oneof _place_id.place_idoptional int64Reference to Place.id
qty double
description string
shared bool
metadatarepeated MetaDataMovement meta data

Numberdef#

RequestUpdate Key->ID keys:

  • id: Numberdef numberkey
FieldTypeDescription
id int64
numberkey stringUnique key
prefix stringThe text prefix of the identifier. It can be any length, but usage of special characters, spaces in the text is not recommended.
curvalue int64The current status of the counter, the next sequence number will be one value higher than this one. It is possible to re-set the counter, but the uniqueness must be ensured in all cases!
isyear boolIf selected, the created identifier will contain the year.
sep stringThe separator character in the identifier. Default: "/"
len int64The value field is arranged in such length to the right and filled with zeros.
description string
visible bool
readonly bool
orderby int64

Pattern#

RequestUpdate Key->ID keys:

  • id: Pattern description
FieldTypeDescription
id int64
description string
transtype int64Reference to Groups.id (only where groupname = 'transtype')
notes string
defpattern bool

Payment#

RequestUpdate Key->ID keys:

  • id: Trans and Item transnumber~rownumber

  • trans_id: Trans transnumber

FieldTypeDescription
id int64
trans_id int64Reference to Trans.id
paiddate string
amount double
notes string
metadatarepeated MetaDataPayment meta data

Place#

RequestUpdate Key->ID keys:

  • id: Place planumber

  • placetype: Valid values: bank, cash, warehouse, other

FieldTypeDescription
id int64
planumber stringUnique ID. If you set it to numberdef, it will be generated at the first data save. The format and value of the next data in row is taken from the numberdef (numberkey = planumber) data series.
placetype int64Reference to Groups.id (only where groupname = 'placetype')
description string
oneof _curr.curroptional string
defplace bool
notes string
inactive bool
metadatarepeated MetaDataPlace meta data

Price#

RequestUpdate Key->ID keys:

  • id: Price partnumber~validfrom~curr~qty

  • product_id: Product partnumber

FieldTypeDescription
id int64
product_id int64Reference to Product.id
validfrom stringStart of validity, mandatory data.
oneof _validto.validtooptional stringEnd of validity, can be left empty.
curr string
qty doublePrice ranges can also be specified, thus different price can be set for a smaller and bigger quantity of the same product. The quantity should be used as the lower threshold, ie. this should be the minimum quantity for the price set.
pricevalue doublePrice value
vendorprice boolSupplier (if marked) or customer price. By default the customer price.
metadatarepeated MetaDataPrice meta data

Product#

RequestUpdate Key->ID keys:

  • id: Product partnumber

  • protype: Valid values: item, service

  • tax_id: Tax taxcode

FieldTypeDescription
id int64
partnumber stringUnique ID. If you set it to numberdef, it will be generated at the first data save. The format and value of the next data in row is taken from the numberdef (numberkey = partnumber) data series.
protype int64Reference to Groups.id (only where groupname = 'protype')
description stringThe full name of the product or short description.
unit string
tax_id int64Reference to Tax.id
notes string
webitem bool
inactive bool
metadatarepeated MetaDataProduct meta data

Project#

RequestUpdate Key->ID keys:

  • id: Project pronumber

  • customer_id: Tax custnumber

FieldTypeDescription
id int64
pronumber stringUnique ID. If you set it to numberdef, it will be generated at the first data save. The format and value of the next data in row is taken from the numberdef (numberkey = pronumber) data series.
description stringThe name of the project.
oneof _customer_id.customer_idoptional int64Reference to Customer.id
oneof _startdate.startdateoptional string
oneof _enddate.enddateoptional string
notes string
inactive bool
metadatarepeated MetaDataProject meta data

Rate#

RequestUpdate Key->ID keys:

  • id: Rate ratetype~ratedate~curr~planumber

  • place_id: Place planumber

  • ratetype: Valid values: rate, buy, sell,average

  • rategroup: all groupvalue from Groups, where groupname equal rategroup

FieldTypeDescription
id int64
ratetype int64Reference to Groups.id (only where groupname = 'ratetype')
ratedate string
curr string
oneof _place_id.place_idoptional int64Reference to Place.id
oneof _rategroup.rategroupoptional int64Reference to Groups.id (only where groupname = 'rategroup')
ratevalue doubleRate or interest value
metadatarepeated MetaDataRate meta data

RequestDatabaseCreate#

New database props.

FieldTypeDescription
alias stringAlias name of the database
demo boolCreate a DEMO database

RequestDelete#

Delete parameters

FieldTypeDescription
nervatype DataType
id int64The object ID
key stringUse Key instead of ID

RequestEmpty#

No parameters

RequestFunction#

FieldTypeDescription
key stringServer function name
valuesmap RequestFunction.ValuesEntryThe array of parameter values

RequestFunction.ValuesEntry#

FieldTypeDescription
key string
value Value

RequestGet#

FieldTypeDescription
nervatype DataType
metadata bool
idsrepeated int64
filterrepeated string

RequestReport#

FieldTypeDescription
reportkey stringExample : ntr_invoice_en
orientation ReportOrientation
size ReportSize
output ReportOutput
type ReportType
refnumber stringExample : DMINV/00001
template stringCustom report JSON template
filtersmap RequestReport.FiltersEntry

RequestReport.FiltersEntry#

FieldTypeDescription
key string
value Value

RequestReportDelete#

FieldTypeDescription
reportkey stringExample : ntr_invoice_en

RequestReportInstall#

Admin user group membership required.

FieldTypeDescription
reportkey stringExample : ntr_invoice_en

RequestReportList#

FieldTypeDescription
label string

RequestTokenDecode#

FieldTypeDescription
value stringAccess token code.

RequestUpdate#

FieldTypeDescription
nervatype DataType
itemsrepeated RequestUpdate.Item

RequestUpdate.Item#

FieldTypeDescription
valuesmap RequestUpdate.Item.ValuesEntry
keysmap RequestUpdate.Item.KeysEntry

RequestUpdate.Item.KeysEntry#

FieldTypeDescription
key string
value Value

RequestUpdate.Item.ValuesEntry#

FieldTypeDescription
key string
value Value

RequestUserLogin#

FieldTypeDescription
username stringEmployee username or Customer custnumber (email or phone number)
password string
database stringOptional. Default value: NT_DEFAULT_ALIAS

RequestUserPassword#

FieldTypeDescription
password stringNew password
confirm stringNew password confirmation
username stringOptional. Only if different from the logged in user. Admin user group membership required.
custnumber stringOptional. Only if different from the logged in user. Admin user group membership required.

RequestView#

Only "select" queries and functions can be executed. Changes to the data are not saved in the database.

FieldTypeDescription
optionsrepeated RequestView.QueryThe array of Query object

RequestView.Query#

FieldTypeDescription
key stringGive the query a unique name
text stringThe SQL query as a string
valuesrepeated ValueThe array of parameter values

ResponseDatabaseCreate#

Result log data

FieldTypeDescription
details ResponseRows

ResponseEmpty#

Does not return content.

ResponseFunction#

FieldTypeDescription
value bytes

ResponseGet#

FieldTypeDescription
valuesrepeated ResponseGet.Value

ResponseGet.Value#

FieldTypeDescription
oneof value.address Address
oneof value.barcode Barcode
oneof value.contact Contact
oneof value.currency Currency
oneof value.customer Customer
oneof value.deffield Deffield
oneof value.employee Employee
oneof value.event Event
oneof value.fieldvalue Fieldvalue
oneof value.groups Groups
oneof value.item Item
oneof value.link Link
oneof value.log Log
oneof value.movement Movement
oneof value.numberdef Numberdef
oneof value.pattern Pattern
oneof value.payment Payment
oneof value.place Place
oneof value.price Price
oneof value.product Product
oneof value.project Project
oneof value.rate Rate
oneof value.tax Tax
oneof value.tool Tool
oneof value.trans Trans
oneof value.ui_audit UiAudit
oneof value.ui_menu UiMenu
oneof value.ui_menufields UiMenufields
oneof value.ui_message UiMessage
oneof value.ui_printqueue UiPrintqueue
oneof value.ui_report UiReport
oneof value.ui_userconfig UiUserconfig

ResponseReport#

FieldTypeDescription
value bytes

ResponseReportInstall#

FieldTypeDescription
id int64Returns a new report ID.

ResponseReportList#

Returns all installable files from the NT_REPORT_DIR directory (empty value: all available built-in Nervatura Reports)

FieldTypeDescription
itemsrepeated ResponseReportList.Info

ResponseReportList.Info#

FieldTypeDescription
reportkey string
repname string
description string
label string
reptype string
filename string
installed bool

ResponseRows#

FieldTypeDescription
itemsrepeated ResponseRows.Item

ResponseRows.Item#

FieldTypeDescription
valuesmap ResponseRows.Item.ValuesEntry

ResponseRows.Item.ValuesEntry#

FieldTypeDescription
key string
value Value

ResponseTokenDecode#

Access token claims.

FieldTypeDescription
username string
database string
exp doubleJWT expiration time
iss string

ResponseTokenLogin#

Token user properties

FieldTypeDescription
id int64
username string
empnumber string
usergroup int64
scope string
department string

ResponseTokenRefresh#

FieldTypeDescription
value stringAccess token code.

ResponseUpdate#

If the ID (or Key) value is missing, it creates a new item.

FieldTypeDescription
valuesrepeated int64Returns the all new/updated IDs values.

ResponseUserLogin#

FieldTypeDescription
token stringAccess JWT token
engine stringType of database
version stringService version

ResponseView#

FieldTypeDescription
valuesmap ResponseView.ValuesEntrykey - results map

ResponseView.ValuesEntry#

FieldTypeDescription
key string
value ResponseRows

Tax#

RequestUpdate Key->ID keys:

  • id: Tax taxcode
FieldTypeDescription
id int64
taxcode stringUnique ID.
description string
rate doubleRate or interest value
inactive bool
metadatarepeated MetaDataTax meta data

Tool#

RequestUpdate Key->ID keys:

  • id: Tool serial

  • toolgroup: all groupvalue from Groups, where groupname equal toolgroup

  • product_id: Product partnumber

FieldTypeDescription
id int64
serial stringUnique ID. If you set it to numberdef, it will be generated at the first data save. The format and value of the next data in row is taken from the numberdef (numberkey = serial) data series.
description string
product_id int64Reference to Product.id
oneof _toolgroup.toolgroupoptional int64Reference to Groups.id (only where groupname = 'toolgroup')
notes string
inactive bool
metadatarepeated MetaDataTool meta data

Trans#

RequestUpdate Key->ID keys:

  • id: Trans transnumber

  • transtype: all groupvalue from Groups, where groupname equal transtype

  • direction: Valid values in, out, transfer

  • customer_id: Customer custnumber

  • employee_id: Employee empnumber

  • department: all groupvalue from Groups, where groupname equal department

  • project_id: Project pronumber

  • place_id: Place planumber

  • paidtype: all groupvalue from Groups, where groupname equal paidtype

  • transtate: all groupvalue from Groups, where groupname equal transtate

FieldTypeDescription
id int64
transnumber stringUnique ID. If you set it to numberdef, it will be generated at the first data save. The format and value of the next data in row is taken from the numberdef (numberkey = transnumber) data series.
transtype int64Reference to Groups.id (only where groupname = 'transtype')Groups.id
direction int64Reference to Groups.id (only where groupname = 'direction')
oneof _ref_transnumber.ref_transnumberoptional string
crdate string
transdate string
oneof _duedate.duedateoptional stringDate-time
oneof _customer_id.customer_idoptional int64Reference to Customer.id
oneof _employee_id.employee_idoptional int64Reference to Employee.id
oneof _department.departmentoptional int64Reference to Groups.id (only where groupname = 'department')
oneof _project_id.project_idoptional int64Reference to Project.id
oneof _place_id.place_idoptional int64Reference to Place.id
oneof _paidtype.paidtypeoptional int64Reference to Groups.id (only where groupname = 'paidtype')
oneof _curr.curroptional string
notax bool
paid bool
acrate double
notes string
intnotes string
fnote string
transtate int64Reference to Groups.id (only where groupname = 'transtate')
closed bool
metadatarepeated MetaDataTrans meta data

UiAudit#

RequestUpdate Key->ID keys:

  • id: UiAudit {usergroup}~{nervatype}~{transtype}

  • usergroup: all groupvalue from Groups, where groupname equal usergroup

  • nervatype: all groupvalue from Groups, where groupname equal nervatype

  • subtype: all groupvalue from Groups, where groupname equal transtype, movetype, protype, custtype, placetype

  • inputfilter: Valid values disabled, readonly, update, all

FieldTypeDescription
id int64
usergroup int64Reference to Groups.id (only where groupname = 'usergroup')
nervatype int64Reference to Groups.id (only where groupname = 'nervatype')
oneof _subtype.subtypeoptional int64Reference to Groups.id (only where groupname = 'movetype')
inputfilter int64Reference to Groups.id (only where groupname = 'inputfilter')
supervisor bool

UiMenu#

RequestUpdate Key->ID keys:

  • id: UiMenu menukey
FieldTypeDescription
id int64
menukey string
description string
modul string
icon string
method int64Reference to Groups.id (only where groupname = 'method')
funcname string
address string

UiMenufields#

RequestUpdate Key->ID keys:

  • id: UiMenufields {menukey}~{fieldname}

  • menu_id: UiMenu menukey

FieldTypeDescription
id int64
menu_id int64Reference to UiMenu.id
fieldname string
description string
fieldtype int64Reference to Groups.id (only where groupname = 'fieldtype')
orderby int64

UiMessage#

RequestUpdate Key->ID keys:

  • id: UiMessage {secname}~{fieldname}~{lang}
FieldTypeDescription
id int64
secname string
fieldname string
lang string
msg string

UiPrintqueue#

FieldTypeDescription
id int64
oneof _nervatype.nervatypeoptional int64Reference to Groups.id (only where groupname = 'nervatype')
ref_id int64Reference to {nervatype}.id
qty double
oneof _employee_id.employee_idoptional int64Reference to Employee.id
report_id int64Reference to UiReport.id
crdate stringDate-time

UiReport#

RequestUpdate Key->ID keys:

  • id: UiReport reportkey

  • nervatype: all groupvalue from Groups, where groupname equal nervatype

  • transtype: all groupvalue from Groups, where groupname equal transtype

  • direction: all groupvalue from Groups, where groupname equal direction

  • filetype: all groupvalue from Groups, where groupname equal filetype

FieldTypeDescription
id int64
reportkey string
nervatype int64Reference to Groups.id (only where groupname = 'nervatype')
oneof _transtype.transtypeoptional int64Reference to Groups.id (only where groupname = 'transtype')
oneof _direction.directionoptional int64Reference to Groups.id (only where groupname = 'direction')
repname string
description string
label string
filetype int64Reference to Groups.id (only where groupname = 'filetype')
report string

UiUserconfig#

RequestUpdate Key->ID keys:

  • id: {empnumber}~{section}~{cfgroup}~{cfname}

  • employee_id: Employee {empnumber}

FieldTypeDescription
id int64
oneof _employee_id.employee_idoptional int64Reference to Employee.id
oneof _section.sectionoptional string
cfgroup string
cfname string
oneof _cfvalue.cfvalueoptional string
orderby int64

Value#

FieldTypeDescription
oneof value.boolean bool
oneof value.number double
oneof value.text stringgoogle.protobuf.NullValue null = 4;


Enums

DataType#

NameNumberDescription
address0Address
barcode1Barcode
contact2Contact
currency3Currency
customer4Customer
deffield5Deffield
employee6Employee
event7Event
fieldvalue8Fieldvalue
groups9Groups
item10Item
link11Link
log12Log
movement13Movement
numberdef14Numberdef
pattern15Pattern
payment16Payment
place17Place
price18Price
product19Product
project20Project
rate21Rate
tax22Tax
tool23Tool
trans24Trans
ui_audit25UiAudit
ui_menu26UiMenu
ui_menufields27UiMenufields
ui_message28UiMessage
ui_printqueue29UiPrintqueue
ui_report30UiReport
ui_userconfig31UiUserconfig

ReportOrientation#

NameNumberDescription
portrait0
landscape1

ReportOutput#

NameNumberDescription
auto0
xml1
data2
base643

ReportSize#

NameNumberDescription
a30
a41
a52
letter3
legal4

ReportType#

NameNumberDescription
report_none0
report_customer1
report_employee2
report_event3
report_place4
report_product5
report_project6
report_tool7
report_trans8


Scalar Value Types

.proto TypeNotesC++ TypeJava TypePython Type
doubledoubledoublefloat
int64Uses variable-length encodingint64longint/long
boolboolbooleanboolean
stringA string must always contain UTF-8 encoded or 7-bit ASCII text.stringStringstr/unicode
bytesMay contain any arbitrary sequence of bytes.stringByteStringstr