Difference between revisions of "Appendix: Operators and functions"
From 1Archive help
(→List of functions and their parameters) |
|||
| Line 329: | Line 329: | ||
== List of functions and their parameters == | == List of functions and their parameters == | ||
| − | * COMPANYBARCODE(): | + | * COMPANYBARCODE(): get the barcode of the company of the document. |
| − | * COMPANYID() | + | * COMPANYID(): get the ID of the company of the document. |
| − | * COMPANYCODE(): | + | * COMPANYCODE(): get the code of the company of the document. |
* COMPANYNAME(): get the name of the company of the document. | * COMPANYNAME(): get the name of the company of the document. | ||
| − | * COMPANYFIELD(): | + | * COMPANYFIELD(FIELDCODE): get the value of one of the company's fields. |
| − | * DOCUMENTARCHIVEID(): | + | * DOCUMENTARCHIVEID(): get the ID of the document as it is seen in the archive view. |
| − | * DOCUMENTID(): | + | * DOCUMENTID(): when a document has another ID (in an external package for example), get that ID. |
* DOCUMENTLIST(): | * DOCUMENTLIST(): | ||
* DOCUMENTTYPECODE(): | * DOCUMENTTYPECODE(): | ||
| Line 351: | Line 351: | ||
* IF(): | * IF(): | ||
| − | * COUNTER(): | + | * COUNTER(): |
* USERNAME(): get the name of the current user logged in. | * USERNAME(): get the name of the current user logged in. | ||
Revision as of 10:00, 16 January 2017
When creating/editing a 
"Template", you have the possibility to use some operators or functions to automatically fill in a value of a field.
 |
Only text fields can be automatically filled in. These are:
|
The operators and functions are always constructed in the same way:
- Operators: #{OPERATOR(FIELDCODE, PARAMETER1, PARAMETER2)}
- Functions: #{FUNCTION(PARAMETER)}
|
Operators and functions can be used in combination with fixed text. |
 |
The operators that can be used are all header- and technical fields. There are also some predefined functions available. See below for more details. |
For example:
When you receive an invoice from Electrabel every period, you can use an operator (in combination with fixed text) to automatically fill in the Comment field.
This would result in the following:
 |
When an incorrect operator/function is given, an error will occur when the template is applied. |
|
The operators/functions are case sensitive, you have to enter the upper case codes of fields (not their name!). |
Contents
1 List of header field codes and their parameters
Usage: #{HEADERFIELD(FIELDCODE, PARAMETER 1, PARAMETER 2)}
All environments:
| Fieldname | Fieldcode | Parameter 1 | Parameter 2 | Example usage |
|---|---|---|---|---|
| Supplier | SUPPCODE | CODE | #{HEADERFIELD(SUPPCODE,CODE)} | |
| NAME | #{HEADERFIELD(SUPPCODE,NAME)} | |||
| Customer | CUSTCODE | CODE | #{HEADERFIELD(CUSTCODE,CODE)} | |
| NAME | #{HEADERFIELD(CUSTCODE,NAME)} | |||
| CUSTVATID | #{HEADERFIELD(CUSTVATID)} | |||
| Journal | JOURNAL | CODE | #{HEADERFIELD(JOURNAL,CODE)} | |
| NAME | #{HEADERFIELD(JOURNAL,NAME)} | |||
| Invoice date | INVDATE | Dateformat | Calculation | #{HEADERFIELD(INVDATE,yyyy,+1y)} |
| Comment | COMMENT1 | #{HEADERFIELD(COMMENT1)} | ||
| OGM | OGM | #{HEADERFIELD(OGM)} | ||
| Net amount | NETAMNT | #{HEADERFIELD(NETAMNT)} | ||
| VAT amount | VATAMNT | #{HEADERFIELD(VATAMNT)} | ||
| Total amount | TOTAMNT | #{HEADERFIELD(TOTAMNT)} | ||
| Currency | CURRENCY | CODE | #{HEADERFIELD(CURRENCY,CODE)} | |
| NAME | #{HEADERFIELD(CURRENCY,NAME)} | |||
| Invoice type | INVTYPE | CODE | #{HEADERFIELD(INVTYPE,CODE)} | |
| NAME | #{HEADERFIELD(INVTYPE,NAME)} | |||
| Payment term | PAYMENTTERM | CODE | #{HEADERFIELD(PAYMENTTERM,CODE)} | |
| NAME | #{HEADERFIELD(PAYMENTTERM,NAME)} | |||
| Due date | INVDUEDATE | #{HEADERFIELD(INVDUEDATE)} | ||
| Voucher number | VOUCHERNR | #{HEADERFIELD(VOUCHERNR)} | ||
| Paid amount | PAIDAMOUNT | #{HEADERFIELD(PAIDAMOUNT)} | ||
| Payment method | PAYMENT_METHOD | #{HEADERFIELD(PAYMENT_METHOD)} | ||
| Paid date | PAIDDATE | #{HEADERFIELD(PAIDDATE)} | ||
| Payment status | PAYMENT_STATUS | CODE | #{HEADERFIELD(PAYMENT_STATUS,CODE)} | |
| NAME | #{HEADERFIELD(PAYMENT_STATUS,NAME)} |
EIS and OIS specific fields:
| Fieldname | Fieldcode | Parameter 1 | Parameter 2 | Example usage |
|---|---|---|---|---|
| Period | PERIOD | CODE | #{HEADERFIELD(PERIOD,CODE)} | |
| NAME | #{HEADERFIELD(PERIOD,NAME)} | |||
| VAT ID | VATID | #{HEADERFIELD(VATID)} | ||
| Invoice number | INVNR | #{HEADERFIELD(INVNR)} |
|
The "VATID" field is the VAT ID of the supplier, not your own VAT ID. |
VIS specific fields:
| Fieldname | Fieldcode | Parameter 1 | Parameter 2 | Example usage |
|---|---|---|---|---|
| Bookyear | YEAR | CODE | #{HEADERFIELD(YEAR,CODE)} | |
| NAME | #{HEADERFIELD(YEAR,NAME)} | |||
| Supplier VAT | SUPPVATID | #{HEADERFIELD(SUPPVATID)} | ||
| Invoice number | INVOICENR | #{HEADERFIELD(INVOICENR)} | ||
| Voucher date | VOUCHERDATE | #{HEADERFIELD(VOUCHERDATE)} |
2 List of technical field codes and their parameters
All environments
| Fieldname | Fieldcode | Parameter 1 | Parameter 2 | Example usage |
|---|---|---|---|---|
| Scan user | SCANUSER | #{TECHNICALFIELD(SCANUSER)} | ||
| Scan batch | SCANBATCH | #{TECHNICALFIELD(SCANBATCH)} | ||
| Scanning date | SCANNINGDATE | #{TECHNICALFIELD(SCANNINGDATE)} | ||
| Incoming date | INCOMINGDATE | Dateformat | Calculation | #{TECHNICALFIELD(INCOMINGDATE)} |
| Accountant | ACOUNTANT | Dateformat | Calculation | #{TECHNICALFIELD(ACCOUNTANT)} |
| Cancel reason | CANCELREASON | CODE | #{TECHNICALFIELD(CANCELREASON,CODE)} | |
| NAME | #{TECHNICALFIELD(CANCELREASON,NAME)} | |||
| Booking date/Sent to Venice date | BOOKINGDATE | #{TECHNICALFIELD(BOOKINGDATE)} |
3 List of functions and their parameters
- COMPANYBARCODE(): get the barcode of the company of the document.
- COMPANYID(): get the ID of the company of the document.
- COMPANYCODE(): get the code of the company of the document.
- COMPANYNAME(): get the name of the company of the document.
- COMPANYFIELD(FIELDCODE): get the value of one of the company's fields.
- DOCUMENTARCHIVEID(): get the ID of the document as it is seen in the archive view.
- DOCUMENTID(): when a document has another ID (in an external package for example), get that ID.
- DOCUMENTLIST():
- DOCUMENTTYPECODE():
- DOCUMENTTYPENAME():
- RECMETHOD():
- RECMETHODCODE():
- SCANBATCHTYPECODE():
- SCANBATCHTYPENAME():
- SCANNINGUSERNAME():
- OPTINPARTNERS():
- CUSTOMTEXT():
- ENCRYPT():
- IF():
- COUNTER():
- USERNAME(): get the name of the current user logged in.
- USERID():
- USERREALNAME():
- CURRENTDATE():
- GETQUARTER():
4 Dateformats
Some operators/functions require a date format to be entered as a parameter. This is how those formats should be built:
- d: day
- M: month
- y: year
- H: hour
- m: minutes
- EOM: end of month
- BOM: begin of month
