Difference between revisions of "MOR API credit note update"

From Kolmisoft Wiki
Jump to navigationJump to search
(Created page with '''This functionality is available from MOR 12'' MOR API Create credit note <br><br> ---- <br><br> * Call: /api/credit_note_create * Methods: PO…')
 
Line 1: Line 1:
''This functionality is available from [[MOR 12 documentation | MOR 12]]''
''This functionality is available from [[MOR 12| MOR 12]]''




[[MOR API]]
[[MOR API]]
Create credit note
 
Credit note update


<br><br>
<br><br>
Line 9: Line 10:
<br><br>
<br><br>


* Call: /api/credit_note_create
* Call: /api/credit_note_update
* Methods: POST, GET(if allowed, not recomended)
* Methods: POST, GET(if allowed, not recomended)
* Params:
* Params:
** user_id - User ID in MOR database, for which user device should be created. '''Required'''.
** credit_note_id - Credit note ID in MOR database. '''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'''.
** u - username to login. '''Required'''.
** p - password to login. '''Required'''.
** p - password to login. '''Required'''.
** status - status of credit note, posible values are 'paid', 'unpaid'. '''Optional'''
** comment - unlimited length text. '''Optional'''
** [[MOR API hash construction | hash]] - SHA1 hash constructed using '''params''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
** [[MOR API hash construction | hash]] - SHA1 hash constructed using '''params''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.


* Returns:
* Returns:
**Success
**Success
*** <status>Credit note was created</status>
*** <status>Credit note updated</status>
** Errors:
** Errors:
*** <error>User was not found</error> - User was not found using user_id. Use correct user id.
*** <error>Credit note was not saved</error>
*** <error>Bad login</error>
*** <error>Credit note was not found</error> - credit note was not found using phonebook_id. Use correct phonebook id.
*** <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
*** <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>


<br><br>
<br><br>
----
----
*Example:
*Example:
**We have user_id = 123, API Secret Key = 456789
**We have credit_note_id = 123, API Secret Key = 456789
**Hash string to be converted: "123456789"
**Hash string to be converted: "123456789"
**We send:
**We send:
***/api/credit_note_create?u=admin&p=admin&user_id=123&price=100&issue_date=214543&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441
***/api/credit_note_update?u=admin&p=admin&credit_note_id=123&status=paid&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441
'''* Note that username and password are not included in hash'''
'''* Note that username and password are not included in hash'''

Revision as of 14:25, 12 January 2012

This functionality is available from MOR 12


MOR API

Credit note update





  • Call: /api/credit_note_update
  • Methods: POST, GET(if allowed, not recomended)
  • Params:
    • credit_note_id - Credit note ID in MOR database. Required.
    • u - username to login. Required.
    • p - password to login. Required.
    • status - status of credit note, posible values are 'paid', 'unpaid'. Optional
    • comment - unlimited length text. Optional
    • hash - SHA1 hash constructed using params and API_Secret_Key ( More described in Constructing hash). Required.
  • Returns:
    • Success
      • <status>Credit note updated</status>
    • Errors:
      • <error>Credit note was not saved</error>
      • <error>Bad login</error>
      • <error>Credit note was not found</error> - credit note was not found using phonebook_id. Use correct phonebook id.
      • <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.



  • Example:
    • We have credit_note_id = 123, API Secret Key = 456789
    • Hash string to be converted: "123456789"
    • We send:
      • /api/credit_note_update?u=admin&p=admin&credit_note_id=123&status=paid&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441

* Note that username and password are not included in hash

Retrieved from "https://wiki.kolmisoft.com/index.php?title=MOR_API_credit_note_update&oldid=12113"