companies

type: table

Methods

GET

List documents

List of documents matching search, pagination and order clauses returned

GET /<yourcompany>/companies/

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>/companies/?_pageNo=0&_pageLength=50

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

One document contents

GET /<yourcompany>/companies/<id>

Returns document data with all subdocuments (rows etc).

POST

Insert document

POST /<yourcompany>/companies/

Update existing document

POST /<yourcompany>/companies/<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>/companies/<id>

Deletes document with given id

Fields

Field	Type	Default	Etc
id	int		PK
code	varchar(20)		SK
name	varchar(100)
regCode	varchar(20)
vatCode	varchar(20)
address	varchar(255)
phone	varchar(255)
fax	varchar(255)
email	varchar(100)
contact	varchar(100)
paymentPeriod	int
interest	double
memo	varchar(1000)
customer	int
supplier	int
clientAccountId	int		accounts
supplierAccountId	int		accounts
pricelistId	int		pricelists
discount	double	0
KYKORTER	int	0
KYPINDALA	double	0
KYOMANIK	varchar(100)	''
KYINIMARV	int	0
KYKORRUS	int	0
KYAADRESS	varchar(100)	''
salesmanId	int	0	users
KREDLIMIIT	double	0
JURAADRESSTANAV	varchar(100)	''
JURAADRESSLINN	varchar(100)	''
JURAADRESSINDEKS	varchar(20)	''
JURAADRESSRIIKID	int	0	countries
POSTIAADRESSTANAV	varchar(100)	''
POSTIAADRESSLINN	varchar(100)	''
POSTIAADRESSINDEKS	varchar(20)	''
POSTIAADRESSRIIKID	int	0	countries
groupId	int	0	companygroups
closed	int	0
LEPING	varchar(50)	''
KYMAJAID	int	0	KYMAJAD
KYKPINDALA	double	0
vatTypeId	int	0	vattypes
VIITENUMBER	varchar(20)	''
MARVEVORMID	int	0	ARUANDED
currencyId	int	0	currencies
webshop	int	0
KYARVEEMAILI	int	0
OTSEKORRALDUS	int	0
EMKONTOID	int	0	accounts
MYYGIMAKS	int	0
shippingAreaId	int	0	VEOPIIRKONNAD
paymentTermId	int	0	paymentterms
GLN	varchar(50)	''
invoiceMemo	varchar(255)	''
payerId	int	0	companies
TEHINGUPARTNERID	int	0	TEHINGUPARTNERID
KYTREPIKODA	int	0
D_TAGS	varchar(1000)	''
eInvoiceChannel	varchar
KYMAKSJA	varchar
KMDINF	int	1

Subdocuments

FIRMAKONTAKTID

Field	Type	Default	Etc
companyId	int		PK
nr	int		PK
PREFIX	varchar(10)	''
KONTAKT	varchar(100)	''
phone	varchar(50)	''
email	varchar(50)	''
memo	varchar(255)	''
EMAILKEELATUD	int	0
EPOODUID	varchar(32)	''
EPOODPWD	varchar(32)	''

PANGAARVED

Field	Type	Default	Etc
companyId	int		PK
nr	int		PK
bankId	int		banks
invoiceNr	varchar(20)	''
memo	varchar(255)
IBAN	varchar(100)	''

KYFIRMAMOOTJAD

Field	Type	Default	Etc
companyId	int		PK
articleId	int		PK articles
MOOTJA	int	1

KYFIRMASEERIAD

Field	Type	Etc
companyId	int	PK
enumerationId	int	PK KYSEERIAD
paymentDue	int

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.