Get a PDF template by ID

GET

/document_templates/:document_template_id

Path parameters

document_template_idstringRequired

Headers

Auth

AuthorizationstringRequired

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

x-monite-versionstringRequired

x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Response

Successful Response

idstring

document_typeenum

is_defaultboolean

languagestring

namestring

templatestring

created_atdatetimeOptional

updated_atdatetimeOptional

blockslist of stringsOptional

previewobjectOptional

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

template_type"block" or "source_object"Optional

Allowed values: blocksource_object

Errors

GET

1 curl https://api.sandbox.monite.com/v1/document_templates/document_template_id \
2      -H "x-monite-version: 2023-09-01" \
3      -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4      -H "Authorization: Bearer <token>"

1 {
2   "id": "id",
3   "document_type": "quote",
4   "is_default": true,
5   "language": "language",
6   "name": "name",
7   "template": "template",
8   "created_at": "2024-01-15T09:30:00Z",
9   "updated_at": "2024-01-15T09:30:00Z",
10   "blocks": [
11     "blocks"
12   ],
13   "preview": {
14     "id": "id",
15     "created_at": "2024-01-15T09:30:00Z",
16     "file_type": "payables",
17     "md5": "31d1a2dd1ad3dfc39be849d70a68dac0",
18     "mimetype": "application/pdf",
19     "name": "invoice.pdf",
20     "region": "eu-central-1",
21     "size": 24381,
22     "url": "https://bucketname.s3.amazonaws.com/12345/67890.pdf",
23     "pages": [
24       {
25         "id": "id",
26         "mimetype": "image/png",
27         "number": 0,
28         "size": 21972,
29         "url": "https://bucket.s3.amazonaws.com/123/456.png"
30       }
31     ],
32     "previews": [
33       {
34         "height": 400,
35         "url": "https://bucketname.s3.amazonaws.com/1/2/3.png",
36         "width": 200
37       }
38     ]
39   },
40   "template_type": "block"
41 }

Set the default PDF template

Up Next

1	curl https://api.sandbox.monite.com/v1/document_templates/document_template_id \
2	-H "x-monite-version: 2023-09-01" \
3	-H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4	-H "Authorization: Bearer <token>"

1	{
2	"id": "id",
3	"document_type": "quote",
4	"is_default": true,
5	"language": "language",
6	"name": "name",
7	"template": "template",
8	"created_at": "2024-01-15T09:30:00Z",
9	"updated_at": "2024-01-15T09:30:00Z",
10	"blocks": [
11	"blocks"
12	],
13	"preview": {
14	"id": "id",
15	"created_at": "2024-01-15T09:30:00Z",
16	"file_type": "payables",
17	"md5": "31d1a2dd1ad3dfc39be849d70a68dac0",
18	"mimetype": "application/pdf",
19	"name": "invoice.pdf",
20	"region": "eu-central-1",
21	"size": 24381,
22	"url": "https://bucketname.s3.amazonaws.com/12345/67890.pdf",
23	"pages": [
24	{
25	"id": "id",
26	"mimetype": "image/png",
27	"number": 0,
28	"size": 21972,
29	"url": "https://bucket.s3.amazonaws.com/123/456.png"
30	}
31	],
32	"previews": [
33	{
34	"height": 400,
35	"url": "https://bucketname.s3.amazonaws.com/1/2/3.png",
36	"width": 200
37	}
38	]
39	},
40	"template_type": "block"
41	}