List of documents

GET

doc

list

Authorizations

Authorization

string

headerrequired

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

Query Parameters

document_type

enum<string>

default: invoicerequired

Available options:

invoice,

purchase,

pro_forma_invoice,

estimate,

sales_return,

purchase_return,

delivery_challan,

purchase_order

start_date

string

default: 01-01-2024required

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

end_date

string

default: 31-12-2024required

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

Response

200 - application/json

success

boolean

Success flag

message

string

Message

error_code

string

Error code

errors

object

Error details

data

object

data.transactions

object[]

List of transactions

data.transactions.serial_number

string

Invoice number assigned to document

data.transactions.document_date

string

Transaction date [DD-MM-YYYY]

data.transactions.customer

object

Customer Details for the document

data.transactions.due_date

string

Transaction date [DD-MM-YYYY]

data.transactions.amount_paid

number

Amount Paid for the document

data.transactions.amount_pending

number

Remaining amount to be paid for the document

data.transactions.reference

string

Reference Text

data.transactions.notes

string

Notes for the document

data.transactions.terms

string

Terms and Conditions

data.transactions.is_created_by_recurring

integer

Is the invoice created from subscriptions

data.transactions.net_amount

number

Net amount of the transaction

data.transactions.hash_id

string

Hash id for the document

data.transactions.payment_status

enum<string>

Payment status of the document

Available options:

paid,

pending,

cancelled

data.transactions.payments

object[]

List of payments recorded for this document

data.transactions.tax_amount

number

Tax amount of the transaction

data.transactions.total_amount

number

Total amount of the transaction

data.transactions.total_discount

number

Discount given on this document

data.total_records

integer

Total number of records

Cancel a document Record payment

API Documentation

Document

Customer

Payment

Product

Subscriptions

Utility

Customer V2

Document V2

Payment V2

Product V2

List of documents

Authorizations

Query Parameters

Response