MOR API credit notes create

From Kolmisoft Wiki

Jump to: navigation, search


[edit] Description

MOR API Create credit note

[edit] Usage

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

[edit] Parametres

Parameters which are included into hash:

  • user_id - User ID in MOR database, for which user device should be created. Required.
  • number - number of credit note. 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.* price - credit note price in system currency. Required.
  • issue_date - date credit note was issued(unix timestamp). Required.
  • comment - unlimited length text. Optional.

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.

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

[edit] Returns


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


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

[edit] See also

Personal tools


Try M2