HisabKitab
  1. Payment Transaction
HisabKitab
  • Third Party APIs
    • How to Generate ApiKey ?
    • Account Master
      • Ledger Groups
        • List of All Groups
        • Create Group
        • Create Batch Groups
        • Edit Group
        • Update Group
        • Delete Group
      • Ledgers
        • Create Ledger
          • Customer Ledger
          • Supplier Ledger
          • Bank Ledger
          • Capital Ledger
          • Cash Ledger
          • Income Ledger
          • Expense Ledger
          • Fixed Asset Ledger
          • Investment Ledger
          • Loan and Advance (Asset) Ledger
          • Misc Assets Ledger
          • Other Current Assets Ledger
          • Taxes - GST Ledger
          • Taxes - TDS Ledger
          • Taxes - TCS Ledger
          • Provisions Ledger
          • Reserve and Surplus Ledger
          • Secured Loan Ledger
          • Unsecured Loan Ledger
          • Stock In Hand Ledger
          • Other Current Liabilities Ledger
          • TDS Receivable Ledger
          • TCS Receivable Ledger
        • Ledger Detail
        • List of all Ledgers
        • Edit Ledger
        • Update Ledger
        • Delete Ledger
        • Delete Ledger Media
        • Add Location(Fixed Asset )
        • Check Unique GST Number
        • Check Unique GST Number with Ledger
        • Holding & Profit Ratio
        • Ledger TDS tax Data
        • Ledger TCS tax Data
    • Item Master
      • Item Groups
        • List of all groups
        • Create Group
        • Create Batch Groups
        • Edit Group
        • Update Group
        • Delete Group
      • Items
        • Item Form Details
        • List of items
        • Create Good Item
        • Create Service Item
        • Edit Item
        • Update Item
        • Delete Item
      • Unit of Measurement
        • List of Unit of Measurement
        • Create Unit of Measurement
        • Edit Unit of Measurement
        • Update Unit of Measurement
        • Delete Unit of Measurement
    • Broker Master
      • List of Brokers
      • Create Broker
      • Edit Broker
      • Update Broker
      • Delete Broker
    • Transport Master
      • List of Transport
      • Create Transport
      • Edit Transport
      • Update Transport
      • Delete Transport
    • Cess Rate
      • List of Cess Rate
      • Create Cess Rate
      • Edit Cess Rate
      • Update Cess Rate
      • Delete Cess Rate
    • Dispatch Address
      • List of Dispatch Address
      • Create Dispatch Address
      • Edit Dispatch Address
      • Update Dispatch Address
      • Delete Dispatch Address
    • Shipping Address
      • List of Shipping Addresses
      • Create Shipping Address
      • Edit Shipping Address
      • Update Shipping Address
      • Delete Shipping Address
    • Comman APIs
      • Company Details
      • Countries
      • States
      • Cities
      • Gst Rates
      • Classification-nature-type
    • Configuration
      • Sale
        • Sale Configuration
        • Update Configuration
        • Update Configuration with Type
      • Sale Return
        • Sale Return Configuration
        • Update Configuration
        • Update Configuration with Type
      • Income Debit Note
        • Debit Note Configuration
        • Update Configuration
        • Update Configuration with Type
      • Income Credit Note
        • Credit Note Configuration
        • Update Configuration
        • Update Configuration with Type
      • Estimate Quote
        • Estimate Configuration
        • Update Configuration with Type
        • Update Configuration
      • Delivery Challan
        • Delivery Challan Configuration
        • Update Configuration
        • Update Configuration with Type
      • Purchase
        • Purchase Configuration
        • Update Configuration
        • Update Configuration with Type
      • Purchase Return
        • Purchase Return Configuration
        • Update Configuration
        • Update Configuration with Type
      • Expense Credit Note
        • Expense Credit Note Configuration
        • Update Configuration
        • Update Configuration with Type
      • Expense Debit Note
        • Expense Debit Note Configuration
        • Update Configuration
        • Update Configuration with Type
      • Purchase Order
        • Purchase Order Configuration
        • Update Configuration
        • Update Configuration with Type
    • Sale Transactions
      • List of Transactions
      • Next Invoice Number
      • Create Item Sale
      • Create Accounting Sale
      • Edit Sale
      • Update Sale
      • Duplicate Sale
      • Delete Sale
      • Get Sale For Sale Return
      • Create Challan From Sale Invoice
    • Sale Return Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Sale Return
      • Create Accounting Sale Return
      • Edit Sale Return
      • Update Sale Return
      • Duplicate Sale Return
      • Delete Sale Return
    • Income Debit Note Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Debit Note
      • Create Accounting Debit Note
      • Edit Debit Note
      • Update Debit Note
      • Duplicate Debit Note
      • Delete Debit Note
    • Income Credit Note Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Credit Note
      • Create Accounting Credit Note
      • Edit Credit Note
      • Update Credit Note
      • Duplicate Credit Note
      • Delete Credit Note
    • Estimate Quote Transaction
      • List of Transactions
      • Next Estimate Number
      • Create Item Estimate
      • Create Accounting Estimate
      • Edit Estimate
      • Update Estimate
      • Duplicate Estimate
      • Create Sale From Estimate
      • Delete Estimate
    • Delivery Challan Transaction
      • List of Transactions
      • Next Challan Number
      • Create Delivery Challan
      • Edit Delivery Challan
      • Update Delivery Challan
      • Duplicate Delivery Challan
      • Create Sale From Delivery Challan
      • Delete Delivery Challan
    • Purchase Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Purchase
      • Create Accounting Purchase
      • Edit purchase
      • Update purchase
      • Duplicate purchase
      • Get purchase For purchase Return
      • Delete purchase
    • Purchase Return Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Purchase Return
      • Create Accounting Purchase Return
      • Edit purchase Return
      • Update purchase Return
      • Duplicate purchase Return
      • Delete purchase Return
    • Expense Credit Note Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Expense Credit Note
      • Create Accounting Expense Credit Note
      • Edit Expense Credit Note
      • Update Expense Credit Note
      • Duplicate Expense Credit Note
      • Delete Expense Credit Note
    • Expense Debit Note Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Expense Debit Note
      • Create Accounting Expense Debit Note
      • Edit Expense Debit Note
      • Update Expense Debit Note
      • Duplicate Expense Debit Note
      • Delete Expense Debit Note
    • Purchase Order Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Purchase Order
      • Create Accounting Purchase Order
      • Edit purchase Order
      • Update Purchase Order
      • Duplicate purchase Order
      • Delete purchase Order
      • Book Purchase Order
    • Receipt Transaction
      • List of Receipts
      • Next invoice number
      • Create Receipt
      • Edit Receipt
      • Update Receipt
      • Delete Receipt
    • Payment Transaction
      • List of Payments
        GET
      • Next invoice number
        GET
      • Create Payment
        POST
      • Edit Payment
        GET
      • Update Payment
        POST
      • Delete Payment
        DELETE
    • Journal Transaction
      • List of Journals
      • Next invoice number
      • Create Journal
      • Edit Journal
      • Update Journal
      • Delete Journal
  1. Payment Transaction

List of Payments

GET
https://app.hisabkitab.co/third-party/payment-transactions
The List of Payments API allows users to retrieve payment transaction records, helping businesses track outgoing payments efficiently. Payments refer to financial transactions where funds are transferred to suppliers, vendors, or service providers in exchange for goods or services. These transactions can be processed through various methods, including cash, bank transfers, checks, or digital payment platforms.

Request#

The request is a GET method and does not require a request body. Instead, it supports the query parameters for filtering.

Response#

The response includes a list of payment transactions along with relevant details such as transaction ID, payment date, party name, payment amount, payment mode, and other information related to payment. Additionally, a success flag and a message confirm successful retrieval.

Request

Authorization
Add parameter in header
ApiKey
Example:
ApiKey: ********************
Query Params
start_date
string 
required
The start date of the financial year (DD-MM-YYYY).
Example:
01-04-2024
end_date
string 
required
The end date of the financial year (DD-MM-YYYY).
Example:
31-03-2025
skip
integer 
optional
The skip query parameter determines how many records to skip from the start, e.g., skip=10 ignores the first 10 records and fetches the rest.
Example:
0
limit
integer 
optional
The limit specifies the number of records to retrieve, e.g., limit=20 returns 20 records.
Example:
20

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://app.hisabkitab.co/third-party/payment-transactions?start_date=01-04-2024&end_date=31-03-2025&skip=0&limit=20' \
--header 'ApiKey;'

Responses

🟢200List of Payment
application/json
Body
data
array [object {18}] 
required
Contain a list of payment transactions.
id
integer 
required
A unique identifier for the payment transaction.
voucher_number
string 
required
The reference number assigned to the payment transaction, often formatted with a prefix to indicate the type of transaction (e.g., "sale/25128").
date
string 
required
The date when the payment transaction was recorded.
bank_cash_ledger
string 
required
The bank or cash ledger from which the payment was made.
ledger
string 
required
The name of the party (vendor or service provider) involved in the transaction.
paid_amount
number 
required
The total amount paid in the transaction.
narration
string  | null 
required
An optional field that stores additional notes or descriptions related to the transaction.
payment_mode
string 
required
Indicates how the payment was received, such as Cash, Bank Transfer, Cheque, or Digital Payment.
reference_number
string 
required
Stores a reference number for transactions involving bank transfers, UPI, or cheques.
media
string 
required
Stores file attachments or supporting documents linked to the transaction, such as invoices or receipts.
phone
string 
required
Stores the phone number of the party associated with the payment.
phone_no
string  | null 
required
An alternate field for the phone number.
is_locked
boolean 
required
A boolean flag that determines if the transaction is locked, preventing further modifications. If false, the transaction can still be edited.
is_default_created_by_transaction
boolean 
required
A flag that indicates whether this payment was auto-generated as part of another transaction, such as a sale or purchase.
transaction_type
string  | null 
required
Defines the type of transaction linked to the payment, such as "Sale," "Purchase," etc.
transaction_id
integer  | null 
required
The unique identifier of the linked transaction, helping to track and reference related financial records.
created_by
string 
required
The name of the user who recorded the payment transaction.
created_at
string 
required
The date and time when the payment transaction was added to the system.
success
boolean 
required
message
string 
required
Example
{
    "data": [
        {
            "id": 1,
            "voucher_number": "expense-credit-note/3",
            "date": "07-10-2024",
            "bank_cash_ledger": "bank test",
            "ledger": "Armaan Shah",
            "paid_amount": 14511,
            "narration": null,
            "payment_mode": "Cash",
            "reference_number": "",
            "phone": "",
            "phone_no": null,
            "media": "",
            "is_locked": false,
            "is_default_created_by_transaction": true,
            "transaction_type": "Expense Credit Note",
            "transaction_id": 3,
            "created_by": "Santosh malani ",
            "created_at": "07-10-2024 05:13 PM"
        },
        {
            "id": 4,
            "voucher_number": "sale-return/2023-246",
            "date": "01-05-2024",
            "bank_cash_ledger": "Cash",
            "ledger": "Bhairav Impex",
            "paid_amount": 10,
            "narration": null,
            "payment_mode": "Cash",
            "reference_number": "",
            "phone": "",
            "phone_no": null,
            "media": "",
            "is_locked": false,
            "is_default_created_by_transaction": true,
            "transaction_type": "Sale Return",
            "transaction_id": 2,
            "created_by": "Santosh malani ",
            "created_at": "01-05-2024 03:42 PM"
        }
    ],
    "success": true,
    "message": "Payment Transactions retrieved successfully."
}
Modified at 2025-04-03 10:23:14
Previous
Delete Receipt
Next
Next invoice number
Built with