Create Document

post https://api.next-tech.com/v1/document/

Body Params

data

string | null

Base64 encoded document data. NOTE: Requires that the field filename is also used. Cannot be used with url.

description

string | null

Description/comment/notes

diaryid

integer | null

Diary (if any) this document belongs to

documenttypeid

integer | null

Document type

enlargeinreports

boolean

Defaults to false

Show larger than normal in reports

filename

string | null

Name of file. NOTE: Required if 'data' is provided.

hideonmobile

boolean

Defaults to true

Hide document in lists on mobile devices.

includeinreport

boolean

Defaults to false

Include in report

includeonoffer

boolean

Defaults to false

Include on offer

lastmodified

date-time | null

When the content of the document was last changed

projectid

integer

required

The Id of the associated project

showinportal

boolean

Defaults to false

Show in portal

title

string | null

Name of document. NOTE: Default value is filename without file extension.

url

string | null

URL to document. NOTE: Cannot be used with data.

workorderid

integer | null

Workorder this document belongs to

Responses

Response body

object

integer

required

Id of record, used as primary key when looking up items using the API

changed

date-time

required

Timestamp of the last time the object was modified

changedname

string | null

Full name of the user who last changed this document

changeduserid

integer

required

The Id of the user that last made changes to the object

created

date-time

required

Timestamp of when the object was first created

createdname

string | null

Full name of the user that created this document

createduserid

integer

required

The Id of the user that first created the object

addition

boolean

required

If this document is attached to an additional work order

description

string | null

Description/comment/notes

diaryid

integer | null

Diary (if any) this document belongs to

documenttypeid

integer | null

Document type

documenttypename

string | null

Type of document

enlargeinreports

boolean

Defaults to false

Show larger than normal in reports

filename

string | null

Name of file. Used when downloading

generatedtime

date-time | null

When the document was filled with auto generated content

hideonmobile

boolean

Defaults to false

Hide document in lists on mobile devices.

imageheight

integer | null

Image height in pixels (if image, otherwise should be null)

imagewidth

integer | null

Image width in pixels (if image, otherwise should be null)

includeinreport

boolean

Defaults to true

Include in report

includeonoffer

boolean

Defaults to false

Include on offer

lastmodified

date-time | null

When the content of the document was last changed

mimetype

string

required

length ≤ 255

MIME type of document.

name

string | null

filename if filename is not null, otherwise title

projectid

integer

required

The Id of the associated project

projectno

string

required

length ≤ 10

The project number of the associated project

showinportal

boolean

Defaults to false

Show in portal

size

integer

required

Size of document in bytes

title

string | null

Name of document. NOTE: Default value is filename without file extension.

uploaded

date

required

When this document was uploaded

url

string | null

URL to document. NOTE: Cannot be used with data.

workorderid

integer | null

Workorder this document belongs to

workorderno

integer | null

The work order number of the associated work order

Language

Credentials

OAuth2

URL


xxxxxxxxxx
13
1
curl --request POST \
2
     --url https://api.next-tech.com/v1/document/ \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "enlargeinreports": false,
8
  "hideonmobile": true,
9
  "includeinreport": false,
10
  "includeonoffer": false,
11
  "showinportal": false
12
}
13
'


xxxxxxxxxx
34
}
1
{
2
  "id": 5,
3
  "changed": "2025-04-11T14:46:28.282Z",
4
  "changedname": "Adam Admin",
5
  "changeduserid": 7,
6
  "created": "2025-04-11T14:46:28.282Z",
7
  "createdname": "Adam Admin",
8
  "createduserid": 3,
9
  "addition": false,
10
  "description": "Important information",
11
  "diaryid": 2,
12
  "documenttypeid": 2,
13
  "documenttypename": "Construction act",
14
  "enlargeinreports": false,
15
  "filename": "building_codes.pdf",
16
  "generatedtime": "2022-02-02 14:00:40",
17
  "hideonmobile": true,
18
  "imageheight": 480,
19
  "imagewidth": 640,
20
  "includeinreport": false,
21
  "includeonoffer": true,
22
  "lastmodified": "2022-02-02 14:00:40",
23
  "mimetype": "application/pdf",
24
  "name": "Test.pdf",
25
  "projectid": 2000,

200Successful Response

422Validation Error