v1
latestOpenAPI 3.0.12026-07-263591116.9 KBDocument V2
List of documents
get/v2/doc/list
Query parameters
document_type'invoice' | 'purchase' | 'pro_forma_invoice' | 'estimate' | 'sales_return' | 'purchase_return' | 'delivery_challan' | 'purchase_order' required
start_datestring required
Start date for the list, [DD-MM-YYY]
end_datestring required
End date for the list, [DD-MM-YYY]
payment_status'all' | 'pending' | 'paid' | 'cancelled'
Filter list based on payment status of the document.
num_recordsstring
Number of records to fetch max(100)
pageinteger
Page number
customer_idstring
Customer ID
Response
Documents List fetched successfully
Example response
{
"success": true,
"message": "Details Fetched",
"data": {
"transactions": [
{
"serial_number": "INV-12",
"document_date": "11-06-2024",
"customer": {
"id": "CUST123",
"name": "John Doe",
"country_code": "91",
"phone_number": "1234567890",
"company_name": "Company Name",
"email": "johndoe@example.com",
"gstin": "27AARCS7202C1ZD"
},
"due_date": "11-06-2024",
"amount_paid": 28,
"amount_pending": 90,
"net_amount": 100,
"payment_status": "paid",
"payments": [
{
"amount": 100,
"method": "upi",
"notes": "Payment notes",
"bank_details": {
"account_number": "1234567890",
"ifsc": "SBIN0000001",
"bank_name": "State Bank of India",
"branch": "Mumbai"
}
}
],
"tax_amount": 18,
"total_amount": 118,
"total_discount": 100
}
],
"total_records": 10
}
}