MOR API credit notes create
From Kolmisoft Wiki
Revision as of 04:29, 27 May 2013 by Aisteb (talk | contribs) (moved MOR API credit notes create api to MOR API credit notes create)
Description
MOR API Create credit note
Usage
- Call: /api/credit_note_create
- Methods: POST, GET(if allowed, not recomended)
Parametres
- 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 for authentication. Required.
- hash - SHA1 hash constructed using params and API_Secret_Key ( More described in Constructing hash). Required.
Note that if user of type accountant does not have privileges to manage invoices at least in read mode or does note have privilege to see financial data in edit mode, accountant cannot create credit note.
Request
We have user_id = 123, price=100 and API Secret Key = 456789\
We send:
HTML POST: http://<SERVER_IP>/billing/api/credit_note_create?u=username&user_id=123&price=100&issue_date=214543&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441
NOTE that username are not included in hash
Returns
Success
<?xml version="1.0" encoding="UTF-8"?> <page> <status>Credit note was created</status> </page>
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>