MOR API credit notes create
From Kolmisoft Wiki
Jump to navigationJump to search
This functionality is available from MOR 12
MOR API
Create credit note
- Call: /api/credit_note_create
- Methods: POST, GET(if allowed, not recomended)
- Params:
- user_id - User ID in MOR database, for which user device should be created. Required.
- price - credit note price in system currency. Required.
- issue_date - date credit note was issued(unix timestamp). Required.
- comment - unlimited length text. Optional.
- number - number of credit note. Optional.
- u - username to login. Required.
- p - password to login. Required.
- hash - SHA1 hash constructed using params and API_Secret_Key ( More described in Constructing hash). Required.
- Returns:
- Success
- <status>Credit note was created</status>
- Errors:
- <error>User was not found</error> - User was not found using user_id. Use correct user id.
- <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
- <error>Credit note was not created</error>
- <error>Bad login</error>
- Success
- Example:
- We have user_id = 123, API Secret Key = 456789
- Hash string to be converted: "123456789"
- We send:
- /api/credit_note_create?u=admin&p=admin&user_id=123&price=100&issue_date=214543&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441
* Note that username and password are not included in hash