Get a document
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
Amount Paid for the document
Remaining amount to be paid for the document
Transaction date [DD-MM-YYYY]
Transaction date [DD-MM-YYYY]
Hash id for the document
Is the invoice created from subscriptions
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
Product or Service enum
Product, Service Name of the Product
Net Amount
Price per item with Tax
Quantity
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.
Price per item without Tax
Category
Item Description
Discount Amount, will be ignored if discount_percent is provided
Discount Percent
HSN Code. HSN Code can only be of length 4,6 & 8
Tax percentage for each item . Only valid tax rates are accepted
Item quantity unit. You can find the GST-approved units in the UQC Codes section at: https://einvoice1.gst.gov.in/Others/MasterCodes.
Net amount of the transaction
Notes for the document
Party Details for the document
Unique id for each party.
Name of the 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 Party billing to Address, refer Shipping Address Object for parameters
Address ID. Value should be n >= 0 and n <= 999999, It will automatically update the existing address if the address ID already exists.
Address Line 1
Address Line 2
City
Country. You can copy the country details from https://developers.getswipe.in/api-reference/references#country-array
Pincode
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 Company Name
Party Phone Number Country code
Party Email
GSTIN
Party Phone Number
Party shipping to Address, refer Shipping Address Object for parameters
Address ID. Value should be n >= 0 and n <= 999999, It will automatically update the existing address if the address ID already exists.
Address Line 1
Address Line 2
City
Country. You can copy the country details from https://developers.getswipe.in/api-reference/references#country-array
Pincode
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 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 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. It will link document payments to your company bank details.
Account Number
Bank Name
Branch
IFSC Code
Any internal notes for payment
Reference Text
Invoice number assigned to document
Tax amount of the transaction
Terms and Conditions
Total amount of the transaction
Discount given on this document
Error code
Error details
Message
Success flag