Upload an entity logo

PUT

/entities/:entity_id/logo

Entity logo can be PNG, JPG, or GIF, up to 10 MB in size. The logo is used, for example, in PDF documents created by this entity.

Path parameters

entity_idstringRequired

A unique ID to specify the entity.

Headers

Auth

AuthorizationstringRequired

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

x-monite-versionstringRequired

Request

This endpoint expects a multipart form containing a file.

filefileRequired

Response

Successful Response

idstring

A unique ID of this file.

created_atdatetime

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

file_typestring

The type of the business object associated with this file.

namestring

The original file name (if available).

regionstring

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

md5string

The MD5 hash of the file.

mimetypestring

The file’s media type.

urlstring

The URL to download the file.

sizeinteger>=0

The file size in bytes.

previewslist of objectsOptional

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

pageslist of objectsOptional

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

Errors

PUT

1 curl -X PUT https://api.sandbox.monite.com/v1/entities/ea837e28-509b-4b6a-a600-d54b6aa0b1f5/logo \
2      -H "x-monite-version: 2024-01-31" \
3      -H "Authorization: Bearer <token>" \
4      -H "Content-Type: multipart/form-data" \
5      -F file=@<file1>

1 {
2   "id": "id",
3   "created_at": "2024-01-15T09:30:00Z",
4   "file_type": "payables",
5   "name": "invoice.pdf",
6   "region": "eu-central-1",
7   "md5": "31d1a2dd1ad3dfc39be849d70a68dac0",
8   "mimetype": "application/pdf",
9   "url": "https://bucketname.s3.amazonaws.com/12345/67890.pdf",
10   "size": 24381,
11   "previews": [
12     {
13       "url": "https://bucketname.s3.amazonaws.com/1/2/3.png",
14       "width": 200,
15       "height": 400
16     }
17   ],
18   "pages": [
19     {
20       "id": "id",
21       "mimetype": "image/png",
22       "size": 21972,
23       "number": 0,
24       "url": "https://bucket.s3.amazonaws.com/123/456.png"
25     }
26   ]
27 }

Delete an entity's logo

Up Next

1	curl -X PUT https://api.sandbox.monite.com/v1/entities/ea837e28-509b-4b6a-a600-d54b6aa0b1f5/logo \
2	-H "x-monite-version: 2024-01-31" \
3	-H "Authorization: Bearer <token>" \
4	-H "Content-Type: multipart/form-data" \
5	-F file=@<file1>

1	{
2	"id": "id",
3	"created_at": "2024-01-15T09:30:00Z",
4	"file_type": "payables",
5	"name": "invoice.pdf",
6	"region": "eu-central-1",
7	"md5": "31d1a2dd1ad3dfc39be849d70a68dac0",
8	"mimetype": "application/pdf",
9	"url": "https://bucketname.s3.amazonaws.com/12345/67890.pdf",
10	"size": 24381,
11	"previews": [
12	{
13	"url": "https://bucketname.s3.amazonaws.com/1/2/3.png",
14	"width": 200,
15	"height": 400
16	}
17	],
18	"pages": [
19	{
20	"id": "id",
21	"mimetype": "image/png",
22	"size": 21972,
23	"number": 0,
24	"url": "https://bucket.s3.amazonaws.com/123/456.png"
25	}
26	]
27	}