HisabKitab
  1. Purchase 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
      • 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
        GET
      • Next Invoice Number
        GET
      • Create Item Purchase Return
        POST
      • Create Accounting Purchase Return
        POST
      • Edit purchase Return
        GET
      • Update purchase Return
        POST
      • Duplicate purchase Return
        GET
      • Delete purchase Return
        DELETE
    • 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. Purchase Return Transaction

List of Transactions

GET
https://app.hisabkitab.co/third-party/purchase-return-transactions
This API retrieves a list of purchase return transactions based on specified query parameters and supports various query parameters for filtering and pagination. The start_date and end_date define the financial year range for transactions. The party_id allows filtering by a specific party, while the status parameter helps retrieve transactions based on payment status (Paid, Unpaid, or Partially Unpaid). The limit parameter controls the number of records returned, and skip determines how many records to ignore before fetching results, ensuring efficient data retrieval.

Request#

The API uses a GET request to fetch purchase return transaction data. Since it does not require a request body, users can simply call the endpoint to retrieve the necessary information.

Response#

The API returns a response containing transaction details such as transaction ID, party name, invoice number, invoice amount, payment status, transaction type, and date. Additionally, it includes a success flag and a message confirming successful retrieval of the purchase return transactions.

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
party_id
integer 
optional
The unique identifier (ID) of the party used to filter transactions by party.
Example:
1
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:
0

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

Responses

🟢200List of Transactions
application/json
Body
data
array [object {9}] 
required
Contain a list of purchase return transactions.
transaction_id
integer 
required
A unique identifier is assigned to each transaction.
party_name
string 
required
The name of the party or vendor involved in the transaction. This represents the seller or supplier from whom the purchase return is made.
party_id
integer 
required
A unique numerical identifier assigned to the party, which helps in managing and retrieving vendor details efficiently within the system.
phone_no
string  | null 
required
The contact number of the party involved in the transaction. If no phone number is available, this field remains null.
invoice_number
string 
required
A unique number assigned to the purchase return invoice.
invoice_amount
integer 
required
The total monetary value of the invoice, indicating the amount payable for the purchased goods or services.
payment_status
string 
required
Specifies whether the payment for the transaction is completed or pending, such as Paid = 1, Unpaid = 2, Partially Unpaid = 3.
transaction_type
string 
required
Defines the nature of the transaction, which is a "Purchase Return".
date
string 
required
The date when the transaction took place, formatted as "DD-MM-YYYY.
success
boolean 
required
message
string 
required
Example
{
    "data": [
        {
            "transaction_id": 1,
            "party_name": "Ahana Dress Show Room",
            "party_id": 2,
            "phone_no": null,
            "invoice_number": "3",
            "invoice_amount": 112100,
            "payment_status": "Unpaid",
            "transaction_type": "Purchase Return",
            "date": "19-09-2024"
        },
        {
            "transaction_id": 2,
            "party_name": "Anil tax",
            "party_id": 3,
            "phone_no": "919668566765",
            "invoice_number": "1",
            "invoice_amount": 1000,
            "payment_status": "",
            "transaction_type": "Purchase Return",
            "date": "10-05-2024"
        }
    ],
    "success": true,
    "message": "Purchase Return transactions retrieved successfully."
}
Modified at 2025-04-03 10:08:21
Previous
Delete purchase
Next
Next Invoice Number
Built with