Elorus API v1.0 (BETA)

Only demo organizations can be used within this interactive console to test the Elorus API.

 

Data types

Address type

A postal address may be of the following types:

Value Description
bill Billing
ship Shipping
other Other

Country

Elorus supports the following countries:

Value Description
AF Afghanistan
AL Albania
DZ Algeria
AS American Samoa
AD Andorra
AO Angola
AI Anguilla
AQ Antarctica
AG Antigua & Barbuda
AR Argentina
AM Armenia
AW Aruba
AU Australia
AT Austria
AZ Azerbaijan
BS Bahama
BH Bahrain
BD Bangladesh
BB Barbados
BY Belarus
BE Belgium
BZ Belize
BJ Benin
BM Bermuda
BT Bhutan
BO Bolivia
BA Bosnia and Herzegovina
BW Botswana
BV Bouvet Island
BR Brazil
IO British Indian Ocean Territory
VG British Virgin Islands
BN Brunei Darussalam
BG Bulgaria
BF Burkina Faso
BI Burundi
KH Cambodia
CA Canada
CM Cameroon
CV Cape Verde
KY Cayman Islands
CF Central African Republic
TD Chad
CL Chile
CN China
CX Christmas Island
CC Cocos (Keeling) Islands
CO Colombia
KM Comoros
CG Congo
CK Cook Iislands
CR Costa Rica
HR Croatia
CU Cuba
CY Cyprus
CZ Czech Republic
DK Denmark
DJ Djibouti
DM Dominica
DO Dominican Republic
TP East Timor
EC Ecuador
EG Egypt
SV El Salvador
GQ Equatorial Guinea
ER Eritrea
EE Estonia
ET Ethiopia
FK Falkland Islands (Malvinas)
FO Faroe Islands
FJ Fiji
FI Finland
FR France
FX France, Metropolitan
GF French Guiana
PF French Polynesia
TF French Southern Territories
GA Gabon
GM Gambia
GE Georgia
DE Germany
GH Ghana
GI Gibraltar
GR Greece
GL Greenland
GD Grenada
GP Guadeloupe
GU Guam
GT Guatemala
GN Guinea
GW Guinea-Bissau
GY Guyana
HT Haiti
HM Heard & McDonald Islands
HN Honduras
HK Hong Kong
HU Hungary
IS Iceland
IN India
ID Indonesia
IQ Iraq
IE Ireland
IR Islamic Republic of Iran
IL Israel
IT Italy
CI Ivory Coast
JM Jamaica
JP Japan
JO Jordan
KZ Kazakhstan
KE Kenya
KI Kiribati
KP Korea, Democratic People's Republic of
KR Korea, Republic of
KW Kuwait
KG Kyrgyzstan
LA Lao People's Democratic Republic
LV Latvia
LB Lebanon
LS Lesotho
LR Liberia
LY Libyan Arab Jamahiriya
LI Liechtenstein
LT Lithuania
LU Luxembourg
MO Macau
MG Madagascar
MW Malawi
MY Malaysia
MV Maldives
ML Mali
MT Malta
MH Marshall Islands
MQ Martinique
MR Mauritania
MU Mauritius
YT Mayotte
MX Mexico
FM Micronesia
MD Moldova, Republic of
MC Monaco
ME Montenegro
MN Mongolia
MS Monserrat
MA Morocco
MZ Mozambique
MM Myanmar
NA Namibia
NR Nauru
NP Nepal
NL Netherlands
AN Netherlands Antilles
NC New Caledonia
NZ New Zealand
NI Nicaragua
NE Niger
NG Nigeria
NU Niue
NF Norfolk Island
MP Northern Mariana Islands
NO Norway
OM Oman
PK Pakistan
PW Palau
PA Panama
PG Papua New Guinea
PY Paraguay
PE Peru
PH Philippines
PN Pitcairn
PL Poland
PT Portugal
PR Puerto Rico
QA Qatar
RE Reunion
RO Romania
RU Russian Federation
RW Rwanda
LC Saint Lucia
WS Samoa
SM San Marino
ST Sao Tome & Principe
SA Saudi Arabia
SN Senegal
RS Serbia
SC Seychelles
SL Sierra Leone
SG Singapore
SK Slovakia
SI Slovenia
SB Solomon Islands
SO Somalia
ZA South Africa
GS South Georgia and the South Sandwich Islands
ES Spain
LK Sri Lanka
SH St. Helena
KN St. Kitts and Nevis
PM St. Pierre & Miquelon
VC St. Vincent & the Grenadines
SD Sudan
SR Suriname
SJ Svalbard & Jan Mayen Islands
SZ Swaziland
SE Sweden
CH Switzerland
SY Syrian Arab Republic
TW Taiwan, Province of China
TJ Tajikistan
TZ Tanzania, United Republic of
TH Thailand
TG Togo
TK Tokelau
TO Tonga
TT Trinidad & Tobago
TN Tunisia
TR Turkey
TM Turkmenistan
TC Turks & Caicos Islands
TV Tuvalu
UG Uganda
UA Ukraine
AE United Arab Emirates
GB United Kingdom (Great Britain)
UM United States Minor Outlying Islands
VI United States Virgin Islands
ZZ Unknown or unspecified country
US United States of America
UY Uruguay
UZ Uzbekistan
VU Vanuatu
VA Vatican City State (Holy See)
VE Venezuela
VN Viet Nam
WF Wallis & Futuna Islands
EH Western Sahara
YE Yemen
ZR Zaire
ZM Zambia
ZW Zimbabwe

Currencies

Elorus supports the following currencies:

Value Description
EUR Euro
GBP GB Pound
USD US Dollar
AFN Afghani
DZD Algerian Dinar
ARS Argentine Peso
AMD Armenian Dram
AWG Aruban Florin
AUD Australian Dollar
AZN Azerbaijanian Manat
BSD Bahamian Dollar
BHD Bahraini Dinar
THB Baht
PAB Balboa
BBD Barbados Dollar
BYR Belarussian Ruble
BZD Belize Dollar
BMD Bermudian Dollar(Bermuda Dollar)
VEF Bolivar Fuerte
BOB Boliviano
BRL Brazilian Real
BND Brunei Dollar
BGN Bulgarian Lev
BIF Burundi Franc
CAD Canadian Dollar
CVE Cape Verde Escudo
KYD Cayman Islands Dollar
GHS Cedi
XOF CFA Franc BCEAO
XAF CFA Franc BEAC
XPF CFP Franc
CLP Chilean Peso
COP Colombian Peso
KMF Comoro Franc
BAM Convertible Marks
NIO Cordoba Oro
CRC Costa Rican Colon
HRK Croatian Kuna
CUC Cuba Convertible Peso
CUP Cuban Peso
CZK Czech Koruna
GMD Dalasi
DKK Danish Krone
MKD Denar
DJF Djibouti Franc
STD Dobra
DOP Dominican Peso
VND Dong
XCD East Caribbean Dollar
EGP Egyptian Pound
ETB Ethiopian Birr
FKP Falkland Islands Pound
FJD Fiji Dollar
HUF Forint
CDF Franc Congolais
GIP Gibraltar Pound
HTG Gourde
PYG Guarani
GNF Guinea Franc
GYD Guyana Dollar
HKD Hong Kong Dollar
UAH Hryvnia
ISK Iceland Krona
INR Indian Rupee
IRR Iranian Rial
IQD Iraqi Dinar
JMD Jamaican Dollar
JOD Jordanian Dinar
KES Kenyan Shilling
PGK Kina
LAK Kip
KWD Kuwaiti Dinar
MWK Kwacha
AOA Kwanza
MMK Kyat
GEL Lari
LBP Lebanese Pound
ALL Lek
HNL Lempira
SLL Leone
LRD Liberian Dollar
LYD Libyan Dinar
SZL Lilangeni
LSL Loti
MGA Malagascy Ariary
MYR Malaysian Ringgit
MUR Mauritius Rupee
MXN Mexican Peso
MXV Mexican Unidad de Inversion(UID)
MDL Moldovan Leu
MAD Moroccan Dirham
MZN Mozambique Metical
BOV Mvdol
NGN Naira
ERN Nakfa
NAD Namibian Dollar
NPR Nepalese Rupee
ANG Netherlands Antillian Guilder
ILS New Israeli Sheqel
RON Romanian Leu
TWD New Taiwan Dollar
TRY Turkish Lira
NZD New Zealand Dollar
BTN Ngultrum
KPW North Korean Won
NOK Norwegian Krone
PEN Nuevo Sol
MRO Ouguiya
TOP Paanga
PKR Pakistan Rupee
MOP Pataca
UYU Peso Uruguayo
PHP Philippine Peso
BWP Pula
QAR Qatari Rial
GTQ Quetzal
ZAR Rand
OMR Rial Omani
KHR Riel
MVR Rufiyaa
IDR Rupiah
RUB Russian Ruble
RWF Rwanda Franc
XDR SDR
SHP Saint Helena Pound
SAR Saudi Riyal
RSD Serbian Dinar
SCR Seychelles Rupee
SGD Singapore Dollar
SBD Solomon Islands Dollar
KGS Som
SOS Somali Shilling
TJS Somoni
LKR Sri Lanka Rupee
SDG Sudanese Pound
SRD Surinam Dollar
SEK Swedish Krona
CHF Swiss Franc
SYP Syrian Pound
BDT Taka
WST Tala
TZS Tanzanian Shilling
KZT Tenge
TTD Trinidad and Tobago Dollar
MNT Tugrik
TND Tunisian Dinar
TMT Turkmenistan New Manat
AED UAE Dirham
UGX Uganda Shilling
COU Unidad de Valor Real
CLF Unidades de formento
UYI Uruguay Peso en Unidades Indexadas
UZS Uzbekistan Sum
VUV Vatu
CHE WIR Euro
CHW WIR Franc
KRW Won
YER Yemeni Rial
JPY Yen
CNY Yuan Renminbi
ZMW Zambian Kwacha
ZWL Zimbabwe Dollar
PLN Zloty
BTC Bitcoin

Document calculations

Elorus will automatically calculate / correct document values based on the specified calculation mode.

Value Description
initial Initial; calculates values based on each item's initial value, quantity and taxes
total Total; calculates values based on each item's total value, quantity and taxes

Document language

Whenever a document language -e.g. default invoicing language- is required you may use one of the following:

Value Description
bg Bulgarian
en English
en-gn English (United Kingdom)
fr French
de German
el Greek
it Italian
es Spanish

Document status

Based on whether a document is draft or is paid etc., a current status is automatically calculated. This can be one of the following:

Value Description
draft Draft
issued Issued
partial Partially paid
paid Paid
overdue Overdue

Document template

A template defines the document appearance. The available templates are the following:

Value Description
classic Classic
modern Modern
prof Professional
strict Strict

Template variations

Each template has its own color variations that you may choose from.

Classic
Value Color
default Green
blue Blue
cyan Cyan
orange Orange
red Red
Modern
Value Color
default Yellow
black Black
blue Blue
green Green
orange Orange
red Red
Professional
Value Color
default Red
black Black
blue Blue
earth Earth
golden Golden
violet Violet

Strict

Value Color
default Grey
blue Blue
orange Orange
purple Purple
red Red

Template font size

Value Color
small Small
default Medium
large Large

Discount column appearance

How the item discount column will appear on the template

Value Description
0 As value
1 As percentage
2 Hidden

Document type application

Each document type may apply to a single kind of documents. The available kinds of documents are:

Value Description
1 Invoices
2 Credit notes
3 Estimates

Email type

An email address may be of the following types:

Value Description
home Personal
work Work
other Other

MCSR role

The monthly client / supplier report (MCSR) is a special tax report targeted to organizations based in Greece. To denote the role a document type should play in these reports, you may use one of the following values. This should not concern organizations based in countries other than Greece.

Value Description
1 Invoice
2 Receipt

Payment gateway backend

The supported payment gateways are the following:

Value Description
1 PayPal
2 VivaPayments redirect
3 Braintree

Phone type

A phone number may be of the following types:

Value Description
home Home
fax Fax
mobile Mobile
work Work
other Other

Tax office

Greek organizations may use the following codes to refer to a tax office. This does not concern organizations based in countries other than Greece.

Value Description
1129 Agiou Dimitriou
8221 Agiou Nikolaou
1136 Agion Anargiron
1511 Agriniou
1101 A' Athinon
1104 D' Athinon
1106 ST' Athinon
1112 IB' Athinon
1113 IG' Athinon
1114 ID' Athinon
1117 IZ' Athinon
1159 F.A.E. Athinon
1137 Aigaleo
2311 Aigiou
5211 Aleksandroupolis
2411 Amaliadas
1135 Amarousiou
4233 Ampelokipon
1912 Amfissas
9311 Argostoliou
2111 Argous
6111 Artas
1302 Axarnon
4112 Veroias
3321 Volou
1152 Vyronos
1179 Galatsiou
4621 Giannitson
1139 Glifadas
4521 Grevenon
5111 Dramas
4611 Edessas
1303 Elefsinas
9111 Zakinthou
6211 Igoumenitsas
1173 Ilioupolis
8112 Irakliou
4211 A' Thessalonikis
4214 D' Thessalonikis
4215 E' Thessalonikis
4216 ST' Thessalonikis
4217 Z' Thessalonikis
4228 H' Thessalonikis
4224 F.A.E. Thessalonikis
1411 Thivon
7121 Thiras
6311 Ioanninon
4234 Ionias Thessalonikis
5321 Kavalas
4232 Kalamarias
2711 Kalamatas
1130 Kallitheas
3111 Karditsas
1611 Karpenisiou
4311 Kastorias
4711 Katerinis
1125 Katoikon Eksoterikou
9211 Kerkiras
1153 Kifisias
4411 Kilkis
4541 Kozanis
5511 Komotinis
2513 Korinthou
1304 Koropiou
1722 Kimis
7531 Ko
1832 Lamias
3211 A' Larisas
3232 B'-G' Larisas
4222 Lagada
9421 Lefkadas
1421 Livadias
1531 Mesologiou
1211 Moschatou
7172 Mikonou
7231 Mitilinis
3323 N. Ionias Volou
1145 N. Irakleiou
7151 Naksou
2122 Nafpliou
1131 Neas Ionias
1132 Neas Smyrnis
4921 Neon Moudanion
1220 Nikaias
5411 Ksanthis
5221 Orestiadas
1133 Palaiou Falirou
1312 Pallinis
7161 Parou
2331 A' Patron
2333 G' Patron
1201 A' Peiraia
1203 G' Peiraia
1204 D' Peiraia
1205 E' Peiraia
1207 Ploion Peiraia
1206 F.A.E. Peiraia
1138 A' Peristeriou
1157 B' Peristeriou
4922 Polygirou
6411 Prevezas
4531 Ptolemaidas
2412 Pirgou
8341 Rethimnou
7542 Rodou
7322 Samou
5611 A' Serron
2632 Spartis
7171 Sirou
3412 Trikalon
2211 Tripolis
4812 Florinas
1134 Chalandriou
1732 Chalkidas
8431 Chanion
7411 Chiou
1151 Cholargou
1175 Psixikou
8111 A' Irakliou
8113 B' Irakliou
1118 Megalon Epixeiriseon

Tax operand

The operand controls whether the tax adds or subtracts from the value.

Value Description
+ Plus; denotes an additive tax
- Minus; denotes a deduction

Transaction type

Cash transactions -cash receipts or cash payments- may be one of the following types:

Value Description
dp Direct payment
ap Advance payment
ip Invoice payment
cnp Credit note payment
op Over-payment

Translations dictionary

A dictionary providing translations for each document language, where a language code is the dictionary key. A valid translations dictionary may look like this:

{
    "en": "Good morning",
    "en-gb": "Good morning",
    "de": "Guten tag",
    "el": "Καλημέρα",
    "es": "Buenos días",
    "fr": "Bonjour",
    "it": "Buongiorno",
    "bg": "добро утро"
}

When updating a translations dictionary you must specify all languages. Omitted keys will result in empty translations for the missing language, even if previous values exist.

Unit measure

Product or service unit measures might be one of the following:

Value Description
0 Item
1 Service
2 Square millimetre
3 Square centimetre
4 Square metre
5 Square kilometre
6 Millimetre
7 Centimetre
8 Metre
9 Kilometre
10 Millilitre
11 Litre
12 Milligram
13 Gram
14 Kilogram
15 Ton
16 Minute
17 Hour
18 Month
19 Year
20 Man-Hour
21 Man-Day
22 Man-Month

Unit measure appearance

How the unit measure will appear on the commercial documents

Value Description
0 Hidden
1 Symbol; an abbreviation
2 Label; the full name