Invoices API
General:
Basics:
Base-URL: https://capi.lagerkoll.com/v1/invoices/
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 |
901801 | Error when getting invoice draft |
901802 | Error when adding invoice draft |
901803 | Error when updating invoice draft |
901804 | Error when deleting invoice draft |
901805 | Error when invoicing draft |
{ "errorCode" : 900101, "errorMessage" : "Something went wrong on the server", "errorField" : null, "errorData" : null }
Invoices API:
Invoice drafts
Get invoice drafts
GETUrl: /drafts
Headers:
Accept: application/json or application/xml
Get a list of invoice drafts
Valid parameters:
Parameter | Description | Default value | Allowed values |
---|---|---|---|
query | |||
type | ALL | ALL, PROJECT, CUSTOMER_ORDER | |
return_invoiced_rows | true | ||
page | 0 | ||
limit | 100 | ||
sort_column | created | type, article_id, article_name, user, created | |
sort_order | desc | asc,desc |
Body:
Successfull response:
{ "invoiceDrafts": [{ "createdByName": "createdByName", "amount": 3049.0308399969445, "articleName": "articleName", "pricelistId": 1886, "endDate": 1752882500164, "rentalAmount": 9217.902250204816, "created": 1752882500164, "dataType": "dataType", "articleId": "articleId", "isInvoiced": false, "rentalCurrency": "rentalCurrency", "dataId": 4810, "price": 5099.662255585572, "isProcessed": true, "dataArticleId": 775, "currency": "currency", "comment": "comment", "invoiceId": "invoiceId", "id": 3226, "startDate": 1752882500164, "createdById": 812 }], "ordersCount": 328, "pages": 3252, "pageSize": 706, "page": 5877 }
Create invoice draft
POSTUrl: /drafts/customer_order/{order_id}
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 customer order
Body:
Successfull response:
{ "invoiceDrafts": [{ "createdByName": "createdByName", "amount": 8360.050376157102, "articleName": "articleName", "pricelistId": 7283, "endDate": 1752882500167, "rentalAmount": 2244.4876088414003, "created": 1752882500167, "dataType": "dataType", "articleId": "articleId", "isInvoiced": false, "rentalCurrency": "rentalCurrency", "dataId": 8646, "price": 1094.0122358754102, "isProcessed": false, "dataArticleId": 5135, "currency": "currency", "comment": "comment", "invoiceId": "invoiceId", "id": 4832, "startDate": 1752882500167, "createdById": 1787 }], "ordersCount": 923, "pages": 7653, "pageSize": 3001, "page": 2513 }
Invoice drafts
PUTUrl: /drafts/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:
{ "type": "type", "invoiceDraftIds": [{}] }
Successfull response:
{ "invoiceDrafts": [{ "createdByName": "createdByName", "amount": 52.048698314001165, "articleName": "articleName", "pricelistId": 5291, "endDate": 1752882500167, "rentalAmount": 6047.4560812444015, "created": 1752882500167, "dataType": "dataType", "articleId": "articleId", "isInvoiced": true, "rentalCurrency": "rentalCurrency", "dataId": 4126, "price": 9745.543961769816, "isProcessed": false, "dataArticleId": 1302, "currency": "currency", "comment": "comment", "invoiceId": "invoiceId", "id": 1514, "startDate": 1752882500167, "createdById": 619 }], "articles": [{ "articleName": "articleName", "snId": "snId", "invoicedAmount": 1979.6817740787476, "batchSnBestBefore": 459, "accountName": "accountName", "articleId": "articleId", "priceListId": 2944, "purchasePrice": 6485.364718121094, "batchId": "batchId", "rental": true, "rentalCurrency": "rentalCurrency", "accountId": 3323, "checkoutDate": 3857, "price": 3729.929080727555, "comment": "comment", "id": 890, "projectId": 1610, "checkoutAmount": 9458.337042175755, "events": [{ "date": 1752882500167, "amount": 1218.8947906411752, "type": "type" }], "checkinConsumeDate": 1752882500167, "checkinAmount": 6769.79190605116, "consumedAmount": 6582.678396365689 }] }
Classes:
InvoiceDraftDto
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 |
InvoiceDraftIdsRequestDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
invoiceDraftIds | List | R,W | |||||
type | String | invoice, cash, card, ag | R |
InvoiceDraftsResponseDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
page | int | R | |||||
pages | int | R | |||||
pageSize | int | R | |||||
ordersCount | int | R | |||||
invoiceDrafts | List | R |
InvoiceProjectArticlesResponseDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articles | List | R | |||||
invoiceDrafts | List | R |
ProjectArticleDto
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 |
ProjectArticleEventDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
type | String | R,W | |||||
amount | double | R,W | |||||
date | Date | R,W |