MOR API credit notes delete

From Kolmisoft Wiki

Jump to: navigation, search

Contents

[edit] Deescription

MOR API Delete credit note

[edit] Usage

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



[edit] Parametres

Note that only API_Secret_Key is included into hash

Parameters which are not included into hash:

  • hash - SHA1 hash constructed using API_Secret_Key ( More described in Constructing hash). Required.
  • u - username for authentication. Required.
  • credit_note_id - Credit note ID in MOR database, whose datas we want to delete. Required.



[edit] Request

We have credit_note_id = 123, API Secret Key = 456789

We send:

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

* Note that username are not included in hash

[edit] Returns

Success

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




Errors

  • <error>Credit note was not found</error> - Credit note was not found using credit_note_id. Use correct credit note id.
  • <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
  • <error>Bad login</error>



[edit] See also

Personal tools

Try MOR

Try M2