entrybatches
type: tableMethods
GET
List documents
List of documents matching search, pagination and order clauses returned
GET /<yourcompany>/entrybatches/
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>/entrybatches/?_pageNo=0&_pageLength=50
_pageNo starts with 0 (default value), Default _pageLength is 50.
One document contents
GET /<yourcompany>/entrybatches/<id>
Returns document data with all subdocuments (rows etc).
POST
Insert document
POST /<yourcompany>/entrybatches/
Update existing document
POST /<yourcompany>/entrybatches/<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>/entrybatches/<id>
Deletes document with given id
Fields
| Field | Type | Default | Etc |
|---|---|---|---|
| id | int | PK | |
| status | int | ||
| entryTypeId | int | entrytypes | |
| date | date | ||
| withCurrency | int | ||
| document | varchar(100) | ||
| memo | varchar(255) | ||
| SUMMA_D | double | ||
| SUMMA_K | double | ||
| nr | int | SK | |
| locked | int | ||
| fiscalYearId | int | SK fiscalperiods | |
| ORDERNR | int | ||
| ORDERTEXT | varchar(100) | ||
| ORDERLISA | varchar(100) | ||
| ORDERALLKIRI1 | varchar(100) | ||
| ORDERALLKIRI2 | varchar(100) | ||
| AVDFIRMAID | int | ||
| AVDMAKSEAEG | int | ||
| AVDVIIVIS | int | ||
| AVDMAKSTUD | double | ||
| AVDARVE | int | ||
| invoiceId | int | ||
| PVID | int | POHIVARAD | |
| MARVEID | int | 0 | salesinvoices |
| OARVEID | int | 0 | purchaseinvoices |
| TASUMINEID | int | 0 | payments |
| STLID | int | 0 | waybills |
| LAEKID | int | 0 | incomings |
| PALGAKUUID | int | 0 | PALGAKUUD |
| AVDSEOTUD | double | 0 | |
| AVDSEOTAV | double | 0 | |
| DOKKPV | date |
Subdocuments
entries
| Field | Type | Default | Etc |
|---|---|---|---|
| KANDEID | int | PK | |
| nr | int | PK | |
| accountId | int | accounts | |
| objectId | int | objects | |
| memo | varchar(255) | ||
| currencyId | int | currencies | |
| debit | double | ||
| credit | double | ||
| debitBase | double | ||
| creditBase | double | ||
| rate | double | 1 | |
| companyId | int | 0 | companies |
| invoiceNr | varchar(100) | '' | |
| dueDate | int | ||
| interest | double | ||
| datePaid | date | ||
| drate | double | 1 | |
| TEHINGUPARTNERID | int | 0 | TEHINGUPARTNERID |
| TEGEVUSALAID | int | 0 | TEGEVUSALAD |
| ALLIKASID | int | 0 | ALLIKAD |
| RAHAVOOGID | int | 0 | RAHAVOOD |
entrylinks
| Field | Type | Default | Etc |
|---|---|---|---|
| KANDE1ID | int | entrybatches | |
| KANDE2ID | int | ||
| companyId | int | companies | |
| KONTO1ID | int | accounts | |
| KONTO2ID | int | accounts | |
| datePaid | double |
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.
Profit API v 0.1.4.2 beta, © Intellisoft OÜ 2017 - 2024