List of documents
curl --request GET \
--url https://app.getswipe.in/api/partner/v2/doc/list \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.getswipe.in/api/partner/v2/doc/list"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.getswipe.in/api/partner/v2/doc/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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"
},
"payment_date": "14-02-2024"
}
],
"tax_amount": 18,
"total_amount": 118,
"total_discount": 100
}
],
"total_records": 10
}
}{
"success": true,
"message": "Message",
"error_code": "",
"errors": {},
"data": {}
}{
"success": true,
"message": "Message",
"error_code": "",
"errors": {},
"data": {}
}{
"success": true,
"message": "Message",
"error_code": "",
"errors": {},
"data": {}
}Documents
List of documents
Lists documents of one document_type within a required date range. Filter by payment_status to track pending, partially paid, or fully paid documents.
GET
/
v2
/
doc
/
list
List of documents
curl --request GET \
--url https://app.getswipe.in/api/partner/v2/doc/list \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.getswipe.in/api/partner/v2/doc/list"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.getswipe.in/api/partner/v2/doc/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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"
},
"payment_date": "14-02-2024"
}
],
"tax_amount": 18,
"total_amount": 118,
"total_discount": 100
}
],
"total_records": 10
}
}{
"success": true,
"message": "Message",
"error_code": "",
"errors": {},
"data": {}
}{
"success": true,
"message": "Message",
"error_code": "",
"errors": {},
"data": {}
}{
"success": true,
"message": "Message",
"error_code": "",
"errors": {},
"data": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is an API key from the API Integration section of your dashboard. Keys are scoped to the company they are generated in — for testing, add a separate test company and generate the key there, so requests never touch your real books.
Query Parameters
Available options:
invoice, purchase, pro_forma_invoice, estimate, sales_return, purchase_return, delivery_challan, purchase_order Start date for the list, [DD-MM-YYYY]
End date for the list, [DD-MM-YYYY]
Filter list based on payment status of the document.
Available options:
all, pending, paid, cancelled Number of records to fetch max(100)
Page number
Customer ID

