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.
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 |
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 |
901291 | Error when getting search settings |
901292 | Error when updating search settings |
{ "errorCode" : 900101, "errorMessage" : "Something went wrong on the server", "errorField" : null, "errorData" : null }
Account API:
Company Account
Get API component settings
GETUrl: /search/settings
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Other headers: user_id, user_token
Get API component settings for all of the company accounts
Body:
Successfull response:
{ "integrationSuccessfull": false, "integrationName": "integrationName", "stores": [{}], "apiKeys": [{ "name": "name", "requests": [{ "path": "path", "method": "method" }], "key": "key" }], "callbackUrl": "callbackUrl" }
Get email settings
GETUrl: /email/settings
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Other headers: user_id, user_token
Get email settings
Body:
Successfull response:
{ "password": "password", "auth": "false", "verified": true, "outgoingAddress": "outgoingAddress", "tls": "false", "ssl": "false", "email": "email", "outgoingPort": 173, "username": "username" }
Get invoices
GETUrl: /invoices
Headers:
Accept: application/json or application/xml
Get list of invoices for account
Body:
Successfull response:
{"invoices": [{ "invoiceExpireDate": 1751045239980, "invoiceDays": 5519, "invoicePaidDate": 1751045239980, "invoiceId": 9176, "state": "state", "invoiceDate": 1751045239980, "paymentDate": 1751045239980, "rows": [{ "articleName": "articleName", "discountPercent": 1240.0150837741407, "articleVat": 5912.618147609253, "articleId": "articleId", "articlePrice": 4981.775350345277 }], "serverId": 8770, "invoicePeriodInMonths": 1204 }]}
Get next invoice
GETUrl: /invoices/next
Headers:
Accept: application/json or application/xml
Get next invoice for account
Body:
Successfull response:
{ "invoiceExpireDate": 1751045239980, "invoiceDays": 3111, "invoicePaidDate": 1751045239980, "invoiceId": 3777, "state": "state", "invoiceDate": 1751045239980, "paymentDate": 1751045239980, "rows": [{ "articleName": "articleName", "discountPercent": 9761.473091203767, "articleVat": 9219.065661787634, "articleId": "articleId", "articlePrice": 484.8109424682001 }], "serverId": 3267, "invoicePeriodInMonths": 2266 }
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 |
Get company account
GETUrl:
Headers:
Accept: application/json or application/xml
Content-type: 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": 4078, "defaultCategory": { "name": "name", "id": 8066, "articles": 4545 }, "articleNameMaxLength": 4339, "showVATAccount": false, "canCreateCustomerOrderInvoice": true, "canChangeCustomerOnOrderStateStart": 1296, "canCancelCustomerOrder": true, "allowZeroSumCustomerOrders": false, "customerOrderReservedStateEnd": 344, "canCreateCustomerDeliveryTerm": false, "canCreateVAT": true, "customerOrderReservedStateStart": 4486, "defaultUnitType": { "name": "name", "externalId": "externalId", "id": 7505 }, "defaultVAT": { "isDefault": true, "code": "code", "vat": 1613.4989588746073, "description": "description", "id": 6603, "account": 8631 }, "supportsCustomerOrderFees": false, "doesVATControllArticleType": false, "canCreatePaymentTerm": false, "canSetCostCentersOnCustomerOrder": true, "maxArticles": 5781, "allowNegativeOrderedSumInCustomerOrder": true, "canCreateWayOfDelivery": true, "maxCustomers": 2204, "maxIntegrationDecimals": 7053, "canSetDefaultPricelist": false, "supportsBracketPricing": false, "allowRestCustomerOrder": false, "customerTypeSetsVAT": true, "batchAccess": true, "maxStocks": 8073, "supportsNoVAT": false, "canSetStock": false, "canCreateUnit": true, "increaseStockOnReceiveForPickNPack": false, "canChangeCustomerOnOrderStateEnd": 2177, "supportsInvoiceTypes": true }, "invoiceAddress": "invoiceAddress", "invoiceEmail": "invoiceEmail", "fortnox": true, "paymentType": 4694, "masterStoreId": 2137, "features": [{ "image": "image", "server": true, "roles": [{}], "icon": "icon", "description": {}, "version": "version", "credits": "credits", "price": 6496.045697173411, "name": {}, "annual": false, "publisher": "publisher", "files": [{ "filename": "filename", "menuTitle": {}, "index": 5722 }], "id": "id", "category": [{}], "dashboard": "dashboard" }], "deactivateDate": 6275, "storeGroupId": 6616, "countryCode": "countryCode", "barcodePrintingFieldsSettings": {}, "customerOrderSettings": {}, "currency": "currency", "storeName": "storeName", "orgNumber": "orgNumber", "email": "email", "zip": "zip", "settings": { "cashInvoicePaymentWay": "cashInvoicePaymentWay", "truncateArticleName": true, "automaticBundling": false, "weeklyStatus": false, "projectInvoicePaymentWay": "projectInvoicePaymentWay", "decimals": 1605, "automaticDailyExport": true, "customerOrderNotification": true, "defaultTemplate": 4177, "language": "language", "lowStockWarning": true }, "address": "address", "invoiceCountry": "invoiceCountry", "customerPortalSettings": { "showOtherPurchasedArticles": false, "showSerials": true, "showName": true, "welcomeTitle": {}, "welcomeText": {}, "showImage": true, "showArticleId": false, "orderArticlesNotInStock": true, "showWebshop": true, "showDescription": false, "showPrice": false, "showArticleStockStatus": false, "showBatches": false }, "purchaseOrderSettings": {}, "address2": "address2", "contactName": "contactName", "articleSuffix": "articleSuffix", "fortnoxV2": true, "salesPriceIncludesVAT": true, "invoiceAddress2": "invoiceAddress2", "storeId": 8391, "invoiceCity": "invoiceCity", "phone": "phone", "name": "name", "invoiceCountryCode": "invoiceCountryCode" }
Get API component settings
GETUrl: /api/settings
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Other headers: user_id, user_token
Get API component settings for all of the company accounts
Body:
Successfull response:
{ "integrationSuccessfull": false, "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
Other headers: user_id, user_token
Get Scheduled Events component settings for all of the company accounts
Body:
Successfull response:
{ "bestBeforeTrigger": 6323, "purchaseOrdersReminder": false }
Get Report component settings
GETUrl: /reports/settings
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Other headers: user_id, user_token
Get Report component settings for all of the company accounts
Body:
Successfull response:
{ "tobaccoEUCustomerTagDto": { "name": "name", "externalId": "externalId", "id": 6923, "desc": "desc" }, "tobaccoSWCustomerTagDto": { "name": "name", "externalId": "externalId", "id": 7320, "desc": "desc" }, "tobaccoNoTaxCustomerTagDto": { "name": "name", "externalId": "externalId", "id": 7393, "desc": "desc" } }
Get license
GETUrl: /license
Headers:
Accept: application/json or application/xml
Other headers: Open request, no identification-headers needed
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": 6648, "maxArticles": 8192, "reseller": true, "vismaAccess": 6042, "maxCustomers": 9543, "fortnoxAccess": 7471, "paymentType": 9872, "discountPercentage": 6160.66287597345, "premium": true, "batchAccess": 3217, "price": 5430.482961880653, "name": "name", "maxStocks": 5789, "id": 839, "peAccess": 6189 }], "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": 1751045239981, "invoiceDays": 7591, "invoicePaidDate": 1751045239981, "invoiceId": 7696, "state": "state", "invoiceDate": 1751045239981, "paymentDate": 1751045239981, "rows": [{ "articleName": "articleName", "discountPercent": 7211.797985434777, "articleVat": 6770.605447200874, "articleId": "articleId", "articlePrice": 8926.601709709339 }], "serverId": 9931, "invoicePeriodInMonths": 1879 }
Invite new company to Lagerkoll
POSTUrl: /promotion/invite
Headers:
Accept: application/json or application/xml
Content-type: 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
Register company account
POSTUrl: /register
Headers:
Accept: application/json or application/xml
Content-type: 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": 578, "features": [{}], "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": true, "canCreateSupplierDeliveryTerm": false, "maxUsers": 8564, "defaultCategory": { "name": "name", "id": 6073, "articles": 4732 }, "articleNameMaxLength": 8229, "showVATAccount": false, "canCreateCustomerOrderInvoice": true, "canChangeCustomerOnOrderStateStart": 2986, "canCancelCustomerOrder": true, "allowZeroSumCustomerOrders": true, "customerOrderReservedStateEnd": 1231, "canCreateCustomerDeliveryTerm": true, "canCreateVAT": true, "customerOrderReservedStateStart": 6471, "defaultUnitType": { "name": "name", "externalId": "externalId", "id": 842 }, "defaultVAT": { "isDefault": false, "code": "code", "vat": 7630.047458845782, "description": "description", "id": 9199, "account": 7391 }, "supportsCustomerOrderFees": true, "doesVATControllArticleType": false, "canCreatePaymentTerm": false, "canSetCostCentersOnCustomerOrder": true, "maxArticles": 3563, "allowNegativeOrderedSumInCustomerOrder": false, "canCreateWayOfDelivery": true, "maxCustomers": 7320, "maxIntegrationDecimals": 2908, "canSetDefaultPricelist": false, "supportsBracketPricing": true, "allowRestCustomerOrder": true, "customerTypeSetsVAT": true, "batchAccess": false, "maxStocks": 9158, "supportsNoVAT": false, "canSetStock": false, "canCreateUnit": false, "increaseStockOnReceiveForPickNPack": true, "canChangeCustomerOnOrderStateEnd": 1259, "supportsInvoiceTypes": true }, "invoiceAddress": "invoiceAddress", "invoiceEmail": "invoiceEmail", "fortnox": false, "paymentType": 7667, "masterStoreId": 4831, "features": [{ "image": "image", "server": false, "roles": [{}], "icon": "icon", "description": {}, "version": "version", "credits": "credits", "price": 3762.0115405924794, "name": {}, "annual": true, "publisher": "publisher", "files": [{ "filename": "filename", "menuTitle": {}, "index": 2688 }], "id": "id", "category": [{}], "dashboard": "dashboard" }], "deactivateDate": 6453, "storeGroupId": 9501, "countryCode": "countryCode", "barcodePrintingFieldsSettings": {}, "customerOrderSettings": {}, "currency": "currency", "storeName": "storeName", "orgNumber": "orgNumber", "email": "email", "zip": "zip", "settings": { "cashInvoicePaymentWay": "cashInvoicePaymentWay", "truncateArticleName": false, "automaticBundling": false, "weeklyStatus": false, "projectInvoicePaymentWay": "projectInvoicePaymentWay", "decimals": 3387, "automaticDailyExport": false, "customerOrderNotification": true, "defaultTemplate": 6852, "language": "language", "lowStockWarning": true }, "address": "address", "invoiceCountry": "invoiceCountry", "customerPortalSettings": { "showOtherPurchasedArticles": false, "showSerials": true, "showName": false, "welcomeTitle": {}, "welcomeText": {}, "showImage": true, "showArticleId": true, "orderArticlesNotInStock": true, "showWebshop": true, "showDescription": true, "showPrice": false, "showArticleStockStatus": false, "showBatches": true }, "purchaseOrderSettings": {}, "address2": "address2", "contactName": "contactName", "articleSuffix": "articleSuffix", "fortnoxV2": false, "salesPriceIncludesVAT": false, "invoiceAddress2": "invoiceAddress2", "storeId": 9618, "invoiceCity": "invoiceCity", "phone": "phone", "name": "name", "invoiceCountryCode": "invoiceCountryCode" }
Send email
POSTUrl: /email/send
Headers:
Accept: application/json or application/xml
Content-type: multipart/form-data
Other headers: user_id, user_token
Content-type: multipart/form-data
Other headers: user_id, user_token
Send email to an email address
Valid parameters:
Parameter | Description | Default value | Allowed values |
---|---|---|---|
file | |||
file | |||
toAddress | Email to receiver | ||
subject | Subject of email | ||
message | Message of email |
Body:
Successfull response:
Send support
POSTUrl: /support
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Content-type: application/json or application/xml
Send support mail to Lagerkoll
Upgrade premium
PUTUrl: /premium/{payment_type}
Headers:
Accept: application/json or application/xml
Content-type: 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": false, "fieldsSettings": {"fields": {}}, "city": "city", "rules": { "canCreateCostCenters": true, "canCreateSupplierDeliveryTerm": false, "maxUsers": 4106, "defaultCategory": { "name": "name", "id": 1717, "articles": 357 }, "articleNameMaxLength": 5584, "showVATAccount": false, "canCreateCustomerOrderInvoice": true, "canChangeCustomerOnOrderStateStart": 6489, "canCancelCustomerOrder": false, "allowZeroSumCustomerOrders": false, "customerOrderReservedStateEnd": 2227, "canCreateCustomerDeliveryTerm": false, "canCreateVAT": false, "customerOrderReservedStateStart": 6477, "defaultUnitType": { "name": "name", "externalId": "externalId", "id": 7447 }, "defaultVAT": { "isDefault": false, "code": "code", "vat": 3739.189797866146, "description": "description", "id": 7034, "account": 5763 }, "supportsCustomerOrderFees": false, "doesVATControllArticleType": true, "canCreatePaymentTerm": false, "canSetCostCentersOnCustomerOrder": true, "maxArticles": 9067, "allowNegativeOrderedSumInCustomerOrder": false, "canCreateWayOfDelivery": true, "maxCustomers": 3727, "maxIntegrationDecimals": 3379, "canSetDefaultPricelist": false, "supportsBracketPricing": false, "allowRestCustomerOrder": true, "customerTypeSetsVAT": false, "batchAccess": true, "maxStocks": 6758, "supportsNoVAT": false, "canSetStock": false, "canCreateUnit": false, "increaseStockOnReceiveForPickNPack": true, "canChangeCustomerOnOrderStateEnd": 1991, "supportsInvoiceTypes": true }, "invoiceAddress": "invoiceAddress", "invoiceEmail": "invoiceEmail", "fortnox": false, "paymentType": 7940, "masterStoreId": 8918, "features": [{ "image": "image", "server": false, "roles": [{}], "icon": "icon", "description": {}, "version": "version", "credits": "credits", "price": 4667.909633248474, "name": {}, "annual": true, "publisher": "publisher", "files": [{ "filename": "filename", "menuTitle": {}, "index": 7587 }], "id": "id", "category": [{}], "dashboard": "dashboard" }], "deactivateDate": 6667, "storeGroupId": 8280, "countryCode": "countryCode", "barcodePrintingFieldsSettings": {}, "customerOrderSettings": {}, "currency": "currency", "storeName": "storeName", "orgNumber": "orgNumber", "email": "email", "zip": "zip", "settings": { "cashInvoicePaymentWay": "cashInvoicePaymentWay", "truncateArticleName": false, "automaticBundling": false, "weeklyStatus": false, "projectInvoicePaymentWay": "projectInvoicePaymentWay", "decimals": 6912, "automaticDailyExport": false, "customerOrderNotification": false, "defaultTemplate": 4066, "language": "language", "lowStockWarning": false }, "address": "address", "invoiceCountry": "invoiceCountry", "customerPortalSettings": { "showOtherPurchasedArticles": true, "showSerials": true, "showName": true, "welcomeTitle": {}, "welcomeText": {}, "showImage": true, "showArticleId": true, "orderArticlesNotInStock": false, "showWebshop": true, "showDescription": true, "showPrice": false, "showArticleStockStatus": true, "showBatches": false }, "purchaseOrderSettings": {}, "address2": "address2", "contactName": "contactName", "articleSuffix": "articleSuffix", "fortnoxV2": true, "salesPriceIncludesVAT": true, "invoiceAddress2": "invoiceAddress2", "storeId": 2842, "invoiceCity": "invoiceCity", "phone": "phone", "name": "name", "invoiceCountryCode": "invoiceCountryCode" }
Update API component settings
PUTUrl: /api/settings
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
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": true, "integrationName": "integrationName", "stores": [{}], "apiKeys": [{ "name": "name", "requests": [{ "path": "path", "method": "method" }], "key": "key" }], "callbackUrl": "callbackUrl" }
Update search settings
PUTUrl: /search/settings
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Other headers: user_id, user_token
Update Search settings for all of the stores
Update Events component settings
PUTUrl: /events/settings
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Other headers: user_id, user_token
Update Scheduled Events component settings for all of the company accounts
Body:
{ "bestBeforeTrigger": 958, "purchaseOrdersReminder": false }
Successfull response:
{ "bestBeforeTrigger": 1317, "purchaseOrdersReminder": true }
Update Report component settings
PUTUrl: /reports/settings
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Other headers: user_id, user_token
Update Report component settings for all of the company accounts
Body:
{ "tobaccoEUCustomerTagDto": { "name": "name", "externalId": "externalId", "id": 5443, "desc": "desc" }, "tobaccoSWCustomerTagDto": { "name": "name", "externalId": "externalId", "id": 1135, "desc": "desc" }, "tobaccoNoTaxCustomerTagDto": { "name": "name", "externalId": "externalId", "id": 9883, "desc": "desc" } }
Successfull response:
{ "tobaccoEUCustomerTagDto": { "name": "name", "externalId": "externalId", "id": 5082, "desc": "desc" }, "tobaccoSWCustomerTagDto": { "name": "name", "externalId": "externalId", "id": 2532, "desc": "desc" }, "tobaccoNoTaxCustomerTagDto": { "name": "name", "externalId": "externalId", "id": 3888, "desc": "desc" } }
Update barcode settings
PUTUrl: /barcode/settings
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
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
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": true, "outgoingAddress": "outgoingAddress", "tls": "false", "ssl": "false", "email": "email", "outgoingPort": 4915, "username": "username" }
Successfull response:
{ "password": "password", "auth": "false", "verified": false, "outgoingAddress": "outgoingAddress", "tls": "false", "ssl": "false", "email": "email", "outgoingPort": 7115, "username": "username" }
Verify email settings
PUTUrl: /email/verify
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Other headers: user_id, user_token
Verify email settings and activates them on success
Update company account
PUTUrl:
Headers:
Accept: application/json or application/xml
Content-type: 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": true, "canCreateSupplierDeliveryTerm": true, "maxUsers": 8199, "defaultCategory": { "name": "name", "id": 7234, "articles": 6689 }, "articleNameMaxLength": 1182, "showVATAccount": false, "canCreateCustomerOrderInvoice": true, "canChangeCustomerOnOrderStateStart": 8996, "canCancelCustomerOrder": false, "allowZeroSumCustomerOrders": false, "customerOrderReservedStateEnd": 7491, "canCreateCustomerDeliveryTerm": false, "canCreateVAT": false, "customerOrderReservedStateStart": 687, "defaultUnitType": { "name": "name", "externalId": "externalId", "id": 4194 }, "defaultVAT": { "isDefault": true, "code": "code", "vat": 475.678758178999, "description": "description", "id": 5977, "account": 8663 }, "supportsCustomerOrderFees": true, "doesVATControllArticleType": true, "canCreatePaymentTerm": false, "canSetCostCentersOnCustomerOrder": true, "maxArticles": 6657, "allowNegativeOrderedSumInCustomerOrder": true, "canCreateWayOfDelivery": true, "maxCustomers": 6391, "maxIntegrationDecimals": 6792, "canSetDefaultPricelist": false, "supportsBracketPricing": true, "allowRestCustomerOrder": true, "customerTypeSetsVAT": true, "batchAccess": true, "maxStocks": 2401, "supportsNoVAT": false, "canSetStock": false, "canCreateUnit": true, "increaseStockOnReceiveForPickNPack": true, "canChangeCustomerOnOrderStateEnd": 2850, "supportsInvoiceTypes": false }, "invoiceAddress": "invoiceAddress", "invoiceEmail": "invoiceEmail", "fortnox": false, "paymentType": 7045, "masterStoreId": 1883, "features": [{ "image": "image", "server": false, "roles": [{}], "icon": "icon", "description": {}, "version": "version", "credits": "credits", "price": 9628.78862419777, "name": {}, "annual": true, "publisher": "publisher", "files": [{ "filename": "filename", "menuTitle": {}, "index": 3128 }], "id": "id", "category": [{}], "dashboard": "dashboard" }], "deactivateDate": 5239, "storeGroupId": 4451, "countryCode": "countryCode", "barcodePrintingFieldsSettings": {}, "customerOrderSettings": {}, "currency": "currency", "storeName": "storeName", "orgNumber": "orgNumber", "email": "email", "zip": "zip", "settings": { "cashInvoicePaymentWay": "cashInvoicePaymentWay", "truncateArticleName": false, "automaticBundling": false, "weeklyStatus": true, "projectInvoicePaymentWay": "projectInvoicePaymentWay", "decimals": 3462, "automaticDailyExport": false, "customerOrderNotification": false, "defaultTemplate": 4339, "language": "language", "lowStockWarning": true }, "address": "address", "invoiceCountry": "invoiceCountry", "customerPortalSettings": { "showOtherPurchasedArticles": true, "showSerials": false, "showName": false, "welcomeTitle": {}, "welcomeText": {}, "showImage": true, "showArticleId": false, "orderArticlesNotInStock": false, "showWebshop": false, "showDescription": false, "showPrice": true, "showArticleStockStatus": false, "showBatches": false }, "purchaseOrderSettings": {}, "address2": "address2", "contactName": "contactName", "articleSuffix": "articleSuffix", "fortnoxV2": true, "salesPriceIncludesVAT": false, "invoiceAddress2": "invoiceAddress2", "storeId": 1304, "invoiceCity": "invoiceCity", "phone": "phone", "name": "name", "invoiceCountryCode": "invoiceCountryCode" }
Successfull response:
{ "invoiceZip": "invoiceZip", "country": "country", "visma": false, "fieldsSettings": {"fields": {}}, "city": "city", "rules": { "canCreateCostCenters": true, "canCreateSupplierDeliveryTerm": true, "maxUsers": 7330, "defaultCategory": { "name": "name", "id": 4138, "articles": 3354 }, "articleNameMaxLength": 339, "showVATAccount": false, "canCreateCustomerOrderInvoice": true, "canChangeCustomerOnOrderStateStart": 752, "canCancelCustomerOrder": false, "allowZeroSumCustomerOrders": true, "customerOrderReservedStateEnd": 7760, "canCreateCustomerDeliveryTerm": false, "canCreateVAT": true, "customerOrderReservedStateStart": 1972, "defaultUnitType": { "name": "name", "externalId": "externalId", "id": 2559 }, "defaultVAT": { "isDefault": false, "code": "code", "vat": 4675.73010096171, "description": "description", "id": 4364, "account": 9774 }, "supportsCustomerOrderFees": true, "doesVATControllArticleType": false, "canCreatePaymentTerm": true, "canSetCostCentersOnCustomerOrder": false, "maxArticles": 7171, "allowNegativeOrderedSumInCustomerOrder": true, "canCreateWayOfDelivery": false, "maxCustomers": 2995, "maxIntegrationDecimals": 5155, "canSetDefaultPricelist": true, "supportsBracketPricing": false, "allowRestCustomerOrder": false, "customerTypeSetsVAT": false, "batchAccess": true, "maxStocks": 1282, "supportsNoVAT": true, "canSetStock": true, "canCreateUnit": true, "increaseStockOnReceiveForPickNPack": false, "canChangeCustomerOnOrderStateEnd": 9942, "supportsInvoiceTypes": true }, "invoiceAddress": "invoiceAddress", "invoiceEmail": "invoiceEmail", "fortnox": true, "paymentType": 8764, "masterStoreId": 7659, "features": [{ "image": "image", "server": true, "roles": [{}], "icon": "icon", "description": {}, "version": "version", "credits": "credits", "price": 6612.01019787951, "name": {}, "annual": true, "publisher": "publisher", "files": [{ "filename": "filename", "menuTitle": {}, "index": 4740 }], "id": "id", "category": [{}], "dashboard": "dashboard" }], "deactivateDate": 6179, "storeGroupId": 8815, "countryCode": "countryCode", "barcodePrintingFieldsSettings": {}, "customerOrderSettings": {}, "currency": "currency", "storeName": "storeName", "orgNumber": "orgNumber", "email": "email", "zip": "zip", "settings": { "cashInvoicePaymentWay": "cashInvoicePaymentWay", "truncateArticleName": true, "automaticBundling": false, "weeklyStatus": false, "projectInvoicePaymentWay": "projectInvoicePaymentWay", "decimals": 7044, "automaticDailyExport": true, "customerOrderNotification": true, "defaultTemplate": 3695, "language": "language", "lowStockWarning": true }, "address": "address", "invoiceCountry": "invoiceCountry", "customerPortalSettings": { "showOtherPurchasedArticles": true, "showSerials": false, "showName": true, "welcomeTitle": {}, "welcomeText": {}, "showImage": true, "showArticleId": true, "orderArticlesNotInStock": true, "showWebshop": false, "showDescription": false, "showPrice": false, "showArticleStockStatus": true, "showBatches": false }, "purchaseOrderSettings": {}, "address2": "address2", "contactName": "contactName", "articleSuffix": "articleSuffix", "fortnoxV2": true, "salesPriceIncludesVAT": true, "invoiceAddress2": "invoiceAddress2", "storeId": 1135, "invoiceCity": "invoiceCity", "phone": "phone", "name": "name", "invoiceCountryCode": "invoiceCountryCode" }
Remove email settings
DELETEUrl: /email/settings
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
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
Other headers: user_id, user_token
Get number of unread status messages.
Get status messages
GETUrl: /status
Headers:
Accept: application/json or application/xml
Content-type: 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": 2207, "pageSize": 8699, "messages": [{ "integrationType": "integrationType", "created": 4024, "technicalMessage": "technicalMessage", "action": "action", "messageId": "messageId", "progress": 2640, "type": "type", "message": "message" }], "page": 2918, "messagesCount": 6098 }
Send status message
POSTUrl: /status
Headers:
Accept: application/json or application/xml
Content-type: 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": 3699, "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
Content-type: application/json or application/xml
Remove all status messages for the store
Body:
Successfull response:
User Account
Get users
GETUrl: /users
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
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 | ||
filter_customers | false |
Body:
Successfull response:
{ "pages": 6732, "pageSize": 5459, "usersCount": 2856, "page": 5735, "users": [{ "systemAdmin": true, "bankID": true, "notes": "notes", "role": { "loginServices": [{}], "storeGroupId": 4673, "paths": {}, "name": "name", "id": 9649, "nativeFeatures": [{}], "fields": {}, "portal": "portal", "users": 1501 }, "phone": "phone", "name": "name", "emailInvalid": true, "admin": true, "lastLoggedIn": 2937, "id": 9342, "email": "email", "customer": false }], "since": 4414 }
Get unread web messages
GETUrl: /webmessages
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
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": 2131 }]}
Get user
GETUrl: /users/{id}
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Other headers: user_id, user_token
Get a user by id
Body:
Successfull response:
{ "systemAdmin": true, "bankID": true, "notes": "notes", "role": { "loginServices": [{}], "storeGroupId": 5827, "paths": {}, "name": "name", "id": 8709, "nativeFeatures": [{}], "fields": {}, "portal": "portal", "users": 3099 }, "phone": "phone", "name": "name", "emailInvalid": true, "admin": true, "lastLoggedIn": 5645, "id": 3105, "email": "email", "customer": true }
Get user account settings
GETUrl: /settings
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Other headers: user_id, user_token
Get user account settings
Body:
Successfull response:
{ "productSortOrder": "productSortOrder", "storeArticleSortData": {}, "supplierArticleSettings": {}, "projectSortData": [{ "column": "column", "state": 870, "order": "order" }], "showWelcome": false, "language": "language", "multiPickData": {}, "reportsSettings": {}, "customerSortData": {}, "articleSortData": {}, "pickingListSortData": {}, "projectArticleSortData": {}, "storeGroupId": 5011, "pickingListSortColumn": "pickingListSortColumn", "customerOrderSortData": [{ "column": "column", "state": 6427, "order": "order" }], "productSortColumn": "productSortColumn", "productionOrderSortData": [{ "column": "column", "state": 4192, "order": "order" }], "warnedArticlesSortData": {}, "systemAccountSortData": {}, "lastReadStatusMessages": 7816, "invoiceDraftSortData": {}, "stocktakeArticleSortData": {}, "pickingListSortOrder": "pickingListSortOrder", "orderedArticlesSortData": {}, "accountSortData": {}, "supplierSortData": {}, "productionOrderData": {}, "openPurchaseOrderSortData": {}, "priceListSortData": {}, "storeId": 8414, "purchaseOrderSortData": [{ "column": "column", "state": 2674, "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
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": 379, "order": "order" }], "showWelcome": true, "language": "language", "multiPickData": {}, "reportsSettings": {}, "customerSortData": {}, "articleSortData": {}, "pickingListSortData": {}, "projectArticleSortData": {}, "storeGroupId": 4351, "pickingListSortColumn": "pickingListSortColumn", "customerOrderSortData": [{ "column": "column", "state": 5678, "order": "order" }], "productSortColumn": "productSortColumn", "productionOrderSortData": [{ "column": "column", "state": 5165, "order": "order" }], "warnedArticlesSortData": {}, "systemAccountSortData": {}, "lastReadStatusMessages": 277, "invoiceDraftSortData": {}, "stocktakeArticleSortData": {}, "pickingListSortOrder": "pickingListSortOrder", "orderedArticlesSortData": {}, "accountSortData": {}, "supplierSortData": {}, "productionOrderData": {}, "openPurchaseOrderSortData": {}, "priceListSortData": {}, "storeId": 6119, "purchaseOrderSortData": [{ "column": "column", "state": 5408, "order": "order" }], "systemUserSortData": {}, "helpSectionsCollapsed": {}, "viewedReleaseNotesVersion": "viewedReleaseNotesVersion", "invoiceSortData": {} }, "apiKey": "apiKey", "phone": "phone", "name": "name", "storeGroups": [{ "stores": 1555, "groupId": 9996, "name": "name", "integration": "integration", "storePermissions": [{ "role": { "loginServices": [{}], "storeGroupId": 3654, "paths": {}, "name": "name", "id": 9202, "nativeFeatures": [{}], "fields": {}, "portal": "portal", "users": 7445 }, "capabilities": [{}], "storeGroupId": 8413, "isMaster": false, "name": "name", "currency": "currency", "language": "language", "storeId": 5463 }] }], "admin": false, "delayedInvoicesMessage": "delayedInvoicesMessage", "userId": 7368, "email": "email" }
Verify user account
POSTUrl: /verify
Headers:
Accept: application/json or application/xml
Content-type: 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"}
Log in
POSTUrl: /login
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Content-type: application/json or application/xml
Login to your Lagerkoll user account to get a valid user token to be used for other requests
Body:
{ "password": "password", "username": "username" }
Successfull response:
{ "systemAdmin": true, "settings": { "productSortOrder": "productSortOrder", "storeArticleSortData": {}, "supplierArticleSettings": {}, "projectSortData": [{ "column": "column", "state": 7776, "order": "order" }], "showWelcome": false, "language": "language", "multiPickData": {}, "reportsSettings": {}, "customerSortData": {}, "articleSortData": {}, "pickingListSortData": {}, "projectArticleSortData": {}, "storeGroupId": 9230, "pickingListSortColumn": "pickingListSortColumn", "customerOrderSortData": [{ "column": "column", "state": 3109, "order": "order" }], "productSortColumn": "productSortColumn", "productionOrderSortData": [{ "column": "column", "state": 1827, "order": "order" }], "warnedArticlesSortData": {}, "systemAccountSortData": {}, "lastReadStatusMessages": 676, "invoiceDraftSortData": {}, "stocktakeArticleSortData": {}, "pickingListSortOrder": "pickingListSortOrder", "orderedArticlesSortData": {}, "accountSortData": {}, "supplierSortData": {}, "productionOrderData": {}, "openPurchaseOrderSortData": {}, "priceListSortData": {}, "storeId": 767, "purchaseOrderSortData": [{ "column": "column", "state": 8209, "order": "order" }], "systemUserSortData": {}, "helpSectionsCollapsed": {}, "viewedReleaseNotesVersion": "viewedReleaseNotesVersion", "invoiceSortData": {} }, "apiKey": "apiKey", "phone": "phone", "name": "name", "storeGroups": [{ "stores": 1484, "groupId": 8285, "name": "name", "integration": "integration", "storePermissions": [{ "role": { "loginServices": [{}], "storeGroupId": 9953, "paths": {}, "name": "name", "id": 4986, "nativeFeatures": [{}], "fields": {}, "portal": "portal", "users": 720 }, "capabilities": [{}], "storeGroupId": 3414, "isMaster": true, "name": "name", "currency": "currency", "language": "language", "storeId": 8905 }] }], "admin": false, "delayedInvoicesMessage": "delayedInvoicesMessage", "userId": 1122, "email": "email" }
Log in with SSO
POSTUrl: /login/sso
Headers:
Accept: application/json or application/xml
Content-type: 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": true, "settings": { "productSortOrder": "productSortOrder", "storeArticleSortData": {}, "supplierArticleSettings": {}, "projectSortData": [{ "column": "column", "state": 3397, "order": "order" }], "showWelcome": true, "language": "language", "multiPickData": {}, "reportsSettings": {}, "customerSortData": {}, "articleSortData": {}, "pickingListSortData": {}, "projectArticleSortData": {}, "storeGroupId": 720, "pickingListSortColumn": "pickingListSortColumn", "customerOrderSortData": [{ "column": "column", "state": 882, "order": "order" }], "productSortColumn": "productSortColumn", "productionOrderSortData": [{ "column": "column", "state": 2354, "order": "order" }], "warnedArticlesSortData": {}, "systemAccountSortData": {}, "lastReadStatusMessages": 7940, "invoiceDraftSortData": {}, "stocktakeArticleSortData": {}, "pickingListSortOrder": "pickingListSortOrder", "orderedArticlesSortData": {}, "accountSortData": {}, "supplierSortData": {}, "productionOrderData": {}, "openPurchaseOrderSortData": {}, "priceListSortData": {}, "storeId": 5235, "purchaseOrderSortData": [{ "column": "column", "state": 5837, "order": "order" }], "systemUserSortData": {}, "helpSectionsCollapsed": {}, "viewedReleaseNotesVersion": "viewedReleaseNotesVersion", "invoiceSortData": {} }, "apiKey": "apiKey", "phone": "phone", "name": "name", "storeGroups": [{ "stores": 4211, "groupId": 9723, "name": "name", "integration": "integration", "storePermissions": [{ "role": { "loginServices": [{}], "storeGroupId": 9917, "paths": {}, "name": "name", "id": 2711, "nativeFeatures": [{}], "fields": {}, "portal": "portal", "users": 4942 }, "capabilities": [{}], "storeGroupId": 5864, "isMaster": true, "name": "name", "currency": "currency", "language": "language", "storeId": 391 }] }], "admin": false, "delayedInvoicesMessage": "delayedInvoicesMessage", "userId": 2148, "email": "email" }
Log in 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": 3211, "order": "order" }], "showWelcome": false, "language": "language", "multiPickData": {}, "reportsSettings": {}, "customerSortData": {}, "articleSortData": {}, "pickingListSortData": {}, "projectArticleSortData": {}, "storeGroupId": 8880, "pickingListSortColumn": "pickingListSortColumn", "customerOrderSortData": [{ "column": "column", "state": 5992, "order": "order" }], "productSortColumn": "productSortColumn", "productionOrderSortData": [{ "column": "column", "state": 8080, "order": "order" }], "warnedArticlesSortData": {}, "systemAccountSortData": {}, "lastReadStatusMessages": 1453, "invoiceDraftSortData": {}, "stocktakeArticleSortData": {}, "pickingListSortOrder": "pickingListSortOrder", "orderedArticlesSortData": {}, "accountSortData": {}, "supplierSortData": {}, "productionOrderData": {}, "openPurchaseOrderSortData": {}, "priceListSortData": {}, "storeId": 8293, "purchaseOrderSortData": [{ "column": "column", "state": 5178, "order": "order" }], "systemUserSortData": {}, "helpSectionsCollapsed": {}, "viewedReleaseNotesVersion": "viewedReleaseNotesVersion", "invoiceSortData": {} }, "apiKey": "apiKey", "phone": "phone", "name": "name", "storeGroups": [{ "stores": 7394, "groupId": 6530, "name": "name", "integration": "integration", "storePermissions": [{ "role": { "loginServices": [{}], "storeGroupId": 4008, "paths": {}, "name": "name", "id": 3326, "nativeFeatures": [{}], "fields": {}, "portal": "portal", "users": 2235 }, "capabilities": [{}], "storeGroupId": 9495, "isMaster": true, "name": "name", "currency": "currency", "language": "language", "storeId": 8520 }] }], "admin": false, "delayedInvoicesMessage": "delayedInvoicesMessage", "userId": 481, "email": "email" }
Invite user
POSTUrl: /users/invite
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Other headers: user_id, user_token
Invite user to store
Body:
{ "notes": "notes", "role": { "loginServices": [{}], "paths": {}, "name": "name", "nativeFeatures": [{}], "fields": {}, "portal": "portal" }, "phone": "phone", "name": "name", "email": "email" }
Successfull response:
{ "systemAdmin": true, "bankID": false, "notes": "notes", "role": { "loginServices": [{}], "storeGroupId": 6277, "paths": {}, "name": "name", "id": 9910, "nativeFeatures": [{}], "fields": {}, "portal": "portal", "users": 1414 }, "phone": "phone", "name": "name", "emailInvalid": false, "admin": true, "lastLoggedIn": 2526, "id": 5632, "email": "email", "customer": false }
Update user settings
PUTUrl: /settings
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Other headers: user_id, user_token
Update user account settings for the fields provided
Body:
{ "productSortOrder": "productSortOrder", "storeArticleSortData": {}, "supplierArticleSettings": {}, "projectSortData": [{ "column": "column", "state": 2615, "order": "order" }], "showWelcome": false, "language": "language", "multiPickData": {}, "reportsSettings": {}, "customerSortData": {}, "articleSortData": {}, "pickingListSortData": {}, "projectArticleSortData": {}, "storeGroupId": 3420, "pickingListSortColumn": "pickingListSortColumn", "customerOrderSortData": [{ "column": "column", "state": 6053, "order": "order" }], "productSortColumn": "productSortColumn", "productionOrderSortData": [{ "column": "column", "state": 1648, "order": "order" }], "warnedArticlesSortData": {}, "systemAccountSortData": {}, "lastReadStatusMessages": 3865, "invoiceDraftSortData": {}, "stocktakeArticleSortData": {}, "pickingListSortOrder": "pickingListSortOrder", "orderedArticlesSortData": {}, "accountSortData": {}, "supplierSortData": {}, "productionOrderData": {}, "openPurchaseOrderSortData": {}, "priceListSortData": {}, "storeId": 6041, "purchaseOrderSortData": [{ "column": "column", "state": 7234, "order": "order" }], "systemUserSortData": {}, "helpSectionsCollapsed": {}, "viewedReleaseNotesVersion": "viewedReleaseNotesVersion", "invoiceSortData": {} }
Successfull response:
{ "productSortOrder": "productSortOrder", "storeArticleSortData": {}, "supplierArticleSettings": {}, "projectSortData": [{ "column": "column", "state": 5054, "order": "order" }], "showWelcome": true, "language": "language", "multiPickData": {}, "reportsSettings": {}, "customerSortData": {}, "articleSortData": {}, "pickingListSortData": {}, "projectArticleSortData": {}, "storeGroupId": 3243, "pickingListSortColumn": "pickingListSortColumn", "customerOrderSortData": [{ "column": "column", "state": 8633, "order": "order" }], "productSortColumn": "productSortColumn", "productionOrderSortData": [{ "column": "column", "state": 1101, "order": "order" }], "warnedArticlesSortData": {}, "systemAccountSortData": {}, "lastReadStatusMessages": 5262, "invoiceDraftSortData": {}, "stocktakeArticleSortData": {}, "pickingListSortOrder": "pickingListSortOrder", "orderedArticlesSortData": {}, "accountSortData": {}, "supplierSortData": {}, "productionOrderData": {}, "openPurchaseOrderSortData": {}, "priceListSortData": {}, "storeId": 579, "purchaseOrderSortData": [{ "column": "column", "state": 5209, "order": "order" }], "systemUserSortData": {}, "helpSectionsCollapsed": {}, "viewedReleaseNotesVersion": "viewedReleaseNotesVersion", "invoiceSortData": {} }
Update user
PUTUrl: /users/{id}
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Other headers: user_id, user_token
Update user account for the fields provided
Body:
{ "systemAdmin": true, "bankID": true, "notes": "notes", "role": { "loginServices": [{}], "storeGroupId": 4647, "paths": {}, "name": "name", "id": 5145, "nativeFeatures": [{}], "fields": {}, "portal": "portal", "users": 5650 }, "phone": "phone", "name": "name", "emailInvalid": false, "admin": true, "lastLoggedIn": 5574, "id": 2550, "email": "email", "customer": false }
Successfull response:
{ "systemAdmin": false, "bankID": true, "notes": "notes", "role": { "loginServices": [{}], "storeGroupId": 4108, "paths": {}, "name": "name", "id": 4907, "nativeFeatures": [{}], "fields": {}, "portal": "portal", "users": 9513 }, "phone": "phone", "name": "name", "emailInvalid": false, "admin": false, "lastLoggedIn": 3616, "id": 2458, "email": "email", "customer": true }
Prepare change user password
PUTUrl: /users/password/reset
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Other headers: user_id, user_token
Sends out an email with a reset-url for the given user
Change user password
PUTUrl: /users/{id}/password
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
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
Content-type: application/json or application/xml
Remove Single Sign On from user
Body:
Successfull response:
Delete user
DELETEUrl: /users/{id}
Headers:
Accept: application/json or application/xml
Other headers: user_id, user_token
Other headers: user_id, user_token
Delete existing user account
Body:
Successfull response:
Classes:
AccountDto
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 | ||||
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 | ||||
features | List | List of feature ids that should be pre installed and part of the invoice when registering a new account | R,W |
AccountModelDto
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 |
AccountResponseDto
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 | StoreSettingsDto | Settings for store | R,W | ||||
customerPortalSettings | CustomerPortalSettingsDto | Settings for customer portal | R,W | ||||
fieldsSettings | FieldsSettingsDto | 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 | RulesDto | 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 | |||||
countryCode | String | R,W | |||||
country | String | R,W | |||||
invoiceAddress | String | R,W | |||||
invoiceAddress2 | String | R,W | |||||
invoiceZip | String | R,W | |||||
invoiceCity | String | R,W | |||||
invoiceCountryCode | String | R,W | |||||
invoiceCountry | String | R,W | |||||
phone | String | R,W | |||||
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 |
AccountSettingsDto
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 | ||||
priceListSortData | HashMap | sort column and order for price 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 |
APIKeyDto
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 |
APIRequestDto
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 |
APISettingsDto
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 |
BarcodeSettingsDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
barcodePrintingFieldsSettings | HashMap | Settings for barcode labels | R,W |
CategoryDto
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 |
CountDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
count | int | R |
CustomerPortalSettingsDto
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 | |||||
showOtherPurchasedArticles | Boolean | R | |||||
welcomeTitle | HashMap | R,W | |||||
welcomeText | HashMap | R,W |
CustomerTagDto
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 |
EmailSettingsDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
username | String | Username for email account. If missing email address will be used | W | ||||
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 |
EmailVerificationDto
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 |
EventsSettingsDto
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 |
FeatureFileDto
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 |
FeatureResponseDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
id | String | Id of feature | R | ||||
name | Map | Name of feature | R | ||||
roles | List | List of roles 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 | Map | 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 |
FieldsSettingsDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
fields | HashMap | R |
InvoiceDto
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 |
InvoiceRowDto
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 |
InvoicesResponseDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
invoices | List | R |
LicenseDto
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 |
LoginDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
username | String | true | R,W | ||||
password | String | true | R,W |
LoginResponseDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
userId | long | R | |||||
apiKey | String | R | |||||
name | String | R | |||||
String | R | ||||||
phone | String | R | |||||
storeGroups | List | R | |||||
systemAdmin | Boolean | R | |||||
admin | Boolean | R | |||||
settings | AccountSettingsDto | R | |||||
delayedInvoicesMessage | String | If account is premium and has delayed invoices | R |
LoginSSODto
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 |
PasswordDto
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 |
PrepareResetPasswordDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
username | String | Username to reset password for | true | W |
PromotionCodeInviteRequestDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
String | Email for the invited user | true | W |
RoleDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
id | Long | R | |||||
storeGroupId | Long | R | |||||
name | String | R,W | |||||
paths | ArrayList | List of paths role has access to | R,W | ||||
fields | HashMap | List of objects and fields that is filtered out when sending data to api and request data from api | R,W | ||||
portal | String | What part of Lagerkoll is the role used | ADMIN, SHOP | R,W | |||
users | int | Number of users connected to role | R | ||||
loginServices | List | List of login services role has access to | R,W | ||||
nativeFeatures | List | List of native features in mobile application role has access to | R,W |
RulesDto
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 | VATDto | R | |||||
defaultUnitType | UnitDto | R | |||||
defaultCategory | CategoryDto | 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 | |||||
allowNegativeOrderedSumInCustomerOrder | 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 |
SearchSettingsDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
storeIds | List | Store ids that are included in article search across stores | R,W |
SortDataDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
state | Integer | R | |||||
column | String | R | |||||
order | String | R |
StatusMessageDto
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 |
StatusMessagesResponseDto
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 |
StoreGroupDto
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 |
StoreGroupReportsSettingsDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
tobaccoSWCustomerTagDto | CustomerTagDto | R,W | |||||
tobaccoEUCustomerTagDto | CustomerTagDto | R,W | |||||
tobaccoNoTaxCustomerTagDto | CustomerTagDto | R,W |
StorePermissionDto
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 | |||||
role | RoleDto | Role current user has access to | 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 |
StoreSettingsDto
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 |
SupportDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
subject | String | true | R,W | ||||
message | String | true | R,W |
UnitDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
id | Long | R,W | |||||
externalId | String | R | |||||
name | String | Name of unit | R,W |
UserDto
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 | |||||
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 | ||||
role | RoleDto | Role of the current user. Admins can update permissions on other users, but a user cannot update his own permissions | R,W | ||||
lastLoggedIn | Long | Timestamp when this user was last logged in | R | ||||
bankID | Boolean | If user has activated login with BankID | R |
UsersResponseDto
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 |
VATDto
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 |
VerificationDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
verification | String | code to verify account | true | R,W |
VerificationResponseDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
username | String | account username | R,W |
WebMessageDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
params | HashMap | R | |||||
action | String | R |
WebMessagesResponseDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
messages | List | R |
WebMessageStatusDto
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
action | String | R | |||||
responseCode | int | R | |||||
data | WebMessageDto | R |