Skip to main content
GET
E-way bills: the consignment each one covers, both GSTINs, the document it travels on, the tax, the transport and, once…

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

id
string
eway_bill_reference
string
status
string
purpose
string
asset_transfer_batch_id
string
batch_number
string
from_site_id
string
from_site
string
to_site_id
string
to_site
string
to_party
string
from_gstin
string
to_gstin
string
buyer_customer_id
string
buyer_vendor_id
string
to_address
string
ship_to_address
string
ship_to_state_code
string
transaction_type
string
from_state_code
string
to_state_code
string
document_type
string
document_number
string
document_date
string
sub_supply_type
string
tax_kind
string
total_taxable_value
string
cgst_amount
string
sgst_amount
string
igst_amount
string
total_invoice_value
string
transport_mode
string
vehicle_number
string
transporter_id
string
transporter_name
string
distance_km
string
ewb_number
string
ewb_date
string
valid_until
string
failure_reason
string
irn
string
signed_qr_code
string
pdf_file_id
string
cancelled_at
string
cancellable_until
string
filing_problems
string
pending_action
string
from_address_line1
string
from_address_line2
string
from_city
string
from_postal_code
string
to_address_line1
string
to_address_line2
string
to_city
string
to_postal_code
string
ship_to_address_line1
string
ship_to_address_line2
string
ship_to_city
string
ship_to_postal_code
string
vehicle_type
string
transport_document_number
string
transport_document_date
string
line_count
string
prepared_at
string
prepared_by_user_id
string
prepared_by
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

asset_transfer_batch_id
string<uuid>

Note: This is a Foreign Key to asset_transfer_batches.id.

batch_number
string<character varying>
Maximum string length: 40
buyer_customer_id
string<uuid>
buyer_vendor_id
string<uuid>

Note: This is a Foreign Key to assignable_vendors.id.

cancellable_until
string<timestamp with time zone>
cancelled_at
string<timestamp with time zone>
cgst_amount
number<numeric>
distance_km
integer<integer>
document_date
string<date>
document_number
string<character varying>
Maximum string length: 16
document_type
string<character varying>
Maximum string length: 3
eway_bill_reference
string<character varying>
Maximum string length: 40
ewb_date
string<timestamp with time zone>
ewb_number
string<character varying>
Maximum string length: 12
failure_reason
string<text>
filing_problems
string[]
from_address_line1
string<character varying>
Maximum string length: 200
from_address_line2
string<character varying>
Maximum string length: 200
from_city
string<character varying>
Maximum string length: 120
from_gstin
string<character varying>
Maximum string length: 15
Maximum string length: 250
from_postal_code
string<character varying>
Maximum string length: 10
from_site
string<character varying>
Maximum string length: 200
from_site_id
string<uuid>

Note: This is a Foreign Key to entry_currencies.for_site_id.

from_state_code
string<character varying>
Maximum string length: 2
id
string<uuid>

Note: This is a Primary Key.

igst_amount
number<numeric>
irn
string<character varying>
Maximum string length: 64
line_count
integer<bigint>
pdf_file_id
string<uuid>
pending_action
string<character varying>
Maximum string length: 12
prepared_at
string<timestamp with time zone>
prepared_by
string<character varying>
Maximum string length: 200
prepared_by_user_id
string<uuid>

Note: This is a Foreign Key to capex_invite_candidates.id.

purpose
string<character varying>
Maximum string length: 10
sgst_amount
number<numeric>
ship_to_address
string<text>
ship_to_address_line1
string<character varying>
Maximum string length: 200
ship_to_address_line2
string<character varying>
Maximum string length: 200
ship_to_city
string<character varying>
Maximum string length: 120
ship_to_postal_code
string<character varying>
Maximum string length: 10
ship_to_state_code
string<character varying>
Maximum string length: 2
signed_qr_code
string<text>
status
string<character varying>
Maximum string length: 20
sub_supply_type
integer<smallint>
tax_kind
string<character varying>
Maximum string length: 10
to_address
string<text>
to_address_line1
string<character varying>
Maximum string length: 200
to_address_line2
string<character varying>
Maximum string length: 200
to_city
string<character varying>
Maximum string length: 120
to_gstin
string<character varying>
Maximum string length: 15
Maximum string length: 250
to_party
string<character varying>
to_postal_code
string<character varying>
Maximum string length: 10
to_site
string<character varying>
Maximum string length: 200
to_site_id
string<uuid>

Note: This is a Foreign Key to entry_currencies.for_site_id.

to_state_code
string<character varying>
Maximum string length: 2
total_invoice_value
number<numeric>
total_taxable_value
number<numeric>
transaction_type
integer<smallint>
transport_document_date
string<date>
transport_document_number
string<character varying>
Maximum string length: 15
transport_mode
integer<smallint>
transporter_id
string<character varying>
Maximum string length: 15
transporter_name
string<character varying>
Maximum string length: 100
valid_until
string<timestamp with time zone>
vehicle_number
string<character varying>
Maximum string length: 15
vehicle_type
string<character varying>
Maximum string length: 1