Tenant Payment Voucher Listing - GET

Tenant Payment Voucher Listing - GET API Endpoint
StoRegister - Login

Tenant Payment Voucher Listing API

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.

GET
/v1/transaction/voucher/payment/list
Request Content Type
application/json
Response Content Type
application/json

Request Header

  • api-key string required

    api-key is a string of letters and numbers, used to authenticate and control access to an API which can be generated in StoRegister management application.

  • token string required

    token refers to wrapped user's legal information (user's credentials) that grants or denies access to the application.

Response Payload:

  • succeeded boolean

    Indicates whether the request to retrieve payment voucher information was successful.

  • status string

    Describes the status of the request to retrieve payment voucher information (e.g., "SUCCESS" or "ERROR").

  • data array

    Array containing payment voucher information.

  • 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.

Payment Voucher Details

Details about the Payment Voucher for the logged-in user.

array data

  • id unique-identifier

    Unique identifier for the payment voucher.

  • transactDate string

    Date of the payment voucher.

  • transactId string

    Transaction ID associated with the payment voucher.

  • transactionType string

    Type of transaction (e.g., RENTAL, CUSTOM, LATE FEE, etc.).

  • transactionTypeValue string

    Human-readable value of the transaction type.

  • grossAmount object

    Details about the gross amount (amount and formatted amount).

  • advanceAmount object

    Details about the advance amount (amount and formatted amount); it represents the company owes to the tenant.

  • 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 --token--

API Response

{
    "data": [
        {
            "id": "d721485e-cd39-48bb-aca8-47d2939956fe",
            "transactDate": "08-02-2024",
            "transactId": "CRV40",
            "transactionType": "RENTAL",
            "transactionTypeValue": "Rental",
            "grossAmount": {
                "price": 41.660,
                "formattedPrice": "41,66 €"
            },
            "advanceAmount": {
                "price": 0.000,
                "formattedPrice": "0,00 €"
            },
            "transactionAssetsInfoId": "64d9a319-b2c7-4570-b36d-5af0b9163bd5"
        }
    ],
    "pagination": {
        "pageNumber": 1,
        "pageCount": 1,
        "totalCount": 1
    },
    "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.
API Reference documentation