Get a document
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The hash id of the document to be fetched
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The hash id of the document to be fetched
Response
Success flag
Message
Error code
Error details
Invoice number assigned to document
Transaction date [DD-MM-YYYY]
Party Details for the document
Unique id for each party.
Party type, use only specified values. Party type customer can be used for creating invoices, sales returns, estimates, pro forma invoices and delivery challans. Party type vendor can be used for creating purchases, purchase orders & purchase returns, .
customer, vendor Name of the Party
Party Phone Number Country code
Party Phone Number
Company Name
Party Email
GSTIN
Party shipping to Address, refer Shipping Address Object for parameters
Address ID. It will automatically update the existing address if the address ID already exists.
Address Line 1
Address Line 2
City
State. Select OTHER TERRITORY for countries other than India. You can copy the state details from https://developers.getswipe.in/api-reference/references#state-details
JAMMU AND KASHMIR, HIMACHAL PRADESH, PUNJAB, CHANDIGARH, UTTARAKHAND, HARYANA, DELHI, RAJASTHAN, UTTAR PRADESH, BIHAR, SIKKIM, ARUNACHAL PRADESH, NAGALAND, MANIPUR, MIZORAM, TRIPURA, MEGHALAYA, ASSAM, WEST BENGAL, JHARKHAND, ODISHA, CHHATTISGARH, MADHYA PRADESH, GUJARAT, DADRA & NAGAR HAVELI & DAMAN & DIU, MAHARASHTRA, ANDHRAPRADESH(BEFOREADDED), KARNATAKA, GOA, LAKSHWADEEP, KERALA, TAMIL NADU, PUDUCHERRY, ANDAMAN & NICOBAR, TELANGANA, ANDHRA PRADESH, LADAKH(NEWLYADDED), OTHER TERRITORY Country. You can copy the country details from https://developers.getswipe.in/api-reference/references#country-array
Pincode
Party billing to Address, refer Shipping Address Object for parameters
Address ID. It will automatically update the existing address if the address ID already exists.
Address Line 1
Address Line 2
City
State. Select OTHER TERRITORY for countries other than India. You can copy the state details from https://developers.getswipe.in/api-reference/references#state-details
JAMMU AND KASHMIR, HIMACHAL PRADESH, PUNJAB, CHANDIGARH, UTTARAKHAND, HARYANA, DELHI, RAJASTHAN, UTTAR PRADESH, BIHAR, SIKKIM, ARUNACHAL PRADESH, NAGALAND, MANIPUR, MIZORAM, TRIPURA, MEGHALAYA, ASSAM, WEST BENGAL, JHARKHAND, ODISHA, CHHATTISGARH, MADHYA PRADESH, GUJARAT, DADRA & NAGAR HAVELI & DAMAN & DIU, MAHARASHTRA, ANDHRAPRADESH(BEFOREADDED), KARNATAKA, GOA, LAKSHWADEEP, KERALA, TAMIL NADU, PUDUCHERRY, ANDAMAN & NICOBAR, TELANGANA, ANDHRA PRADESH, LADAKH(NEWLYADDED), OTHER TERRITORY Country. You can copy the country details from https://developers.getswipe.in/api-reference/references#country-array
Pincode
Transaction date [DD-MM-YYYY]
Amount Paid for the document
Remaining amount to be paid for the document
Reference Text
Notes for the document
Terms and Conditions
List of items in the document
Unique id for each item. If a new id is sent, a new Item with the below details will be automatically created. if existing Item id is sent the details will not override the original item details. They will be applicable only to the current documents. Use update item to actually update the item details in swipe
Name of the Product
Quantity
Price per item without Tax
Tax percentage for each item . Only valid tax rates are accepted
Price per item with Tax
Net Amount
Item total amount (Net Amount + Tax). We calculate the discount amount by multiplying the item's quantity, unit price, and discount percentage. If a discount amount is provided instead, we reverse-calculate the percentage. If no discount is given, it is set to 0.
Discount Percent
Discount Amount, will be ignored if discount_percent is provided
Item Description
HSN Code. HSN Code can only be of length 4,6 & 8
Product or Service enum
Product, Service item quantity unit
OTH, kg, g, l, ml, m, cm, sqm, sqcm, sqft, sqkm, unit Category
Is the invoice created from subscriptions
Net amount of the transaction
Hash id for the document
Payment status of the document
paid, pending, cancelled List of payments recorded for this document
Payment Amount
Payment method, use only specified values
cash, card, upi, netBanking, cheque, emi Any internal notes for payment
Bank Details, refer Bank Details Object below for parameters, If account_number, ifsc matched with existing bank details, it will be used, else new bank details will be added to your swipe account
Account Number
IFSC Code
Bank Name
Branch
Tax amount of the transaction
Total amount of the transaction
Discount given on this document