Payment terms API
General:
Basics:
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 |
900531 | Error when getting payment term |
900532 | Error when creating a payment term |
900533 | Error when updating a payment term |
900534 | Error when deleting a payment term |
{ "errorCode" : 900101, "errorMessage" : "Something went wrong on the server", "errorField" : null, "errorData" : null }
Payment terms API:
Payment terms
Get payment terms
GETUrl:
Headers:
Accept: application/json or application/xml
Get a list of payment terms
Valid parameters:
Parameter | Description | Default value | Allowed values |
---|---|---|---|
since | 0 |
Body:
Successfull response:
{ "paymentTerms": [{ "code": "code", "description": "description" }], "since": 6300 }
Get payment term
GETUrl: /{term_id : .+}
Headers:
Accept: application/json or application/xml
Get a single payment term based on term id
Body:
Successfull response:
{ "paymentTerms": [{ "code": "code", "description": "description" }], "since": 8905 }
Add payment term
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 payment term
Body:
{ "code": "code", "description": "description" }
Successfull response:
{ "code": "code", "description": "description" }
Update payment term
PUTUrl: /{term_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 payment term
Body:
{ "code": "code", "description": "description" }
Successfull response:
{ "code": "code", "description": "description" }
Delete payment term
DELETEUrl: /{term_id : .+}
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Content-type: application/json or application/xml
Delete an existing payment term
Body:
Successfull response:
Classes:
PaymentTerm
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
code | String | Write only with POST | Post | R,W | |||
description | String | Post | R,W |
PaymentTermsResponse
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
since | long | R | |||||
paymentTerms | List | R |