Skip to main content
PUT
/
entities
/
{entity_id}
/
logo
Upload an entity logo
curl --request PUT \
  --url https://api.sandbox.monite.com/v1/entities/{entity_id}/logo \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-monite-version: <x-monite-version>' \
  --form file='@example-file'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "file_type": "<string>",
  "md5": "<string>",
  "mimetype": "<string>",
  "name": "<string>",
  "region": "<string>",
  "size": 1,
  "url": "<string>",
  "pages": [],
  "previews": []
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-monite-version
string<date>
required

Path Parameters

​
entity_id
string<uuid>
required

A unique ID to specify the entity.

Example:

"ea837e28-509b-4b6a-a600-d54b6aa0b1f5"

Body

multipart/form-data
​
file
file
required

Response

Successful Response

Represents a file (such as a PDF invoice) that was uploaded to Monite.

​
id
string<uuid>
required

A unique ID of this file.

​
created_at
string<date-time>
required

UTC date and time when this file was uploaded to Monite. Timestamps follow the ISO 8601 format.

​
file_type
string
required

The type of the business object associated with this file.

Example:

"payables"

​
md5
string
required

The MD5 hash of the file.

Example:

"31d1a2dd1ad3dfc39be849d70a68dac0"

​
mimetype
string
required

The file's media type.

Example:

"application/pdf"

​
name
string
required

The original file name (if available).

Maximum string length: 512
Example:

"invoice.pdf"

​
region
string
required

Geographical region of the data center where the file is stored.

Example:

"eu-central-1"

​
size
integer
required

The file size in bytes.

Required range: x >= 0
Example:

24381

​
url
string
required

The URL to download the file.

Example:

"https://bucketname.s3.amazonaws.com/12345/67890.pdf"

​
pages
object[] | null

If the file is a PDF document, this property contains individual pages extracted from the file. Otherwise, an empty array.

​
previews
object[] | null

Preview images generated for this file. There can be multiple images with different sizes.