Add Additionalworkorder

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

Body Params

activitycode

string | null

The type of activity this record is associated with. Used with budget and forecast.

closed

boolean

Defaults to false

True if the workorder is locked and cannot be modified.

constructiontypeid

integer

required

The id of a Construction Type for the Workorder. Can be retrieved from constructiontypestore

costregulationtypeid

integer | null

Id of CostRegulationType.

customercontactid

integer | null

Can be used to look up details about the customer contact from the customercontact endpoint

customerid

integer

required

Can be used to look up details about the customer from the customer endpoint

description

string | null

Description of the workorder. What the job entails.

hidemarkup

boolean

Defaults to false

Indicates if markup should be shown on printed AdditionalWorkOrder

locationcode

string | null

The specific location this record is associated with. Used with budget and forecast.

markupmodelid

integer | null

Id of MarkupModel used on AdditionalWorkOrder.

name

string

required

length ≤ 100

Workorder Name

orderamount

number | null

Ordered amount / Budget amount. Used for Budget revenue in prognosis

orderdate

date | null

The date when the workorder was ordered

pricetypeid

integer

required

The id of a Price Type for the Workorder. Can be retrieved from pricetypestore

projectid

integer

required

Can be used to look up details about the customer contact from the project endpoint

reportsign

string | null

The signature of whom reported this workorder back to the office

reporttime

date-time | null

The time when this workorder was reported back to the office

statusid

integer | null

Defaults to 1

Can be used to look up more details about the status from the workorderstatus endpoint. Default value is '1' (Corresponds to status code '10' in most databases.).

updateprices

boolean

If an update to a workorder changes FrameWorkContractId, this field can be set to True to trigger a recalculation of all prices on the workorders rows.

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

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

createduserid

integer

required

The Id of the user that first created the object

activitycode

string | null

The type of activity this record is associated with. Used with budget and forecast.

additionalworkorderno

string

required

length ≤ 20

Sequence number of AdditionalWorkOrder in relation to parent project.

approvalcomment

string | null

Comment made by Portal user when deciding to approve or disapprove AdditionalWorkOrder.

approvaltimestamp

date-time | null

Date and time of approval/disapproval made by Portal user.

approvedbycustomer

boolean

Defaults to false

Indicates if AdditionalWorkOrder is approved by portal user

approvedbycustomerid

integer | null

Internal id of the portal user that approved/disapproved additionalworkorder

bookedcosttotal

number | null

Sum of InvoiceAmount on costs connected to this workorder

bookedhourstotal

number | null

The number of hours worked against this workorder

bookedrevenuetotal

number | null

Sum of InvoiceAmount on revenues connected to this workorder

closed

boolean

Defaults to false

True if the workorder is locked and cannot be modified.

constructiontypeid

integer | null

The id of a Construction Type for the Workorder. Can be retrieved from constructiontypestore

constructiontypename

string | null

Type of work

contributionmargin

number | null

bookedrevenuetotal - bookedcosttotal

contributionmarginpercent

number | null

100 * (bookedrevenuetotal - bookedcosttotal) / bookedrevenuetotal

costregulationtypeid

integer | null

Id of CostRegulationType.

costregulationtypename

string | null

Name of CostRegulationType.

createdname

string | null

Name of user that created this workorder.

creditrisk

boolean

Defaults to false

Indicates if customer is creditworthy. False if creditworthy.

customercontactid

integer | null

Can be used to look up details about the customer contact from the customercontact endpoint

customercontactname

string | null

Name of customer contact.

customerid

integer | null

Can be used to look up details about the customer from the customer endpoint

customername

string | null

Name of customer.

customertypename

string | null

Name of customer type.

description

string | null

Description of the workorder. What the job entails.

deviationref

string | null

Contains comma separated list of DeviationNo if AdditionalWorkOrder is related to one or more Deviations.

earnedrevenue

number | null

Sum of InvoiceAmount + MarkupAmount on chargeable costs connected to this workorder

fullyinvoiced

boolean

Defaults to false

True if all workorder rows, costs and hours for this workorder been invoiced

hasdocument

boolean

Defaults to false

Indicates if workorder has document(s), true if workorder has one or more documents.

hidemarkup

boolean

Defaults to false

Indicates if markup should be shown on printed AdditionalWorkOrder

latestinvoicedate

date | null

Date of the most recent invoice for the workorder.

locationcode

string | null

The specific location this record is associated with. Used with budget and forecast.

markupmodelcode

string | null

The number that users see as a representation of the code, not the same as markupmodelid.

markupmodelid

integer | null

Id of MarkupModel used on AdditionalWorkOrder.

markuptotal

number | null

Total markup is the sum of markup of all additionalworkorderrows.

name

string

required

length ≤ 100

Workorder Name

orderamount

number | null

Ordered amount / Budget amount. Used for Budget revenue in prognosis

orderdate

date | null

The date when the workorder was ordered

pricetypeid

integer | null

The id of a Price Type for the Workorder. Can be retrieved from pricetypestore

pricetypename

string | null

Name of workorder PriceType.

projectid

integer

required

Can be used to look up details about the customer contact from the project endpoint

projectname

string | null

The name of the Project

projectnumber

string

required

length ≤ 10

Project number this workorder is related to.

reportsign

string | null

The signature of whom reported this workorder back to the office

reporttime

date-time | null

The time when this workorder was reported back to the office

statuscode

integer | null

The number that users see as a representation of the code, not the same as additionstatusid.

statusid

integer | null

Defaults to 1

Can be used to look up more details about the status from the workorderstatus endpoint. Default value is '1' (Corresponds to status code '10' in most databases.).

tendertotal

number | null

Total tender is the sum of markup and price of all rows of additionalworkorder.

tendertotalwork

number | null

Total tender is the sum of markup and price of all rows coded as work of additionalworkorder.

totalearnednotinvoiced

number | null

Sum of TotalPrice + markup on un-invoiced WorkOrderRow

vattotal

number | null

Total markup is the sum of vat of all rows of additionalworkorder.

Language

Credentials

OAuth2

URL


xxxxxxxxxx
11
1
curl --request POST \
2
     --url https://api.next-tech.com/v1/additionalworkorder/ \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "closed": false,
8
  "hidemarkup": false,
9
  "statusid": 1
10
}
11
'


xxxxxxxxxx
57
}
1
{
2
  "id": 5,
3
  "changed": "2025-04-11T13:56:45.893Z",
4
  "changeduserid": 7,
5
  "created": "2025-04-11T13:56:45.893Z",
6
  "createduserid": 3,
7
  "activitycode": "3",
8
  "additionalworkorderno": "Ä002",
9
  "approvalcomment": "Denied because it should be included in the original offer.",
10
  "approvaltimestamp": "2017-05-03 07:53:37",
11
  "approvedbycustomer": false,
12
  "approvedbycustomerid": 3,
13
  "bookedcosttotal": "11050.75",
14
  "bookedhourstotal": "48",
15
  "bookedrevenuetotal": "9999.9",
16
  "closed": false,
17
  "constructiontypeid": 7,
18
  "constructiontypename": "Plumbing",
19
  "contributionmargin": 135000.75,
20
  "contributionmarginpercent": 37.5,
21
  "costregulationtypeid": 3,
22
  "costregulationtypename": "Yes, subcontractor",
23
  "createdname": "John Doe",
24
  "creditrisk": false,
25
  "customercontactid": 78,

200Successful Response

422Validation Error