Difference between revisions of "MOR API invoices get"
From Kolmisoft Wiki
Jump to navigationJump to search
Line 3: | Line 3: | ||
Retrieves list of invoices in selected time period. | Retrieves list of invoices in selected time period. | ||
==Request== | |||
If user has 'admin' rights - he will get all invoices from selected period, if user has 'user' rights - he will get only his invoices in selected period. | If user has 'admin' rights - he will get all invoices from selected period, if user has 'user' rights - he will get only his invoices in selected period. | ||
Line 14: | Line 14: | ||
* '''lang''' - choose in which language do you want to get invoice details (mainly 'Calls'). | * '''lang''' - choose in which language do you want to get invoice details (mainly 'Calls'). | ||
==Example result== | |||
<Invoices from="2007-09-01" till="2007-10-01"> | <Invoices from="2007-09-01" till="2007-10-01"> | ||
Line 33: | Line 33: | ||
</Invoices> | </Invoices> | ||
==Errors== | |||
<Error>user not found</Error> | <Error>user not found</Error> | ||
<Error>no invoices found</Error> | <Error>no invoices found</Error> |
Revision as of 14:52, 17 January 2008
Retrieves list of invoices in selected time period.
Request
If user has 'admin' rights - he will get all invoices from selected period, if user has 'user' rights - he will get only his invoices in selected period.
HTML POST: http://<SERVER IP>/mor/api/invoices?u=username&p=password&from=1188604800&till=1191196799&lang=en
Here:
- from/till - time period for invoices in 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 in which language do you want to get invoice details (mainly 'Calls').
Example result
<Invoices from="2007-09-01" till="2007-10-01"> <Invoice agreementnumber="0000000000" user_id="0" clientid="240887380"> <Product> <Name>Monthly fee - test</Name> <Quantity></Quantity> <Price>10.0</Price> </Product> </Invoice> <Invoice agreementnumber="0000000000" user_id="0" clientid="240887380"> <Product> <Name>Calls</Name> <Quantity>65</Quantity> <Price>112.3324</Price> </Product> </Invoice> </Invoices>
Errors
<Error>user not found</Error>
<Error>no invoices found</Error>