v1
latestOpenAPI 3.1.02026-08-045901.5 MBList Invoice
get/invoice
Query parameters
page_numbernumber float
Defines the page number for pagination. This is useful when you have a large dataset and want to retrieve it page-by-page.
filter.contact_idinteger
Filters the invoices based on the contact ID. This is useful when you want to retrieve invoices specific to a customer or client.
page_sizeinteger
Specifies the number of invoices to be returned per page. This allows control over the amount of data returned at once.
filter.payment_status'Paid' | 'Part Paid' | 'Not Paid'
Filters invoices based on their payment status.
filter.invoice_status'Deleted'
Filters invoices based on their overall status.
filter.date_fromstring
Filters invoices from a specific starting date. You can use this to narrow down results to invoices created after this date.
filter.date_tostring
Filters invoices up until a specific end date. This is useful for narrowing results to invoices created before this date.
Response
200
Example response
{
"success": true,
"meta": {
"total_count": 1
},
"data": [
{
"invoice_id": 8756,
"invoice_number": "ABF-1001",
"invoice_date": "2025-04-24",
"validity_date": "2025-05-09",
"gst_type": 1,
"seller_info": {
"business_name": "STOCK HOLDING CORPORATION OF INDIA LIMITED",
"gstin": "25AABCS1429B1ZY",
"branch_id": "413",
"address": {
"address_line_1": "ESTAMPING OFFICE, PWD, DIVISION -1",
"address_line_2": "NEAR FATIMA CONVENT SCHOOL",
"city": "MOTI",
"state": "DAMAN AND DIU",
"country": "India",
"pincode": "396220"
}
},
"seller_branch_id": 413,
"customer_info": {
"id": 4947,
"name": "John Doe",
"email": "johndoe@example.com",
"mobile": "9876543210",
"business_name": "Doe Enterprises",
"gstin": "29ABCDE1234F1Z5",
"pos": "DAMAN AND DIU",
"billing_details": {
"bill_city": "Chennai",
"bill_addr1": "123, Mount Road",
"bill_addr2": "Teynampet",
"bill_gstin": "29ABCDE1234F1Z5",
"bill_state": "TAMIL NADU",
"bill_country": "India",
"bill_pincode": "600018"
},
"shipping_details": {
"ship_city": "Chennai",
"ship_addr1": "123, Mount Road",
"ship_addr2": "Teynampet",
"ship_gstin": "29ABCDE1234F1Z5",
"ship_state": "TAMIL NADU",
"ship_country": "India",
"ship_pincode": "600018"
}
},
"invoice_item": [
{
"product_id": 3031,
"variant_id": 1,
"item_name": "Laptop Model X",
"item_description": "High performance business laptop",
"item_type": 1,
"item_code": 983722,
"quantity": 2,
"units": "UNT-UNITS",
"rate": 75000,
"taxable_amt": 150000,
"discount": 5000,
"gst_rate": 18,
"sgst_amt": 13500,
"cgst_amt": 13500,
"tax_info": {
"gst_type": 1,
"cess_type": "percentage",
"cgst_rate": 9,
"sgst_rate": 9,
"cgst_amount": 13500,
"sgst_amount": 13500
},
"discount_type": "amount",
"custom_fields": [
{
"label": "Warranty",
"value": "2 Years"
}
],
"item_total_amt": 172000
}
],
"total_taxable_amount": 150000,
"total_gst_amount": 27000,
"total_amount": 172000,
"payable_amount": 172000,
"added_by": 1501425402,
"added_on": "2025-04-24 15:23:43",
"invoice_status": 1,
"payment_info": {
"rid": "RID123456789"
},
"export_details": {
"export_port": "Chennai Port",
"export_type": 1,
"export_bill_no": "EBN12345",
"special_supply": "0",
"export_bill_date": "2025-04-26"
},
"billing_currency": "INR",
"terms_conditions": "Payment due within 15 days from the invoice date.",
"notes": "Please ensure payment is made through bank transfer.",
"billing_currency_info": {
"name": "INR",
"exchange_rate": 1,
"exchnage_time": "2025-04-24 15:23:35"
},
"bank_id": 535,
"tax_info": {
"gst_type": 1,
"cgst_amount": 13500,
"sgst_amount": 13500
},
"data_source": 1,
"auto_mode": 1,
"recon_details": {
"receipt": [
{
"receipt_id": "RCPT98765",
"receipt_date": "2025-04-25",
"amount": 50000
}
]
},
"url": "https://indev.ledgers.cloud/public/invoice/S0J2cVV2Um9zRHp2UHpBUG9TTDZFdz09/RIc012eEh5MFg3OWNRb25DZz09"
}
],
"message": "Data Fetched Successfully"
}