Goto APIs

Account API

General:

Basics:

Base-URL: https://capi.lagerkoll.com/v1/account/
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.

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.
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
901011 Error when getting license-url
901012 Error when creating account
901112 Error when creating integration
901212 Error when creating status message
901222 Error when logging in
901232 Error when verifying account
901242 Error when updating account
901251 Error when getting invoice
901261 Error when getting api settings
901262 Error when updating api settings
901272 Error when updating email settings
901273 Error when verifying email settings
901282 Error when sending support
{
  "errorCode" : 900101,
  "errorMessage" : "Something went wrong on the server",
  "errorField" : null,
  "errorData" : null
}

Account API:

Company Account

Get invoices

GETUrl: /invoices
Headers:
Accept: application/json or application/xml
Get list of invoices for account
Body:
Successfull response:

{"invoices": [{ "invoiceExpireDate": 1679790675635, "invoiceDays": 5495, "invoicePaidDate": 1679790675635, "invoiceId": 4602, "state": "state", "invoiceDate": 1679790675635, "paymentDate": 1679790675635, "rows": [{ "articleName": "articleName", "discountPercent": 2525.277546442968, "articleVat": 8517.371349805855, "articleId": "articleId", "articlePrice": 8680.57028067857 }], "serverId": 6214, "invoicePeriodInMonths": 2970 }]}

Get next invoice

GETUrl: /invoices/next
Headers:
Accept: application/json or application/xml
Get next invoice for account
Body:
Successfull response:

{ "invoiceExpireDate": 1679790675635, "invoiceDays": 8316, "invoicePaidDate": 1679790675635, "invoiceId": 7420, "state": "state", "invoiceDate": 1679790675635, "paymentDate": 1679790675635, "rows": [{ "articleName": "articleName", "discountPercent": 4287.5827248568, "articleVat": 9101.32019811732, "articleId": "articleId", "articlePrice": 169.59100398480254 }], "serverId": 5767, "invoicePeriodInMonths": 7523 }

Get license

GETUrl: /license
Headers:
Accept: application/json or application/xml
Other headers: Open request, no identification-headers needed
Get link to license. This must be displayed to user before he/she is allowed to register

Valid parameters:

Parameter Description Default value Allowed values
promotion_code

Body:
Successfull response:

{ "models": [{ "maxUsers": 6862, "maxArticles": 5000, "reseller": false, "vismaAccess": 2789, "maxCustomers": 3881, "fortnoxAccess": 8628, "paymentType": 2088, "discountPercentage": 8649.563303460585, "premium": false, "batchAccess": 3475, "price": 9761.482223106474, "name": "name", "maxStocks": 1881, "id": 625, "peAccess": 3699 }], "eula": "eula" }

Get invoice by id

GETUrl: /invoices/{invoice_id}
Headers:
Accept: application/json or application/xml
Get single invoice by id for account
Body:
Successfull response:

{ "invoiceExpireDate": 1679790675636, "invoiceDays": 5358, "invoicePaidDate": 1679790675636, "invoiceId": 7054, "state": "state", "invoiceDate": 1679790675636, "paymentDate": 1679790675636, "rows": [{ "articleName": "articleName", "discountPercent": 6473.457068061911, "articleVat": 1117.63637180887, "articleId": "articleId", "articlePrice": 916.6575919288955 }], "serverId": 7049, "invoicePeriodInMonths": 2622 }

Get invoice file

GETUrl: /invoices/{invoice_id}/print
Headers:
Accept: application/pdf or application/json
Get invoice binary file by id for account

Valid parameters:

Parameter Description Default value Allowed values
credit
store

Body:
Successfull response:

Get company account

GETUrl:
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Get information about the company account and master stock. This is not to be confused with a user account.
Body:
Successfull response:

{ "invoiceZip": "invoiceZip", "country": "country", "visma": false, "fieldsSettings": {"fields": {}}, "city": "city", "rules": { "canCreateCostCenters": true, "canCreateSupplierDeliveryTerm": false, "maxUsers": 9604, "defaultCategory": { "name": "name", "id": 8061, "articles": 6313 }, "articleNameMaxLength": 1806, "showVATAccount": false, "canCreateCustomerOrderInvoice": false, "allowNegativeOrderedAmountInCustomerOrder": true, "canChangeCustomerOnOrderStateStart": 6435, "canCancelCustomerOrder": true, "allowZeroSumCustomerOrders": true, "customerOrderReservedStateEnd": 6697, "canCreateCustomerDeliveryTerm": true, "canCreateVAT": false, "customerOrderReservedStateStart": 8817, "defaultUnitType": { "name": "name", "externalId": "externalId", "id": 9100 }, "defaultVAT": { "isDefault": true, "code": "code", "vat": 4651.374688670122, "description": "description", "id": 4231, "account": 2929 }, "supportsCustomerOrderFees": true, "doesVATControllArticleType": false, "canCreatePaymentTerm": true, "canSetCostCentersOnCustomerOrder": false, "maxArticles": 2911, "canCreateWayOfDelivery": false, "maxCustomers": 4057, "maxIntegrationDecimals": 1694, "canSetDefaultPricelist": true, "supportsBracketPricing": true, "allowRestCustomerOrder": true, "customerTypeSetsVAT": true, "batchAccess": true, "maxStocks": 8553, "supportsNoVAT": true, "canSetStock": true, "canCreateUnit": false, "increaseStockOnReceiveForPickNPack": true, "canChangeCustomerOnOrderStateEnd": 1203, "supportsInvoiceTypes": false }, "invoiceAddress": "invoiceAddress", "invoiceEmail": "invoiceEmail", "fortnox": true, "paymentType": 2970, "masterStoreId": 8243, "features": [{ "image": "image", "server": false, "role": 2519, "icon": "icon", "description": {}, "version": "version", "credits": "credits", "price": 6895.731474001013, "name": {}, "annual": false, "publisher": "publisher", "files": [{ "filename": "filename", "menuTitle": {}, "index": 4713 }], "id": "id", "category": [{}], "dashboard": "dashboard" }], "deactivateDate": 3967, "storeGroupId": 7825, "barcodePrintingFieldsSettings": {}, "customerOrderSettings": {}, "currency": "currency", "storeName": "storeName", "orgNumber": "orgNumber", "email": "email", "zip": "zip", "settings": { "cashInvoicePaymentWay": "cashInvoicePaymentWay", "truncateArticleName": false, "automaticBundling": false, "weeklyStatus": false, "projectInvoicePaymentWay": "projectInvoicePaymentWay", "decimals": 9812, "automaticDailyExport": false, "customerOrderNotification": true, "defaultTemplate": 9446, "defaultFortnoxVATId": 5763, "language": "language", "lowStockWarning": false }, "address": "address", "invoiceCountry": "invoiceCountry", "customerPortalSettings": { "showWebshop": true, "showDescription": false, "showSerials": true, "showName": true, "showPrice": false, "showArticleStockStatus": false, "showBatches": false, "showImage": true, "showArticleId": true, "orderArticlesNotInStock": false }, "purchaseOrderSettings": {}, "address2": "address2", "contactName": "contactName", "articleSuffix": "articleSuffix", "fortnoxV2": false, "salesPriceIncludesVAT": false, "invoiceAddress2": "invoiceAddress2", "storeId": 2728, "invoiceCity": "invoiceCity", "phone": "phone", "name": "name" }

Get API component settings

GETUrl: /api/settings
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Get API component settings for all of the company accounts
Body:
Successfull response:

{ "integrationSuccessfull": true, "integrationName": "integrationName", "stores": [{}], "apiKeys": [{ "name": "name", "requests": [{ "path": "path", "method": "method" }], "key": "key" }], "callbackUrl": "callbackUrl" }

Get Events component settings

GETUrl: /events/settings
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Get Scheduled Events component settings for all of the company accounts
Body:
Successfull response:

{ "bestBeforeTrigger": 8552, "purchaseOrdersReminder": true }

Get Report component settings

GETUrl: /reports/settings
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Get Report component settings for all of the company accounts
Body:
Successfull response:

{ "tobaccoEUCustomerTag": { "name": "name", "externalId": "externalId", "id": 7987, "desc": "desc" }, "tobaccoNoTaxCustomerTag": { "name": "name", "externalId": "externalId", "id": 7770, "desc": "desc" }, "tobaccoSWCustomerTag": { "name": "name", "externalId": "externalId", "id": 8237, "desc": "desc" } }

Get email settings

GETUrl: /email/settings
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Get email settings
Body:
Successfull response:

{ "password": "password", "auth": "false", "verified": false, "outgoingAddress": "outgoingAddress", "tls": "false", "ssl": "false", "email": "email", "outgoingPort": 918, "username": "username" }

Register company account

POSTUrl: /register
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Register a new company account. Before user is allowed to do this, he/she must first view and accept the license agreement.
Body:

{ "zip": "zip", "country": "country", "address": "address", "notes": "notes", "city": "city", "licenceAccepted": "false", "companyName": "companyName", "promotionCode": "promotionCode", "contactPerson": "contactPerson", "language": "en", "paymentType": 8535, "password": "password", "phone": "phone", "currency": "currency", "orgNumber": "orgNumber", "email": "email", "bankIDOrderRef": "bankIDOrderRef" }
Successfull response:

{ "invoiceZip": "invoiceZip", "country": "country", "visma": false, "fieldsSettings": {"fields": {}}, "city": "city", "rules": { "canCreateCostCenters": false, "canCreateSupplierDeliveryTerm": true, "maxUsers": 6167, "defaultCategory": { "name": "name", "id": 878, "articles": 9523 }, "articleNameMaxLength": 7232, "showVATAccount": false, "canCreateCustomerOrderInvoice": true, "allowNegativeOrderedAmountInCustomerOrder": true, "canChangeCustomerOnOrderStateStart": 9395, "canCancelCustomerOrder": false, "allowZeroSumCustomerOrders": true, "customerOrderReservedStateEnd": 8930, "canCreateCustomerDeliveryTerm": true, "canCreateVAT": false, "customerOrderReservedStateStart": 7266, "defaultUnitType": { "name": "name", "externalId": "externalId", "id": 1023 }, "defaultVAT": { "isDefault": false, "code": "code", "vat": 1564.5354492856834, "description": "description", "id": 2705, "account": 9246 }, "supportsCustomerOrderFees": true, "doesVATControllArticleType": false, "canCreatePaymentTerm": true, "canSetCostCentersOnCustomerOrder": false, "maxArticles": 2514, "canCreateWayOfDelivery": false, "maxCustomers": 6121, "maxIntegrationDecimals": 900, "canSetDefaultPricelist": true, "supportsBracketPricing": true, "allowRestCustomerOrder": false, "customerTypeSetsVAT": false, "batchAccess": false, "maxStocks": 4428, "supportsNoVAT": true, "canSetStock": true, "canCreateUnit": false, "increaseStockOnReceiveForPickNPack": false, "canChangeCustomerOnOrderStateEnd": 196, "supportsInvoiceTypes": false }, "invoiceAddress": "invoiceAddress", "invoiceEmail": "invoiceEmail", "fortnox": false, "paymentType": 2185, "masterStoreId": 7090, "features": [{ "image": "image", "server": true, "role": 9535, "icon": "icon", "description": {}, "version": "version", "credits": "credits", "price": 3229.8350136849217, "name": {}, "annual": false, "publisher": "publisher", "files": [{ "filename": "filename", "menuTitle": {}, "index": 873 }], "id": "id", "category": [{}], "dashboard": "dashboard" }], "deactivateDate": 4547, "storeGroupId": 5720, "barcodePrintingFieldsSettings": {}, "customerOrderSettings": {}, "currency": "currency", "storeName": "storeName", "orgNumber": "orgNumber", "email": "email", "zip": "zip", "settings": { "cashInvoicePaymentWay": "cashInvoicePaymentWay", "truncateArticleName": true, "automaticBundling": false, "weeklyStatus": false, "projectInvoicePaymentWay": "projectInvoicePaymentWay", "decimals": 8283, "automaticDailyExport": false, "customerOrderNotification": true, "defaultTemplate": 3904, "defaultFortnoxVATId": 6919, "language": "language", "lowStockWarning": true }, "address": "address", "invoiceCountry": "invoiceCountry", "customerPortalSettings": { "showWebshop": false, "showDescription": true, "showSerials": true, "showName": false, "showPrice": true, "showArticleStockStatus": true, "showBatches": false, "showImage": true, "showArticleId": false, "orderArticlesNotInStock": true }, "purchaseOrderSettings": {}, "address2": "address2", "contactName": "contactName", "articleSuffix": "articleSuffix", "fortnoxV2": false, "salesPriceIncludesVAT": false, "invoiceAddress2": "invoiceAddress2", "storeId": 7617, "invoiceCity": "invoiceCity", "phone": "phone", "name": "name" }

Invite new company to Lagerkoll

POSTUrl: /promotion/invite
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Invite a new company to use Lagerkoll and get a discount on the next invoice
Body:

{"email": "email"}
Successfull response:

Send support

POSTUrl: /support
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Send support mail to Lagerkoll
Body:

{ "subject": "subject", "message": "message" }
Successfull response:

Update company account

PUTUrl:
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Update information on the company account. This is not to be confused with a user account.
Body:

{ "invoiceZip": "invoiceZip", "country": "country", "visma": true, "fieldsSettings": {"fields": {}}, "city": "city", "rules": { "canCreateCostCenters": false, "canCreateSupplierDeliveryTerm": true, "maxUsers": 5271, "defaultCategory": { "name": "name", "id": 3351, "articles": 8680 }, "articleNameMaxLength": 2504, "showVATAccount": false, "canCreateCustomerOrderInvoice": false, "allowNegativeOrderedAmountInCustomerOrder": false, "canChangeCustomerOnOrderStateStart": 4330, "canCancelCustomerOrder": true, "allowZeroSumCustomerOrders": false, "customerOrderReservedStateEnd": 2310, "canCreateCustomerDeliveryTerm": false, "canCreateVAT": false, "customerOrderReservedStateStart": 7163, "defaultUnitType": { "name": "name", "externalId": "externalId", "id": 9988 }, "defaultVAT": { "isDefault": false, "code": "code", "vat": 5027.626732925408, "description": "description", "id": 4942, "account": 5243 }, "supportsCustomerOrderFees": false, "doesVATControllArticleType": true, "canCreatePaymentTerm": false, "canSetCostCentersOnCustomerOrder": true, "maxArticles": 2078, "canCreateWayOfDelivery": false, "maxCustomers": 7657, "maxIntegrationDecimals": 3903, "canSetDefaultPricelist": true, "supportsBracketPricing": false, "allowRestCustomerOrder": false, "customerTypeSetsVAT": true, "batchAccess": true, "maxStocks": 4636, "supportsNoVAT": false, "canSetStock": false, "canCreateUnit": true, "increaseStockOnReceiveForPickNPack": true, "canChangeCustomerOnOrderStateEnd": 5564, "supportsInvoiceTypes": false }, "invoiceAddress": "invoiceAddress", "invoiceEmail": "invoiceEmail", "fortnox": true, "paymentType": 8593, "masterStoreId": 9141, "features": [{ "image": "image", "server": true, "role": 7736, "icon": "icon", "description": {}, "version": "version", "credits": "credits", "price": 5211.907667819169, "name": {}, "annual": false, "publisher": "publisher", "files": [{ "filename": "filename", "menuTitle": {}, "index": 8361 }], "id": "id", "category": [{}], "dashboard": "dashboard" }], "deactivateDate": 6455, "storeGroupId": 5796, "barcodePrintingFieldsSettings": {}, "customerOrderSettings": {}, "currency": "currency", "storeName": "storeName", "orgNumber": "orgNumber", "email": "email", "zip": "zip", "settings": { "cashInvoicePaymentWay": "cashInvoicePaymentWay", "truncateArticleName": true, "automaticBundling": true, "weeklyStatus": true, "projectInvoicePaymentWay": "projectInvoicePaymentWay", "decimals": 548, "automaticDailyExport": false, "customerOrderNotification": false, "defaultTemplate": 5471, "defaultFortnoxVATId": 4747, "language": "language", "lowStockWarning": false }, "address": "address", "invoiceCountry": "invoiceCountry", "customerPortalSettings": { "showWebshop": false, "showDescription": false, "showSerials": false, "showName": true, "showPrice": false, "showArticleStockStatus": true, "showBatches": true, "showImage": false, "showArticleId": false, "orderArticlesNotInStock": false }, "purchaseOrderSettings": {}, "address2": "address2", "contactName": "contactName", "articleSuffix": "articleSuffix", "fortnoxV2": false, "salesPriceIncludesVAT": true, "invoiceAddress2": "invoiceAddress2", "storeId": 8487, "invoiceCity": "invoiceCity", "phone": "phone", "name": "name" }
Successfull response:

{ "invoiceZip": "invoiceZip", "country": "country", "visma": true, "fieldsSettings": {"fields": {}}, "city": "city", "rules": { "canCreateCostCenters": false, "canCreateSupplierDeliveryTerm": false, "maxUsers": 3996, "defaultCategory": { "name": "name", "id": 1916, "articles": 7581 }, "articleNameMaxLength": 8738, "showVATAccount": true, "canCreateCustomerOrderInvoice": false, "allowNegativeOrderedAmountInCustomerOrder": false, "canChangeCustomerOnOrderStateStart": 7128, "canCancelCustomerOrder": true, "allowZeroSumCustomerOrders": false, "customerOrderReservedStateEnd": 4871, "canCreateCustomerDeliveryTerm": false, "canCreateVAT": false, "customerOrderReservedStateStart": 4827, "defaultUnitType": { "name": "name", "externalId": "externalId", "id": 2406 }, "defaultVAT": { "isDefault": false, "code": "code", "vat": 5712.42059980332, "description": "description", "id": 6440, "account": 9883 }, "supportsCustomerOrderFees": true, "doesVATControllArticleType": true, "canCreatePaymentTerm": true, "canSetCostCentersOnCustomerOrder": true, "maxArticles": 2385, "canCreateWayOfDelivery": true, "maxCustomers": 9506, "maxIntegrationDecimals": 4029, "canSetDefaultPricelist": true, "supportsBracketPricing": true, "allowRestCustomerOrder": false, "customerTypeSetsVAT": true, "batchAccess": true, "maxStocks": 5109, "supportsNoVAT": false, "canSetStock": false, "canCreateUnit": true, "increaseStockOnReceiveForPickNPack": true, "canChangeCustomerOnOrderStateEnd": 4164, "supportsInvoiceTypes": false }, "invoiceAddress": "invoiceAddress", "invoiceEmail": "invoiceEmail", "fortnox": true, "paymentType": 293, "masterStoreId": 988, "features": [{ "image": "image", "server": false, "role": 7137, "icon": "icon", "description": {}, "version": "version", "credits": "credits", "price": 648.5002318979283, "name": {}, "annual": true, "publisher": "publisher", "files": [{ "filename": "filename", "menuTitle": {}, "index": 5665 }], "id": "id", "category": [{}], "dashboard": "dashboard" }], "deactivateDate": 4406, "storeGroupId": 5484, "barcodePrintingFieldsSettings": {}, "customerOrderSettings": {}, "currency": "currency", "storeName": "storeName", "orgNumber": "orgNumber", "email": "email", "zip": "zip", "settings": { "cashInvoicePaymentWay": "cashInvoicePaymentWay", "truncateArticleName": true, "automaticBundling": false, "weeklyStatus": false, "projectInvoicePaymentWay": "projectInvoicePaymentWay", "decimals": 9726, "automaticDailyExport": false, "customerOrderNotification": false, "defaultTemplate": 7970, "defaultFortnoxVATId": 2443, "language": "language", "lowStockWarning": true }, "address": "address", "invoiceCountry": "invoiceCountry", "customerPortalSettings": { "showWebshop": false, "showDescription": true, "showSerials": true, "showName": false, "showPrice": false, "showArticleStockStatus": true, "showBatches": true, "showImage": true, "showArticleId": false, "orderArticlesNotInStock": false }, "purchaseOrderSettings": {}, "address2": "address2", "contactName": "contactName", "articleSuffix": "articleSuffix", "fortnoxV2": false, "salesPriceIncludesVAT": false, "invoiceAddress2": "invoiceAddress2", "storeId": 5593, "invoiceCity": "invoiceCity", "phone": "phone", "name": "name" }

Upgrade premium

PUTUrl: /premium/{payment_type}
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Upgrade to a premium account. This can only be done if the account is a free account. If you wish to upgrade or downgrade please contact us on support@lagerkoll.com
Body:
Successfull response:

{ "invoiceZip": "invoiceZip", "country": "country", "visma": true, "fieldsSettings": {"fields": {}}, "city": "city", "rules": { "canCreateCostCenters": false, "canCreateSupplierDeliveryTerm": false, "maxUsers": 1218, "defaultCategory": { "name": "name", "id": 747, "articles": 5022 }, "articleNameMaxLength": 1626, "showVATAccount": false, "canCreateCustomerOrderInvoice": false, "allowNegativeOrderedAmountInCustomerOrder": false, "canChangeCustomerOnOrderStateStart": 3157, "canCancelCustomerOrder": false, "allowZeroSumCustomerOrders": false, "customerOrderReservedStateEnd": 4175, "canCreateCustomerDeliveryTerm": false, "canCreateVAT": true, "customerOrderReservedStateStart": 8364, "defaultUnitType": { "name": "name", "externalId": "externalId", "id": 6286 }, "defaultVAT": { "isDefault": false, "code": "code", "vat": 3238.87287553028, "description": "description", "id": 7649, "account": 2885 }, "supportsCustomerOrderFees": true, "doesVATControllArticleType": false, "canCreatePaymentTerm": true, "canSetCostCentersOnCustomerOrder": false, "maxArticles": 6945, "canCreateWayOfDelivery": true, "maxCustomers": 887, "maxIntegrationDecimals": 8307, "canSetDefaultPricelist": true, "supportsBracketPricing": false, "allowRestCustomerOrder": false, "customerTypeSetsVAT": false, "batchAccess": true, "maxStocks": 1274, "supportsNoVAT": false, "canSetStock": false, "canCreateUnit": true, "increaseStockOnReceiveForPickNPack": true, "canChangeCustomerOnOrderStateEnd": 2329, "supportsInvoiceTypes": false }, "invoiceAddress": "invoiceAddress", "invoiceEmail": "invoiceEmail", "fortnox": true, "paymentType": 6523, "masterStoreId": 869, "features": [{ "image": "image", "server": false, "role": 7634, "icon": "icon", "description": {}, "version": "version", "credits": "credits", "price": 638.652931357806, "name": {}, "annual": false, "publisher": "publisher", "files": [{ "filename": "filename", "menuTitle": {}, "index": 7662 }], "id": "id", "category": [{}], "dashboard": "dashboard" }], "deactivateDate": 6024, "storeGroupId": 8016, "barcodePrintingFieldsSettings": {}, "customerOrderSettings": {}, "currency": "currency", "storeName": "storeName", "orgNumber": "orgNumber", "email": "email", "zip": "zip", "settings": { "cashInvoicePaymentWay": "cashInvoicePaymentWay", "truncateArticleName": false, "automaticBundling": false, "weeklyStatus": true, "projectInvoicePaymentWay": "projectInvoicePaymentWay", "decimals": 204, "automaticDailyExport": false, "customerOrderNotification": false, "defaultTemplate": 4056, "defaultFortnoxVATId": 5800, "language": "language", "lowStockWarning": false }, "address": "address", "invoiceCountry": "invoiceCountry", "customerPortalSettings": { "showWebshop": false, "showDescription": true, "showSerials": false, "showName": false, "showPrice": true, "showArticleStockStatus": true, "showBatches": true, "showImage": true, "showArticleId": true, "orderArticlesNotInStock": true }, "purchaseOrderSettings": {}, "address2": "address2", "contactName": "contactName", "articleSuffix": "articleSuffix", "fortnoxV2": true, "salesPriceIncludesVAT": true, "invoiceAddress2": "invoiceAddress2", "storeId": 5904, "invoiceCity": "invoiceCity", "phone": "phone", "name": "name" }

Update API component settings

PUTUrl: /api/settings
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Update API component settings for all of the company accounts
Body:

{ "integrationSuccessfull": false, "integrationName": "integrationName", "stores": [{}], "apiKeys": [{ "name": "name", "requests": [{ "path": "path", "method": "method" }], "key": "key" }], "callbackUrl": "callbackUrl" }
Successfull response:

{ "integrationSuccessfull": false, "integrationName": "integrationName", "stores": [{}], "apiKeys": [{ "name": "name", "requests": [{ "path": "path", "method": "method" }], "key": "key" }], "callbackUrl": "callbackUrl" }

Update Events component settings

PUTUrl: /events/settings
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Update Scheduled Events component settings for all of the company accounts
Body:

{ "bestBeforeTrigger": 2863, "purchaseOrdersReminder": false }
Successfull response:

{ "bestBeforeTrigger": 8413, "purchaseOrdersReminder": false }

Update Report component settings

PUTUrl: /reports/settings
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Update Report component settings for all of the company accounts
Body:

{ "tobaccoEUCustomerTag": { "name": "name", "externalId": "externalId", "id": 9803, "desc": "desc" }, "tobaccoNoTaxCustomerTag": { "name": "name", "externalId": "externalId", "id": 6929, "desc": "desc" }, "tobaccoSWCustomerTag": { "name": "name", "externalId": "externalId", "id": 7684, "desc": "desc" } }
Successfull response:

{ "tobaccoEUCustomerTag": { "name": "name", "externalId": "externalId", "id": 2498, "desc": "desc" }, "tobaccoNoTaxCustomerTag": { "name": "name", "externalId": "externalId", "id": 9571, "desc": "desc" }, "tobaccoSWCustomerTag": { "name": "name", "externalId": "externalId", "id": 3687, "desc": "desc" } }

Update barcode settings

PUTUrl: /barcode/settings
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Update barcode settings for company account
Body:

{"barcodePrintingFieldsSettings": {}}
Successfull response:

{"barcodePrintingFieldsSettings": {}}

Update email settings

PUTUrl: /email/settings
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Update email settings to start using another email service than LagerkollĀ“s when sending emails
Body:

{ "password": "password", "auth": "false", "verified": false, "outgoingAddress": "outgoingAddress", "tls": "false", "ssl": "false", "email": "email", "outgoingPort": 435, "username": "username" }
Successfull response:

{ "password": "password", "auth": "false", "verified": false, "outgoingAddress": "outgoingAddress", "tls": "false", "ssl": "false", "email": "email", "outgoingPort": 8549, "username": "username" }

Verify email settings

PUTUrl: /email/verify
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Verify email settings and activates them on success
Body:

{ "storeId": 5240, "verification": "verification" }
Successfull response:

Remove email settings

DELETEUrl: /email/settings
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Remove email settings and start using LagerkollĀ“s email server again when sending emails
Body:
Successfull response:

Status

Get unread status messages count

GETUrl: /status/count
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Get number of unread status messages.
Body:
Successfull response:

{"count": 6548}

Get status messages

GETUrl: /status
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Get a list of the latest status messages saved for the store

Valid parameters:

Parameter Description Default value Allowed values
page 0
limit 100

Body:
Successfull response:

{ "pages": 9014, "pageSize": 9620, "messages": [{ "integrationType": "integrationType", "created": 9637, "technicalMessage": "technicalMessage", "action": "action", "messageId": "messageId", "progress": 6084, "type": "type", "message": "message" }], "page": 8666, "messagesCount": 8000 }

Send status message

POSTUrl: /status
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Send a status-message to Lagerkoll. INFO and ERRORs are stored and can be viewed when user loggs in, PROGRESS and PROGRESS_DONE are only showed for logged in users
Body:

{ "integrationType": "integrationType", "action": "action", "messageId": "messageId", "progress": 6316, "type": "type", "message": "message" }
Successfull response:

Remove all messages

DELETEUrl: /status
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Remove all status messages for the store
Body:
Successfull response:

User Account

Get user account settings

GETUrl: /settings
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Get user account settings
Body:
Successfull response:

{ "productSortOrder": "productSortOrder", "storeArticleSortData": {}, "supplierArticleSettings": {}, "projectSortData": [{ "column": "column", "state": 7334, "order": "order" }], "showWelcome": true, "language": "language", "multiPickData": {}, "reportsSettings": {}, "customerSortData": {}, "articleSortData": {}, "pickingListSortData": {}, "projectArticleSortData": {}, "storeGroupId": 7265, "pickingListSortColumn": "pickingListSortColumn", "customerOrderSortData": [{ "column": "column", "state": 2615, "order": "order" }], "productSortColumn": "productSortColumn", "productionOrderSortData": [{ "column": "column", "state": 1903, "order": "order" }], "warnedArticlesSortData": {}, "systemAccountSortData": {}, "lastReadStatusMessages": 3675, "invoiceDraftSortData": {}, "stocktakeArticleSortData": {}, "pickingListSortOrder": "pickingListSortOrder", "orderedArticlesSortData": {}, "accountSortData": {}, "supplierSortData": {}, "productionOrderData": {}, "openPurchaseOrderSortData": {}, "storeId": 5205, "purchaseOrderSortData": [{ "column": "column", "state": 5739, "order": "order" }], "systemUserSortData": {}, "helpSectionsCollapsed": {}, "viewedReleaseNotesVersion": "viewedReleaseNotesVersion", "invoiceSortData": {} }

Get logged in user

GETUrl: /login
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Get logged in user, same response as in login
Body:
Successfull response:

{ "systemAdmin": true, "settings": { "productSortOrder": "productSortOrder", "storeArticleSortData": {}, "supplierArticleSettings": {}, "projectSortData": [{ "column": "column", "state": 3534, "order": "order" }], "showWelcome": false, "language": "language", "multiPickData": {}, "reportsSettings": {}, "customerSortData": {}, "articleSortData": {}, "pickingListSortData": {}, "projectArticleSortData": {}, "storeGroupId": 7667, "pickingListSortColumn": "pickingListSortColumn", "customerOrderSortData": [{ "column": "column", "state": 7095, "order": "order" }], "productSortColumn": "productSortColumn", "productionOrderSortData": [{ "column": "column", "state": 8630, "order": "order" }], "warnedArticlesSortData": {}, "systemAccountSortData": {}, "lastReadStatusMessages": 5599, "invoiceDraftSortData": {}, "stocktakeArticleSortData": {}, "pickingListSortOrder": "pickingListSortOrder", "orderedArticlesSortData": {}, "accountSortData": {}, "supplierSortData": {}, "productionOrderData": {}, "openPurchaseOrderSortData": {}, "storeId": 1635, "purchaseOrderSortData": [{ "column": "column", "state": 6941, "order": "order" }], "systemUserSortData": {}, "helpSectionsCollapsed": {}, "viewedReleaseNotesVersion": "viewedReleaseNotesVersion", "invoiceSortData": {} }, "apiKey": "apiKey", "phone": "phone", "name": "name", "storeGroups": [{ "stores": 6282, "groupId": 3278, "name": "name", "integration": "integration", "storePermissions": [{ "capabilities": [{}], "storeGroupId": 3919, "permissions": [{}], "isMaster": false, "name": "name", "currency": "currency", "language": "language", "storeId": 2934 }] }], "admin": false, "delayedInvoicesMessage": "delayedInvoicesMessage", "userId": 7424, "email": "email" }

Get unread web messages

GETUrl: /webmessages
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Get list of unread web messages. This request will return a list of unread messages and then mark them as read. The messages will only be returned once

Valid parameters:

Parameter Description Default value Allowed values
statistics false

Body:
Successfull response:

{"messages": [{ "data": { "action": "action", "params": {} }, "action": "action", "responseCode": 6614 }]}

Get a user

GETUrl: /users/{id}
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Get a user by id
Body:
Successfull response:

{ "systemAdmin": false, "bankID": false, "notes": "notes", "phone": "phone", "permissions": [{}], "name": "name", "emailInvalid": true, "admin": false, "lastLoggedIn": 3251, "id": 6884, "email": "email", "customer": true }

Get users

GETUrl: /users
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Get list of users connected to company account

Valid parameters:

Parameter Description Default value Allowed values
query
since 0
page 0
limit 100

Body:
Successfull response:

{ "pages": 2090, "pageSize": 2951, "usersCount": 1882, "page": 8082, "users": [{ "systemAdmin": false, "bankID": false, "notes": "notes", "phone": "phone", "permissions": [{}], "name": "name", "emailInvalid": false, "admin": true, "lastLoggedIn": 5341, "id": 417, "email": "email", "customer": true }], "since": 1347 }

Verify user account

POSTUrl: /verify
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Verify the user account. If successful the account is activated and can be used to login with
Body:

{"verification": "verification"}
Successfull response:

{"username": "username"}

Login into user account with SSO

POSTUrl: /login/sso
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Login to your Lagerkoll user account and connect your SSO user with your Lagerkoll user
Body:

{ "password": "password", "externalId": "externalId", "type": "type", "username": "username" }
Successfull response:

{ "systemAdmin": false, "settings": { "productSortOrder": "productSortOrder", "storeArticleSortData": {}, "supplierArticleSettings": {}, "projectSortData": [{ "column": "column", "state": 8970, "order": "order" }], "showWelcome": false, "language": "language", "multiPickData": {}, "reportsSettings": {}, "customerSortData": {}, "articleSortData": {}, "pickingListSortData": {}, "projectArticleSortData": {}, "storeGroupId": 5035, "pickingListSortColumn": "pickingListSortColumn", "customerOrderSortData": [{ "column": "column", "state": 9409, "order": "order" }], "productSortColumn": "productSortColumn", "productionOrderSortData": [{ "column": "column", "state": 5321, "order": "order" }], "warnedArticlesSortData": {}, "systemAccountSortData": {}, "lastReadStatusMessages": 5388, "invoiceDraftSortData": {}, "stocktakeArticleSortData": {}, "pickingListSortOrder": "pickingListSortOrder", "orderedArticlesSortData": {}, "accountSortData": {}, "supplierSortData": {}, "productionOrderData": {}, "openPurchaseOrderSortData": {}, "storeId": 8242, "purchaseOrderSortData": [{ "column": "column", "state": 9798, "order": "order" }], "systemUserSortData": {}, "helpSectionsCollapsed": {}, "viewedReleaseNotesVersion": "viewedReleaseNotesVersion", "invoiceSortData": {} }, "apiKey": "apiKey", "phone": "phone", "name": "name", "storeGroups": [{ "stores": 9333, "groupId": 9583, "name": "name", "integration": "integration", "storePermissions": [{ "capabilities": [{}], "storeGroupId": 9130, "permissions": [{}], "isMaster": false, "name": "name", "currency": "currency", "language": "language", "storeId": 3863 }] }], "admin": true, "delayedInvoicesMessage": "delayedInvoicesMessage", "userId": 3837, "email": "email" }

Login with webtoken

POSTUrl: /login/webtoken/{web_token}
Headers:
Accept: application/json or application/xml
Login to your user account using a valid webtoken
Body:
Successfull response:

{ "systemAdmin": false, "settings": { "productSortOrder": "productSortOrder", "storeArticleSortData": {}, "supplierArticleSettings": {}, "projectSortData": [{ "column": "column", "state": 8712, "order": "order" }], "showWelcome": true, "language": "language", "multiPickData": {}, "reportsSettings": {}, "customerSortData": {}, "articleSortData": {}, "pickingListSortData": {}, "projectArticleSortData": {}, "storeGroupId": 5791, "pickingListSortColumn": "pickingListSortColumn", "customerOrderSortData": [{ "column": "column", "state": 4205, "order": "order" }], "productSortColumn": "productSortColumn", "productionOrderSortData": [{ "column": "column", "state": 9616, "order": "order" }], "warnedArticlesSortData": {}, "systemAccountSortData": {}, "lastReadStatusMessages": 9268, "invoiceDraftSortData": {}, "stocktakeArticleSortData": {}, "pickingListSortOrder": "pickingListSortOrder", "orderedArticlesSortData": {}, "accountSortData": {}, "supplierSortData": {}, "productionOrderData": {}, "openPurchaseOrderSortData": {}, "storeId": 1487, "purchaseOrderSortData": [{ "column": "column", "state": 1064, "order": "order" }], "systemUserSortData": {}, "helpSectionsCollapsed": {}, "viewedReleaseNotesVersion": "viewedReleaseNotesVersion", "invoiceSortData": {} }, "apiKey": "apiKey", "phone": "phone", "name": "name", "storeGroups": [{ "stores": 1205, "groupId": 8596, "name": "name", "integration": "integration", "storePermissions": [{ "capabilities": [{}], "storeGroupId": 1817, "permissions": [{}], "isMaster": false, "name": "name", "currency": "currency", "language": "language", "storeId": 6198 }] }], "admin": false, "delayedInvoicesMessage": "delayedInvoicesMessage", "userId": 2024, "email": "email" }

Invite account

POSTUrl: /users/invite
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Invite account to store
Body:

{ "notes": "notes", "phone": "phone", "permissions": [{}], "name": "name", "email": "email" }
Successfull response:

{ "systemAdmin": true, "bankID": false, "notes": "notes", "phone": "phone", "permissions": [{}], "name": "name", "emailInvalid": true, "admin": true, "lastLoggedIn": 9085, "id": 62, "email": "email", "customer": false }

Login into user account

POSTUrl: /login
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Login to your Lagerkoll user account to get a valid api_key to be used for other requests
Body:

{ "password": "password", "username": "username" }
Successfull response:

{ "systemAdmin": true, "settings": { "productSortOrder": "productSortOrder", "storeArticleSortData": {}, "supplierArticleSettings": {}, "projectSortData": [{ "column": "column", "state": 9627, "order": "order" }], "showWelcome": false, "language": "language", "multiPickData": {}, "reportsSettings": {}, "customerSortData": {}, "articleSortData": {}, "pickingListSortData": {}, "projectArticleSortData": {}, "storeGroupId": 9101, "pickingListSortColumn": "pickingListSortColumn", "customerOrderSortData": [{ "column": "column", "state": 4158, "order": "order" }], "productSortColumn": "productSortColumn", "productionOrderSortData": [{ "column": "column", "state": 1409, "order": "order" }], "warnedArticlesSortData": {}, "systemAccountSortData": {}, "lastReadStatusMessages": 8698, "invoiceDraftSortData": {}, "stocktakeArticleSortData": {}, "pickingListSortOrder": "pickingListSortOrder", "orderedArticlesSortData": {}, "accountSortData": {}, "supplierSortData": {}, "productionOrderData": {}, "openPurchaseOrderSortData": {}, "storeId": 1724, "purchaseOrderSortData": [{ "column": "column", "state": 4439, "order": "order" }], "systemUserSortData": {}, "helpSectionsCollapsed": {}, "viewedReleaseNotesVersion": "viewedReleaseNotesVersion", "invoiceSortData": {} }, "apiKey": "apiKey", "phone": "phone", "name": "name", "storeGroups": [{ "stores": 2307, "groupId": 4330, "name": "name", "integration": "integration", "storePermissions": [{ "capabilities": [{}], "storeGroupId": 913, "permissions": [{}], "isMaster": true, "name": "name", "currency": "currency", "language": "language", "storeId": 2453 }] }], "admin": false, "delayedInvoicesMessage": "delayedInvoicesMessage", "userId": 9245, "email": "email" }

Update user account settings

PUTUrl: /settings
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Update user account settings for the fields provided
Body:

{ "productSortOrder": "productSortOrder", "storeArticleSortData": {}, "supplierArticleSettings": {}, "projectSortData": [{ "column": "column", "state": 2872, "order": "order" }], "showWelcome": true, "language": "language", "multiPickData": {}, "reportsSettings": {}, "customerSortData": {}, "articleSortData": {}, "pickingListSortData": {}, "projectArticleSortData": {}, "storeGroupId": 2211, "pickingListSortColumn": "pickingListSortColumn", "customerOrderSortData": [{ "column": "column", "state": 3494, "order": "order" }], "productSortColumn": "productSortColumn", "productionOrderSortData": [{ "column": "column", "state": 5350, "order": "order" }], "warnedArticlesSortData": {}, "systemAccountSortData": {}, "lastReadStatusMessages": 4708, "invoiceDraftSortData": {}, "stocktakeArticleSortData": {}, "pickingListSortOrder": "pickingListSortOrder", "orderedArticlesSortData": {}, "accountSortData": {}, "supplierSortData": {}, "productionOrderData": {}, "openPurchaseOrderSortData": {}, "storeId": 4903, "purchaseOrderSortData": [{ "column": "column", "state": 8850, "order": "order" }], "systemUserSortData": {}, "helpSectionsCollapsed": {}, "viewedReleaseNotesVersion": "viewedReleaseNotesVersion", "invoiceSortData": {} }
Successfull response:

{ "productSortOrder": "productSortOrder", "storeArticleSortData": {}, "supplierArticleSettings": {}, "projectSortData": [{ "column": "column", "state": 9019, "order": "order" }], "showWelcome": true, "language": "language", "multiPickData": {}, "reportsSettings": {}, "customerSortData": {}, "articleSortData": {}, "pickingListSortData": {}, "projectArticleSortData": {}, "storeGroupId": 7171, "pickingListSortColumn": "pickingListSortColumn", "customerOrderSortData": [{ "column": "column", "state": 2289, "order": "order" }], "productSortColumn": "productSortColumn", "productionOrderSortData": [{ "column": "column", "state": 3765, "order": "order" }], "warnedArticlesSortData": {}, "systemAccountSortData": {}, "lastReadStatusMessages": 6266, "invoiceDraftSortData": {}, "stocktakeArticleSortData": {}, "pickingListSortOrder": "pickingListSortOrder", "orderedArticlesSortData": {}, "accountSortData": {}, "supplierSortData": {}, "productionOrderData": {}, "openPurchaseOrderSortData": {}, "storeId": 5617, "purchaseOrderSortData": [{ "column": "column", "state": 2262, "order": "order" }], "systemUserSortData": {}, "helpSectionsCollapsed": {}, "viewedReleaseNotesVersion": "viewedReleaseNotesVersion", "invoiceSortData": {} }

Update user account

PUTUrl: /users/{id}
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Update user account for the fields provided
Body:

{ "systemAdmin": true, "bankID": true, "notes": "notes", "phone": "phone", "permissions": [{}], "name": "name", "emailInvalid": true, "admin": false, "lastLoggedIn": 1436, "id": 6244, "email": "email", "customer": true }
Successfull response:

{ "systemAdmin": false, "bankID": false, "notes": "notes", "phone": "phone", "permissions": [{}], "name": "name", "emailInvalid": false, "admin": false, "lastLoggedIn": 473, "id": 3670, "email": "email", "customer": false }

Prepare change user password

PUTUrl: /users/password/reset
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Sends out an email with a reset-url for the given user
Body:

{"username": "username"}
Successfull response:

Change user password

PUTUrl: /users/{id}/password
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Update user password from a reset key
Body:

{ "password": "password", "confirmPassword": "confirmPassword", "resetKey": "resetKey" }
Successfull response:

Remove SSO

DELETEUrl: /sso/{type}
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Remove Single Sign On from user
Body:
Successfull response:

Delete user account

DELETEUrl: /users/{id}
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Delete existing user account
Body:
Successfull response:

Classes:

Account

Field Type Description Default Mandatory Accepted values Example values Access
companyName String true R,W
orgNumber String true R,W
address String R,W
city String R,W
zip String R,W
country String true Two letter codes for country, ISO alpha-2. SE for Sweden, DK for Denmark... For more codes, see http://www.nationsonline.org/oneworld/country_code_list.htm R,W
language String en en, sv R,W
contactPerson String true R,W
email String true R,W
phone String R,W
notes String R,W
currency String Currency used for sales true 3 letter codes for currencies. SEK for Swedish krona, DKK for Danish krone... For more codes, see http://www.nationsonline.org/oneworld/currencies.htm R,W
password String Either bankIDOrderRef or password Length must be 8 or more characters R,W
bankIDOrderRef String If user registers with BankID, this is the orderRef from a successfully authenticated user from BankID Either bankIDOrderRef or password R,W
paymentType Integer true Free account = 0, Small account = 1, Medium account = 2, Large account = 3 R,W
licenceAccepted Boolean The license agreement must be displayed to the user. It can be fetched by the /account/license request false true true, false R,W
promotionCode String Promotion code to get discount on next invoice R,W

AccountModel

Field Type Description Default Mandatory Accepted values Example values Access
id int R
paymentType int 0 = Free account, 1 = Small account, 2 = Medium account, 3 = Large account R
premium boolean Is this model premium or free R
reseller boolean Is this model for resellers R
name String R
price double Invoice price annually R
discountPercentage double Discount invoice price annually R
maxUsers int Max number of active users that can log in to Lagerkoll R
maxCustomers int When customer portal is active, max number of invited customers R
maxStocks int Max number of stores R
maxArticles int Max number of articles per store R
fortnoxAccess int 0 = Not available, 1 = Available, 2 = Included R
vismaAccess int 0 = Not available, 1 = Available, 2 = Included R
peAccess int 0 = Not available, 1 = Available, 2 = Included R
batchAccess int 0 = Not available, 1 = Available, 2 = Included R

AccountResponse

Field Type Description Default Mandatory Accepted values Example values Access
storeId Long Id of the requested store R
masterStoreId Long Id of master-store in the store-group R
storeGroupId Long R
name String R
orgNumber String R
paymentType Integer Free account = 0, Small account = 1, Medium account = 2, Large account = 3 R
deactivateDate Long If account is marked for deactivation, the date will tell when it will be deactivated R
fortnox Boolean Is Fortnox integration active? R
fortnoxV2 Boolean Is Fortnox V2 integration active? R
visma Boolean Is Visma integration active? R
settings StoreSettings Settings for store R,W
customerPortalSettings CustomerPortalSettings Settings for customer portal R,W
fieldsSettings FieldsSettings Settings for different fields R,W
purchaseOrderSettings HashMap Settings for purchase orders R,W
customerOrderSettings HashMap Settings for customer orders R,W
barcodePrintingFieldsSettings HashMap Settings for barcode labels R,W
rules Rules Set of rules for this account R
currency String R
salesPriceIncludesVAT Boolean Flag to indicate if salesprices include VAT R,W
contactName String R,W
address String R,W
address2 String R,W
zip String R,W
city String R,W
country String R,W
invoiceAddress String R,W
invoiceAddress2 String R,W
invoiceZip String R,W
invoiceCity String R,W
invoiceCountry String R,W
phone String R,W
email String R,W
invoiceEmail String Email-address used to send invoices from Lagerkoll R
storeName String The name of the store R
articleSuffix String R
features List List of uploaded features R

AccountSettings

Field Type Description Default Mandatory Accepted values Example values Access
language String selected language sv, en R,W
storeGroupId Long selected storegroup id R
storeId Long selected store id R,W
showWelcome Boolean is it first time the user is logging in R,W
productSortColumn String sort column for articles R,W
productSortOrder String sort order for articles R,W
pickingListSortColumn String sort column for articles in customer order pickinglist R,W
pickingListSortOrder String sort order for articles in customer order pickinglist R,W
lastReadStatusMessages long timestamp of last read status message R,W
supplierArticleSettings HashMap last selected supplier in Supplier article R,W
supplierSortData HashMap sort column and order for suppliers R,W
openPurchaseOrderSortData HashMap sort column and order for open purchase order R,W
customerSortData HashMap sort column and order for customers R,W
articleSortData HashMap sort column and order for articles R,W
storeArticleSortData HashMap sort column and order for articles in all stores R,W
pickingListSortData HashMap sort column and order for picking list R,W
orderedArticlesSortData HashMap sort column and order for ordered articles R,W
warnedArticlesSortData HashMap sort column and order for warned articles R,W
accountSortData HashMap sort column and order for accounts R,W
stocktakeArticleSortData HashMap sort column and order for stocktake articles R,W
systemAccountSortData HashMap sort column and order for account R,W
systemUserSortData HashMap sort column and order for users R,W
helpSectionsCollapsed HashMap a map of what helpsections in Webapp that is collapsed R,W
reportsSettings HashMap settings for reports R,W
customerOrderSortData List sort column and order for customer orders based on order state R,W
purchaseOrderSortData List sort column and order for purchase orders based on order state R,W
productionOrderSortData List sort column and order for production orders based on order state R,W
productionOrderData HashMap settings for production order R,W
projectSortData List sort column and order for project based on order state R,W
projectArticleSortData HashMap sort column and order for project article based on order state R,W
invoiceDraftSortData HashMap sort column and order for invoice draft R,W
invoiceSortData HashMap sort column and order for invoice R,W
viewedReleaseNotesVersion String last viewed version of release notes R,W
multiPickData HashMap settings for multipick feature R,W

APIKey

Field Type Description Default Mandatory Accepted values Example values Access
name String Name of api key R,W
key String API key used for external integrations R,W
requests List API requests supported for the api key R,W

APIRequest

Field Type Description Default Mandatory Accepted values Example values Access
method String Allowed methods for this request GET, POST, PUT, DELETE, * R,W
path String Path for the request R,W

APISettings

Field Type Description Default Mandatory Accepted values Example values Access
apiKeys List API keys used for external integrations R,W
stores List List of store ids where the API key can be used. For all stores use * R,W
callbackUrl String Callback url used when there is an update made in Lagerkoll R,W
integrationName String Name of external integration R
integrationSuccessfull boolean Flag to indicate if integration to external system was successfull R

BarcodeSettings

Field Type Description Default Mandatory Accepted values Example values Access
barcodePrintingFieldsSettings HashMap Settings for barcode labels R,W

Category

Field Type Description Default Mandatory Accepted values Example values Access
id long R
name String Name of category R,W
articles Integer Number of articles that include this category R

Count

Field Type Description Default Mandatory Accepted values Example values Access
count int R

CustomerPortalSettings

Field Type Description Default Mandatory Accepted values Example values Access
showArticleStockStatus Boolean R
orderArticlesNotInStock Boolean R
showWebshop Boolean R
showArticleId Boolean R
showName Boolean R
showDescription Boolean R
showImage Boolean R
showPrice Boolean R
showBatches Boolean R
showSerials Boolean R

CustomerTag

Field Type Description Default Mandatory Accepted values Example values Access
id Long Write only with POST Post R,W
externalId String R,W
name String Post R,W
desc String Post R,W

EmailSettings

Field Type Description Default Mandatory Accepted values Example values Access
username String Username for email account. If missing email address will be used W
email String Email address W
password String Password for email account W
outgoingAddress String Outgoing address for email server, SMTP W
outgoingPort Integer Outgoing port for email server W
auth Boolean Should auth be used when connecting to email server false W
tls Boolean Should tls be used when connecting to email server false W
ssl Boolean Should ssl be used when connecting to email server false W
verified Boolean Flag to indicate if settings have been verified or not R

EmailVerification

Field Type Description Default Mandatory Accepted values Example values Access
verification String Verification key for email settings W
storeId Long Store id to verify email settings W

EventsSettings

Field Type Description Default Mandatory Accepted values Example values Access
bestBeforeTrigger Integer Number of week before the best before date expires R,W
purchaseOrdersReminder Boolean Activate delayed deliveries of purchase orders R,W

FeatureFile

Field Type Description Default Mandatory Accepted values Example values Access
index int If file should have its own link in the menu, this will be rendered according to ascending index R,W
filename String Filename R
menuTitle HashMap If file should have its own link in the menu, this will be the title R,W

FeatureResponse

Field Type Description Default Mandatory Accepted values Example values Access
id String Id of feature R
name HashMap Name of feature R
role Integer Role needed to access the feature R,W
icon String Icon (Font Awesome v.5.15.4) to be rendered in the menu R
image String Name if image-file bundled in zip-file R
description HashMap Description of feature R
publisher String Name responsible person for this feature R
credits String Credits to people involved with this feature R
price Double Price for this feature R
annual Boolean Indicates if price is annual or onetime R
dashboard String Name of the function that renders data in the dashboard in Lagerkoll R
version String Version of feature R
files List List of files in the feature R
server Boolean Indicates if this feature has event callbacks R
category List List of categories for this feature R

FieldsSettings

Field Type Description Default Mandatory Accepted values Example values Access
fields HashMap R

Invoice

Field Type Description Default Mandatory Accepted values Example values Access
invoiceId Long R
serverId long R
invoiceDate Date R
invoiceDays int R
paymentDate Date R
invoicePeriodInMonths int R
rows List R
invoiceExpireDate Date R
state String R
invoicePaidDate Date R

InvoiceRow

Field Type Description Default Mandatory Accepted values Example values Access
articleId String R
articleName String R
articlePrice double R
articleVat double R
discountPercent double R

InvoicesResponse

Field Type Description Default Mandatory Accepted values Example values Access
invoices List R

License

Field Type Description Default Mandatory Accepted values Example values Access
eula String License agreement R
models List List of account models with information about price and limitations R

Login

Field Type Description Default Mandatory Accepted values Example values Access
username String true R,W
password String true R,W

LoginResponse

Field Type Description Default Mandatory Accepted values Example values Access
userId long R
apiKey String R
name String R
email String R
phone String R
storeGroups List R
systemAdmin Boolean R
admin Boolean R
settings AccountSettings R
delayedInvoicesMessage String If account is premium and has delayed invoices R

LoginSSO

Field Type Description Default Mandatory Accepted values Example values Access
username String true R,W
password String true R,W
type String true visma, bankid R,W
externalId String true R,W

Password

Field Type Description Default Mandatory Accepted values Example values Access
resetKey String Reset key is sent out in an email when requesting to change password W
password String New password W
confirmPassword String Confirm password W

PrepareResetPassword

Field Type Description Default Mandatory Accepted values Example values Access
username String Username to reset password for true W

PromotionCodeInviteRequest

Field Type Description Default Mandatory Accepted values Example values Access
email String Email for the invited user true W

Rules

Field Type Description Default Mandatory Accepted values Example values Access
articleNameMaxLength int R
canCreateVAT boolean R
supportsNoVAT boolean R
canCreateWayOfDelivery boolean R
canCreateSupplierDeliveryTerm boolean R
canCreateCustomerDeliveryTerm boolean R
canCreatePaymentTerm boolean R
canCreateUnit boolean R
canSetDefaultPricelist boolean R
supportsBracketPricing boolean R
showVATAccount boolean R
canCreateCustomerOrderInvoice boolean R
canCancelCustomerOrder boolean R
customerTypeSetsVAT boolean R
customerOrderReservedStateStart int R
customerOrderReservedStateEnd int R
defaultVAT VAT R
defaultUnitType Unit R
defaultCategory Category R
maxIntegrationDecimals int If account is connected to an integration (Fortnox or Visma), this field indicates the max number of decimals that system supports R
supportsCustomerOrderFees boolean R
doesVATControllArticleType boolean R
canCreateCostCenters boolean R
canSetCostCentersOnCustomerOrder boolean R
canSetStock boolean R
increaseStockOnReceiveForPickNPack boolean R
allowZeroSumCustomerOrders boolean R
allowNegativeOrderedAmountInCustomerOrder boolean R
maxUsers int R
maxCustomers int R
maxStocks int R
maxArticles int R
batchAccess boolean R
allowRestCustomerOrder boolean R
supportsInvoiceTypes boolean R
canChangeCustomerOnOrderStateStart int R
canChangeCustomerOnOrderStateEnd int R

SortData

Field Type Description Default Mandatory Accepted values Example values Access
state Integer R
column String R
order String R

StatusMessage

Field Type Description Default Mandatory Accepted values Example values Access
type String What kind of message is this true info, error, progress, progress_done R,W
action String What action is this message connected to true get, add, update, delete R,W
messageId String Message id R,W
message String Message true R,W
technicalMessage String Technical message R
progress Integer If type is progress this value reflects the progress 1 - 100 R,W
integrationType String What kind of integration is this for. Default is Webshop fortnox, visma_v2, webshop, import, email R,W
created Long Created date R

StatusMessagesResponse

Field Type Description Default Mandatory Accepted values Example values Access
pages int Total pages R
page int Current page R
pageSize int Message per page R
messagesCount int Total amount of messages R
messages List R

StoreGroup

Field Type Description Default Mandatory Accepted values Example values Access
groupId long R
name String R
stores int R
storePermissions List R
integration String R

StoreGroupReportsSettings

Field Type Description Default Mandatory Accepted values Example values Access
tobaccoSWCustomerTag CustomerTag R,W
tobaccoEUCustomerTag CustomerTag R,W
tobaccoNoTaxCustomerTag CustomerTag R,W

StorePermission

Field Type Description Default Mandatory Accepted values Example values Access
storeId long R
storeGroupId long R
name String R
currency String R
language String R
permissions List List of permissions current user has access to READ_ITEMS(1), UPDATE_ITEMS(2), DELETE_ITEMS(4), READ_STORES(8), UPDATE_STORES(16), DELETE_STORES(32), READ_ADMINS(64), UPDATE_ADMINS(128), DELETE_ADMINS(256), SYSTEM_ADMIN(512), READ_CUSTOMER_ORDERS(1024), UPDATE_CUSTOMER_ORDERS(2048), DELETE_CUSTOMER_ORDERS(4096), FILTER_OUT_PRICES(8192), READ_INVENTORY(16384), UPDATE_INVENTORY(32768), HANDLE_INVENTORY(65536), FINISH_INVENTORY(131072), READ_SUPPLIER_ORDERS(262144), UPDATE_SUPPLIER_ORDERS(524288), DELETE_SUPPLIER_ORDERS(1048576), HANDLE_DELIVERY(2097152), FINISH_DELIVERY(4194304), READ_PICKING_LISTS(8388608), PICK_PICKING_LIST(16777216), FINISH_PICKING_LIST(33554432), CHECKOUT(67108864) R
capabilities List List of capabilities current user has access to MAIN_INVENTORY(1), INVENTORY_CREATE_NEW(101), INVENTORY_FINISH_LIST(102), MAIN_PRODUCT(2), PRODUCT_CREATE_NEW(201), PRODUCT_EDIT_EXISTING(202), PRODUCT_VIEW_PRICES(203), PRODUCT_UNIT_CREATE_NEW(204), MAIN_ORDER(5), ORDER_CREATE_NEW(501), MAIN_DELIVERY(6), DELIVERY_CLOSE_ORDER(601), MAIN_PICKING_LISTS(7), PICKING_LISTS_PICK(701), PICKING_LISTS_FINISH(702), MAIN_CHECKOUT(8), CHECKOUT(801), CHECKIN(802), MAIN_CUSTOMER_ORDER(9), CUSTOMER_ORDER_CREATE_NEW(901), BATCHES(1001) R
isMaster Boolean True if this is the master stock R

StoreSettings

Field Type Description Default Mandatory Accepted values Example values Access
decimals Integer R
weeklyStatus Boolean R
lowStockWarning Boolean R
customerOrderNotification Boolean R
truncateArticleName Boolean R
automaticBundling Boolean R
defaultTemplate Long R
automaticDailyExport Boolean R
language String R
cashInvoicePaymentWay String R
projectInvoicePaymentWay String R
defaultFortnoxVATId Long R

Support

Field Type Description Default Mandatory Accepted values Example values Access
subject String true R,W
message String true R,W

Unit

Field Type Description Default Mandatory Accepted values Example values Access
id Long R,W
externalId String R
name String Name of unit R,W

User

Field Type Description Default Mandatory Accepted values Example values Access
id Long R
customer boolean flag to indicate if user has customer privileges R
admin boolean flag to indicate if user has admin privileges R
systemAdmin boolean flag to indicate if user has system admin privileges R
name String R,W
email String R,W
phone String R,W
notes String R,W
emailInvalid boolean If this flag is set to true, Lagerkoll has detected on multiple occassions that it cannot send emails to this address R
permissions List List of permissions current user has access to. Admins can update permissions on other users, but a user cannot update his own permissions READ_ITEMS(1), UPDATE_ITEMS(2), DELETE_ITEMS(4), READ_STORES(8), UPDATE_STORES(16), DELETE_STORES(32), READ_ADMINS(64), UPDATE_ADMINS(128), DELETE_ADMINS(256), SYSTEM_ADMIN(512), READ_CUSTOMER_ORDERS(1024), UPDATE_CUSTOMER_ORDERS(2048), DELETE_CUSTOMER_ORDERS(4096), FILTER_OUT_PRICES(8192), READ_INVENTORY(16384), UPDATE_INVENTORY(32768), HANDLE_INVENTORY(65536), FINISH_INVENTORY(131072), READ_SUPPLIER_ORDERS(262144), UPDATE_SUPPLIER_ORDERS(524288), DELETE_SUPPLIER_ORDERS(1048576), HANDLE_DELIVERY(2097152), FINISH_DELIVERY(4194304), READ_PICKING_LISTS(8388608), PICK_PICKING_LIST(16777216), FINISH_PICKING_LIST(33554432), CHECKOUT(67108864) R,W
lastLoggedIn Long Timestamp when this user was last logged in R
bankID Boolean If user has activated login with BankID R

UsersResponse

Field Type Description Default Mandatory Accepted values Example values Access
page int R
pages int R
pageSize int R
usersCount int R
since long R
users List R

VAT

Field Type Description Default Mandatory Accepted values Example values Access
id long R
vat double VAT value in percentage R
account int sales account R
code String vat code R
description String description of vat R
isDefault Boolean default vat R

Verification

Field Type Description Default Mandatory Accepted values Example values Access
verification String code to verify account true R,W

VerificationResponse

Field Type Description Default Mandatory Accepted values Example values Access
username String account username R,W

WebMessage

Field Type Description Default Mandatory Accepted values Example values Access
params HashMap R
action String R

WebMessagesResponse

Field Type Description Default Mandatory Accepted values Example values Access
messages List R

WebMessageStatus

Field Type Description Default Mandatory Accepted values Example values Access
action String R
responseCode int R
data WebMessage R