Difference between revisions of "MOR API credit notes create"

From Kolmisoft Wiki
Jump to navigationJump to search
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
''This functionality is available from [[MOR 12 documentation | MOR 12]]''
=Description=
<!---This functionality is available from MOR 12--->
[[MOR API]] Create credit note
<br><br>
=Usage=


* Call: /api/credit_note_create
* Methods: POST, GET(if allowed, not recomended)
<br><br>
===Parametres===


[[MOR API]]
Parameters which are '''included''' into hash:
Create credit note


* 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'''
<br><br>
<br><br>
----
Parameters which are '''not included''' into hash:
 
* [[MOR API hash construction | hash]] - SHA1 hash constructed using parameters above and API_Secret_Key ([[MOR API hash construction | 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.
<br><br>
<br><br>


* Call: /api/credit_note_create
===Request===
* Methods: POST, GET(if allowed, not recomended)
 
* Params:
We have user_id = 123, price=100 and API Secret Key = 456789\
** user_id - User ID in MOR database, for which user device should be created. '''Required'''.
 
** price - credit note price in system currency. '''Required'''.
We send:
** 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'''.
** p - password to login. '''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'''.


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.


* Returns:
HTML POST: http://<SERVER_IP>/billing/api/credit_note_create?u=username&user_id=123&price=100&issue_date=214543&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441
**Success
*** <status>Credit note was created</status>
** Errors:
*** <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>


'''NOTE that username are not included in hash'''
<br><br>
===Returns===
'''Success'''
<?xml version="1.0" encoding="UTF-8"?>
<page>
    <status>Credit note was created</status>
</page>
<br><br>
<br><br>
----
----
*Example:
'''Errors'''
**We have user_id = 123, API Secret Key = 456789
 
**Hash string to be converted: "123456789"
* <error>User was not found</error> - User was not found using user_id. Use correct user id.
**We send:
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
***/api/credit_note_create?u=admin&p=admin&user_id=123&price=100&issue_date=214543&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441
* <error>Credit note was not created</error>
'''* Note that username and password are not included in hash'''
* <error>Bad login</error>
<br><br>
=See also=
 
* [[MOR API]]

Latest revision as of 06:48, 30 May 2014

Description

MOR API Create credit note

Usage

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



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.

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

Returns

Success 

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



Errors

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



See also

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