VATs API
General:
Basics:
Base-URL: https://capi.lagerkoll.com/v1/vats/
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 |
| 901901 | Error when getting VATs |
| 901902 | Error when creating a VAT |
| 901903 | Error when updating a VAT |
| 901904 | Error when deleting a VAT |
{
"errorCode" : 900101,
"errorMessage" : "Something went wrong on the server",
"errorField" : null,
"errorData" : null
}
VATs API:
VATs
Get VATs
GETUrl:
Headers:
Accept: application/json or application/xml
Get a list of VATs
Valid parameters:
| Parameter | Description | Default value | Allowed values |
|---|---|---|---|
| since | 0 |
Body:
Successfull response:
{ "vats": [{ "isDefault": false, "code": "code", "vat": 290.3800746515617, "description": "description", "id": 3388, "account": 9056 }], "since": 1907 }
Get VAT codes
GETUrl: /codes
Headers:
Accept: application/json or application/xml
Get a list of VAT codes
Body:
Successfull response:
{"vatCodes": [{ "description": "description", "vatValue": 5543.875130549234, "vatCode": "vatCode" }]}
Add VAT
POSTUrl:
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Content-type: application/json or application/xml
Add a new VAT
Valid parameters:
| Parameter | Description | Default value | Allowed values |
|---|---|---|---|
| filter | 0 | NONE(0), STOCK(1), SERVICE(2) |
Body:
{}
Successfull response:
{ "vats": [{ "isDefault": false, "code": "code", "vat": 8158.209562331441, "description": "description", "id": 5163, "account": 1977 }], "since": 8723 }
Update VAT
PUTUrl: /{id}
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Content-type: application/json or application/xml
Update an existing VAT
Delete VAT
DELETEUrl: /{id}
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Content-type: application/json or application/xml
Delete existing VAT
Body:
Successfull response:
Classes:
VATCodeDto
| Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
|---|---|---|---|---|---|---|---|
| vatCode | String | R | |||||
| vatValue | double | R | |||||
| description | String | R |
VATCodesResponseDto
| Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
|---|---|---|---|---|---|---|---|
| vatCodes | 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 |
VATsResponseDto
| Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
|---|---|---|---|---|---|---|---|
| since | long | R | |||||
| vats | List | R |