Projects API
General:
Basics:
Base-URL: https://capi.lagerkoll.com/v1/projects/
Parameters in the url should all be encoded and all data sent should be UTF-8
MAX number of requests per minute is set to 200.
When the limit is hit an error with code 429 is returned, with the header "Retry-After" containing the number of seconds you have to wait for your next request.
When the limit is hit an error with code 429 is returned, with the header "Retry-After" containing the number of seconds you have to wait for your next request.
Headers:
There are 2 ways to be authenticated when using this API. in both ways you add headers to the request.
1) Use an API-key together with store-id. This would be used when communicating machine to machine and no real person is involved. The API-key is available from where you activated the API. The store-id is also available in the same place.
2) Use a user_id and user_token together with a store-id. You get these values from the login-request. The values are connected to a person and are gained when an actual login to the system has been made.
1) Use an API-key together with store-id. This would be used when communicating machine to machine and no real person is involved. The API-key is available from where you activated the API. The store-id is also available in the same place.
2) Use a user_id and user_token together with a store-id. You get these values from the login-request. The values are connected to a person and are gained when an actual login to the system has been made.
store: <<STORE>> user_id: <<USER_ID>> user_token: <<USER_TOKEN>> api_key: <<API_KEY>> Accept: application/json Content-Type: application/json
Errors:
Code | Description |
---|---|
900001 | Credentials don't match |
900101 | Common error |
900429 | Too many requests |
906001 | Error when getting project |
906002 | Error when getting customer |
906003 | Error when getting user |
906004 | Error when getting article |
906005 | Error when getting invoice draft |
906011 | Error when creating a project |
906012 | Error when creating a project article |
906013 | Error when creating invoice draft from articles |
906014 | Error when creating invoice from invoice drafts |
906021 | Error when updating a project |
906022 | Error when updating a project article |
906023 | Error when updating an invoice draft |
906031 | To large amount for the artcile |
906032 | Project still has articles with amount in them |
{ "errorCode" : 900101, "errorMessage" : "Something went wrong on the server", "errorField" : null, "errorData" : null }
Projects API:
Export
Create export
POSTUrl: /export
Headers:
Accept: application/json or application/xml
Create export file for articles in open projects
Valid parameters:
Parameter | Description | Default value | Allowed values |
---|---|---|---|
save_document | If true, the document will be saved in the feature extension. If false, a mail will be sent to all admins of the store | false |
Body:
Successfull response:
Projects
Get projects
GETUrl:
Headers:
Accept: application/json or application/xml
Get a list of projects
Valid parameters:
Parameter | Description | Default value | Allowed values |
---|---|---|---|
state | -1 | 0,1 | |
from | 0 | ||
to | 0 | ||
page | 0 | ||
limit | 50 | ||
query | |||
cost | false | ||
sort_column | start_date | start_date,end_date | |
order | desc | asc,desc |
Body:
Successfull response:
{ "pages": 6087, "projects": [{ "createdByName": "createdByName", "cost": 9937.356334192184, "created": 2395, "description": "description", "customerName": "customerName", "stockValue": 2856.2940263149185, "name": "name", "customerId": 7384, "state": "0", "projectId": 9222, "responsibleUserId": 4423, "articles": [{ "articleName": "articleName", "snId": "snId", "invoicedAmount": 1167.301102783057, "batchSnBestBefore": 6203, "accountName": "accountName", "articleId": "articleId", "priceListId": 9050, "purchasePrice": 3774.2242729574396, "batchId": "batchId", "rental": false, "rentalCurrency": "rentalCurrency", "accountId": 8988, "checkoutDate": 3456, "price": 4324.5987979526235, "comment": "comment", "id": 1883, "projectId": 7539, "checkoutAmount": 1001.9219264351908, "events": [{ "date": 1714154183289, "amount": 3595.6022759936013, "type": "type" }], "checkinConsumeDate": 1714154183289, "checkinAmount": 8744.961222674461, "consumedAmount": 1879.8021848556823 }], "createdById": 7827, "responsibleUserName": "responsibleUserName" }], "pageSize": 7205, "page": 4616, "projectsCount": 3636 }
Get changed projects
GETUrl: /events
Headers:
Accept: application/json or application/xml
Get a list of open projects where articles have been checked out, checked in, consumed or invoiced between a start date and end date
Valid parameters:
Parameter | Description | Default value | Allowed values |
---|---|---|---|
start_date | Start date of when events can occur. Format is yyyy-MM-dd and defaults to previous month | ||
end_date | End date of when events can occur. Format is yyyy-MM-dd and defaults to end of start date's month | ||
page | 0 | ||
limit | 50 | ||
sort_column | created | name, customer, created_by, created | |
order | desc | asc,desc |
Body:
Successfull response:
{ "pages": 9959, "projects": [{ "createdByName": "createdByName", "cost": 9041.8999779186, "created": 3054, "description": "description", "customerName": "customerName", "stockValue": 34.53435708778984, "name": "name", "customerId": 7156, "state": "0", "projectId": 6157, "responsibleUserId": 6850, "articles": [{ "articleName": "articleName", "snId": "snId", "invoicedAmount": 250.90250810843372, "batchSnBestBefore": 8340, "accountName": "accountName", "articleId": "articleId", "priceListId": 3031, "purchasePrice": 8523.924396833694, "batchId": "batchId", "rental": false, "rentalCurrency": "rentalCurrency", "accountId": 5422, "checkoutDate": 7833, "price": 5189.834995989281, "comment": "comment", "id": 9432, "projectId": 585, "checkoutAmount": 4678.246856832617, "events": [{ "date": 1714154183289, "amount": 8262.254110771846, "type": "type" }], "checkinConsumeDate": 1714154183289, "checkinAmount": 3220.372539949454, "consumedAmount": 4930.28719660772 }], "createdById": 5403, "responsibleUserName": "responsibleUserName" }], "pageSize": 8128, "page": 4277, "projectsCount": 4035 }
Get project for id
GETUrl: /{project_id}
Headers:
Accept: application/json or application/xml
Get project based on id
Body:
Successfull response:
{ "createdByName": "createdByName", "cost": 3899.790798646232, "created": 599, "description": "description", "customerName": "customerName", "stockValue": 8940.660512130315, "name": "name", "customerId": 901, "state": "0", "projectId": 9178, "responsibleUserId": 137, "articles": [{ "articleName": "articleName", "snId": "snId", "invoicedAmount": 2152.8276914049748, "batchSnBestBefore": 9243, "accountName": "accountName", "articleId": "articleId", "priceListId": 52, "purchasePrice": 2603.5936207608547, "batchId": "batchId", "rental": false, "rentalCurrency": "rentalCurrency", "accountId": 6291, "checkoutDate": 3061, "price": 986.7087316964452, "comment": "comment", "id": 7707, "projectId": 4347, "checkoutAmount": 3224.3819064180266, "events": [{ "date": 1714154183290, "amount": 7982.916623905724, "type": "type" }], "checkinConsumeDate": 1714154183290, "checkinAmount": 7986.391382564788, "consumedAmount": 5846.875694794193 }], "createdById": 6312, "responsibleUserName": "responsibleUserName" }
Get project articles
GETUrl: /{project_id}/articles
Headers:
Accept: application/json or application/xml
Get a list of project articles
Valid parameters:
Parameter | Description | Default value | Allowed values |
---|---|---|---|
query | |||
state | 0-all articles, 1-only checked out articles with available value, 2-checked out and rental articles with available value | 0 | 0,1,2 |
page | 0 | ||
limit | 50 | ||
sort_column | checkout_date | article_id, article_name, user, checkout_date | |
sort_order | desc | asc,desc |
Body:
Successfull response:
{ "pages": 79, "pageSize": 1491, "page": 3388, "projectsCount": 2495, "articles": [{ "articleName": "articleName", "snId": "snId", "invoicedAmount": 4184.068298395549, "batchSnBestBefore": 1304, "accountName": "accountName", "articleId": "articleId", "priceListId": 5443, "purchasePrice": 4374.4296381770255, "batchId": "batchId", "rental": false, "rentalCurrency": "rentalCurrency", "accountId": 6192, "checkoutDate": 1701, "price": 5980.4239118411715, "comment": "comment", "id": 5620, "projectId": 6109, "checkoutAmount": 2319.8824723404045, "events": [{ "date": 1714154183290, "amount": 8940.471713421319, "type": "type" }], "checkinConsumeDate": 1714154183290, "checkinAmount": 8599.428762718997, "consumedAmount": 2604.830114905844 }] }
Get invoice drafts
GETUrl: /{project_id}/articles/invoice
Headers:
Accept: application/json or application/xml
Get a list of invoice drafts for a project
Valid parameters:
Parameter | Description | Default value | Allowed values |
---|---|---|---|
state | 0-invoice drafts that are not invoiced or in processed, 1-invoice drafts that are in process but not yet invoiced 2-invoice drafts which are invoiced and processed | 0 | 0, 1, 2 |
page | 0 | ||
limit | 50 | ||
sort_column | created | article_id, article_name, user, created | |
sort_order | desc | asc,desc |
Body:
Successfull response:
{ "invoiceDrafts": [{ "createdByName": "createdByName", "amount": 5489.0914796975985, "articleName": "articleName", "pricelistId": 2062, "endDate": 1714154183290, "rentalAmount": 2794.279811888255, "created": 1714154183290, "dataType": "dataType", "articleId": "articleId", "isInvoiced": false, "rentalCurrency": "rentalCurrency", "dataId": 6447, "price": 6185.166767969652, "isProcessed": false, "dataArticleId": 3623, "currency": "currency", "comment": "comment", "invoiceId": "invoiceId", "id": 2106, "startDate": 1714154183290, "createdById": 4112 }], "pages": 3413, "pageSize": 7209, "draftsCount": 3132, "page": 215 }
Get cost for project
GETUrl: /{project_id}/cost
Headers:
Accept: application/json or application/xml
Get total cost for a project
Body:
Successfull response:
{ "invoiceDrafts": [{ "createdByName": "createdByName", "amount": 1731.123068263657, "articleName": "articleName", "pricelistId": 1535, "endDate": 1714154183291, "rentalAmount": 3766.5482377133962, "created": 1714154183291, "dataType": "dataType", "articleId": "articleId", "isInvoiced": true, "rentalCurrency": "rentalCurrency", "dataId": 3382, "price": 8210.62550242269, "isProcessed": false, "dataArticleId": 4655, "currency": "currency", "comment": "comment", "invoiceId": "invoiceId", "id": 9528, "startDate": 1714154183291, "createdById": 672 }], "pages": 4648, "pageSize": 93, "draftsCount": 2576, "page": 8207 }
Add project
POSTUrl:
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Content-type: application/json or application/xml
Add a new project
Body:
{ "createdByName": "createdByName", "cost": 9329.526022579994, "created": 79, "description": "description", "customerName": "customerName", "stockValue": 7131.611617266183, "name": "name", "customerId": 6355, "state": "0", "responsibleUserId": 5818, "articles": [{ "articleName": "articleName", "snId": "snId", "invoicedAmount": 3953.985300270554, "batchSnBestBefore": 5784, "accountName": "accountName", "articleId": "articleId", "priceListId": 8217, "purchasePrice": 5305.470614003952, "batchId": "batchId", "rental": true, "rentalCurrency": "rentalCurrency", "accountId": 6, "checkoutDate": 2871, "price": 1903.2378580535924, "comment": "comment", "id": 5444, "projectId": 8868, "checkoutAmount": 3857.3081197638303, "events": [{ "date": 1714154183291, "amount": 879.3520036867242, "type": "type" }], "checkinConsumeDate": 1714154183291, "checkinAmount": 2805.711735815486, "consumedAmount": 6733.631508003363 }], "createdById": 3035, "responsibleUserName": "responsibleUserName" }
Successfull response:
{ "createdByName": "createdByName", "cost": 6005.412328713556, "created": 8478, "description": "description", "customerName": "customerName", "stockValue": 5225.797209941633, "name": "name", "customerId": 4354, "state": "0", "projectId": 3616, "responsibleUserId": 529, "articles": [{ "articleName": "articleName", "snId": "snId", "invoicedAmount": 7848.862221442354, "batchSnBestBefore": 4049, "accountName": "accountName", "articleId": "articleId", "priceListId": 5702, "purchasePrice": 7851.2587482616045, "batchId": "batchId", "rental": false, "rentalCurrency": "rentalCurrency", "accountId": 1007, "checkoutDate": 5697, "price": 9202.764817964025, "comment": "comment", "id": 547, "projectId": 777, "checkoutAmount": 3195.205625980263, "events": [{ "date": 1714154183291, "amount": 1403.7330454443154, "type": "type" }], "checkinConsumeDate": 1714154183291, "checkinAmount": 8672.373418989702, "consumedAmount": 6122.684619453325 }], "createdById": 3906, "responsibleUserName": "responsibleUserName" }
Add project article
POSTUrl: /{id}/article
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Content-type: application/json or application/xml
Add a new article to a project
Body:
{ "articleName": "articleName", "snId": "snId", "invoicedAmount": 850.7377073427913, "batchSnBestBefore": 9255, "accountName": "accountName", "articleId": "articleId", "priceListId": 3253, "purchasePrice": 9836.057822417204, "batchId": "batchId", "rental": true, "rentalCurrency": "rentalCurrency", "accountId": 8251, "checkoutDate": 2781, "price": 6529.509101583223, "comment": "comment", "id": 6131, "projectId": 2168, "checkoutAmount": 3092.629241416297, "events": [{ "date": 1714154183291, "amount": 9458.36475137459, "type": "type" }], "checkinConsumeDate": 1714154183291, "checkinAmount": 1389.5440192363717, "consumedAmount": 3043.0548184343097 }
Successfull response:
{ "articleName": "articleName", "snId": "snId", "invoicedAmount": 2186.529104580579, "batchSnBestBefore": 709, "accountName": "accountName", "articleId": "articleId", "priceListId": 3156, "purchasePrice": 5684.250879217804, "batchId": "batchId", "rental": false, "rentalCurrency": "rentalCurrency", "accountId": 1563, "checkoutDate": 9713, "price": 3994.820422151576, "comment": "comment", "id": 469, "projectId": 6055, "checkoutAmount": 2791.5711528832, "events": [{ "date": 1714154183291, "amount": 124.16457304599393, "type": "type" }], "checkinConsumeDate": 1714154183291, "checkinAmount": 6624.427939275749, "consumedAmount": 9751.808955416995 }
Update project
PUTUrl: /{id}
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Content-type: application/json or application/xml
Update an existing project
Body:
{ "createdByName": "createdByName", "cost": 6018.326454725779, "created": 8253, "description": "description", "customerName": "customerName", "stockValue": 9019.24216366411, "name": "name", "customerId": 6139, "state": "0", "projectId": 6322, "responsibleUserId": 9115, "articles": [{ "articleName": "articleName", "snId": "snId", "invoicedAmount": 6874.873395382873, "batchSnBestBefore": 1306, "accountName": "accountName", "articleId": "articleId", "priceListId": 3373, "purchasePrice": 816.0098992647436, "batchId": "batchId", "rental": true, "rentalCurrency": "rentalCurrency", "accountId": 2436, "checkoutDate": 2867, "price": 5418.504748402691, "comment": "comment", "id": 3486, "projectId": 7563, "checkoutAmount": 3185.3536569839325, "events": [{ "date": 1714154183292, "amount": 454.04090982195777, "type": "type" }], "checkinConsumeDate": 1714154183292, "checkinAmount": 2559.004766871766, "consumedAmount": 6991.684268110628 }], "createdById": 512, "responsibleUserName": "responsibleUserName" }
Successfull response:
{ "createdByName": "createdByName", "cost": 6361.033950906033, "created": 3234, "description": "description", "customerName": "customerName", "stockValue": 3569.8509752625396, "name": "name", "customerId": 8348, "state": "0", "projectId": 8645, "responsibleUserId": 4885, "articles": [{ "articleName": "articleName", "snId": "snId", "invoicedAmount": 882.1514419892628, "batchSnBestBefore": 8310, "accountName": "accountName", "articleId": "articleId", "priceListId": 1212, "purchasePrice": 1169.3112892178804, "batchId": "batchId", "rental": true, "rentalCurrency": "rentalCurrency", "accountId": 1568, "checkoutDate": 5927, "price": 8469.274211767774, "comment": "comment", "id": 7602, "projectId": 1297, "checkoutAmount": 9337.406107602537, "events": [{ "date": 1714154183292, "amount": 976.3217543173197, "type": "type" }], "checkinConsumeDate": 1714154183292, "checkinAmount": 3413.6753536204333, "consumedAmount": 6563.881626249431 }], "createdById": 467, "responsibleUserName": "responsibleUserName" }
Update project article
PUTUrl: /{id}/article/{article_id}
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Content-type: application/json or application/xml
Update an existing project article
Body:
{ "articleName": "articleName", "snId": "snId", "invoicedAmount": 3666.678105577691, "batchSnBestBefore": 1633, "accountName": "accountName", "articleId": "articleId", "priceListId": 1595, "purchasePrice": 9454.376757667722, "batchId": "batchId", "rental": true, "rentalCurrency": "rentalCurrency", "accountId": 7764, "checkoutDate": 8011, "price": 7089.663795219498, "comment": "comment", "id": 8543, "projectId": 1723, "checkoutAmount": 4267.774147737694, "events": [{ "date": 1714154183292, "amount": 8648.021535467306, "type": "type" }], "checkinConsumeDate": 1714154183292, "checkinAmount": 607.8371799819937, "consumedAmount": 2354.480481736624 }
Successfull response:
{ "invoiceDrafts": [{ "createdByName": "createdByName", "amount": 7286.760750224812, "articleName": "articleName", "pricelistId": 3622, "endDate": 1714154183292, "rentalAmount": 7392.002635702944, "created": 1714154183292, "dataType": "dataType", "articleId": "articleId", "isInvoiced": false, "rentalCurrency": "rentalCurrency", "dataId": 8185, "price": 7954.7293338663185, "isProcessed": false, "dataArticleId": 6520, "currency": "currency", "comment": "comment", "invoiceId": "invoiceId", "id": 2265, "startDate": 1714154183292, "createdById": 8382 }], "articles": [{ "articleName": "articleName", "snId": "snId", "invoicedAmount": 1217.66089837698, "batchSnBestBefore": 6077, "accountName": "accountName", "articleId": "articleId", "priceListId": 4638, "purchasePrice": 837.9507163262278, "batchId": "batchId", "rental": true, "rentalCurrency": "rentalCurrency", "accountId": 5970, "checkoutDate": 9818, "price": 132.69290261098797, "comment": "comment", "id": 5054, "projectId": 7499, "checkoutAmount": 9029.31180984982, "events": [{ "date": 1714154183292, "amount": 8545.868773677308, "type": "type" }], "checkinConsumeDate": 1714154183292, "checkinAmount": 7127.796264745731, "consumedAmount": 4629.7795588165645 }] }
Create invoice drafts
PUTUrl: /{id}/invoice/draft
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Content-type: application/json or application/xml
Create invoice drafts for articles in a project
Body:
{ "projectId": 360, "articles": [{ "articleName": "articleName", "snId": "snId", "invoicedAmount": 2810.447297073915, "batchSnBestBefore": 5316, "accountName": "accountName", "articleId": "articleId", "priceListId": 3771, "purchasePrice": 5320.284408879291, "batchId": "batchId", "rental": false, "rentalCurrency": "rentalCurrency", "accountId": 6680, "checkoutDate": 882, "price": 8148.833198913915, "comment": "comment", "id": 4766, "projectId": 3590, "checkoutAmount": 7985.194613215322, "events": [{ "date": 1714154183292, "amount": 9571.652067561276, "type": "type" }], "checkinConsumeDate": 1714154183292, "checkinAmount": 9543.264495035286, "consumedAmount": 2216.926256774199 }] }
Successfull response:
{ "invoiceDrafts": [{ "createdByName": "createdByName", "amount": 8528.668029333523, "articleName": "articleName", "pricelistId": 1594, "endDate": 1714154183292, "rentalAmount": 3808.5015147338318, "created": 1714154183292, "dataType": "dataType", "articleId": "articleId", "isInvoiced": true, "rentalCurrency": "rentalCurrency", "dataId": 6906, "price": 7818.437043052363, "isProcessed": true, "dataArticleId": 3526, "currency": "currency", "comment": "comment", "invoiceId": "invoiceId", "id": 9648, "startDate": 1714154183292, "createdById": 9695 }], "articles": [{ "articleName": "articleName", "snId": "snId", "invoicedAmount": 4073.4356605218622, "batchSnBestBefore": 9937, "accountName": "accountName", "articleId": "articleId", "priceListId": 8809, "purchasePrice": 7245.615650626912, "batchId": "batchId", "rental": true, "rentalCurrency": "rentalCurrency", "accountId": 4976, "checkoutDate": 5667, "price": 8427.398740643617, "comment": "comment", "id": 7539, "projectId": 4420, "checkoutAmount": 5093.912108884808, "events": [{ "date": 1714154183292, "amount": 3037.1850715253513, "type": "type" }], "checkinConsumeDate": 1714154183292, "checkinAmount": 3321.932289004548, "consumedAmount": 7833.952382024529 }] }
Send invoice drafts to external integrations
PUTUrl: /{id}/invoice
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Content-type: application/json or application/xml
Send existing invoice drafts to external integrations and sets the draft to invoiced
Body:
{ "invoiceDrafts": [{ "createdByName": "createdByName", "amount": 2413.853489704305, "articleName": "articleName", "pricelistId": 1375, "endDate": 1714154183294, "rentalAmount": 6710.063055826192, "created": 1714154183294, "dataType": "dataType", "articleId": "articleId", "isInvoiced": true, "rentalCurrency": "rentalCurrency", "dataId": 4026, "price": 205.37016434120537, "isProcessed": false, "dataArticleId": 2874, "currency": "currency", "comment": "comment", "invoiceId": "invoiceId", "id": 9467, "startDate": 1714154183294, "createdById": 2163 }], "freeTexts": [{}], "customerId": 9605, "type": "type", "projectId": 6026 }
Successfull response:
{ "invoiceDrafts": [{ "createdByName": "createdByName", "amount": 9555.645136539055, "articleName": "articleName", "pricelistId": 3183, "endDate": 1714154183294, "rentalAmount": 8765.935582162572, "created": 1714154183294, "dataType": "dataType", "articleId": "articleId", "isInvoiced": false, "rentalCurrency": "rentalCurrency", "dataId": 7859, "price": 3767.1699378608346, "isProcessed": true, "dataArticleId": 4972, "currency": "currency", "comment": "comment", "invoiceId": "invoiceId", "id": 9433, "startDate": 1714154183294, "createdById": 5961 }], "articles": [{ "articleName": "articleName", "snId": "snId", "invoicedAmount": 2637.09032752291, "batchSnBestBefore": 5952, "accountName": "accountName", "articleId": "articleId", "priceListId": 1626, "purchasePrice": 5404.7226956266795, "batchId": "batchId", "rental": true, "rentalCurrency": "rentalCurrency", "accountId": 5902, "checkoutDate": 9934, "price": 5722.378381970343, "comment": "comment", "id": 4494, "projectId": 9587, "checkoutAmount": 6611.6353106045535, "events": [{ "date": 1714154183294, "amount": 318.4510093084381, "type": "type" }], "checkinConsumeDate": 1714154183294, "checkinAmount": 3584.318360960984, "consumedAmount": 1133.59983761256 }] }
Close project
PUTUrl: /{id}/close
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Content-type: application/json or application/xml
Close an existing project
Body:
{"closeArticles": {}}
Successfull response:
{ "createdByName": "createdByName", "cost": 2885.7024341343986, "created": 859, "description": "description", "customerName": "customerName", "stockValue": 2793.3524681689605, "name": "name", "customerId": 4703, "state": "0", "projectId": 9332, "responsibleUserId": 7595, "articles": [{ "articleName": "articleName", "snId": "snId", "invoicedAmount": 7937.921357539925, "batchSnBestBefore": 9849, "accountName": "accountName", "articleId": "articleId", "priceListId": 9889, "purchasePrice": 8738.353509983866, "batchId": "batchId", "rental": true, "rentalCurrency": "rentalCurrency", "accountId": 251, "checkoutDate": 1314, "price": 4136.730209248216, "comment": "comment", "id": 315, "projectId": 3180, "checkoutAmount": 1365.064728044022, "events": [{ "date": 1714154183294, "amount": 5729.518565198181, "type": "type" }], "checkinConsumeDate": 1714154183294, "checkinAmount": 7772.026407516088, "consumedAmount": 7583.094357899786 }], "createdById": 2196, "responsibleUserName": "responsibleUserName" }
Classes:
CloseProjectRequest
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
closeArticles | HashMap | Map containing articles that should be handled when closing a project. Key in map is project-article id and value is from enum set | Value in map can be either checkin, consume, end_rent | R,W |
InvoiceDraft
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
id | long | R | |||||
dataType | String | R | |||||
dataId | Long | R | |||||
dataArticleId | Long | R | |||||
articleId | String | R | |||||
articleName | String | R | |||||
amount | Double | R | |||||
price | Double | R | |||||
pricelistId | long | R | |||||
currency | String | R | |||||
rentalCurrency | String | R | |||||
startDate | Date | R | |||||
endDate | Date | R | |||||
rentalAmount | Double | R | |||||
comment | String | R | |||||
isInvoiced | boolean | Indicates if row has been marked as invoiced | R | ||||
isProcessed | boolean | Indicates if row has been completely processed as invoiced | R | ||||
invoiceId | String | If row has been invoiced, this is id of the created invoice | R | ||||
createdById | Long | R | |||||
createdByName | String | R | |||||
created | Date | R |
InvoiceDraftProjectArticlesRequest
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
projectId | long | R | |||||
articles | List | R |
InvoiceProjectArticlesRequest
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
projectId | long | R | |||||
customerId | Long | R | |||||
type | String | invoice, cash, card, ag | R | ||||
invoiceDrafts | List | R | |||||
freeTexts | List | R,W |
InvoiceProjectArticlesResponse
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articles | List | R | |||||
invoiceDrafts | List | R |
Project
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
projectId | long | R | |||||
name | String | R,W | |||||
customerId | Long | R,W | |||||
customerName | String | R,W | |||||
description | String | R,W | |||||
state | Integer | Write only with POST | 0 | NEW = 0, DEVELOPING = 1, FINISHED = 2, CANCELLED = 3 |
R,W | ||
responsibleUserId | Long | R,W | |||||
responsibleUserName | String | R,W | |||||
createdById | Long | R,W | |||||
createdByName | String | R,W | |||||
created | long | R,W | |||||
articles | List | R,W | |||||
cost | Double | R,W | |||||
stockValue | Double | R,W |
ProjectArticle
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
id | long | R,W | |||||
projectId | long | R,W | |||||
articleId | String | R,W | |||||
articleName | String | R,W | |||||
batchId | String | R,W | |||||
snId | String | R,W | |||||
batchSnBestBefore | Long | R,W | |||||
checkoutAmount | Double | R,W | |||||
checkinAmount | Double | R,W | |||||
consumedAmount | Double | R,W | |||||
invoicedAmount | Double | R,W | |||||
priceListId | long | R,W | |||||
rental | boolean | R,W | |||||
price | double | R,W | |||||
rentalCurrency | String | R,W | |||||
comment | String | R,W | |||||
purchasePrice | Double | R,W | |||||
events | List | R,W | |||||
accountId | long | R,W | |||||
accountName | String | R,W | |||||
checkoutDate | Long | R,W | |||||
checkinConsumeDate | Date | R,W |
ProjectArticleEvent
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
type | String | R,W | |||||
amount | double | R,W | |||||
date | Date | R,W |
ProjectArticlesResponse
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
page | int | R | |||||
pages | int | R | |||||
pageSize | int | R | |||||
projectsCount | int | R | |||||
articles | List | R |
ProjectInvoiceDraftsResponse
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
page | int | R | |||||
pages | int | R | |||||
pageSize | int | R | |||||
draftsCount | int | R | |||||
invoiceDrafts | List | R |
ProjectsResponse
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
page | int | R | |||||
pages | int | R | |||||
pageSize | int | R | |||||
projectsCount | int | R | |||||
projects | List | R |