articles

type: table

Methods

GET

List documents

List of documents matching search, pagination and order clauses returned

GET /<yourcompany>/articles/

Filtering is possible using _filter request.

Filter clauses presented by JSON array of records with next fields:

field - any document field could be used in filter.
operator - filter condition binary operator. Allowed operators are:
- >
- <
- >=
- <=
- =
- <>
- like
value - searched value

Sample filter request
_filter=URLEncode([{"field": "date", "operator": ">", "value": "2017-11-15"}, {"field": "date", "operator": "<", "value": "2017-11-17"}, {"field": "summaryRows", "operator": "like", "value": "%Volvo%"}])

NB! Filter request should be URL encoded!

Pagination is possible using _pageNo and _pageLength:

GET /<yourcompany>/articles/?_pageNo=0&_pageLength=50

_pageNo starts with 0 (default value), Default _pageLength is 50.

One document contents

GET /<yourcompany>/articles/<id>

Returns document data with all subdocuments (rows etc).

POST

Insert document

POST /<yourcompany>/articles/

Update existing document

POST /<yourcompany>/articles/<id>

Document data should be in POST body variable data.

Returns inserted or updated document full data.

Id of inserted document could be found in returned inserted document data.

DELETE

Delete document

DELETE /<yourcompany>/articles/<id>

Deletes document with given id

Fields

Field	Type	Default	Etc
id	int		PK
code	varchar(50)		SK
name	varchar(200)
unitId	int		units
articleGroupId	int		articlegroups
BAASHIND	double
BHKPV	date
memo	varchar(255)
status	int
vatId	int		vats
accountId	int		accounts
purchaseAccountId	int		accounts
purchaseVatId	int		vats
typeId	int
trademarkId	int	0	trademarks
picture	varchar(100)	''
color	varchar(50)	''
supplierId	int	0	companies
supplierCode	varchar(50)	''
purchasePrice	double	0
purchaseCurrencyId	int	0	currencies
markup	double	0
barcode	varchar(50)	''
cnCodeId	int	0	cncodes
countryId	int	0	countries
name2	varchar(200)	''
vatGroupId	int	0	vatgroups
webshop	int	0
KULUKONTOID	int	0	accounts
MPRINT	int	1
MYYGIMAKS	int	0
gtin	varchar(50)	''
TAARAID	int	0	articles
additionalName	varchar(200)	''
masterGoodId	int	0	articles
variation	varchar	''

Subdocuments

articleunits

Field	Type	Etc
articleId	int	PK
unitId	int	PK units
coef	double

minwarehousestate

Field	Type	Default	Etc
articleId	int		PK
warehouseId	int		PK warehouses
warehouseState	double	0

purchaseprices

Field	Type	Default	Etc
articleId	int		PK
companyId	int		PK
nr	int	0
supplierCode	varchar(50)	''
purchasePrice	double	0
currencyId	int	0	currencies
markup	double	0

salesprices

Field	Type	Default	Etc
articleId	int		PK
pricelistId	int		PK
price	double
discount	double	0

articlecomponents

Field	Type	Default	Etc
articleId	int		PK
nr	int		PK
compId	int		articles
quantity	double
sourceWarehouseId	int		warehouses
print	int	1

articleanalogs

Field	Type	Default	Etc
K1ID	int	0	PK articles
K2ID	int	0	PK articles
memo	varchar(255)	''

Output format

Output formats are JSON (default) or PHP print_r output.

Output format could be changed using HTTP_X_OUTPUTFORMAT request header variable.
Possible values:

json
php

Authentication

Token based authentication, with token in X-ProfitToken request header variable.