Tenant Transaction API - Developer Guide
StoRegister API Documentation
Tenant Transaction API
Discover and utilize crucial API endpoints designed for effective management of tenant transactions. These endpoints deliver comprehensive information on various aspects, including ledger entries, invoices, credit notes, receipts, payment vouchers, and related processes. Accessing these APIs empowers users to efficiently handle and track financial transactions within the tenant ecosystem.
Tenant Ledger Listing
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).
Explore endpointsTenant Invoice Listing
This endpoint retrieves a list of tenant invoices, providing detailed information about each invoice transaction. It includes essential details such as invoice ID, transaction date, transaction type, rental information, amount details (gross, paid, and balance amounts), reverse transaction status, and transaction assets information.
Explore endpointsTenant Credit Note Listing
This endpoint retrieves a list of tenant credit notes, providing detailed information about each credit note transaction. It includes essential details such as invoice ID, transaction date, transaction type, rental information, amount details (gross, paid, and balance amounts), reverse transaction status, and transaction assets information.
Explore endpointsTenant Receipt Voucher Listing
This endpoint retrieves a list of receipts associated with the logged-in tenant. It provides details about rental transactions, including payment information, transaction ID, and related assets.
Explore endpointsTenant Payment Voucher Listing
This endpoint retrieves a list of payment vouchers associated with the logged-in tenant. It provides details about rental transactions, including payment information, transaction ID, and related assets.
Explore endpointsUnpaid Invoice Payment Intent Request Generation API
This endpoint generates a payment intent request for unpaid invoice using invoice ID and facilitates seamless integration with various payment gateways based on the invoice ID. It returns the payment intent along with UI-related keys for loading the respective payment gateway (e.g., Stripe, Lyra, Brain Tree). The response includes comprehensive details for setting up the payment gateway form, incorporating necessary UI integration elements. These details encompass client information, business specifics of the storage center, and property information associated with the invoice. In the case of multiple payment gateway options configured for the specific property, the endpoint returns the one associated with the property's default payment gateway. The property data.paymentGateway will return the key of the payment gateway, and based on this key, information will exist in the response payload.
Explore endpointsStripe Payment Confirmation and Generate Receipt for Un-paid Invoice
This endpoint validates a successful payment intent ID from the Stripe payment gateway and initiates the creation of a receipt voucher for the requested un-paid invoice. The API returns the receipt ID upon successful completion of the payment log and receipt voucher generation process.
Explore endpointsLyra Payment Confirmation and Generate Receipt for Un-paid Invoice
This endpoint validates a successful POST request with content type
'application/x-www-form-urlencoded' received from the Lyra payment gateway after a
successful payment redirection. It expects the same POST data
(formData["kr-answer"]) and initiates the creation of a receipt voucher for
the requested un-paid invoice. The API returns the receipt ID upon successful completion
of the payment log and receipt voucher generation process.
BrainTree Payment Confirmation and Generate Receipt for Un-paid Invoice
This endpoint receives the nonce from the BrainTree UI after a successful card save process. The API processes the nonce and charges the card for the requested un-paid invoice. The API returns the receipt ID upon successful completion of the payment log and receipt voucher generation process.
Explore endpoints