MOR API invoices get

From Kolmisoft Wiki

Jump to: navigation, search

Contents

[edit] Description

MOR API Retrieves a list of invoices in the selected time period.

If a user has 'admin' rights, he will get ALL invoices from the selected period. If user has 'user' rights, he will get only HIS invoices from the selected period.

[edit] Usage

  • From MOR X4 call: /api/invoices_get
  • For Backwards-compatibility old name 'invoices' is also usable. Call: /api/invoices
  • Methods: POST, GET(if allowed, not recomended)



[edit] Parametres

  • u - username username of user which can view invoices. Required.
  • from/till - time period for invoices in Unix Epoch Time format. Invoice's period start should be >= from and period end <= till.
  • lang - choose the language in which you want to get invoice details (mainly 'Calls').



[edit] Request

HTML POST: http://<SERVER IP>/billing/api/invoices_get?u=username&from=1188604800&till=1191196799&lang=en



[edit] Returns

Success

<Invoices till="2015-08-22" from="2005-04-21">
 <Invoice clientid="" number="INV0706221" agreementnumber="" user_id="0">
   <paid>0</paid>
   <Product>
     <Name>Calls</Name>
     <Quantity>2</Quantity>
     <Price>5.0000</Price>
     <Date_added></Date_added>
     <Issue_date>2012-06-22</Issue_date>
   </Product>
 </Invoice>
 <Invoice clientid="" number="INV0706222" agreementnumber="" user_id="2">
   <paid>1</paid>
   <Product>
     <Name>Calls</Name>
     <Quantity>4</Quantity>
     <Price>20.0000</Price>
     <Date_added></Date_added>
     <Issue_date>2012-06-22</Issue_date>
   </Product>
   <Product>
     <Name>Test_periodic_service - Test_preriodic_service_memo</Name>
     <Quantity>1</Quantity>
     <Price>390.5591</Price>
     <Date_added></Date_added>
     <Issue_date>2012-06-22</Issue_date>
   </Product>
 </Invoice>
 <Invoice clientid="" number="INV0706223" agreementnumber="0000000001" user_id="3">
   <paid>1</paid>
   <Product>
     <Name>Calls</Name>
     <Quantity>2</Quantity>
     <Price>11.0000</Price>
     <Date_added></Date_added>
     <Issue_date>2012-06-22</Issue_date>
   </Product>
   <Product>
     <Name>Calls from Users</Name>
     <Quantity>7</Quantity>
     <Price>52.0000</Price>
     <Date_added></Date_added>
     <Issue_date>2012-06-22</Issue_date>
   </Product>
 </Invoice>
</Invoices>




Errors

<?xml version="1.0" encoding="UTF-8"?>
<status>
  <error>Incorrect hash</error>
</status>
<Error>user not found</Error>
<Error>no invoices found</Error>



[edit] See also

Personal tools

Try MOR

Try M2