Tenant Credit Note Listing - GET

Tenant Credit Note Listing - GET API Endpoint
StoRegister - Login

Tenant Credit Note Listing API

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.

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

  • status string

    Describes the status of the request to retrieve creditnote information.

  • data object

    Array containing creditnote 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.

Creditnote Details

Details about the Creditnote for login user.

array data

  • id unique-identifier

    Unique identifier for the credit note transaction.

  • transactDate string

    Date of the credit note transaction.

  • transactId string

    Transaction ID associated with the credit note entry.

  • transactionType string

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

  • transactionTypeValue string

    Human-readable value corresponding to the transaction type.

  • rentalInfoId string

    ID associated with rental information for the credit note.

  • rentalInfoTransactId string

    Transaction ID associated with rental information for the credit note.

  • grossAmount object

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

  • paidAmount object

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

  • balanceAmount object

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

  • reverseTxnStatus object

    Status of the reversed transaction.

  • reverseTxnStatusValue string

    Human-readable value corresponding to the reversed transaction status.

  • transactionAssetsInfoId unique-identifier

    Transaction assets information ID used to download the PDF document of the corresponding credit note.

Request Header

Authorization: X-API-Key --api-key--
Authorization: X-Token --user-session-token--

API Response

{
    "data": [
        {
            "id": "37b8130e-f041-4a13-91f3-321a4955dc03",
            "transactDate": "09-02-2024",
            "transactId": "CCN2",
            "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": "7ea09d56-a59c-4098-adb3-be4ebec543c4"
        },
        // ... (Additional credit note 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