Generate Pre-filled Contract Document by Booking ID API

Generate Pre-filled Contract Document by Booking ID API Endpoint
StoRegister - Login

Generate Pre-filled Contract Document by Booking ID API

This endpoint generates a pre-filled contract document based on the provided booking activity ID. The generated document includes comprehensive information such as client details, property information, storage box details, payment terms, and other relevant information. The PDF document is created for viewing purposes and can be accessed through the provided URLs.

GET
/v1/booking/{bookingId}/document/prefilled
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.

URL Query Parameters:

  • bookingId string required

    bookingId refers to an activity ID of the specific booking.

Response Payload:

  • succeeded boolean

    Indicates whether the request to generate the pre-filled contract document was successful. It is a boolean value where true denotes success, and false indicates failure.

  • status string

    Describes the status of the request to generate the pre-filled contract document. It is a string providing additional information about the status.

  • data object | null

    Upon success, this property contains detailed information about the pre-filled contract document for the booking. If the operation is not successful, the value is null.

  • errors array

    Holds error information if applicable. It is an array containing error details in case there are issues with generating the pre-filled contract document.

object: data

  • documentList unique-identifier

    An array containing details of pre-filled documents associated with the booking activity.

array: documentList

  • key string

    The key representing the type of document (e.g., "LEASE", "TERMS", "INSURANCE", etc.,).

  • value object

    Details about the document, including its name and remote URL for loading or downloading it from the web.

Request Header

Authorization: X-API-Key --api-key--

API Response

{
    "data": [
        {
            "key": "LEASE",
            "value": {
                "name": "Lease agreement",
                "url": "https://..."
            }
        },
        {
            "key": "TERMS",
            "value": {
                "name": "Terms and Conditions",
                "url": "https://..."
            }
        }
    ],
    "pagination": {
        "pageNumber": 1,
        "pageCount": 2,
        "totalCount": 2
    },
    "succeeded": true,
    "status": "SUCCESS",
    "errors": null
}

Error Codes

  • INVALID_PARAM_ACTIVITY_INFO_ID

    INVALID_PARAM_ACTIVITY_INFO_ID refers to invalid activity ID.

  • INVALID_ACTIVITY_INFO_DETAILS

    INVALID_ACTIVITY_INFO_DETAILS refers to unable to retreive the activity details.

  • INVALID_DOCUMENT_TYPE_RESPONSE

    INVALID_DOCUMENT_TYPE_RESPONSE refers to invalid document type.

  • INVALID_CLIENT_INFO_DETAILS

    INVALID_CLIENT_INFO_DETAILS refers to invalid client details.

  • 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