Difference between revisions of "MOR API credit note update"

From Kolmisoft Wiki
Jump to navigationJump to search
Line 1: Line 1:
''This functionality is available from [[MOR 12| MOR 12]]''
<!---This functionality is available from MOR 12--->
[[MOR API]] Credit note update
<br><br>
=Usage=
 
* Call: /api/credit_note_update
* Methods: POST, GET(if allowed, not recomended)
<br><br>
===Parametres===
 
* credit_note_id - Credit note ID in MOR database. '''Required'''.
* u - username for authentication. '''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'''.
<br><br>
===Request===


We have credit_note_id = 123, API Secret Key = 456789


[[MOR API]]
We send:


Credit note update
HTML POST: http://<SERVER_IP>/billing/api/credit_note_update?u=username&credit_note_id=123&status=paid&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441


'''NOTE that username are not included in hash'''
<br><br>
<br><br>
----
===Returns===
<br><br>


* Call: /api/credit_note_update
'''Success'''
* 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'''
** [[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:
<?xml version="1.0" encoding="UTF-8"?>
**Success
<page>
*** <status>Credit note updated</status>
    <status>Credit note was updated</status>
** Errors:
</page>
*** <error>Credit note was not saved</error>
<br><br>
*** <error>Bad login</error>
----
*** <error>Credit note was not found</error> - credit note was not found using phonebook_id. Use correct phonebook id.
'''Errors'''
*** <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 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.
<br><br>
<br><br>
----
=See also=
*Example:
 
**We have credit_note_id = 123, API Secret Key = 456789
* [[MOR API]]
**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'''

Revision as of 04:18, 27 May 2013

MOR API Credit note update

Usage

  • Call: /api/credit_note_update
  • Methods: POST, GET(if allowed, not recomended)



Parametres

  • credit_note_id - Credit note ID in MOR database. Required.
  • u - username for authentication. 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.



Request

We have credit_note_id = 123, API Secret Key = 456789

We send: 

HTML POST: http://<SERVER_IP>/billing/api/credit_note_update?u=username&credit_note_id=123&status=paid&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441

NOTE that username are not included in hash

Returns

Success 

<?xml version="1.0" encoding="UTF-8"?>
<page>
   <status>Credit note was updated</status>
</page>



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.



See also

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