GEgetswipe
Document V2

List of documents

Changed on

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

Request

  • Base URL
    https://app.getswipe.in/api/partner
  • URL
    https://app.getswipe.in/api/partner/v2/doc/list
  • Auth
    HTTP bearer

Query parameters

document_type'invoice' | 'purchase' | 'pro_forma_invoice' | 'estimate' | 'sales_return' | 'purchase_return' | 'delivery_challan' | 'purchase_order' required
start_datestring required

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

end_datestring required

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

payment_status'all' | 'pending' | 'paid' | 'cancelled'

Filter list based on payment status of the document.

num_recordsstring

Number of records to fetch max(100)

pageinteger

Page number

customer_idstring

Customer ID

Response

Documents List fetched successfully

successboolean

Success flag

messagestring

Message

error_codestring

Error code

errorsobject

Error details

Example response

{
  "success": true,
  "message": "Details Fetched",
  "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,
        "net_amount": 100,
        "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
  }
}

Changes

  • 0bcdbc62187bRevision changes
    • breaking

      for the query request parameter customer_id, default value was added

    • breaking

      for the query request parameter num_records, default value was changed from 10 to 10

    • breaking

      the /// response's property type changed from object to no type for status

    • breaking

      the ///// response's property type changed from object to no type for status

    • info

      api operation id v2_get_transactions removed and replaced with get_transactions

    • info

      added the optional property ///// to the response with the status

    • info

      the response's property default value 0 was added for the status