Skip to main content
GET
List of documents

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer , where is your auth token.

Query Parameters

document_type
enum<string>
default:invoice
required
Available options:
invoice,
purchase,
pro_forma_invoice,
estimate,
sales_return,
purchase_return,
delivery_challan,
purchase_order
start_date
string
default:01-01-2024
required

Start date for the list, [DD-MM-YYY]

end_date
string
default:31-12-2024
required

End date for the list, [DD-MM-YYY]

payment_status
enum<string>
default:all

Filter list based on payment status of the document.

Available options:
all,
pending,
paid,
cancelled
num_records
string
default:10

Number of records to fetch max(100)

page
integer
default:1

Page number

customer_id
string

Customer ID

Response

Documents List fetched successfully

success
boolean

Success flag

Example:

true

message
string

Message

Example:

"Details Fetched"

error_code
string

Error code

Example:

""

errors
object

Error details

data
object