Difference between revisions of "MOR API invoices get"

From Kolmisoft Wiki
Jump to navigationJump to search
 
(12 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[MOR API]]
=Description=
[[MOR API]] Retrieves a list of invoices in the selected time period.


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 a user has 'accountant' rights and can see only assigned users, he will get only assigned users invoices from the selected period. If user has 'user' rights, he will get only '''HIS''' invoices from the selected period.
<br><br>


==Request==
=Usage=


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.
* 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)
<br><br>
===Parametres===


HTML POST: http://<SERVER IP>/billing/api/invoices?u=username&p=password&from=1188604800&till=1191196799&lang=en
* u - username username of user which can view invoices.
* from/till - time period for invoices in [http://en.wikipedia.org/wiki/Unix_time Unix Epoch Time] format. Invoice's '''period start''' should be >= '''from''' and '''period end''' <= '''till'''.
** http://www.epochconverter.com/ can help to convert time for testing.
* lang - choose the language in which you want to get invoice details (mainly 'Calls').
<br><br>


Here:
===Request===
* '''from/till''' - time period for invoices in [http://en.wikipedia.org/wiki/Unix_time Unix Epoch Time] format. Invoice's '''period start''' should be >= '''from''' and '''period end''' <= '''till'''.
** http://www.epochconverter.com/ can help to convert time for testing.
* '''lang''' - choose the language in which you want to get invoice details (mainly 'Calls').


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


  <Invoices till="2015-08-22" from="2005-04-21">
'''Success'''
  <Invoice clientid="" number="INV0706221" agreementnumber="" user_id="0">
  <Invoices from="2019-05-01" till="2019-05-31">
    <Product>
<Invoice user_id="2" agreementnumber="" clientid="" number="INV1905011">
      <Name>Calls</Name>
<id>5</id>
      <Quantity>2</Quantity>
<paid>0</paid>
      <Price>5.0000</Price>
<Product>
      <Date_added></Date_added>
<Name>Test_periodic_service - 1</Name>
      <Issue_date>2012-06-22</Issue_date>
<Quantity>1</Quantity>
    </Product>
<Price>10.0000</Price>
  </Invoice>
<Discount>0.0000</Discount>
  <Invoice clientid="" number="INV0706222" agreementnumber="" user_id="2">
<Sum>10.0000</Sum>
    <Product>
<Date_added/>
      <Name>Calls</Name>
<Issue_date>2019-06-27</Issue_date>
      <Quantity>4</Quantity>
<Time/>
      <Price>20.0000</Price>
<Service_id>1</Service_id>
      <Date_added></Date_added>
<Prefix></Prefix>
      <Issue_date>2012-06-22</Issue_date>
</Product>
    </Product>
<Product>
    <Product>
<Name>Test_periodic_service - 2</Name>
      <Name>Test_periodic_service - Test_preriodic_service_memo</Name>
<Quantity>1</Quantity>
      <Quantity>1</Quantity>
<Price>10.0000</Price>
      <Price>390.5591</Price>
<Discount>2.0000</Discount>
      <Date_added></Date_added>
<Sum>8.0000</Sum>
      <Issue_date>2012-06-22</Issue_date>
<Date_added/>
    </Product>
<Issue_date>2019-06-27</Issue_date>
  </Invoice>
<Time/>
  <Invoice clientid="" number="INV0706223" agreementnumber="0000000001" user_id="3">
<Service_id>2</Service_id>
    <Product>
<Prefix></Prefix>
      <Name>Calls</Name>
</Product>
      <Quantity>2</Quantity>
<Total_time/>
      <Price>11.0000</Price>
</Invoice>
      <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>
  </Invoices>
----


==Errors==
'''Errors'''
 
<?xml version="1.0" encoding="UTF-8"?>
<status>
  <error>Incorrect hash</error>
</status>


  <Error>user not found</Error>
  <Error>user not found</Error>


  <Error>no invoices found</Error>
  <Error>no invoices found</Error>
<br><br>
=See also=
* [[MOR API]]

Latest revision as of 12:24, 4 December 2024

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 a user has 'accountant' rights and can see only assigned users, he will get only assigned users invoices from the selected period. If user has 'user' rights, he will get only HIS invoices from the selected period.

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)



Parametres

  • u - username username of user which can view invoices.
  • 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').



Request

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



Returns

Success 

<Invoices from="2019-05-01" till="2019-05-31">
<Invoice user_id="2" agreementnumber="" clientid="" number="INV1905011">
<id>5</id>
<paid>0</paid>
<Product>
<Name>Test_periodic_service - 1</Name>
<Quantity>1</Quantity>
<Price>10.0000</Price>
<Discount>0.0000</Discount>
<Sum>10.0000</Sum>
<Date_added/>
<Issue_date>2019-06-27</Issue_date>

Errors 

<?xml version="1.0" encoding="UTF-8"?>
<status>
  <error>Incorrect hash</error>
</status>

<Error>user not found</Error>

<Error>no invoices found</Error>



See also

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