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
  }
}

GET

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

Show child attributes

data.transactions

object[]

List of transactions

Show child attributes

data.transactions.serial_number

string

Invoice number assigned to document

Example:

"INV-12"

data.transactions.document_date

string

Transaction date [DD-MM-YYYY]

Example:

"11-06-2024"

data.transactions.customer

object

Customer Details for the document

Show child attributes

data.transactions.customer.id

string

required

Unique id for each party.

Example:

"CUST123"

data.transactions.customer.name

string

required

Name of the Party

Example:

"John Doe"

data.transactions.customer.country_code

string

Party Phone Number Country code

Example:

"91"

data.transactions.customer.phone_number

string

Party Phone Number

Example:

"1234567890"

data.transactions.customer.company_name

string

Company Name

Example:

"Company Name"

data.transactions.customer.email

string

Party Email

Example:

"[email protected]"

data.transactions.customer.gstin

string

GSTIN

Example:

"27AARCS7202C1ZD"

data.transactions.due_date

string

Transaction date [DD-MM-YYYY]

Example:

"11-06-2024"

data.transactions.amount_paid

number

Amount Paid for the document

Example:

28

data.transactions.amount_pending

number

Remaining amount to be paid for the document

Example:

90

data.transactions.reference

string

Reference Text

data.transactions.notes

string

Notes for the document

data.transactions.terms

string

Terms and Conditions

data.transactions.is_created_by_recurring

integer

Is the invoice created from subscriptions

Example:

0

data.transactions.net_amount

number

Net amount of the transaction

Example:

100

data.transactions.hash_id

string

Hash id for the document

data.transactions.payment_status

enum<string>

Payment status of the document

Available options:

paid,

pending,

cancelled

Example:

"paid"

data.transactions.payments

object[]

List of payments recorded for this document

Show child attributes

data.transactions.payments.amount

number

required

Payment Amount

Example:

100

data.transactions.payments.method

enum<string>

required

Payment method, use only specified values

Available options:

cash,

card,

upi,

netBanking,

cheque,

emi

Example:

"upi"

data.transactions.payments.notes

string

Any internal notes for payment

Example:

"Payment notes"

data.transactions.payments.bank_details

object

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.

Show child attributes

data.transactions.payments.bank_details.account_number

string

required

Account Number

Example:

"1234567890"

data.transactions.payments.bank_details.ifsc

string

required

IFSC Code

Example:

"SBIN0000001"

data.transactions.payments.bank_details.bank_name

string

required

Bank Name

Example:

"State Bank of India"

data.transactions.payments.bank_details.branch

string

required

Branch

Example:

"Mumbai"

data.transactions.tax_amount

number

Tax amount of the transaction

Example:

18

data.transactions.total_amount

number

Total amount of the transaction

Example:

118

data.transactions.total_discount

number

Discount given on this document

Example:

100

data.total_records

integer

Total number of records

Example:

10

Cancel a document Record payment

⌘I

Get Started

Document V2

Payment V2

EwayBill

Customer V2

Vendor V2

Product V2

Inventory V2

Subscriptions V2

Utility V2

List of documents

Authorizations

Query Parameters

Response