HisabKitab
  1. Sale Return 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
        GET
      • Next Invoice Number
        GET
      • Create Item Sale Return
        POST
      • Create Accounting Sale Return
        POST
      • Edit Sale Return
        GET
      • Update Sale Return
        POST
      • Duplicate Sale Return
        GET
      • Delete Sale Return
        DELETE
    • 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
      • Next invoice number
      • Create Payment
      • Edit Payment
      • Update Payment
      • Delete Payment
    • Journal Transaction
      • List of Journals
      • Next invoice number
      • Create Journal
      • Edit Journal
      • Update Journal
      • Delete Journal
  1. Sale Return Transaction

List of Transactions

GET
https://app.hisabkitab.co/third-party/sale-return-transactions
This endpoint allows users to retrieve a list of sale return transactions, filtered by a specified date range and additional criteria. It enables users to fetch records for a particular financial year, and apply filters such as ledger ID and payment status to narrow down the results.

Request#

The GET request must include query parameters to filter sale return transactions based on the provided criteria.

Response#

The API will return a list of sale return transactions that meet the filter conditions, including detailed information for each transaction.

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-2023
end_date
string 
required
The end date of the financial year (DD-MM-YYYY).
Example:
31-03-2024
party_id
integer 
optional
The unique identifier (ID) of the party used to filter transactions by party.
Example:
2
status
integer 
optional
Payment status filter: Paid = 1, Unpaid = 2, Partially Unpaid = 3.
Example:
1
limit
integer 
optional
The limit specifies the number of records to retrieve, e.g., limit=25 returns 25 records.
Example:
25
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:
10

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/sale-return-transactions?start_date=01-04-2023&end_date=31-03-2024&party_id=2&status=1&limit=25&skip=10' \
--header 'ApiKey;'

Responses

🟢200List of Transactions
application/json
Body
data
array [object {9}] 
required
transaction_id
integer 
required
This field represents a unique numerical identifier assigned to each sale return transaction.
party_name
string 
required
This denotes the name of the customer or business entity that is involved in the sale return transaction.
party_id
integer 
required
This is a unique numeric identifier assigned to each party (customer or business entity).
phone_no
string 
required
This field contains the contact number of the party associated with the sale return.
invoice_number
string 
required
This represents the reference number of the original sales invoice for which the goods are being returned.
invoice_amount
number 
required
This field indicates the total monetary value of the sale return transaction.
payment_status
string 
required
This field is meant to capture the status of the payment associated with the sale return.
transaction_type
string 
required
This field defines the nature of the transaction.
date
string 
required
This represents the date on which the sale return transaction was recorded.
success
boolean 
required
This field indicates whether the API request was successfully processed.
message
string 
required
Provides a descriptive response from the API regarding the request's outcome.
Example
{
    "data": [
        {
            "transaction_id": 1,
            "party_name": "Red Entertainment Private Limited",
            "party_id": 1,
            "phone_no": "919033280608",
            "invoice_number": "8",
            "invoice_amount": 106199,
            "payment_status": "",
            "transaction_type": "Sale Return",
            "date": "21-08-2023"
        },        
        {
            "transaction_id": 2,
            "party_name": "Om Textiles",
            "party_id": 2,
            "phone_no": "917575834813",
            "invoice_number": "3",
            "invoice_amount": 50105,
            "payment_status": "",
            "transaction_type": "Sale Return",
            "date": "19-06-2023"
        }        
    ],
    "success": true,
    "message": "Sale Return Transaction retrieved successfully."
}
Modified at 2025-04-03 10:04:22
Previous
Create Challan From Sale Invoice
Next
Next Invoice Number
Built with