This endpoint makes an HTTP GET request to retrieve a list of all sale transactions within a specified date range and filter criteria. It allows users to fetch transaction records for a specific financial year and filter by ledger ID and payment status.
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-transactions?start_date=01-04-2023&end_date=31-03-2024&party_id=1&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 is a unique identifier for each sale transaction, used for tracking and referencing specific transactions in the system.
party_name
stringÂ
required
Represents the name of the customer or business involved in the transaction.
phone_no
string  | nullÂ
required
Stores the contact number of the party associated with the transaction.
party_id
integerÂ
required
A unique identifier assigned to the party (customer) within the system.
invoice_number
stringÂ
required
A unique number is assigned to the sale invoice.
date
stringÂ
required
Indicates the date on which the sale transaction was recorded.
invoice_amount
numberÂ
required
Represents the total amount of the sale transaction, reflecting the value of goods or services sold. This amount includes all applicable charges and taxes.
payment_status
stringÂ
required
Defines the current status of the payment for the sale transaction. It indicates whether the payment is "Unpaid," "Paid," or "Partially Paid," helping in financial reconciliation.
transaction_type
stringÂ
required
Specifies the name of the transaction.
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.