salesinvoices

type: table

Methods

GET

List documents

List of documents matching search, pagination and order clauses returned

GET /<yourcompany>/salesinvoices/

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

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

One document contents

GET /<yourcompany>/salesinvoices/<id>

Returns document data with all subdocuments (rows etc).

POST

Insert document

POST /<yourcompany>/salesinvoices/

Update existing document

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

Deletes document with given id

Fields

Field	Type	Default	Etc
id	int		PK
nr	int		SK
date	date		SK
typeId	int
sourceCompanyId	int
destinationCompanyId	int		companies
sourceWarehouseId	int		warehouses
destinationWarehouseId	int
paymentDue	int
interest	double
memo	varchar(255)
status	int
payerId	int		companies
priceWithVat	int
sum	double
rounding	double
sourceObjectId	int		SK objects
nrprefix	varchar(10)		SK
nrsuffix	varchar(10)		SK
discount	double
additionalText1	varchar(1024)
additionalText2	varchar(1024)
exported	int	0
cash	int	0
currencyId	int	0	currencies
rate	double	1
reportId	int	0	ARUANDED
deliveryTerms	varchar(255)	''
paymentDue	int	0
TRANSPORDIFIRMAID	int	0	companies
transportTypeId	int	0	TRANSPORDILIIGID
KOOSTAJA	int	0	users
VEOKULUVALIS	double	0
VEOKULUSISE	double	0
KINDLUSTUSKULU	double	0
MUUKULU	double	0
KAARDIMAKSE	int	0
VIITENUMBER	varchar(20)	''
PEALKIRI	varchar(100)	''
objAddress	varchar(100)	''
contact	varchar(100)	''
SAATELEHED	varchar(255)	''
KOONDARVE	int	0
summaryRows	varchar(1000)	''
summaryHeader	varchar(1000)	''
createdDatetime	timestamp
updatedDatetime	timestamp
OBJAADRLINN	varchar(100)	''
OBJAADRINDEKS	varchar(20)	''
OBJAADRRIIKID	int	0	countries
shippingAreaId	int	0	VEOPIIRKONNAD
ALGVIITENUMBER	int	0
drate	double	1
TEHINGUPARTNERID	int	0	TEHINGUPARTNERID
EKVIITUNG	int	0
EKVIITUNGTUNNUS	varchar(50)	''
MAKSMATA	double	0
KASSAID	int	0	KASSAD
KMDERISUS	varchar
EINVOICESTATEID	int	0
EINVOICETRANSACTION	varchar	''	EINVOICESTATES
EINVOICESENT	timestamp
EICHBANK	int	0
EICHPOST	int	0
EICHEMAIL	int	0
EICHPORTAL	int	0
EINVOICESENDNOW	int	0

Subdocuments

salesinvoicerows

Field	Type	Default	Etc
salesInvoiceId	int		PK
nr	int		PK
articleId	int		articles
unitId	int		units
quantity	double
price	double
memo	varchar(255)
articleCode	varchar(50)
articleName	varchar(100)
VAT	double
unitCode	varchar(10)
discount	double
vatId	int		vats
KAAL	double	0
RKONTOID	int	0	accounts
sum	double	0
KMKOKKU	double	0
waybillId	int	0	waybills
additionalText1	varchar(255)	''
additionalText2	varchar(255)	''
additionalText3	varchar(255)	''
additionalQuantity1	double	0
additionalQuantity2	double	0
additionalQuantity3	double	0
ONTAARA	int	0
additionalText4	varchar(255)	''
additionalText5	varchar(255)	''
additionalText6	varchar(255)	''
additionalQuantity4	double	0
additionalQuantity5	double	0
additionalQuantity6	double	0
lot	varchar
objId	int	0	objects
vatCoef	double	1

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.