MOR API credit note update

From Kolmisoft Wiki

Jump to: navigation, search

MOR API Credit note update


[edit] Usage

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

[edit] Parametres

  • status - status of credit note, posible values are 'paid', 'unpaid'. Optional

Note that parameters are shown in the same order as they have to be when generating the hash. Last parameter in a row is API_Secret_Key

Parameters which are not included into hash:

  • hash - SHA1 hash constructed using parameters above and API_Secret_Key ( More described in Constructing hash). Required (if setting Disable hash checking is not checked).
  • u - username for authentication. Required.
  • credit_note_id - Credit note ID in MOR database. Required.
  • comment - unlimited length text. Optional

[edit] 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

[edit] Returns


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


  • <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.

[edit] See also

Personal tools


Try M2