Tenant Invoice Listing - GET

Tenant Invoice Listing - GET API Endpoint
StoRegister - Login

Tenant Invoice Listing API

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.

GET
/v1/transaction/invoice/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 invoice information was successful.

  • status string

    Describes the status of the request to retrieve invoice information.

  • data object

    Array containing invoice information upon a successful request.

  • pagination object

    Details about pagination, including the current page number, total number of pages, and overall count of items.

  • errors array

    Holds any error information if applicable.

Invoice Listing Details:

Details about the invoice listings.

array: data

  • id string

    Unique identifier for the invoice transaction.

  • transactDate string

    Date of the transaction.

  • transactId string

    Transaction ID associated with the invoice entry.

  • transactionType string

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

  • transactionTypeValue string

    Value associated with the transaction type.

  • rentalInfoId string

    Identifier for the associated rental information.

  • rentalInfoTransactId string

    Transaction ID associated with rental transactions.

  • grossAmount object

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

  • paidAmount object

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

  • balanceAmount object

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

  • reverseTxnStatus string

    Status of the reversed transaction.

  • reverseTxnStatusValue string

    Value associated with the reverse transaction status.

  • 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": "a0cdf382-7fe1-4bf4-bd3c-e067fde4cf20",
            "transactDate": "08-02-2024",
            "transactId": "CIN57",
            "transactionType": "RENTAL",
            "transactionTypeValue": "Rental",
            "rentalInfoId": "00000000-0000-0000-0000-000000000000",
            "rentalInfoTransactId": null,
            "grossAmount": {
                "price": 41.660,
                "formattedPrice": "41,66 €"
            },
            "paidAmount": {
                "price": 41.660,
                "formattedPrice": "41,66 €"
            },
            "balanceAmount": {
                "price": 0.000,
                "formattedPrice": "0,00 €"
            },
            "reverseTxnStatus": null,
            "reverseTxnStatusValue": null,
            "transactionAssetsInfoId": "feb06942-f37c-42ff-b4cf-4386c655a2b9"
        },
        // ... (Additional invoice information)
    ],
    "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