# Ladu20 API ## API structure Ladu20 API is REST based, queries are processed via CURL POST requests. **API base URL:** henceforth ***BASEURL***, will be provided by KMA. **API key:** henceforth ***APIKEY***, will be provided by KMA **Request data** is posted in CURLOPT\_POSTFIELDS as JSON. **Response** data is JSON formatted and returns request status, request type, result data and rowcount. HTTP header Content-Type needs to be set to application/json ##### PHP sample request

<?php

$curl = curl_init();

curl_setopt_array($curl, array(

CURLOPT_URL => '[https://***baseurl***/product](https://web.kma.ee/api/product)',

CURLOPT\_RETURNTRANSFER => true,

CURLOPT_ENCODING => '',

CURLOPT_MAXREDIRS => 10,

CURLOPT_TIMEOUT => 0,

CURLOPT_FOLLOWLOCATION => true,

CURLOPT_HTTP_VERSION => CURL\_HTTP\_VERSION\_1\_1,

CURLOPT_CUSTOMREQUEST => 'POST',

CURLOPT_POSTFIELDS =>'{"id":"21161"}',

CURLOPT_HTTPHEADER => array(

'Content-Type: application/json',

'x-api-key: **APIKEY**'

));

$response = curl_exec($curl);

curl_close($curl);

echo $response;

##### Result handling Query success or failure is defined in the boolean response field "ok". Response data and error descriptions are available in the field "data". **Successful response with results:** *{"timestamp":"2023-10-13T10:00:35.133","ok":true,"query":"customer","row\_count":1,"data":\[{"customer\_code":"1234","main\_customer\_code":"1234","receiving\_customer\_code":"1234","last\_update":"2023-10-06T10:35:56.177","name":"TEST OÜ","reg\_code":"1234568","vat\_in\_use":1,"vat\_no":"EE1234567","is\_private\_person":0,"is\_customer":1,"is\_supplier":0,"is\_producer":0,"is\_transporter":0,"is\_owner":0,"phone":"555555555","address1":"Mustamäe tee 46","address2":"Harjumaa","address3":"Tallinn","postcode":"10612","country":"EE","language":"","email":"info@kma.ee","currency":"EUR","ref\_no":"0","old":0,"rowno":1}\]}* **Successful response with no results:** *{"timestamp":"2023-10-13T09:54:22.303","ok":true,"query":"customer","row\_count":0}* **Unsuccessful request:** *{"timestamp":"2023-10-13T09:56:54.410","ok":false,"query":"customer","data":{"message":"Technical error occurred"}}* ## Data output requests API requests serve data from Ladu20 by predefined filterable POST requests. Filter parameters are defined per request and are not mandatory. Currently the following standard outputs are available: - Customer data - Product data - Stock levels - Order - Dispatch - Invoice ### Customer data **URL: *BASEURL***/customer Returns customer data from Ladu20 database. Ladu20 defines customers as one collection of data with several statuses. The latter means the customer cards for suppliers, customers, producers etc are the same data unit, with several statuses defining the customer state (eg is\_supplier=1 means that the customer is also regarded a supplier in Ladu20). ##### Filter parameters

PARAMETER NAME	TYPE	DESCRIPTION	Default value
last\_update	string	returns data which is update later than the timestamp; format: 2023-10-11T00:00:00	last 240 hours
old	bool	returns results marked as old in Ladu20;	false
id	string	customer id in Ladu20
page	int	Range 1-n	1
rowcount	int	Range 1-1000	300

##### Sample request data '{"last\_update":"2023-10-11T00:00:00","rowcount":2,"page":1}' ##### Response data

FIELD NAME	TYPE	DESCRIPTION
customer\_code	int
main\_customer\_code	int	payer customer code
receiving\_customer\_code	int
last\_update	date	format: 2023-10-11T00:00:00, created date
name	string
reg\_code	string
vat\_in\_use	int
vat\_no	string
is\_private\_person	boolean
customer	boolean	customer status
supplier	boolean	customer status
producer	boolean	customer status
transporter	boolean	customer status
owner	string
info	string
phone	string
address1	string	street
address2	string	city
address3	string	county
postcode	string
country	string
language	string
email	string
currency	decimal
bank	string	bank name
bankaccount	string
ref\_no	int	reference no
glncode	int
lat	int	latitude
long	int	longitude
credit\_limit	decimal
debt\_min\_amount	decimal
debt\_from	int	debt from days
owner\_customer	string

### Product data **URL: *BASEURL***/product Returns product data from Ladu20 database. Ladu20 defines all product information with prices, replacements, parameters, lots, images and price agreements. In addition, the current state of the products, ordered and reserved quantities. The price of the products ("price excluding VAT") is usually the main selling price. To classify products more easily, we have created groups of products. You can also add subgroups to item groups. For example product group1 no is 1 and, code V1 and description vegetables then subgroup for group1 may be V12(apples), V13 (citrus) etc. ##### Filter parameters

PARAMETER NAME	TYPE	DESCRIPTION	Default value
last\_update	string	returns data which is update later than the timestamp; format: 2023-10-11T00:00:00	last 240 hours
old	bool	returns results marked as old in Ladu20;	false
id	string	customer id in Ladu20
page	int	Range 1-n	1
rowcount	int	Range 1-1000	300
group1	string
group2	string
group3	string
group4	string

##### Sample request data '{"last\_update":"2023-10-11T00:00:00","rowcount":10,"page":4}' ##### Response data

FIELD NAME	TYPE	DESCRIPTION
product\_id	int	product code
product\_code	int	siffer
barcode	string
product\_name	string
baseunit	string
large\_unit	string
large\_unit\_multiplier	string
aidunit	string
aidunit\_multiplier	string	aidunits in one package
min\_sales\_qty	decimal	minimum quantity on sale
sales\_qty\_step	decimal	minimum quantity step on sale
is\_expireable	boolean	product is expirable or not (1,0)
product\_shelf\_life	string
cn8	string	cn8 code
coo	string	country of origin
min\_temp	string	minimum temperature
max\_temp	string	maximum temperature
stock\_qty	decimal	stock quantity
ordered\_qty	decimal	ordered quantity
reserved\_qty	decimal	reserved quantity
netweight	int
brutweight	int
volume	int
price	decimal
vat	int	vat on sale
group1	boolean	product qroup
group2	boolean	product qroup
group3	boolean	product qroup
group4	boolean	product qroup
group5	boolean	product qroup
last\_update	date	format: 2023-10-11T00:00:00
web\_groups/group\_id	int	product webgroup id
web\_groups/group\_code	int	product group id
web\_groups/group\_name	string	product group name
flex\_groups/group\_id	int	product webgroup id
flex\_groups/group\_code	int	product group id
flex\_groups/group\_name	string	product group name

### Stockbalance **URL: *BASEURL***/stockbalance Returns stockbalance data from Ladu20 database - product amounts in different warehouses (balance, ordered, reserved). Owner is usually main warehouse. Filter parameters

PARAMETER NAME	TYPE	DESCRIPTION	Default value
id	int	id
page	int	Range 1-n	1
rowcount	int	Range 1-1000	300

##### Sample request data '{"last\_update":"2023-10-11T00:00:00","rowcount":10,"page":4}' ##### Response data

FIELD NAME	TYPE	DESCRIPTION
product\_id	int
product\_code	string	siffer
stock\_balance	decimal
ordered\_amount	decimal
reserved\_amount	decimal
product\_id	int
rows/owner	string
rows/owner\_stock\_balance	decimal

Order **URL: *BASEURL***/order Returns order data from Ladu20 database. Order = sales order, which is in most cases, the primary document for the sales side for the warehouse. ##### Filter parameters

PARAMETER NAME	TYPE	DESCRIPTION	Default value
start	string	date from, format: 2023-10-11T00:00:00	l
id	int	order id
end	date	date until, format: 2023-10-11T00:00:00
customer\_id	string	customer code
page	int	Range 1-n	1
rowcount	int	Range 1-1000	300

##### Sample request data '{"last\_update":"2023-10-11T00:00:00","rowcount":10,"page":4}' ##### Response data

FIELD NAME	TYPE	DESCRIPTION
customer\_code	int
doc\_no	string	order no
doc\_date	date	order date, format: 2023-10-11T00:00:00
del\_due	date	delivery date, format: 2023-10-11T00:00:00
status	string	order status
additional\_info	string
inserter	string
dicount\_per	decimal	discount percent
doc\_no2	string	customer order no
confirmed	boolean
currency	decimal
currency\_rate	decimal
customer\_date	date	format: 2023-10-11T00:00:00
pre\_order	boolean
payer	string	payer customer
warning	string
xml\_done	boolean
owner	string
customer	string	customer who placed the order
phone	string	customer phone no
country	string	customer country
picking\_in\_prog	boolean	picking in progress
payment\_due	date	format: 2023-10-11T00:00:00
payment\_type	string	cash, transfer etc
weborder\_id	int
customer\_name	string	customer contact who placed the order
doc\_sum	decimal
recip\_customer	string	recipient customer
original\_quantity	decimal
quantity	decimal
price	decimal
baseprice	decimal

### Dispatch **URL: *BASEURL***/dispatch Returns order data from Ladu20 database - dispatch of the products from Ladu20 warehouses. ##### Filter parameters

PARAMETER NAME	TYPE	DESCRIPTION	Default value
start	string	date from, format: 2023-10-11T00:00:00	l
id	int	dispatch id
end	date	date until, format: 2023-10-11T00:00:00
customer\_id	string	customer code
page	int	Range 1-n	1
rowcount	int	Range 1-1000	300

##### Sample request data '{"last\_update":"2023-10-11T00:00:00","rowcount":10,"page":4}' ##### Response data

FIELD NAME	TYPE	DESCRIPTION
dispatch\_code	int
customer\_id	int
dispatch\_type\_id	string
date	date	format: 2023-10-11T00:00:00
doc\_no	string	dispatch document no
discount\_per	int	discount percent
inserter	string
sum\_net	decimal
sum\_incl\_vat	decimal	sum including vat
due	string	payment due
payer	string	payer customer
additional\_info	string
currency	decimal
payment\_type	string	cash, transfer etc
warehouse\_aadress	string
account	string	bank account
country	string
rec\_customer	string	recipient customer
needed\_due	date
owner	string
ship\_customer	string
tracking\_no	string
paid	decimal
amount\_of\_boxes	decimal
product\_id	string
batch	int	batch code
amount	decimal
discount\_per	int	discount percent
price	decimal	product price
net\_value	int
discount\_price	decimal
base\_price	decimal
brut\_weight	int
set	string	set of products
account	string	bank account
row\_amount	decimal
stockaddress	string
set\_amount	decimal	how many products in set
pieces	int
warning	string
sales\_id	int	saleorder id
pricelist\_id	int
price\_type	string
vat\_sale	string
fix\_net\_value	string
warehouse\_agent	string	warehouse agent name
added	boolean	dispatch added (1,0)
package\_id	string
picker	string	warehouse agent who picked products
agent	string	agent on sale
base\_code	string
batch\_id	int
description	string
expiration\_date	date	format: 2023-10-11T00:00:00

### Invoice **URL: *BASEURL***/invoice Returns invoice data from Ladu20 database. Invoices are accounting outputs from dispatches. ##### Filter parameters

PARAMETER NAME	TYPE	DESCRIPTION	Default value
last\_update	string	returns data which is update later than the timestamp; format: 2023-10-11T00:00:00	last 240 hours
end	date	format: 2023-10-11T00:00:00
customer\_id	string	customer code
id	int	invoice id
page	int	Range 1-n	1
rowcount	int	Range 1-1000	300

##### Sample request data '{"last\_update":"2023-10-11T00:00:00","rowcount":10,"page":4}' ##### Response data

FIELD NAME	TYPE	DESCRIPTION
customer\_code	int
invoice\_date	date	invoice (document created) date
invoice\_no	string	invoice number
total	decimal	total sum
paid	decimal
paid\_date	date	format: 2023-10-11T00:00:00
fine\_for\_delay	String
deadline	date	format: 2023-10-11T00:00:00
paym\_meth	string	payment method
printed	boolean
post\_date	date	format: 2023-10-11T00:00:00
partial	string	partial payment
cred\_invoice\_no	string	credit invoice no
from\_stock	string	sent out from stock
report\_done	boolean
warning	string
owner	string
ref\_no	string	reference no
add\_info	string	additional information
prepaym\_amount	decimal
prepaym\_info	string
returned	boolean
product\_id	long
batch	long	products batch
amount	decimal
discount\_percent	int	%
price	decimal
net\_value	int
discount\_price	decimal
base\_price	decimal
brut\_weight	int
set	string	set of products
account	string
row\_amount	decimal
stockaddress	string
set\_amount	decimal	how many products in set
pieces	int
vat\_sale	boolean

## Importing data ### Salesorder **URL: *BASEURL***/salesorder With salesorder access point, you can import sales orders to Ladu20. Posting is identical to data output requests. **Important notes:** - If no customer code is defined, Ladu20 uses a generic customer code for the order. - Delivery information blocks are used for postal services integrations; - If you are using the API for B2B orders services, do not fill the subblocks customer and delivery; - VAT percentages are especially important for cross border sales; - Transportation fees should be added to document rows with product codes according to the product database. Input data

FIELD NAME	TYPE	DESCRIPTION	REQUIRED
customer\_code	string	customer code in Ladu20
customer/name	string	customer name
customer/street	string	delivery address street
customer/city	string	delivery address city
customer/postalcode	string	delivery address postal code
customer/county	string	county code
customer/country	string	country code
customer/email	string	email
customer/phone	string	address
customer/is\_company	bit	yes/no
customer/company\_name	string	Customer company name
customer/company\_regno	string	Mandtory if is\_company=1
customer/company\_vatno	string
delivery/type	string	"Parcel machine", "Courier" or "Self pickup"
delivery/delivery\_partner	string	Delivery partner name for courier and parcel machines	parcel and courier
delivery/name	string	customer name
delivery/company\_name	string	company name
delivery/street	string	delivery address street
delivery/city	string	delivery address city
delivery/postalcode	string	delivery address postal code
delivery/county	string	county
delivery/country	string	country
delivery/email	string	email
delivery/phone	string	phone number
delivery/parcel\_code	string	parcel machine number	parcel only
doc\_no	string	order number in external system	\*
project\_code	string	order project code for Ladu20
doc\_seller	string	Seller code for whole document
doc\_date	string	order date in external system, format "2019-12-31T11:14:25.473" defaults to now
del\_due	string	delivery deadline, format "2019-12-31T11:14:25.473" defaults to now+1
currency	string	order currency code
currency\_rate	decimal	order rate
order\_sum	decimal
order\_sum\_with\_vat	decimal
payment\_partner	string	payment partner or account code. Used for accounting purposes.
payment\_sum	decimal	sum of prepayament
payment\_type	int
rows/product\_code	string	row product code in Ladu20	\*
rows/product\_name	string	product name, if required as additional info; if not filled, default product name will be used
rows/quantity	decimal	order row quantity	\*
rows/price	decimal	netprice	\*
rows/vat	int	vat percentage of order row
rows/seller	string	row based seller code

Sample data ```JSON { "customer_code":"kaupmees#", "customer":{ "name":"kaupmees nimi", "street":"kase 1", "city":"tallinn", "postalcode":"12345", "county":"harjumaa", "country":"ee", "email":"info@mail. Ee", "phone":"55 123 123" }, "delivery":{ "delivery_partner":"Omniva", "email":"info@mail.Ee", "phone":"55 123 123" , "name":"Name on parcel", "country":"ee", /* FOR PARCEL MACHINE */ "type":"Parcel machine", "parcel_code":"444569", , /* FOR COURIER */ "type":"Courier", "street":"kase 1", "city":"tallinn", "county":"harjumaa" "postalcode":"12345" }, "doc_no":"10001", "project_code":"WEBSHOP_01" "doc_date":"2019-12-31t11:14:25.473", "del_due":"2019-12-31t00:00:00", "currency":"eur", "currency_rate":1, "order_sum":134.15, "order_sum_with_vat":154.15, "payment_type":1, "payment_partner":'Maksekeskus", "payment_sum":154.15, "rows":[ { "product_code":"digi", "product_name":"ajakiri digi", "quantity":1, "vat":20, "price":4.185 }, { "product_code":"digi-2", "product_name":"ajakiri digi", "quantity":2, "vat":20, "price":4.185 }, { "product_code":"digi-3", "product_name":"ajakiri digi", "quantity":3, "vat":0, "price":14.185 } ] } ``` ### Order payment **URL: *BASEURL***/order\_payment Adding a payment to an existing order. Input data

FIELD NAME	TYPE	DESCRIPTION	REQUIRED
doc\_no	string	Document number in Ladu20	\*
order\_id	int	Order ID in Ladu20
payment\_sum	decimal	Sum of made payment	\*

Sample data ```JSON { "payment_sum":145.67, "doc_no":"11145", "order_id":12455 } ```