Section T - Invoice details API

T1 - Get all invoice IDs

GET Method :

/api/v1/get_all_invoice_ids/< fromDate >/ < toDate > / < status >with the following data:

Input :

Argument Mandatory Value
fromDate No From Date < Date Format yyyy-mm-dd>
toDate No To Date < Date Format yyyy-mm-dd>
Status (Optional) No String Keyword < “paid”, “unpaid”> Status will be “all” if fromDate and toDate is not specified

Sample Output :

{
"12960":12960,
"12961":12961,
"12855":12855
}

T2 - Get Invoice details

GET Method :

/api/v1/get_invoice_details/< invoiceId > with the following data:

Input :

Argument Mandatory Value
invoiceId Yes Numeric < Id of the invoice >

Sample Output :

[{
"invoiceNumber":"10",
"amount":"1600",
"balance":"200,
"description":"Product1 Period from 09\/26\/2016 to 09\/30\/2016",
"billGeneratedDate":"2016-09-26 00:00:00+05:30",
"detailsOfInvoice": [ "", {
 "amount": "799.00",
 "description": "799 metro plus - Period from 01 Oct 2015 to 31 Oct 2015" }, {
 "amount": "111.86",
 "description": "Service Tax" } ],
"name":"",
"user_id":"8",
"circuit_id":"8",
"billingPeriodFrom":"2016-09-26",
"billingPeriodTo":"2016-09-30",
"billingDueDate":"2016-10-10"
}]

T3 - Get all invoices from userId

GET Method :

/api/v1/get_all_invoices_from_userid/< userId > /< status> with the following data:

Input :

Argument Mandatory Value
userId Yes Numeric < Id of the user >
status (Optional) No String Keyword <“paid” or “unpaid”>

Sample Output :

[{"2109":2109,"2302":2302,"2704":2704}]

T4 - Get all invoices

GET Method :

/api/v1/get_all_invoices/< fromDate >/ < toDate > with the following data:

Input :

Argument Mandatory Value
fromDate No From Date < Date Format yyyy-mm-dd>
toDate No To Date < Date Format yyyy-mm-dd>

Sample Output :

Note: If users last_name is not specified then you we will be returning "Customer" in the same way for email we will be returning "[email protected]" , phone_phone_number we will be returning "9999999999" and street_addres1 we will be returning "123 Anywhere St".

[
 [
 {
 "Contact": {
 "user_id": "447",
 "person_title": "91095701",
 "status": "active",
 "group_name": "2 Mbps",
 "first_name": "",
 "last_name": "Customer",
 "email": "[email protected]",
 "phone_phone_number": "9999999999",
 "street_addres1": "123 Anywhere St",
 "street_addres2": "",
 "account_id": "accountId",
 "create_datetime": "2018-10-08 13:19:46",
 "user_created": "2018-10-08 13:19:46",
 "gst_number": null,
 "gst_start_date": null,
 "deleted": "0",
 "profile_name": "2 Mbps Profile"
 },
 "Invoice": {
 "id": "865",
 "public_number": "862",
 "balance": "201.29",
 "total": "201.29032258064",
 "status_id": "27",
 "create_timestamp": "2018-10-08 13:19:47",
 "package_name": "2 Mbps Profile"
 }
 }
 ] ]

T5 - Get invoice recipt

GET Method :

/api/v1/get_invoice_receipt/< userId>/< invoiceId> with the following data:

Input :

Argument Mandatory Value
userId Yes Numeric < Id of the user >
invoiceId Yes Numeric < Id of the invoice >

Sample Output :

{
 "status": "success",
 "errorCode": 200,
 "message": "http://10.0.0.91:8095/jazetest/invoice1020.pdf"
}