Overview

[Description].

Endpoints

The resources available in this module.

JobBudgetDetailApi

[Description]

/api/JobBudgetDetailApi
Method	Description	Performed As	Request Query	Request Body	Response
DELETE			-
GET
POST

DELETE Parameters

Parameter	Description	Parameter Type	Data Type
key		body	BudgetJobBudgetKey

GET Parameters

Parameter	Description	Parameter Type	Data Type
jobCode	Job code	query	string
estimateId		query	integer
bomQuantity	Bill of Material quantity.	query	double

POST Parameters

Parameter	Description	Parameter Type	Data Type
changedModel		body	Model

JobBudgetListApi

Returns Job Budgets by Job

/api/JobBudgetListApi
Method	Description	Performed As	Request Query	Request Body	Response
POST	Returns Job Budgets by Job

JobDetailApi -here

Retrieves a Job and Job details and…

/api/JobDetailApi
Method	Description	Performed As	Request Query	Request Body	Response
DELETE
GET	Retrieves a Job and Job details.		-
POST

JobListApi

[Description]

/url
Method	Description	Performed As	Request Query	Request Body	Response
GET			-
POST

Models

The definitions of models specific to endpoints in this module.

BudgetBudgetLine

Field	Type	Description
Approved	CellData
SequenceNo	CellData
JobCode	CellData	Code of the job.
BudgetType	CellData	Type of the budget.
Type	CellData	The cost element is being used for this line/pr Line type?
LineCode	CellData	Code of the line.
LineRef	CellData	Line reference.
PlantRate	CellData	Rates of the selected plant.
ActivityCode	CellData	Code of Activity.
ActivityType	CellData	Type of Activity.
WorkCentreCode	CellData	Code of Work Centre of the line.
YearPeriod	CellData	The financial year and period in which this budget was created.
Description	CellData	Description text.
Unit	CellData	The unit of measurement for the line.
Quantity	CellData	the quantity of units being budgeted.
CostRate	CellData	Cost rate.
Cost	CellData	the Qty multiplied by the Cost Rate fields.
Fix	Boolean	Data won’t be changed.
SellBasis	Integer	the basis on which the Selling Value will be calculated.
SellBasisValue	CellData	???
SellingRate	CellData	Sell rate
Markup	CellData	Default value will be based on the configured Markup or Sell Rate for the specific context of the line type.
FCRetailRate	CellData	the Foreign Currency Retail Rate if Foreign Currency is used.
FCRevenue	CellData	is the Qty multiplied by the FC Retail Rate field
PoNumber	CellData	Related Purchase Order number ???
Details	CellData	Explanation or comment text.
SubGridResult	GridResult_BudgetBudgetSubLine
Delete	CellData
Status	String
ReadonlyFlag	Integer
ReadonlyMessage	CellData
OriginalKey	BudgetBudgetLineKey
CurrentKey	BudgetBudgetLineKey
Key	BudgetBudgetLineKey
Index	Integer

BudgetBudgetLineKey

Field	Type	Description
ParentLine	Integer	Code of parent line ???
ChildLine	Integer	Code of child line ???
EstimateId	Integer
EstimateLineId	Integer
JobCode	String	Job code.
ActivityCode	String	Code of e Activities
WorkCentreCode	String	Code of Work Centre of the line.
Type	String
LineCode	String	ID of the line.
PriceCode	String
KeyName	String
UseRate	Boolean

BudgetJobBudgetLine

Field	Type	Description
BudgetOrder	Integer
BudgetHeader	String
BudgetType	String	Budget type
InternalReference	String	The sequence number that defines what the variation relates to. More details
ClientReference	String	To label the budget something that your external stakeholders refer to it as
Description	Description	Description text.
Year	Integer	Year
Period	Integer	Financial period
YearPeriodIndex	Integer
EstimateDate	String
CostRate	Number	Cost rate.
Cost	Number	is the Qty multiplied by the Cost Rate field.
RetailRate	Number	The total Local Currency retail rates of the underlying budget lines.
Revenue	Number	the total Local Currency revenue amount of all underlying lines that this budget contains.
Approved	Boolean
ApprovedDate	String	Approved date.
Select	CellData
BudgetTypeValue	CellData	Budget type
BudgetHeaderValue	CellData	Budger header
InternalReferenceValue	CellData	Internal reference
ClientReferenceValue	CellData	Client reference
DescriptionValue	CellData	Description text.
YearPeriodValue	CellData
EstimateDateValue	CellData
CostRateValue	CellData	Cost rate
CostValue	CellData	Cost.
RetailRateValue	CellData	Retail rate
RevenueValue	CellData	Revenue
ApprovedDateValue	CellData	Approval date.
Status	String
ReadonlyFlag	Boolean
ReadonlyMessage	String
OriginalKey	BudgetJobBudgetKey
CurrentKey	BudgetJobBudgetKey
Key	BudgetJobBudgetKey
Index	Integer

BudgetBudgetSubLine

Field	Type	Description
Approved	CellData
SequenceNo	CellData
JobCode	CellData	Code of the job.
Type	CellData	The cost element is being used for this line.
LineCode	CellData	Code of the line
LineRef	CellData	Line reference.
PlantRate	CellData	Plant Rate if applied.
ActivityCode	CellData	Activity code of the line.
ActivityType	CellData	Activity type of the line.
WorkCentreCode	CellData	Code of the Work Centre of the line
YearPeriod	CellData	The financial year and period in which this budget was created.
Description	CellData	Description text.
Unit	CellData	The unit of measurement for the line
Quantity	CellData	The quantity of units being budgeted
CostRate	CellData	Cost rate.
Cost	CellData	is the Qty multiplied by the Cost Rate field.
Fix	Boolean	Data won’t be changed.
SellingRate	CellData	Selling rate.
Markup	CellData	default value will be based on the configured Markup or Sell Rate for the specific context of the line type.
FCRetailRate	CellData	The Foreign Currency Retail Rate.
FCRevenue	CellData	is the Qty multiplied by the FC Retail Rate field.
PoNumber	CellData
Details	CellData	Explanation or comment text.
Delete	CellData
YearNo	CellData
PeriodNo	CellData	Number of financial period.
Status	String
ReadonlyFlag	Integer
ReadonlyMessage	String
OriginalKey	BudgetBudgetSubLineKey
CurrentKey	BudgetBudgetSubLineKey
Key	BudgetBudgetSubLineKey
Index	Integer

BudgetBudgetSubLineKey

Field	Type	Description
Id	Integer
ChildLine	Integer
EstimateId	Integer
EstimateLineId	Integer
JobCode	String	Code of the job.
ActivityCode	String	Activity code of the line.
WorkCentreCode	String	Code of Work Centre of the line.
Type	String
LineCode	String	Line code
PlantRate	String	Plant Rate

BudgetJobBudgetKey

Field	Type	Description
JobCode	String	Code of job.
EstimateId	Integer
BomQuantity	Number

GeneralJobKey

Field	Type	Description
JobCode	String	Code of job.

GeneralJobMainFields

Field	Type	Description

JobApiModel

Field	Type	Description
Key	GeneralJobKey
Main	GeneralJobMainFields
Attributes	JobApiFields_GeneralAttributeLine
ToDoItems	JobApiFields_GeneralToDoLine
Notes	JobApiFields_GeneralNoteLine
Reporting	JobApiReportsFields
Datasheets	JobApiFields_DatasheetsDatasheetModelLine
ValidationErrors	Array [MvcValidationError]

JobBudgetApiModel

Field	Type	Description
Key	BudgetJobBudgetKey
Rows	Array [BudgetBudgetLine]
BudgetType	PickerViewData	Type of the budget.
Job	StringViewData	Related job
Client	StringViewData	The client. Pulled from the Job Maintenance or Contract Settings
Contact	PickerViewData	Client contact who is responsible for the contract or variation.
Description	StringViewData	Description to define what the budget container represents
Details	StringViewData	Additional definition or explanation to the budget.
InternalReference	StringViewData	The sequence number that defines what the variation relates to, .More details
ClientReference	StringViewData	To label the budget something that your external stakeholders refer to it as
BudgetDate	DateViewData	The date that was entered as the creation date for this budget.
YearPeriod	StringViewData	The financial year and period in which this budget was created.
Currency	StringViewData	Defaults from the Contract Settings currency field
CurrencyRate	DecimalViewData	The manual exchange rate when dealing with foreign currency
CreatedBy	StringViewData	Created person.
Approved	StringViewData	The person who approved.
GridSort	DropdownViewData
GridStructure	DropdownViewData
BillOfMaterials	PickerViewData	Bill of Material lines with the At Cost Element and At Revenue and Cost Element Input methods.
WorkflowType	PickerViewData	The Workflow for approval purposes
ValidationErrors	Array [MvcValidationError]

Field	Type	Description

Field	Type	Description

Examples

Example of JobBudgetDetailApi DELETE

Click to view

Request

Response

Response sample

Sample of JobBudgetDetailApi GET

Click to view

Request

Response

JobBudgetApiModel {
Key (BudgetJobBudgetKey, optional),
Rows (Array[BudgetBudgetLine], optional),
BudgetType (PickerViewData, optional),
Job (StringViewData, optional),
Client (StringViewData, optional),
Contact (PickerViewData, optional),
Description (StringViewData, optional),
Details (StringViewData, optional),
InternalReference (StringViewData, optional),
ClientReference (StringViewData, optional),
BudgetDate (DateViewData, optional),
YearPeriod (StringViewData, optional),
Currency (StringViewData, optional),
CurrencyRate (DecimalViewData, optional),
CreatedBy (StringViewData, optional),
Approved (StringViewData, optional),
GridSort (DropdownViewData, optional),
GridStructure (DropdownViewData, optional),
BillOfMaterials (PickerViewData, optional),
WorkflowType (PickerViewData, optional),
ValidationErrors (Array[MvcValidationError], optional)
}
BudgetJobBudgetKey {
JobCode (string, optional),
EstimateId (integer, optional),
BomQuantity (number, optional)
}
BudgetBudgetLine {
Approved (CellData, optional),
SequenceNo (CellData, optional),
JobCode (CellData, optional),
BudgetType (CellData, optional),
Type (CellData, optional),
LineCode (CellData, optional),
LineRef (CellData, optional),
PlantRate (CellData, optional),
ActivityCode (CellData, optional),
ActivityType (CellData, optional),
WorkCentreCode (CellData, optional),
YearPeriod (CellData, optional),
Description (CellData, optional),
Unit (CellData, optional),
Quantity (CellData, optional),
CostRate (CellData, optional),
Cost (CellData, optional),
Fix (boolean, optional),
SellBasis (integer, optional),
SellBasisValue (CellData, optional),
SellingRate (CellData, optional),
Markup (CellData, optional),
FCRetailRate (CellData, optional),
FCRevenue (CellData, optional),
PoNumber (CellData, optional),
Details (CellData, optional),
SubGridResult (GridResult_BudgetBudgetSubLine, optional),
Delete (CellData, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (BudgetBudgetLineKey, optional),
CurrentKey (BudgetBudgetLineKey, optional),
Key (BudgetBudgetLineKey, optional),
Index (integer, optional)
}
PickerViewData {
SelectedValue (string, optional),
SelectedText (string, optional),
Name (string, optional),
Visible (boolean, optional),
Disabled (boolean, optional),
Required (boolean, optional),
InfoText (string, optional)
}
StringViewData {
StringValue (string, optional),
Name (string, optional),
Visible (boolean, optional),
Disabled (boolean, optional),
Required (boolean, optional)
}
DateViewData {
DateValue (string, optional),
Name (string, optional),
Visible (boolean, optional),
Disabled (boolean, optional),
Required (boolean, optional),
InfoText (string, optional)
}
DecimalViewData {
DecimalValue (number, optional),
Name (string, optional),
Visible (boolean, optional),
InfoText (string, optional)
}
DropdownViewData {
SelectedValue (string, optional),
SelectedText (string, optional),
Name (string, optional),
Visible (boolean, optional),
Disabled (boolean, optional),
Required (boolean, optional),
InfoText (string, optional)
}
MvcValidationError {
n (string, optional),
m (string, optional)
}
CellData {
CellId (string, optional),
CellValue (string, optional),
CellNumValue (number, optional),
CellBoolValue (boolean, optional),
CellTag (string, optional),
CellValueDate (string, optional),
CellValueInt (integer, optional)
}
GridResult_BudgetBudgetSubLine {
total (integer, optional),
page (integer, optional),
records (integer, optional),
rows (Array[BudgetBudgetSubLine], optional),
form (object, optional),
widgets (Array[ViewData_GridWidget], optional)
}
BudgetBudgetLineKey {
ParentLine (integer, optional),
ChildLine (integer, optional),
EstimateId (integer, optional),
EstimateLineId (integer, optional),
JobCode (string, optional),
ActivityCode (string, optional),
WorkCentreCode (string, optional),
Type (string, optional),
LineCode (string, optional),
PriceCode (string, optional),
KeyName (string, optional),
UseRate (boolean, optional)
}
BudgetBudgetSubLine {
Approved (CellData, optional),
SequenceNo (CellData, optional),
JobCode (CellData, optional),
Type (CellData, optional),
LineCode (CellData, optional),
LineRef (CellData, optional),
PlantRate (CellData, optional),
ActivityCode (CellData, optional),
ActivityType (CellData, optional),
WorkCentreCode (CellData, optional),
YearPeriod (CellData, optional),
Description (CellData, optional),
Unit (CellData, optional),
Quantity (CellData, optional),
CostRate (CellData, optional),
Cost (CellData, optional),
Fix (boolean, optional),
SellingRate (CellData, optional),
Markup (CellData, optional),
FCRetailRate (CellData, optional),
FCRevenue (CellData, optional),
PoNumber (CellData, optional),
Details (CellData, optional),
Delete (CellData, optional),
YearNo (CellData, optional),
PeriodNo (CellData, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (BudgetBudgetSubLineKey, optional),
CurrentKey (BudgetBudgetSubLineKey, optional),
Key (BudgetBudgetSubLineKey, optional),
Index (integer, optional)
}
ViewData_GridWidget {
WidgetId (integer, optional),
LayoutCode (string, optional),
Name (string, optional),
Colour (string, optional),
BGColour (string, optional),
Icon (string, optional),
Type (string, optional),
Visible (boolean, optional),
Order (integer, optional),
Count (integer, optional),
WidgetLines (Array[ViewData_GridWidgetLine], optional)
}
BudgetBudgetSubLineKey {
Id (integer, optional),
ChildLine (integer, optional),
EstimateId (integer, optional),
EstimateLineId (integer, optional),
JobCode (string, optional),
ActivityCode (string, optional),
WorkCentreCode (string, optional),
Type (string, optional),
LineCode (string, optional),
PlantRate (string, optional)
}
ViewData_GridWidgetLine {
WidgetLineId (integer, optional),
WidgetId (integer, optional),
Name (string, optional),
Predicate (string, optional),
Order (integer, optional),
Count (integer, optional)
}

Response sample

{
  "Key": {
    "JobCode": "0001",
    "EstimateId": 0
  },
  "Rows": [],
  "BudgetType": {
    "Name": "Budget Type",
    "Visible": true,
    "Disabled": false,
    "Required": true
  },
  "Job": {
    "StringValue": "0001 : Melbourne Freeway1",
    "Name": "Job",
    "Visible": true,
    "Disabled": true,
    "Required": true
  },
  "Client": {
    "StringValue": "ABC RESOURCE COMP LTD",
    "Name": "Client",
    "Visible": true,
    "Disabled": true,
    "Required": true
  },
  "Contact": {
    "Name": "Contact",
    "Visible": true,
    "Disabled": false,
    "Required": false
  },
  "Description": {
    "Name": "Description",
    "Visible": true,
    "Disabled": false,
    "Required": true
  },
  "Details": {
    "Name": "Details",
    "Visible": true,
    "Disabled": false,
    "Required": false
  },
  "InternalReference": {
    "Name": "Internal Reference",
    "Visible": true,
    "Disabled": false,
    "Required": true
  },
  "ClientReference": {
    "Name": "Client Reference",
    "Visible": true,
    "Disabled": false,
    "Required": false
  },
  "BudgetDate": {
    "DateValue": "2024-04-10T00:00:00+12:00",
    "Name": "Budget Date",
    "Visible": true,
    "Disabled": false,
    "Required": true
  },
  "YearPeriod": {
    "StringValue": "2024/10",
    "Name": "Year/Period",
    "Visible": true,
    "Disabled": true,
    "Required": false
  },
  "Currency": {
    "StringValue": "AUD : Australian Dollars",
    "Name": "Currency",
    "Visible": true,
    "Disabled": true,
    "Required": false
  },
  "CurrencyRate": {
    "DecimalValue": 0.92,
    "Name": "Currency Rate",
    "Visible": true,
    "Disabled": true,
    "Required": false
  },
  "CreatedBy": {
    "StringValue": "Workbench User",
    "Name": "Created By",
    "Visible": true,
    "Disabled": true,
    "Required": false
  },
  "Approved": {
    "Name": "Approved By",
    "Visible": true,
    "Disabled": true,
    "Required": false
  },
  "GridSort": {
    "SelectedValue": "Entered",
    "Name": "Grid Sort",
    "Visible": true,
    "Disabled": false,
    "Required": false
  },
  "GridStructure": {
    "SelectedValue": "AtActivityWorkCentre",
    "Name": "Input",
    "Visible": true,
    "Disabled": false,
    "Required": false
  },
  "BillOfMaterials": {
    "Name": "Add Bill Of Materials",
    "Visible": true,
    "Disabled": false,
    "Required": false
  },
  "WorkflowType": {
    "SelectedValue": "",
    "Name": "Workflow Type",
    "Visible": true,
    "Disabled": false,
    "Required": false
  }
}

Sample of JobBudgetDetailApi POST

Click to view

Request

Response

JobBudgetApiModel {
Key (BudgetJobBudgetKey, optional),
Rows (Array[BudgetBudgetLine], optional),
BudgetType (PickerViewData, optional),
Job (StringViewData, optional),
Client (StringViewData, optional),
Contact (PickerViewData, optional),
Description (StringViewData, optional),
Details (StringViewData, optional),
InternalReference (StringViewData, optional),
ClientReference (StringViewData, optional),
BudgetDate (DateViewData, optional),
YearPeriod (StringViewData, optional),
Currency (StringViewData, optional),
CurrencyRate (DecimalViewData, optional),
CreatedBy (StringViewData, optional),
Approved (StringViewData, optional),
GridSort (DropdownViewData, optional),
GridStructure (DropdownViewData, optional),
BillOfMaterials (PickerViewData, optional),
WorkflowType (PickerViewData, optional),
ValidationErrors (Array[MvcValidationError], optional)
}
BudgetJobBudgetKey {
JobCode (string, optional),
EstimateId (integer, optional),
BomQuantity (number, optional)
}
BudgetBudgetLine {
Approved (CellData, optional),
SequenceNo (CellData, optional),
JobCode (CellData, optional),
BudgetType (CellData, optional),
Type (CellData, optional),
LineCode (CellData, optional),
LineRef (CellData, optional),
PlantRate (CellData, optional),
ActivityCode (CellData, optional),
ActivityType (CellData, optional),
WorkCentreCode (CellData, optional),
YearPeriod (CellData, optional),
Description (CellData, optional),
Unit (CellData, optional),
Quantity (CellData, optional),
CostRate (CellData, optional),
Cost (CellData, optional),
Fix (boolean, optional),
SellBasis (integer, optional),
SellBasisValue (CellData, optional),
SellingRate (CellData, optional),
Markup (CellData, optional),
FCRetailRate (CellData, optional),
FCRevenue (CellData, optional),
PoNumber (CellData, optional),
Details (CellData, optional),
SubGridResult (GridResult_BudgetBudgetSubLine, optional),
Delete (CellData, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (BudgetBudgetLineKey, optional),
CurrentKey (BudgetBudgetLineKey, optional),
Key (BudgetBudgetLineKey, optional),
Index (integer, optional)
}
PickerViewData {
SelectedValue (string, optional),
SelectedText (string, optional),
Name (string, optional),
Visible (boolean, optional),
Disabled (boolean, optional),
Required (boolean, optional),
InfoText (string, optional)
}
StringViewData {
StringValue (string, optional),
Name (string, optional),
Visible (boolean, optional),
Disabled (boolean, optional),
Required (boolean, optional)
}
DateViewData {
DateValue (string, optional),
Name (string, optional),
Visible (boolean, optional),
Disabled (boolean, optional),
Required (boolean, optional),
InfoText (string, optional)
}
DecimalViewData {
DecimalValue (number, optional),
Name (string, optional),
Visible (boolean, optional),
InfoText (string, optional)
}
DropdownViewData {
SelectedValue (string, optional),
SelectedText (string, optional),
Name (string, optional),
Visible (boolean, optional),
Disabled (boolean, optional),
Required (boolean, optional),
InfoText (string, optional)
}
MvcValidationError {
n (string, optional),
m (string, optional)
}
CellData {
CellId (string, optional),
CellValue (string, optional),
CellNumValue (number, optional),
CellBoolValue (boolean, optional),
CellTag (string, optional),
CellValueDate (string, optional),
CellValueInt (integer, optional)
}
GridResult_BudgetBudgetSubLine {
total (integer, optional),
page (integer, optional),
records (integer, optional),
rows (Array[BudgetBudgetSubLine], optional),
form (object, optional),
widgets (Array[ViewData_GridWidget], optional)
}
BudgetBudgetLineKey {
ParentLine (integer, optional),
ChildLine (integer, optional),
EstimateId (integer, optional),
EstimateLineId (integer, optional),
JobCode (string, optional),
ActivityCode (string, optional),
WorkCentreCode (string, optional),
Type (string, optional),
LineCode (string, optional),
PriceCode (string, optional),
KeyName (string, optional),
UseRate (boolean, optional)
}
BudgetBudgetSubLine {
Approved (CellData, optional),
SequenceNo (CellData, optional),
JobCode (CellData, optional),
Type (CellData, optional),
LineCode (CellData, optional),
LineRef (CellData, optional),
PlantRate (CellData, optional),
ActivityCode (CellData, optional),
ActivityType (CellData, optional),
WorkCentreCode (CellData, optional),
YearPeriod (CellData, optional),
Description (CellData, optional),
Unit (CellData, optional),
Quantity (CellData, optional),
CostRate (CellData, optional),
Cost (CellData, optional),
Fix (boolean, optional),
SellingRate (CellData, optional),
Markup (CellData, optional),
FCRetailRate (CellData, optional),
FCRevenue (CellData, optional),
PoNumber (CellData, optional),
Details (CellData, optional),
Delete (CellData, optional),
YearNo (CellData, optional),
PeriodNo (CellData, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (BudgetBudgetSubLineKey, optional),
CurrentKey (BudgetBudgetSubLineKey, optional),
Key (BudgetBudgetSubLineKey, optional),
Index (integer, optional)
}
ViewData_GridWidget {
WidgetId (integer, optional),
LayoutCode (string, optional),
Name (string, optional),
Colour (string, optional),
BGColour (string, optional),
Icon (string, optional),
Type (string, optional),
Visible (boolean, optional),
Order (integer, optional),
Count (integer, optional),
WidgetLines (Array[ViewData_GridWidgetLine], optional)
}
BudgetBudgetSubLineKey {
Id (integer, optional),
ChildLine (integer, optional),
EstimateId (integer, optional),
EstimateLineId (integer, optional),
JobCode (string, optional),
ActivityCode (string, optional),
WorkCentreCode (string, optional),
Type (string, optional),
LineCode (string, optional),
PlantRate (string, optional)
}
ViewData_GridWidgetLine {
WidgetLineId (integer, optional),
WidgetId (integer, optional),
Name (string, optional),
Predicate (string, optional),
Order (integer, optional),
Count (integer, optional)
}v

Response sample

⬆️ Back to top

On this page

Unable to render {include} The included page could not be found.