Get payment ledger

curl --request GET \
  --url https://app.getswipe.in/api/partner/v2/customer/ledger \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "message": "",
  "error_code": "",
  "errors": {},
  "data": {
    "closing_balance": -16795.8,
    "is_paid": 1,
    "total_records": 10,
    "ledger": [
      {
        "amount_pending": 0,
        "balance": -16795.8,
        "notes": "",
        "created_time": "2024-06-13T10:08:13.000Z",
        "mode": "UPI",
        "date": "13-06-2024",
        "status": "Success",
        "serial_number": "PAYIN-2",
        "total_amount": 100
      }
    ]
  }
}

GET

customer

ledger

Get payment ledger

curl --request GET \
  --url https://app.getswipe.in/api/partner/v2/customer/ledger \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "message": "",
  "error_code": "",
  "errors": {},
  "data": {
    "closing_balance": -16795.8,
    "is_paid": 1,
    "total_records": 10,
    "ledger": [
      {
        "amount_pending": 0,
        "balance": -16795.8,
        "notes": "",
        "created_time": "2024-06-13T10:08:13.000Z",
        "mode": "UPI",
        "date": "13-06-2024",
        "status": "Success",
        "serial_number": "PAYIN-2",
        "total_amount": 100
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

start_date

string

default:01-01-2024

required

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

end_date

string

default:31-12-2024

required

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

customer_id

string

required

Customer ID

num_records

integer

default:10

Number of records to fetch

page

integer

default:1

Page number

Response

Payment details fetched successfully

success

boolean

Success flag

Example:

true

message

string

Response message

Example:

""

error_code

string

Error Code

Example:

""

errors

object

Errors

data

object

Show child attributes

data.closing_balance

number

Balance as of this record

Example:

-16795.8

data.is_paid

integer

Paid

Example:

1

data.total_records

integer

Number of records

Example:

10

data.ledger

object[]

Show child attributes

data.ledger.amount_pending

number

Amount pending

Example:

0

data.ledger.balance

number

Balance as of this record

Example:

-16795.8

data.ledger.notes

string

Notes

Example:

""

data.ledger.created_time

string

Created Time of the Payment [YYYY-MM-DD HH:MM:SS] GMT

Example:

"2024-06-13T10:08:13.000Z"

data.ledger.mode

string

Payment Mode

Example:

"UPI"

data.ledger.date

string

Payment Date

Example:

"13-06-2024"

data.ledger.status

string

Payment Status

Example:

"Success"

data.ledger.serial_number

string

Serial Number

Example:

"PAYIN-2"

data.ledger.total_amount

number

Total Amount

Example:

100

Delete a customer Get list of customers

⌘I

Get Started

Document V2

Payment V2

EwayBill

Customer V2

Vendor V2

Product V2

Inventory V2

Subscriptions V2

Utility V2

Get payment ledger

Authorizations

Query Parameters

Response