# Upload Booking Document

<mark style="color:green;">`POST`</mark> `[PlatformAddress]/api/1.0/venue?action=uploadBookingDocument`

Uploads a venue booking document.

### Booking Document

| Property       | Type    | Required | Description                                                                                                                         |
| -------------- | ------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| venueId        | integer | required | The id of the venue to which the booking note belongs                                                                               |
| bookingId      | integer | required | The id of the booking to which the booking note will be assigned.                                                                   |
| fileId         | string  | required | The path of the file to be uploaded                                                                                                 |
| type           | integer | required | The [type](#booking-document-type) of the booking note.                                                                             |
| status         | integer | required | The [type](#booking-document-status) of the booking note.                                                                           |
| canBeDeleted   | integer | optional | Indicates whether the document can be deleted. Use 1 for deletable and 0 for non-deletable. By default, the document can be deleted |
| documentNumber | integer | optional | The document number of an existing document to reference when creating a new version of the document.                               |

### Example Request

```sh
#!/usr/bin/env bash

# Configuration variables
API_KEY="apikey"
API_SECRET="apkisecret"
API_VERSION="1.0"
URI_PATH="/api/1.0/venue?action=uploadBookingDocument"
API_URL="[PlatformAddress]${URI_PATH}"

# Get the current date in the required format (UTC timezone)
DATE=$(date -u +"%Y-%m-%d %H:%M:%S")

# Create request data (JSON format)
REQUEST_DATA="{\"venueId\":\"1\",\"bookingId\":\"29836\",\"type\":\"3\",\"status\":\"3\",\"canBeDeleted\":\"1\",\"documentNumber\":\"123\"}"
PATH_TO_FILE="/path/to/document.pdf"

# Compute the MD5 hash of the request data
BODY_MD5=$(echo -n "$REQUEST_DATA" | md5sum | awk '{print $1}')

# Compute the md5 checksum of the file
FILE_MD5=$(md5sum "$PATH_TO_FILE" | awk '{print $1}')

# Set the content-type including the boundary
CONTENT_TYPE="multipart/form-data"

# Prepare the string to sign
STRING_TO_SIGN="POST${BODY_MD5}${FILE_MD5}${CONTENT_TYPE}${URI_PATH}${API_VERSION}ivvydate=${DATE}"
# Convert to lower case
STRING_TO_SIGN="${STRING_TO_SIGN,,}"

# Generate the HMAC signature using the secret key
SIGNATURE=$(echo -n "$STRING_TO_SIGN" | openssl dgst -sha1 -hmac "$API_SECRET" | awk '{print $2}')

# Perform the API call using curl
curl --location "$API_URL" \
  --header "Content-Type: ${CONTENT_TYPE}" \
  --header "X-Api-Authorization: IWS ${API_KEY}:${SIGNATURE}" \
  --header "Content-MD5: ${FILE_MD5}" \
  --header "IVVY-Date: ${DATE}" \
  --header "X-Api-Version: ${API_VERSION}" \
  --form "fileId=@${PATH_TO_FILE}" \
  --form "venueId=1" \
  --form "bookingId=29836" \
  --form "type=3" \
  --form "status=3" \
  --form "canBeDeleted=1" \
  --form "documentNumber=123" \
```

### Returns

| Property       | Description                                                              |
| -------------- | ------------------------------------------------------------------------ |
| success        | Whether or not the booking document was uploaded                         |
| id             | The unique id of the booking document that was uploaded                  |
| documentNumber | The booking document number that was generated for the uploaded document |
| version        | The version of the documentNumber                                        |

### Throws

| Code                 | Description                       |
| -------------------- | --------------------------------- |
| Specific Code: 24464 | The request contains bad data     |
| Specific Code: 24465 | The request contains invalid data |

### Booking Document Type

| Type | Description |
| ---- | ----------- |
| 3    | Quote       |
| 4    | Contract    |
| 5    | Other       |

### Booking Document Status

| Type | Description |
| ---- | ----------- |
| 3    | Draft       |
| 4    | Created     |
| 5    | Sent        |
| 8    | Completed   |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developer.ivvy.com/venues/getoraddbookingdata/upload-booking-document.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.