Nervatura Service

gRPC API

An earlier version of the gRPC API (v5) documentation is available here.

gRPCurl examples

List all the methods of nervatura.API service:

grpcurl -plaintext localhost:9200 list nervatura.API

Login to the demo database and get a token:

grpcurl -d '{"userName":"admin","password":"","database":"demo"}' \
  -plaintext localhost:9200 nervatura.API/AuthLogin

Get customer data by code and result login token:

grpcurl -H 'x-api-key: TEST_API_KEY' \
  -d '{"code":"CUS0000000000N2"}' -plaintext \
  localhost:9200 nervatura.API/CustomerGet

API Services

Method Name Request Type Response Type
AuthLogin RequestAuthLogin ResponseAuthLogin
Login by username and password and get access token
AuthUpdate Auth Auth
Update or create user account. If id or existing code is set, the user is updated, otherwise a new user is created. If user is not admin, the user id and code are set to the current token user id or code
AuthGet RequestGet Auth
Get user account by database id or code (unique key) If user is not admin, the user id and code are set to the current token user id or code
AuthPassword RequestPasswordChange ResponseStatus
Change token user password
AuthPasswordReset RequestGet ResponseStatus
Reset a user password and result a new password If user is not admin, the user id and code are set to the current token user id or code
TokenLogin RequestEmpty Auth
Login by access token. Returns token user
TokenRefresh RequestEmpty ResponseAuthLogin
Refresh access token
TokenDecode RequestTokenDecode ResponseTokenDecode
Decode JWT access token but doesn't validate the signature
Database RequestDatabase JsonBytes
Create new nervatura database schema
Delete RequestDelete ResponseStatus
Delete data by database id or code (unique key) Only admin users can delete configurations except for CONFIG_PRINT_QUEUE and CONFIG_PATTERN Auth user cannot be deleted, only disabled by admin users
Function RequestFunction JsonBytes
Call a server side function and get the result Example: create new PDF invoice, send email or get a product price
View RequestView JsonBytes
Get a predefined view by name
ConfigUpdate Config Config
Update (replace) or create configuration If id or existing code is set, the configuration is updated, otherwise a new configuration is created. Only admin users can create or update configurations except for CONFIG_PRINT_QUEUE and CONFIG_PATTERN
ConfigGet RequestGet Config
Get configuration by database id or code (unique key)
ConfigQuery RequestQuery Configs
Get configurations by query parameters Valid filters: config_type
CurrencyUpdate Currency Currency
Update (replace) or create currency If id or existing code is set, the currency is updated, otherwise a new currency is created.
CurrencyGet RequestGet Currency
Get currency by database id or code (unique key)
CurrencyQuery RequestQuery Currencies
Get currencies by query parameters Valid filters: tag
CustomerUpdate Customer Customer
Update (replace) or create customer If id or existing code is set, the customer is updated, otherwise a new customer is created.
CustomerGet RequestGet Customer
Get customer by database id or code (unique key)
CustomerQuery RequestQuery Customers
Get customers by query parameters Valid filters: customer_type, customer_name, tag
EmployeeUpdate Employee Employee
Update (replace) or create employee If id or existing code is set, the employee is updated, otherwise a new employee is created.
EmployeeGet RequestGet Employee
Get employee by database id or code (unique key)
EmployeeQuery RequestQuery Employees
Get employees by query parameters Valid filters: tag
ItemUpdate Item Item
Update (replace) or create item If id or existing code is set, the item is updated, otherwise a new item is created.
ItemGet RequestGet Item
Get item by database id or code (unique key)
ItemQuery RequestQuery Items
Get items by query parameters Valid filters: trans_code, product_code, tag
LinkUpdate Link Link
Update (replace) or create link If id or existing code is set, the link is updated, otherwise a new link is created.
LinkGet RequestGet Link
Get link by database id or code (unique key)
LinkQuery RequestQuery Links
Get links by query parameters Valid filters: link_type_1, link_code_1, link_type_2, link_code_2, tag
LogGet RequestGet Log
Get log by database id or code (unique key)
LogQuery RequestQuery Logs
Get logs by query parameters Valid filters: log_type, ref_type, ref_code, tag
MovementUpdate Movement Movement
Update (replace) or create movement If id or existing code is set, the movement is updated, otherwise a new movement is created.
MovementGet RequestGet Movement
Get movement by database id or code (unique key)
MovementQuery RequestQuery Movements
Get movements by query parameters Valid filters: trans_code, movement_type, tag
PaymentUpdate Payment Payment
Update (replace) or create payment If id or existing code is set, the payment is updated, otherwise a new payment is created.
PaymentGet RequestGet Payment
Get payment by database id or code (unique key)
PaymentQuery RequestQuery Payments
Get payments by query parameters Valid filters: trans_code, paid_date, tag
PlaceUpdate Place Place
Update (replace) or create place If id or existing code is set, the place is updated, otherwise a new place is created.
PlaceGet RequestGet Place
Get place by database id or code (unique key)
PlaceQuery RequestQuery Places
Get places by query parameters Valid filters: place_type, place_name, tag
PriceUpdate Price Price
Update (replace) or create price If id or existing code is set, the price is updated, otherwise a new price is created.
PriceGet RequestGet Price
Get price by database id or code (unique key)
PriceQuery RequestQuery Prices
Get prices by query parameters Valid filters: price_type, product_code, currency_code, customer_code, tag
ProductUpdate Product Product
Update (replace) or create product If id or existing code is set, the product is updated, otherwise a new product is created.
ProductGet RequestGet Product
Get product by database id or code (unique key)
ProductQuery RequestQuery Products
Get products by query parameters Valid filters: product_type, product_name, tag
ProjectUpdate Project Project
Update (replace) or create project If id or existing code is set, the project is updated, otherwise a new project is created.
ProjectGet RequestGet Project
Get project by database id or code (unique key)
ProjectQuery RequestQuery Projects
Get projects by query parameters Valid filters: project_name, customer_code, tag
RateUpdate Rate Rate
Update (replace) or create rate If id or existing code is set, the rate is updated, otherwise a new rate is created.
RateGet RequestGet Rate
Get rate by database id or code (unique key)
RateQuery RequestQuery Rates
Get rates by query parameters Valid filters: rate_type, currency_code, tag
TaxUpdate Tax Tax
Update (replace) or create tax If id or existing code is set, the tax is updated, otherwise a new tax is created.
TaxGet RequestGet Tax
Get tax by database id or code (unique key)
TaxQuery RequestQuery Taxes
Get taxes by query parameters Valid filters: tag
ToolUpdate Tool Tool
Update (replace) or create tool If id or existing code is set, the tool is updated, otherwise a new tool is created.
ToolGet RequestGet Tool
Get tool by database id or code (unique key)
ToolQuery RequestQuery Tools
Get tools by query parameters Valid filters: product_code, description, tag
TransUpdate Trans Trans
Update (replace) or create transaction If id or existing code is set, the transaction is updated, otherwise a new transaction is created.
TransGet RequestGet Trans
Get transaction by database id or code (unique key)
TransQuery RequestQuery Transactions
Get transactions by query parameters Valid filters: trans_type, direction, trans_date, tag

Messages

Address

Field Type Description
country string
state string
zip_code string
city string
street string
notes string
tags string Additional tags for the address
address_map JsonString Flexible key-value map for additional metadata. The value is any json type.

Auth

Field Type Description
id int64 Database primary key Database dependent serial number type. Its value is unique only at table level and may change during data migrations.
code string Database independent unique external key. If not specified, it is generated on creation. It cannot be modified after creation. Example: USR1731101982N123 ("USR" + UNIX Time stamp + "N" + current ID)
user_name string * Required field. Friendly username, nickname or email for login. It can be changed, but it is a unique identifier at the database level.
user_group UserGroup * Required field. ENUM field. Default value: GROUP_USER
disabled bool
auth_meta AuthMeta
auth_map JsonString Flexible key-value map for additional metadata. The value is any json type.
time_stamp string Timestamp of data creation

AuthMeta

Field Type Description
tags string Additional tags for the user
bookmarks Bookmark

Bookmark

Field Type Description
bookmark_type BookmarkType ENUM field. Valid values: BROWSER, EDITOR
label string Label of the bookmark
key string Editor model or browser view name
code string Model code
filters JsonString Browser filters
columns Bookmark.ColumnsEntry Browser visible columns
time_stamp string Timestamp of data creation

Bookmark.ColumnsEntry

Field Type Description
key string
value bool

Config

Field Type Description
id int64 Database primary key Database dependent serial number type. Its value is unique only at table level and may change during data migrations.
code string Database independent unique external key. If not specified, it is generated on creation. It cannot be modified after creation. Example: CNF1731101982N123 ("CNF" + UNIX Time stamp + "N" + current ID)
config_type ConfigType * Required field. ENUM field.
map ConfigMap
shortcut ConfigShortcut
message ConfigMessage
pattern ConfigPattern
report ConfigReport
print_queue ConfigPrintQueue
config_data JsonString
time_stamp string Timestamp of data creation

ConfigMap

Field Type Description
field_name string
field_type FieldType ENUM field.
description string
tags string ENUM list if FieldType is ENUM ENUM field. Valid values: ADDRESS, BARCODE, CONTACT, CURRENCY, CUSTOMER, EMPLOYEE, EVENT, ITEM, MOVEMENT, PAYMENT, PLACE, PRICE, PRODUCT, PROJECT, RATE, TAX, TOOL, USER, TRANS, INVOICE, RECEIPT, ORDER, OFFER, WORKSHEET, RENT, DELIVERY, INVENTORY, WAYBILL, PRODUCTION, FORMULA, BANK, CASH
filter MapFilter ENUM list if FieldType is FILTER

ConfigMessage

Field Type Description
section string
key string
lang string
value string

ConfigPattern

Field Type Description
trans_type TransType ENUM field.
description string
notes string
default_pattern bool

ConfigPrintQueue

Field Type Description
ref_type string
ref_code string
qty int64
report_code string
auth_code string
time_stamp string

ConfigReport

Field Type Description
report_key string
report_type string
trans_type TransType ENUM field.
direction Direction ENUM field.
file_type FileType ENUM field.
report_name string
description string
label string
template string

ConfigShortcut

Field Type Description
shortcut_key string
description string
modul string
icon string
method ShortcutMethod ENUM field.
funcname string
address string
fields ConfigShortcutField

ConfigShortcutField

Field Type Description
field_name string
description string
field_type ShortcutField ENUM field.
order int64

Configs

Field Type Description
data Config

Contact

Field Type Description
first_name string
surname string
status string
phone string
mobile string
email string
notes string
tags string Additional tags for the contact
contact_map JsonString Flexible key-value map for additional metadata. The value is any json type.

Currencies

Field Type Description
data Currency

Currency

Field Type Description
id int64 Database primary key Database dependent serial number type. Its value is unique only at table level and may change during data migrations.
code string * Required field. The ISO 4217 code of the currency. It cannot be modified after creation.
currency_meta CurrencyMeta
currency_map JsonString Flexible key-value map for additional metadata. The value is any json type.
time_stamp string Timestamp of data creation

CurrencyMeta

Field Type Description
description string The name of the currency.
digit int64 The number of decimal places used for recording and rounding by the program.
cash_round int64 Rounding value for cash. Could be used in case the smallest banknote in circulation for that certain currency is not 1.
tags string Additional tags for the currency

Customer

Field Type Description
id int64 Database primary key Database dependent serial number type. Its value is unique only at table level and may change during data migrations.
code string Database independent unique external key. If not specified, it is generated on creation. It cannot be modified after creation. Example: CUS1731101982N123 ("CUS" + UNIX Time stamp + "N" + current ID)
customer_type CustomerType * Required field. ENUM field. Default value: CUSTOMER_COMPANY
customer_name string * Required field. Full name of the customer
addresses Address
contacts Contact
events Event
customer_meta CustomerMeta
customer_map JsonString Flexible key-value map for additional metadata. The value is any json type.
time_stamp string Timestamp of data creation

CustomerMeta

Field Type Description
tax_number string
account string
tax_free bool Tax-free
terms int64 Payment per.
credit_limit double Customer's credit limit. Data is used by financial reports.
discount double If 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
tags string Additional tags for the customer

Customers

Field Type Description
data Customer

Employee

Field Type Description
id int64 Database primary key Database dependent serial number type. Its value is unique only at table level and may change during data migrations.
code string Database independent unique external key. If not specified, it is generated on creation. It cannot be modified after creation. Example: EMP1731101982N123 ("EMP" + UNIX Time stamp + "N" + current ID)
address Address
contact Contact
events Event
employee_meta EmployeeMeta
employee_map JsonString Flexible key-value map for additional metadata. The value is any json type.
time_stamp string Timestamp of data creation

EmployeeMeta

Field Type Description
start_date string ISO 8601 date
end_date string ISO 8601 date
inactive bool
notes string
tags string Additional tags for the employee

Employees

Field Type Description
data Employee

Event

Field Type Description
uid string
subject string
start_time string ISO 8601 date-time
end_time string ISO 8601 date-time
place string
description string
tags string Additional tags for the event
event_map JsonString Flexible key-value map for additional metadata. The value is any json type.

Invoice

Field Type Description
company_name string
company_address string
company_tax_number string
customer_name string
customer_address string
customer_tax_number string

Item

Field Type Description
id int64 Database primary key Database dependent serial number type. Its value is unique only at table level and may change during data migrations.
code string Database independent unique external key. If not specified, it is generated on creation. It cannot be modified after creation. Example: ITM1731101982N123 ("ITM" + UNIX Time stamp + "N" + current ID)
trans_code string * Required field. Reference to Trans.Code
product_code string * Required field. Reference to Product.Code
tax_code string * Required field. Reference to Tax.Code
item_meta ItemMeta
item_map JsonString Flexible key-value map for additional metadata. The value is any json type.
time_stamp string Timestamp of data creation

ItemMeta

Field Type Description
unit string
qty double
fx_price double
net_amount double
discount double
vat_amount double
amount double
description string
deposit bool
own_stock double
action_price bool
tags string Additional tags for the item

Items

Field Type Description
data Item

JsonBytes

Field Type Description
data bytes JSON data as bytes

JsonString

Field Type Description
data JsonString.DataEntry Build in convertion of number, boolean, array and object types to string

JsonString.DataEntry

Field Type Description
key string
value string

Link

Field Type Description
id int64 Database primary key Database dependent serial number type. Its value is unique only at table level and may change during data migrations.
code string Database independent unique external key. If not specified, it is generated on creation. It cannot be modified after creation. Example: LNK1731101982N123 ("LNK" + UNIX Time stamp + "N" + current ID)
link_type_1 LinkType * Required field. ENUM field.
link_code_1 string * Required field. Reference to LinkType1.code
link_type_2 LinkType * Required field. ENUM field.
link_code_2 string * Required field. Reference to LinkType2.code
link_meta LinkMeta
link_map JsonString Flexible key-value map for additional metadata. The value is any json type.
time_stamp string Timestamp of data creation

LinkMeta

Field Type Description
qty double
rate double
tags string Additional tags for the link

Links

Field Type Description
data Link

Log

Field Type Description
id int64 Database primary key Database dependent serial number type. Its value is unique only at table level and may change during data migrations.
code string Database independent unique external key. If not specified, it is generated on creation. It cannot be modified after creation. Example: LOG1731101982N123 ("LOG" + UNIX Time stamp + "N" + current ID)
log_type LogType ENUM field.
ref_type string
ref_code string Reference to RefType.code
auth_code string Reference to Auth.Code
log_map JsonString Flexible key-value map for additional metadata. The value is any json type.
time_stamp string Timestamp of data creation

Logs

Field Type Description
data Log

Movement

Field Type Description
id int64 Database primary key Database dependent serial number type. Its value is unique only at table level and may change during data migrations.
code string Database independent unique external key. If not specified, it is generated on creation. It cannot be modified after creation. Example: MOV1731101982N123 ("MOV" + UNIX Time stamp + "N" + current ID)
movement_type MovementType * Required field. ENUM field.
shipping_time string ISO 8601 date-time
trans_code string * Required field. Reference to Trans.Code
product_code string * Required field. Reference to Product.Code
tool_code string Reference to Tool.Code
place_code string Reference to Place.Code
item_code string Reference to Item.Code
movement_code string Reference to Movement.Code
movement_meta MovementMeta
movement_map JsonString Flexible key-value map for additional metadata. The value is any json type.
time_stamp string Timestamp of data creation

MovementMeta

Field Type Description
qty double
notes string
shared bool
tags string Additional tags for the movement

Movements

Field Type Description
data Movement

Payment

Field Type Description
id int64 Database primary key Database dependent serial number type. Its value is unique only at table level and may change during data migrations.
code string Database independent unique external key. If not specified, it is generated on creation. It cannot be modified after creation. Example: PMT1731101982N123 ("PMT" + UNIX Time stamp + "N" + current ID)
paid_date string * Required field. ISO 8601 date-time
trans_code string * Required field. Reference to Trans.Code
payment_meta PaymentMeta
payment_map JsonString Flexible key-value map for additional metadata. The value is any json type.
time_stamp string Timestamp of data creation

PaymentMeta

Field Type Description
amount double
notes string
tags string Additional tags for the payment

Payments

Field Type Description
data Payment

Place

Field Type Description
id int64 Database primary key Database dependent serial number type. Its value is unique only at table level and may change during data migrations.
code string Database independent unique external key. If not specified, it is generated on creation. It cannot be modified after creation. Example: PLA1731101982N123 ("PLA" + UNIX Time stamp + "N" + current ID)
place_type PlaceType * Required field. ENUM field.
place_name string * Required field. The full name of the place.
currency_code string Reference to Currency.Code
address Address
contacts Contact
events Event
place_meta PlaceMeta
place_map JsonString Flexible key-value map for additional metadata. The value is any json type.
time_stamp string Timestamp of data creation

PlaceMeta

Field Type Description
notes string
inactive bool
tags string Additional tags for the place

Places

Field Type Description
data Place

Price

Field Type Description
id int64 Database primary key Database dependent serial number type. Its value is unique only at table level and may change during data migrations.
code string Database independent unique external key. If not specified, it is generated on creation. It cannot be modified after creation. Example: PRC1731101982N123 ("PRC" + UNIX Time stamp + "N" + current ID)
price_type PriceType * Required field. ENUM field.
valid_from string * Required field. Start of validity, mandatory data. ISO 8601 date
valid_to string End of validity, can be left empty. ISO 8601 date
product_code string * Required field. Reference to Product.Code
currency_code string * Required field. Reference to Currency.Code
customer_code string Optional field. Reference to Customer.Code
qty double Price 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.
price_meta PriceMeta
price_map JsonString Flexible key-value map for additional metadata. The value is any json type.
time_stamp string Timestamp of data creation

PriceMeta

Field Type Description
price_value double
tags string Additional tags for the price

Prices

Field Type Description
data Price

Product

Field Type Description
id int64 Database primary key Database dependent serial number type. Its value is unique only at table level and may change during data migrations.
code string Database independent unique external key. If not specified, it is generated on creation. It cannot be modified after creation. Example: PRD1731101982N123 ("PRD" + UNIX Time stamp + "N" + current ID)
product_type ProductType * Required field. ENUM field.
product_name string * Required field. The full name of the product or short description.
tax_code string * Required field. Reference to Tax.Code
events Event
product_meta ProductMeta
product_map JsonString Flexible key-value map for additional metadata. The value is any json type.
time_stamp string Timestamp of data creation

ProductMeta

Field Type Description
unit string
barcode_type BarcodeType ENUM field.
barcode_data string Any barcode or QR code data
barcode_qty double The actual amount of the products identified by the barcode. For example can be used for packaged goods, tray packaging.
notes string
inactive bool
tags string Additional tags for the product

Products

Field Type Description
data Product

Project

Field Type Description
id int64 Database primary key Database dependent serial number type. Its value is unique only at table level and may change during data migrations.
code string Database independent unique external key. If not specified, it is generated on creation. It cannot be modified after creation. Example: PRJ1731101982N123 ("PRJ" + UNIX Time stamp + "N" + current ID)
project_name string * Required field. The name of the project.
customer_code string Reference to Customer.Code
addresses Address
contacts Contact
events Event
project_meta ProjectMeta
project_map JsonString Flexible key-value map for additional metadata. The value is any json type.
time_stamp string Timestamp of data creation

ProjectMeta

Field Type Description
start_date string ISO 8601 date
end_date string ISO 8601 date
notes string
inactive bool
tags string Additional tags for the project

Projects

Field Type Description
data Project

Rate

Field Type Description
id int64 Database primary key Database dependent serial number type. Its value is unique only at table level and may change during data migrations.
code string Database independent unique external key. If not specified, it is generated on creation. It cannot be modified after creation. Example: RAT1731101982N123 ("RAT" + UNIX Time stamp + "N" + current ID)
rate_type RateType * Required field. ENUM field.
rate_date string * Required field. ISO 8601 date
place_code string * Required field. Reference to Place.Code
currency_code string * Required field. Reference to Currency.Code
rate_meta RateMeta
rate_map JsonString Flexible key-value map for additional metadata. The value is any json type.
time_stamp string Timestamp of data creation

RateMeta

Field Type Description
rate_value double
tags string Additional tags for the rate

Rates

Field Type Description
data Rate

Rent

Field Type Description
holiday double Holidays (day)
bad_tool double Bad tool / machine (hour)
other double Other non-eligible
justification string Rent justification

RequestAuthLogin

Field Type Description
user_name string
password string
database string

RequestDatabase

Field Type Description
alias string Database alias name
demo bool Create demo data

RequestDelete

Field Type Description
id int64 Database primary key. If specified, the code does not need to be set.
code string Database independent unique external key. If specified, the id does not need to be set.
model Model Model name

RequestEmpty

Field Type Description

RequestFunction

Field Type Description
function string Server function name. Valid function names: report_install, report_list, report_get, product_price, email_send
args RequestFunction.ArgsEntry Function arguments

RequestFunction.ArgsEntry

Field Type Description
key string
value string

RequestGet

Field Type Description
id int64 Database primary key. If specified, the code does not need to be set.
code string Database independent unique external key. If specified, the id does not need to be set.

RequestPasswordChange

Field Type Description
password string
confirm string

RequestQuery

Field Type Description
filters RequestQueryFilter
limit int64
offset int64

RequestQueryFilter

Field Type Description
field string
value string

RequestTokenDecode

Field Type Description
token string

RequestView

Field Type Description
name ViewName Predefined view name
filter string Valid SQL WHERE clause
order_by string Valid SQL ORDER BY clause
limit int64 Limit the number of records
offset int64 Skip the first N records

ResponseAuthLogin

Field Type Description
token string
version string

ResponseStatus

Field Type Description
success bool
message string

ResponseTokenDecode

Field Type Description
code string
user_name string
database string
exp string JWT expiration time
iss string JWT issuer

Tax

Field Type Description
id int64 Database primary key Database dependent serial number type. Its value is unique only at table level and may change during data migrations.
code string * Required field. Database independent unique external key. It cannot be modified after creation.
tax_meta TaxMeta
tax_map JsonString Flexible key-value map for additional metadata. The value is any json type.
time_stamp string Timestamp of data creation

TaxMeta

Field Type Description
description string
rate_value double
tags string Additional tags for the tax

Taxes

Field Type Description
data Tax

Tool

Field Type Description
id int64 Database primary key Database dependent serial number type. Its value is unique only at table level and may change during data migrations.
code string Database independent unique external key. If not specified, it is generated on creation. It cannot be modified after creation. Example: SER1731101982N123 ("SER" + UNIX Time stamp + "N" + current ID)
description string * Required field. The description of the tool.
product_code string * Required field. Reference to Product.Code
events Event
tool_meta ToolMeta
tool_map JsonString Flexible key-value map for additional metadata. The value is any json type.
time_stamp string Timestamp of data creation

ToolMeta

Field Type Description
serial_number string
notes string
inactive bool
tags string Additional tags for the tool

Tools

Field Type Description
data Tool

Trans

Field Type Description
id int64 Database primary key Database dependent serial number type. Its value is unique only at table level and may change during data migrations.
code string Database independent unique external key. If not specified, it is generated on creation. It cannot be modified after creation. Example: TRN1731101982N123 ("TRN" + UNIX Time stamp + "N" + current ID)
trans_type TransType * Required field. ENUM field.
trans_date string * Required field. ISO 8601 date
direction Direction * Required field. ENUM field.
trans_code string Reference to Trans.Code
customer_code string Reference to Customer.Code
employee_code string Reference to Employee.Code
project_code string Reference to Project.Code
place_code string Reference to Place.Code
currency_code string Reference to Currency.Code
auth_code string Reference to Auth.Code
trans_meta TransMeta
trans_map JsonString Flexible key-value map for additional metadata. The value is any json type.
time_stamp string Timestamp of data creation

TransMeta

Field Type Description
due_time string ISO 8601 date-time
ref_number string
paid_type PaidType ENUM field.
tax_free bool
paid bool
rate double
closed bool
status TransStatus ENUM field.
trans_state TransState ENUM field.
notes string
internal_notes string
report_notes string
worksheet Worksheet
rent Rent
invoice Invoice
tags string Additional tags for the trans

Transactions

Field Type Description
data Trans

Worksheet

Field Type Description
distance double Distance (km)
repair double Repair time (hour)
total double Total time (hour)
justification string Worksheet justification

Enums

BarcodeType

Name Number
BARCODE_CODE_39 0
BARCODE_CODE_128 1
BARCODE_EAN_8 2
BARCODE_EAN_13 3
BARCODE_QR_CODE 4

BookmarkType

Name Number
BOOKMARK_BROWSER 0
BOOKMARK_EDITOR 1

ConfigType

Name Number
CONFIG_MAP 0
CONFIG_SHORTCUT 1
CONFIG_MESSAGE 2
CONFIG_PATTERN 3
CONFIG_REPORT 4
CONFIG_PRINT_QUEUE 5
CONFIG_DATA 6

CustomerType

Name Number
CUSTOMER_COMPANY 0
CUSTOMER_PRIVATE 1
CUSTOMER_OTHER 2
CUSTOMER_OWN 3

Direction

Name Number
DIRECTION_OUT 0
DIRECTION_IN 1
DIRECTION_TRANSFER 2

FieldType

Name Number
FIELD_STRING 0
FIELD_BOOL 1
FIELD_INTEGER 2
FIELD_NUMBER 3
FIELD_DATE 4
FIELD_DATETIME 5
FIELD_MEMO 6
FIELD_ENUM 7
FIELD_URL 8
FIELD_CUSTOMER 9
FIELD_EMPLOYEE 10
FIELD_PLACE 11
FIELD_PRODUCT 12
FIELD_PROJECT 13
FIELD_TOOL 14
FIELD_TRANS 15
FIELD_TRANS_ITEM 16
FIELD_TRANS_MOVEMENT 17
FIELD_TRANS_PAYMENT 18

FileType

Name Number
FILE_PDF 0
FILE_CSV 1

LinkType

Name Number
LINK_CUSTOMER 0
LINK_EMPLOYEE 1
LINK_ITEM 2
LINK_MOVEMENT 3
LINK_PAYMENT 4
LINK_PLACE 5
LINK_PRODUCT 6
LINK_PROJECT 7
LINK_TOOL 8
LINK_TRANS 9

LogType

Name Number
LOG_INSERT 0
LOG_UPDATE 1
LOG_DELETE 2

MapFilter

Name Number
FILTER_ADDRESS 0
FILTER_BARCODE 1
FILTER_CONTACT 2
FILTER_CURRENCY 3
FILTER_CUSTOMER 4
FILTER_EMPLOYEE 5
FILTER_EVENT 6
FILTER_ITEM 7
FILTER_MOVEMENT 8
FILTER_PAYMENT 9
FILTER_PLACE 10
FILTER_PRICE 11
FILTER_PRODUCT 12
FILTER_PROJECT 13
FILTER_RATE 14
FILTER_TAX 15
FILTER_TOOL 16
FILTER_USER 17
FILTER_TRANS 18
FILTER_INVOICE 19
FILTER_RECEIPT 20
FILTER_ORDER 21
FILTER_OFFER 22
FILTER_WORKSHEET 23
FILTER_RENT 24
FILTER_DELIVERY 25
FILTER_INVENTORY 26
FILTER_WAYBILL 27
FILTER_PRODUCTION 28
FILTER_FORMULA 29
FILTER_BANK 30
FILTER_CASH 31

Model

Name Number
AUTH 0
CONFIG 1
CURRENCY 2
CUSTOMER 3
EMPLOYEE 4
ITEM 5
LINK 6
MOVEMENT 7
PAYMENT 8
PLACE 9
PRICE 10
PRODUCT 11
PROJECT 12
RATE 13
TAX 14
TOOL 15
TRANS 16

MovementType

Name Number
MOVEMENT_INVENTORY 0
MOVEMENT_TOOL 1
MOVEMENT_PLAN 2
MOVEMENT_HEAD 3

PaidType

Name Number
PAID_ONLINE 0
PAID_CARD 1
PAID_TRANSFER 2
PAID_CASH 3
PAID_OTHER 4

PlaceType

Name Number
PLACE_WAREHOUSE 0
PLACE_BANK 1
PLACE_CASH 2
PLACE_OTHER 3

PriceType

Name Number
PRICE_CUSTOMER 0
PRICE_VENDOR 1

ProductType

Name Number
PRODUCT_ITEM 0
PRODUCT_SERVICE 1
PRODUCT_VIRTUAL 2

RateType

Name Number
RATE_RATE 0
RATE_BUY 1
RATE_SELL 2
RATE_AVERAGE 3

ShortcutField

Name Number
SHORTCUT_STRING 0
SHORTCUT_BOOL 1
SHORTCUT_INTEGER 2
SHORTCUT_NUMBER 3
SHORTCUT_DATE 4

ShortcutMethod

Name Number
METHOD_GET 0
METHOD_POST 1

TransState

Name Number
TRANS_OK 0
TRANS_NEW 1
TRANS_BACK 2

TransStatus

Name Number
TRANS_NORMAL 0
TRANS_CANCELLATION 1
TRANS_AMENDMENT 2

TransType

Name Number
TRANS_INVOICE 0
TRANS_RECEIPT 1
TRANS_ORDER 2
TRANS_OFFER 3
TRANS_WORKSHEET 4
TRANS_RENT 5
TRANS_DELIVERY 6
TRANS_INVENTORY 7
TRANS_WAYBILL 8
TRANS_PRODUCTION 9
TRANS_FORMULA 10
TRANS_BANK 11
TRANS_CASH 12

UserGroup

Name Number
GROUP_USER 0
GROUP_ADMIN 1
GROUP_GUEST 2

ViewName

Name Number
VIEW_CONFIG_DATA 0
VIEW_CONFIG_MAP 1
VIEW_CONFIG_MESSAGE 2
VIEW_CONFIG_PATTERN 3
VIEW_CONFIG_PRINT_QUEUE 4
VIEW_CONFIG_REPORT 5
VIEW_CONFIG_SHORTCUT 6
VIEW_CURRENCY_MAP 7
VIEW_CURRENCY_TAGS 8
VIEW_CURRENCY_VIEW 9
VIEW_CUSTOMER_ADDRESSES 10
VIEW_CUSTOMER_CONTACTS 11
VIEW_CUSTOMER_EVENTS 12
VIEW_CUSTOMER_MAP 13
VIEW_CUSTOMER_TAGS 14
VIEW_CUSTOMER_VIEW 15
VIEW_EMPLOYEE_EVENTS 16
VIEW_EMPLOYEE_MAP 17
VIEW_EMPLOYEE_TAGS 18
VIEW_EMPLOYEE_VIEW 19
VIEW_ITEM_MAP 20
VIEW_ITEM_TAGS 21
VIEW_ITEM_VIEW 22
VIEW_LINK_MAP 23
VIEW_LINK_TAGS 24
VIEW_LINK_VIEW 25
VIEW_MOVEMENT_MAP 26
VIEW_MOVEMENT_TAGS 27
VIEW_MOVEMENT_STOCK 28
VIEW_MOVEMENT_INVENTORY 29
VIEW_MOVEMENT_WAYBILL 30
VIEW_MOVEMENT_FORMULA 31
VIEW_MOVEMENT_VIEW 32
VIEW_PAYMENT_MAP 33
VIEW_PAYMENT_INVOICE 34
VIEW_PAYMENT_TAGS 35
VIEW_PAYMENT_VIEW 36
VIEW_PLACE_MAP 37
VIEW_PLACE_TAGS 38
VIEW_PLACE_VIEW 39
VIEW_PRICE_MAP 40
VIEW_PRICE_TAGS 41
VIEW_PRICE_VIEW 42
VIEW_PRODUCT_MAP 43
VIEW_PRODUCT_TAGS 44
VIEW_PRODUCT_VIEW 45
VIEW_PRODUCT_COMPONENTS 46
VIEW_PROJECT_MAP 47
VIEW_PROJECT_TAGS 48
VIEW_PROJECT_VIEW 49
VIEW_RATE_MAP 50
VIEW_RATE_TAGS 51
VIEW_RATE_VIEW 52
VIEW_TAX_MAP 53
VIEW_TAX_TAGS 54
VIEW_TAX_VIEW 55
VIEW_TOOL_MAP 56
VIEW_TOOL_TAGS 57
VIEW_TOOL_VIEW 58
VIEW_TRANS_MAP 59
VIEW_TRANS_TAGS 60
VIEW_TRANS_VIEW 61

Scalar Value Types

proto Type C++ Java Python Go
double double double float float64
int64 int64 long int/long int64
Uses variable-length encoding. Inefficient for encoding negative numbers if your field is likely to have negative values, use sint64 instead.
bool bool boolean boolean bool
string string String str/unicode string
A string must always contain UTF-8 encoded or 7-bit ASCII text
bytes string ByteString str []byte
May contain any arbitrary sequence of bytes
Previous
HTTP Open API
Next
Nervatura MCP