Client Ledger Listing - GET API
Client Ledger Listing - GET API Endpoint
Tenant Ledger Listing API
This endpoint retrieves a list of tenant ledger transactions. Each transaction provides details about invoice, receipt voucher, credit note and payment voucher associated with a specific tenant (i.e., client).
GET
/v1/transaction/ledger/list
Request Content Type
application/json
Response Content Type
application/json
Request Header
-
Authorization: X-API-Key string required
X-API-Key is a string of letters and numbers used to authenticate and control access to the API. It can be generated in the StoRegister management application. -
Authorization: X-Token string required
X-Token represents the user session token. It is a string of characters that uniquely identifies the user's session.
Response Payload:
-
succeeded boolean
Indicates whether the request to retrieve ledger information was successful. -
status string
Describes the status of the request to retrieve ledger information. -
data object
Array containing ledger information upon a successful request. -
pagination object
Details about pagination, including current page number, total number of pages, and overall count of items. -
errors array
Holds any error information if applicable.
Transaction Details:
Details about the ledger transaction.
array: data
-
id string
Unique identifier for the ledger transaction. -
ledgerIndex integer
Index of the transaction in the ledger. -
transactId string
Transaction ID associated with the ledger entry. -
transactDate string
Date of the transaction. -
transactionType object
Type of transaction (e.g., Payment, Credit Note, Receipt, Rental Invoice). -
rentalTransactId string
Transaction ID associated with rental transactions. -
referenceBookInfoId string
Reference book information ID. -
referenceBookInfoTransactId string
Transaction ID associated with reference book information. -
payment object
Details about the payment (amount and formatted amount). -
receipt object
Details about the receipt (amount and formatted amount). -
balance object
Details about the balance (amount and formatted amount). -
taxablePrice object
Taxable amount (amount and formatted amount) if the transaction category is an invoice or credit note. -
nonTaxablePrice object
Non-taxable amount (amount and formatted amount) if the transaction category is an invoice or credit note. -
taxAmount object
Tax amount (amount and formatted amount) if the transaction category is an invoice or credit note. -
netAmount object
Net amount (amount and formatted amount) if the transaction category is an invoice or credit note. -
grossAmount object
Gross amount (amount and formatted amount) if the transaction category is an invoice or credit note. -
transactionStatus object
Status of the transaction (e.g., Paid, Unpaid) if the transaction category is an invoice or credit note. -
reverseTxnStatus object
Status of the reversed transaction. -
transactionAssetsInfoId unique-identifier
Transaction assets information ID, which is used to download the PDF document of the corresponding transaction.
Request Header
Authorization: X-API-Key --api-key-- Authorization: X-Token --user-session-token--
API Response
{
"data": [
{
"id": "65f25c72-fd44-498b-b846-4bfd48eabc03",
"ledgerIndex": 5,
"transactId": "CPY4",
"transactDate": "09-02-2024",
"transactionType": {
"id": "PAYMENT",
"name": "Payment"
},
"rentalTransactId": null,
"referenceBookInfoId": "37b8130e-f041-4a13-91f3-321a4955dc03",
"referenceBookInfoTransactId": "CCN2",
"payment": {
"price": 41.660,
"formattedPrice": "41,66 €"
},
"receipt": {
"price": 0.000,
"formattedPrice": "0,00 €"
},
"balance": {
"price": 0.000,
"formattedPrice": "0,00 €"
},
"taxablePrice": {
"price": 0,
"formattedPrice": "0,00 €"
},
"nonTaxablePrice": {
"price": 0,
"formattedPrice": "0,00 €"
},
"taxAmount": {
"price": 0,
"formattedPrice": "0,00 €"
},
"netAmount": {
"price": 0,
"formattedPrice": "0,00 €"
},
"grossAmount": {
"price": 0,
"formattedPrice": "0,00 €"
},
"transactionStatus": {
"id": null,
"name": null
},
"reverseTxnStatus": {
"id": null,
"name": null
},
"transactionAssetsInfoId": "cb60c997-4f36-41f7-8960-cf6d74fd87b7"
},
{
"id": "06340356-49f2-448b-91c0-47596856823b",
"ledgerIndex": 4,
"transactId": "CCN2",
"transactDate": "09-02-2024",
"transactionType": {
"id": "CREDIT_NOTE",
"name": "Credit Note"
},
"rentalTransactId": "CSC50",
"referenceBookInfoId": "37b8130e-f041-4a13-91f3-321a4955dc03",
"referenceBookInfoTransactId": "CCN2",
"payment": {
"price": 0.000,
"formattedPrice": "0,00 €"
},
"receipt": {
"price": 41.660,
"formattedPrice": "41,66 €"
},
"balance": {
"price": 41.660,
"formattedPrice": "41,66 €"
},
"taxablePrice": {
"price": 25.000,
"formattedPrice": "25,00 €"
},
"nonTaxablePrice": {
"price": 11.660,
"formattedPrice": "11,66 €"
},
"taxAmount": {
"price": 5.000,
"formattedPrice": "5,00 €"
},
"netAmount": {
"price": 30.000,
"formattedPrice": "30,00 €"
},
"grossAmount": {
"price": 41.660,
"formattedPrice": "41,66 €"
},
"transactionStatus": {
"id": "OFFLINEPAY",
"name": "Paid by Offline Payment"
},
"reverseTxnStatus": {
"id": null,
"name": null
},
"transactionAssetsInfoId": "7ea09d56-a59c-4098-adb3-be4ebec543c4"
},
{
"id": "d721485e-cd39-48bb-aca8-47d2939956fe",
"ledgerIndex": 3,
"transactId": "CRV40",
"transactDate": "08-02-2024",
"transactionType": {
"id": "RECEIPT",
"name": "Receipt"
},
"rentalTransactId": null,
"referenceBookInfoId": "a0cdf382-7fe1-4bf4-bd3c-e067fde4cf20",
"referenceBookInfoTransactId": "CIN57",
"payment": {
"price": 0.000,
"formattedPrice": "0,00 €"
},
"receipt": {
"price": 41.660,
"formattedPrice": "41,66 €"
},
"balance": {
"price": 0.000,
"formattedPrice": "0,00 €"
},
"taxablePrice": {
"price": 0,
"formattedPrice": "0,00 €"
},
"nonTaxablePrice": {
"price": 0,
"formattedPrice": "0,00 €"
},
"taxAmount": {
"price": 0,
"formattedPrice": "0,00 €"
},
"netAmount": {
"price": 0,
"formattedPrice": "0,00 €"
},
"grossAmount": {
"price": 0,
"formattedPrice": "0,00 €"
},
"transactionStatus": {
"id": null,
"name": null
},
"reverseTxnStatus": {
"id": null,
"name": null
},
"transactionAssetsInfoId": "64d9a319-b2c7-4570-b36d-5af0b9163bd5"
},
{
"id": "d1249877-f10e-4240-91a4-f2768cd700bf",
"ledgerIndex": 2,
"transactId": "CIN57",
"transactDate": "08-02-2024",
"transactionType": {
"id": "RENTAL_INVOICE",
"name": "Rental Invoice"
},
"rentalTransactId": "CSC50",
"referenceBookInfoId": "a0cdf382-7fe1-4bf4-bd3c-e067fde4cf20",
"referenceBookInfoTransactId": "CIN57",
"payment": {
"price": 41.660,
"formattedPrice": "41,66 €"
},
"receipt": {
"price": 0.000,
"formattedPrice": "0,00 €"
},
"balance": {
"price": -41.660,
"formattedPrice": "41,66 €"
},
"taxablePrice": {
"price": 25.000,
"formattedPrice": "25,00 €"
},
"nonTaxablePrice": {
"price": 11.660,
"formattedPrice": "11,66 €"
},
"taxAmount": {
"price": 5.000,
"formattedPrice": "5,00 €"
},
"netAmount": {
"price": 30.000,
"formattedPrice": "30,00 €"
},
"grossAmount": {
"price": 41.660,
"formattedPrice": "41,66 €"
},
"transactionStatus": {
"id": "OFFLINEPAY",
"name": "Paid by Offline Payment"
},
"reverseTxnStatus": {
"id": "INVOICE",
"name": "Invoice"
},
"transactionAssetsInfoId": "feb06942-f37c-42ff-b4cf-4386c655a2b9"
}
],
"pagination": {
"pageNumber": 1,
"pageCount": 4,
"totalCount": 4
},
"succeeded": true,
"status": "SUCCESS",
"errors": null
}Error Codes
-
INVALID_PARAM_CONTACT_BOOK_ID
INVALID_PARAM_CONTACT_BOOK_ID refers to invalid Contact Id, please find Contact Book Id. -
INVALID_PARAM_BUSINESS_INFO_ID
INVALID_PARAM_BUSINESS_INFO_ID refers to invalid Buisness Id, something went wrong. -
NO_RECORDS_FOUND
NO_RECORDS_FOUND means there is no relevant information found. -
FAILED
FAILED refers to an unsuccessful API call. -
SOMETHING_WENT_WRONG
SOMETHING_WENT_WRONG refers to technical glitch. Please contact administrator.