Get Started
Document V2
Payment V2
Customer V2
Vendor V2
Product V2
Subscriptions V2
Utility V2
List of documents
curl --request GET \
--url https://app.getswipe.in/api/partner/v2/doc/list \
--header 'Authorization: <api-key>'{
"success": true,
"message": "Details Fetched",
"error_code": "",
"errors": {},
"data": {
"transactions": [
{
"serial_number": "INV-12",
"document_date": "11-06-2024",
"customer": {
"id": "CUST123",
"name": "John Doe",
"country_code": "91",
"phone_number": "1234567890",
"company_name": "Company Name",
"email": "johndoe@example.com",
"gstin": "27AARCS7202C1ZD"
},
"due_date": "11-06-2024",
"amount_paid": 28,
"amount_pending": 90,
"reference": "<string>",
"notes": "<string>",
"terms": "<string>",
"is_created_by_recurring": 0,
"net_amount": 100,
"hash_id": "<string>",
"payment_status": "paid",
"payments": [
{
"amount": 100,
"method": "upi",
"notes": "Payment notes",
"bank_details": {
"account_number": "1234567890",
"ifsc": "SBIN0000001",
"bank_name": "State Bank of India",
"branch": "Mumbai"
}
}
],
"tax_amount": 18,
"total_amount": 118,
"total_discount": 100
}
],
"total_records": 10
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
invoice, purchase, pro_forma_invoice, estimate, sales_return, purchase_return, delivery_challan, purchase_order Start date for the list, [DD-MM-YYY]
End date for the list, [DD-MM-YYY]
Filter list based on payment status of the document.
all, pending, paid, cancelled Number of records to fetch max(100)
Page number
Customer ID
Response
Success flag
true
Message
"Details Fetched"
Error code
""
Error details
List of transactions
Invoice number assigned to document
"INV-12"
Transaction date [DD-MM-YYYY]
"11-06-2024"
Customer Details for the document
Unique id for each party.
"CUST123"
Name of the Party
"John Doe"
Party Phone Number Country code
"91"
Party Phone Number
"1234567890"
Company Name
"Company Name"
Party Email
"johndoe@example.com"
GSTIN
"27AARCS7202C1ZD"
Transaction date [DD-MM-YYYY]
"11-06-2024"
Amount Paid for the document
28
Remaining amount to be paid for the document
90
Reference Text
Notes for the document
Terms and Conditions
Is the invoice created from subscriptions
0
Net amount of the transaction
100
Hash id for the document
Payment status of the document
paid, pending, cancelled "paid"
List of payments recorded for this document
Payment Amount
100
Payment method, use only specified values
cash, card, upi, netBanking, cheque, emi "upi"
Any internal notes for payment
"Payment notes"
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
"1234567890"
IFSC Code
"SBIN0000001"
Bank Name
"State Bank of India"
Branch
"Mumbai"
Tax amount of the transaction
18
Total amount of the transaction
118
Discount given on this document
100
Total number of records
10
curl --request GET \
--url https://app.getswipe.in/api/partner/v2/doc/list \
--header 'Authorization: <api-key>'{
"success": true,
"message": "Details Fetched",
"error_code": "",
"errors": {},
"data": {
"transactions": [
{
"serial_number": "INV-12",
"document_date": "11-06-2024",
"customer": {
"id": "CUST123",
"name": "John Doe",
"country_code": "91",
"phone_number": "1234567890",
"company_name": "Company Name",
"email": "johndoe@example.com",
"gstin": "27AARCS7202C1ZD"
},
"due_date": "11-06-2024",
"amount_paid": 28,
"amount_pending": 90,
"reference": "<string>",
"notes": "<string>",
"terms": "<string>",
"is_created_by_recurring": 0,
"net_amount": 100,
"hash_id": "<string>",
"payment_status": "paid",
"payments": [
{
"amount": 100,
"method": "upi",
"notes": "Payment notes",
"bank_details": {
"account_number": "1234567890",
"ifsc": "SBIN0000001",
"bank_name": "State Bank of India",
"branch": "Mumbai"
}
}
],
"tax_amount": 18,
"total_amount": 118,
"total_discount": 100
}
],
"total_records": 10
}
}