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": 9390.255515019544, "articleName": "articleName", "pricelistId": 4085, "endDate": 1714112488368, "rentalAmount": 9539.724895385063, "created": 1714112488368, "dataType": "dataType", "articleId": "articleId", "isInvoiced": true, "rentalCurrency": "rentalCurrency", "dataId": 8532, "price": 440.59291143814573, "isProcessed": true, "dataArticleId": 7535, "currency": "currency", "comment": "comment", "invoiceId": "invoiceId", "id": 7775, "startDate": 1714112488368, "createdById": 9433 }], "ordersCount": 364, "pages": 8828, "pageSize": 8900, "page": 9584 }
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": 1471.636610893452, "articleName": "articleName", "pricelistId": 7738, "endDate": 1714112488372, "rentalAmount": 2809.7285846087084, "created": 1714112488372, "dataType": "dataType", "articleId": "articleId", "isInvoiced": false, "rentalCurrency": "rentalCurrency", "dataId": 4802, "price": 1864.4417424920034, "isProcessed": true, "dataArticleId": 1745, "currency": "currency", "comment": "comment", "invoiceId": "invoiceId", "id": 8239, "startDate": 1714112488372, "createdById": 3462 }], "ordersCount": 2870, "pages": 8592, "pageSize": 4519, "page": 8743 }
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": 7826.667999089016, "articleName": "articleName", "pricelistId": 5341, "endDate": 1714112488372, "rentalAmount": 2027.3579562864995, "created": 1714112488372, "dataType": "dataType", "articleId": "articleId", "isInvoiced": true, "rentalCurrency": "rentalCurrency", "dataId": 5266, "price": 6778.5554763646705, "isProcessed": false, "dataArticleId": 3314, "currency": "currency", "comment": "comment", "invoiceId": "invoiceId", "id": 995, "startDate": 1714112488372, "createdById": 678 }], "articles": [{ "articleName": "articleName", "snId": "snId", "invoicedAmount": 6313.573877960749, "batchSnBestBefore": 8893, "accountName": "accountName", "articleId": "articleId", "priceListId": 7969, "purchasePrice": 2923.9716248841587, "batchId": "batchId", "rental": false, "rentalCurrency": "rentalCurrency", "accountId": 5863, "checkoutDate": 6531, "price": 9756.73439896862, "comment": "comment", "id": 1096, "projectId": 4726, "checkoutAmount": 8379.525989904763, "events": [{ "date": 1714112488372, "amount": 1676.2278259646723, "type": "type" }], "checkinConsumeDate": 1714112488372, "checkinAmount": 9333.981582946479, "consumedAmount": 1662.7546189570376 }] }
Classes:
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 |
InvoiceDraftIdsRequest
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
invoiceDraftIds | List | R,W | |||||
type | String | invoice, cash, card, ag | R |
InvoiceDraftsResponse
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 |
InvoiceProjectArticlesResponse
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articles | List | R | |||||
invoiceDrafts | List | R |
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 |