Skip to main content
GET
/
v2
/
doc
/
list
List of documents
curl --request GET \
  --url https://app.getswipe.in/api/partner/v2/doc/list \
  --header 'Authorization: Bearer <token>'
{
  "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": "[email protected]",
          "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

​
Authorization
string
header
required

Bearer authentication header of the form Bearer , where is your auth token.

Query Parameters

​
document_type
enum<string>
default:invoice
required
Available options:
invoice,
purchase,
pro_forma_invoice,
estimate,
sales_return,
purchase_return,
delivery_challan,
purchase_order
​
start_date
string
default:01-01-2024
required

Start date for the list, [DD-MM-YYY]

​
end_date
string
default:31-12-2024
required

End date for the list, [DD-MM-YYY]

​
payment_status
enum<string>
default:all

Filter list based on payment status of the document.

Available options:
all,
pending,
paid,
cancelled
​
num_records
string
default:10

Number of records to fetch max(100)

​
page
integer
default:1

Page number

​
customer_id
string

Customer ID

Response

Documents List fetched successfully

​
success
boolean

Success flag

Example:

true

​
message
string

Message

Example:

"Details Fetched"

​
error_code
string

Error code

Example:

""

​
errors
object

Error details

​
data
object