List of documents

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> 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:

Number of records to fetch max(100)

page

integer

default:

Page number

customer_id

string

Customer ID

Response

200 - application/json

data

object

data.total_records

integer

Total number of records

data.transactions

object[]

List of transactions

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.customer

object

Customer Details for the document

data.transactions.document_date

string

Transaction date [DD-MM-YYYY]

data.transactions.due_date

string

Transaction date [DD-MM-YYYY]

data.transactions.hash_id

string

Hash id for the document

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.notes

string

Notes 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.reference

string

Reference Text

data.transactions.serial_number

string

Invoice number assigned to document

data.transactions.tax_amount

number

Tax amount of the transaction

data.transactions.terms

string

Terms and Conditions

data.transactions.total_amount

number

Total amount of the transaction

data.transactions.total_discount

number

Discount given on this document

error_code

string

Error code

errors

object

Error details

message

string

Message

success

boolean

Success flag

Get Started

Document V2

Payment V2

Customer V2

Product V2

Subscriptions V2

Utility V2

List of documents

Authorizations

Query Parameters

Response