Overview

APIs about Job and Job Budget in Workbench.

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

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

GET Parameters

Parameter	Value	Description	Parameter Type	Data Type
jobCode	Required	Code of the preferred job	query	string

JobListApi

Returns all Workbench jobs.

/api/JobListApi
Method	Description	Performed As	Request Query	Request Body	Response
POST

JobMaintenanceApi - here

APIs related to Job maintenance screen in Workbench.

/api/JobMaintenanceApi
Method	Description	Performed As	Request Query	Request Body	Response
GET	Retrieves a a job and it's maintenance lines: Job Work Centres and Job Groups
POST	Updates an existing job. Use JobDetail method in order to create a new job.

GET Parameters

Parameter	Description	Parameter Type	Data Type
jobCode	Code of the Job.	query	string
jobDescription	Job description.	query	string
quoteID		query	integer

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/or 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.

GeneralJobLine

Field	Type	Description
JobCode	String	Code of job.
Description	String	Description of the project or purpose.
CodeDescription	String
Company	String	The client Company for this Job.
CompanyId	Integer	The id of client Company.
Level	Integer	The tier or hierarchy that this Job or Subjob was created at. Jobs can be 5 levels deep.
ProfitCentre	String	The Profit Centre this Job sits under.
ProfitCentreDescription	String	Profit Centre description.
Finalised	Boolean	Job is finalised or not.
OpenClosed	String
OpenClosedCode	Integer
Status	String	Job status.
JobManager	String	The person nominated to be the central manager of the Job.
JobManagerId	Integer	ID of the Job manager person.
AccountManager	String	The person nominated to be the manager of the client account for the Job.
AccountManagerId	Integer	ID of the Account manager person.
JobType	String	The category that this Job is assigned to.
JobLevel	Integer	The hierarchical position of the job
FinancialCompany	String	The financial company.
ChargeType	String	The Charge Type of the job.
HasContract	Boolean	Does the job have a contract or not.
HasSubcontract	Boolean	Does the job have a Subcontract or not
RequiresSchedule	Integer	Stands for Requires Scheduling, enabling this job to be used with the Datasheet Scheduling module.
JobSiteAddressID	Integer
JobSiteAddress	String	The Client Company's default site address
JobSiteAddressDetails	String	The custom text field to enter a specific site address or other details.
OrderNumber	String	An optional field to place a client Purchase Order number, which will be shown on the claim/invoice.
ClientReference	String	To label the budget something that your external stakeholders refer to it as.
QuoteReference	String	An optional field for custom text, used for tracking quote numbers given to the client for this Job.
JobReference	String	An optional field for custom text
AssetReference	String
CreatedDate	String	Created date.
FinalisedDate	String	Finalised date.
StartDate	String	Started date.
CompletedDate	String	Completed date.
IncludeSubjobs	Boolean
HierarchyCode1	String
HierarchyCode2	String
HierarchyCode3	String
HierarchyCode4	String
HierarchyCode5	String
HierarchyCode6	String
Select	CellData
JobCodeValue	CellData	Job code
DescriptionValue	CellData	Job description
CompanyValue	CellData	The client Company for this Job.
LevelValue	CellData	The job level
ProfitCentreValue	CellData	The Profit Centre this Job sits under.
OpenClosedValue	CellData
StatusValue	CellData	Job status
JobManagerValue	CellData	Job manager
AccountManagerValue	CellData	Account mananger
JobTypeValue	CellData	Job type
ChargeTypeValue	CellData	Charge type of the job.
HasContractValue	CellData	Does the job have a contract or not.
Group1	String
Group2	String
Group3	String
UpdatedDate	String	Updated date
ReadonlyFlag	Integer
ReadonlyMessage	String
OriginalKey	GeneralJobKey
CurrentKey	GeneralJobKey
Key	GeneralJobKey
Index	Integer

GeneralJobMainFields

Field	Type	Description
JobCode	StringViewData	Code of the job.
Description	StringViewData	Description text.
JobLevel	StringViewData
ParentJob	StringViewData
Client	StringViewData	The Client of the job.
ProfitCentre	PickerViewData	The Profit Centre that Job sits under.
JobManager	PickerViewData
AccountManager	PickerViewData
PriceCode	PickerViewData
JobType	PickerViewData
JobStatus	PickerViewData
Closed	BoolViewData
ClosedSubJobs	BoolViewData
Finalised	BoolViewData
FinalisedSubJobs	BoolViewData
Details	StringViewData
CurrencyValid	Boolean
Company	PickerViewData
ChargeType	PickerViewData
InvoiceType	PickerViewData
CurrencyCode	PickerViewData
ScheduleCode	PickerViewData
ActivityGroup	PickerViewData
UseGST	BoolViewData
CreatedDate	DateViewData

JobsAddressesFields

Field	Type	Description
BillingAddress	PickerViewData	The client company's billing address.
SiteAddress	PickerViewData	The client company's Site address.
SiteAddressDetails	StringViewData	Site Address details.
BillingContact	PickerViewData	The client company's billing contact.
SiteContact	PickerViewData	Site contact person.
StreetLine1	StringViewData	Part of street address.
StreetLine2	StringViewData	Part of street address.
Suburb	StringViewData	Part of street address.
City	StringViewData	Part of street address.
State	StringViewData	Part of street address.
Country	StringViewData	Part of street address.
PostCode	StringViewData	Post code of the address.

JobApiFields_DatasheetsDatasheetModelLine

Field	Type	Description
Row	Array [DatasheetsDatasheetModelLine]

JobApiFields_GeneralAttributeLine

Field	Type	Description
Row	Array [GeneralAttributeLine]

JobApiFields_GeneralToDoLine

Field	Type	Description
Row	Array [GeneralToDoLine]

JobApiFields_GeneralNoteLine

Field	Type	Description
Row	Array [GeneralToDoLine]

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]

JobApiReportsFields

Field	Type	Description
ParameterName	String
ParameterValue	String

JobsBillingFields

Field	Type	Description
PriceCode	PickerViewData
ChargeType	PickerViewData
WipCode	PickerViewData
InvoiceType	PickerViewData
ClientCreditStatus	StringViewData
JobValue	DecimalViewData
DrAccount	StringViewData
CrAccount	StringViewData
InvoiceTitle	StringViewData
InvoiceText	StringViewData
EmployeeAgreementScheme	DropdownViewData
EbaTags	MultiPickerViewData
LabourCostingGroup	DropdownViewData
ForecastRevenue	BoolViewData
ChargeToJob	PickerViewData
ChargeToActivity	PickerViewData
ChargeToLog	PickerViewData
AllowInternalSales	Boolean

JobBudgetApiModel

Field	Type	Description
Key	BudgetJobBudgetKey
Rows	Array [BudgetBudgetLine]
BudgetType	PickerViewData	Type of the budget.
Job	StringViewData	Related job
Client	StringViewData	The client name.
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]

JobsContractFields

Field	Type	Description
HaveContract	OptionsViewData	Job has contract or not.
Status	DropdownViewData	Job status.
BriefConfirmed	BoolViewData
ContractType	DropdownViewData	Type of contract.
RetentionType	DropdownViewData	Type of retention applied.
Site	StringViewData	The site address.
ForeignCurrency	StringViewData	The foreign currency.
ForeignCurrencyCode	StringViewData
CurrencyRateType	DropdownViewData
CurrencyRate	DecimalViewData
NonContractBilling	DropdownViewData
AncestorHasContract	Boolean

JobsDocketCostSchedulesFields

Field	Type	Description
Layout	Layour
Rows	Array [JobsDocketCostScheduleLine]

JobsDocketCostScheduleKey

Field	Type	Description
Job	String
Catalogue	Integer

JobsDocketCostScheduleLine

Field	Type	Description
Catalogue	CellData
ActivityGroup	CellData
Delete	CellData
Status	String
ReadonlyFlag	Integer
ReadonlyMessage	String
OriginalKey	JobsDocketCostScheduleKey
CurrentKey	JobsDocketCostScheduleKey
Key	JobsDocketCostScheduleKey
Index	integer

JobsGeneralFields

Field	Type	Description
Name	StringViewData
Company	PickerViewData	The client of the job.
JobManager	PickerViewData	The person nominated to be the central manager of the Job.
AccountManager	PickerViewData	The person nominated to be the manager of the client account for the Job.
ProfitCentre	PickerViewData	The Profit Centre the Job sits under.
JobType	PickerViewData
Contract	StringViewData
ParentJob	PickerViewData
JobHierarchy	StringViewData
JobLevel	StringViewData
JobStatus	DropDownViewData
CostActivityGroup	PickerViewData
BudgetActivityGroup	PickerViewData
ForecastActivityGroup	PickerViewData
BillingCurrency	PickerViewData
StockLocation	PickerViewData
CheckAgainstBudget	DropDownViewData
JobDetails	StringViewData
UseGst	BoolViewData
AdminJob	BoolViewData
ReqSched	BoolViewData
TemplateCode	String

JobsJobFields

Field	Type	Description
JobCode	String	Code of job.
ContractCode	String	Code of the contract of the job.
HasContract	Boolean	Id of the contract.
CurrencyValid	Boolean
GeneralFields	JobsGeneralFields	Call function to get related data.
Extensions	GeneralExtensionFields	Call function to get related data.
BillingFields	JobsBillingFields	Call function to get related data.
ReferencesFields	JobsReferencesFields	Call function to get related data.
AddressesFields	JobsAddressesFields	Call function to get related data.
JobGroupsFields	JobsJobGroupsFields	Call function to get related data.
JobWorkCentresFields	JobsJobWorkCentresFields	Call function to get related data.
JobSchedulesFields	JobsJobSchedulesFields	Call function to get related data.
DocketCostSchedulesFields	JobsDocketCostSchedulesFields	Call function to get related data.
StandardOutputsFields	JobsStandardOutputsFields	Call function to get related data.

JobsJobGroupsFields

Field	Type	Description
Layout	Layout
Rows	Array [JobsJobGroupLine]

JobsJobGroupKey

Field	Type	Description
Job	String
Category	String
Group	String

JobsJobGroupLine

Field	Type	Description
Category	CellData
Group	CellData	x
Value	CellData
Delete	CellData
Status	String
ReadonlyFlag	Integer
ReadonlyMessage	String
OriginalKey	JobsJobGroupKey
CurrentKey	JobsJobGroupKey
Key	JobsJobGroupKey
Index	Index

JobsJobSchedulesFields

Field	Type	Description
Layout	Layout
Rows	Array [JobsJobScheduleLine]

JobsJobScheduleKey

Field	Type	Description
Job	String
Schedule	String

JobsJobScheduleLine

Field	Type	Description
Schedule	CellData
Type	CellData
Delete	CellData
Status	CellData
ReadonlyFlag	Integer
ReadonlyMessage	String
OriginalKey	JobsJobScheduleKey
CurrentKey	JobsJobScheduleKey
Key	JobsJobScheduleKey
Index	Integer

JobsJobWorkCentresFields

Field	Type	Description
Layout	Layout
Rows	Array [JobsJobWorkCentreLine]

JobsJobWorkCentreKey

Field	Type	Description
JobCode	String
WorkCentreCode	String

JobsJobWorkCentreLine

Field	Type	Description
Job	CellData
WorkCentre	CellData
Description	CellData
BalanceOfBudget	CellData
CashflowByActivity	CellData
Closed	Boolean
Complete	Boolean
StartDate	String
EndDate	String
ExtensionFields	CellData
Delete	CellData
Status	String
ReadonlyFlag	Integer
ReadonlyMessage	String
OriginalKey	JobsJobWorkCentreKey
CurrentKey	JobsJobWorkCentreKey
Key	JobsJobWorkCentreKey
Index	Integer

JobMaintenanceApiModel

Field	Type	Description
Key	JobsMaintenanceKey
JobFields	JobsJobFields	Generate data fields.
WizardFields	JobsWizardFields	Generate data fields.
ContractFields	JobsContractFields	Generate data fields.
ValidationErrors	Array [MvcValidationError]

JobsMaintenanceKey

Field	Type	Description
JobCode	String	Code of the job.
JobDescription	String	Job description.
QuoteID	Integer

JobsReferencesFields

Field	Type	Description
OrderNumber	StringViewData
JobReference	StringViewData
ClientReference	StringViewData
QuoteReference	StringViewData
AssetReference	StringViewData
CreatedDate	StringViewData
StartDate	DateViewData
ClosedDate	DateViewData
RequiredDate	DateViewData
ExpectedDate	DateViewData
FinalisedDate	DateViewData
Asset	PickerViewData

JobsStandardOutputsFields

Field	Type	Description
Layout	Layout
Rows	Array [JobsStandardOutputLine]

JobsStandardOutputKey

Field	Type	Description
StandardOutputId	Integer
JobCode	String
ScheduleCode	String
OutputCode	String
ScheduleOutputRate	Number

JobsStandardOutputLine

Field	Type	Description
FixedRate	Boolean
ScheduleCode	CellData
OutputCode	CellData
Description	CellData
Unit	CellData
Rate	CellData
Quantity	CellData
Amount	CellData
SpecialRate	CellData
AuditDetails	CellData
Delete	CellData
Status	String
ReadonlyFlag	Integer
ReadonlyMessage	String
OriginalKey	JobsStandardOutputKey
CurrentKey	JobsStandardOutputKey
Key	JobsStandardOutputKey
Index	Integer

JobsWizardFields

Field	Type	Description
Level	OptionsViewData
Name	StringViewData
Client	PickerViewData	Client name
ParentJob	PickerViewData	Parent job
CreateJob	OptionsViewData
JobTemplate	PickerViewData	Job template list
Template	PickerViewData
JobCode	StringViewData	Code of the job.

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

Sample of JobDetailApi DELETE

Click to view

Request

Response

Response sample

Sample of getting details of a job

Click to view

Request

JobApiModel {
Key (GeneralJobKey, optional),
Main (GeneralJobMainFields, optional),
Attributes (JobApiFields_GeneralAttributeLine, optional),
ToDoItems (JobApiFields_GeneralToDoLine, optional),
Notes (JobApiFields_GeneralNoteLine, optional),
Reporting (JobApiReportsFields, optional),
Datasheets (JobApiFields_DatasheetsDatasheetModelLine, optional),
ValidationErrors (Array[MvcValidationError], optional)
}
GeneralJobKey {
JobCode (string, optional)
}
GeneralJobMainFields {
JobCode (StringViewData, optional),
Description (StringViewData, optional),
JobLevel (StringViewData, optional),
ParentJob (StringViewData, optional),
Client (StringViewData, optional),
ProfitCentre (PickerViewData, optional),
JobManager (PickerViewData, optional),
AccountManager (PickerViewData, optional),
PriceCode (PickerViewData, optional),
JobType (PickerViewData, optional),
JobStatus (PickerViewData, optional),
Closed (BoolViewData, optional),
ClosedSubJobs (BoolViewData, optional),
Finalised (BoolViewData, optional),
FinalisedSubJobs (BoolViewData, optional),
Details (StringViewData, optional),
CurrencyValid (boolean, optional),
Company (PickerViewData, optional),
ChargeType (PickerViewData, optional),
InvoiceType (PickerViewData, optional),
CurrencyCode (PickerViewData, optional),
ScheduleCode (PickerViewData, optional),
ActivityGroup (PickerViewData, optional),
UseGST (BoolViewData, optional),
CreatedDate (DateViewData, optional)
}
JobApiFields_GeneralAttributeLine {
Rows (Array[GeneralAttributeLine], optional)
}
JobApiFields_GeneralToDoLine {
Rows (Array[GeneralToDoLine], optional)
}
JobApiFields_GeneralNoteLine {
Rows (Array[GeneralNoteLine], optional)
}
JobApiReportsFields {
ParameterName (string, optional),
ParameterValue (string, optional)
}
JobApiFields_DatasheetsDatasheetModelLine {
Rows (Array[DatasheetsDatasheetModelLine], optional)
}
MvcValidationError {
n (string, optional),
m (string, optional)
}
StringViewData {
StringValue (string, optional),
Name (string, optional),
Visible (boolean, optional),
Disabled (boolean, optional),
Required (boolean, optional)
}
PickerViewData {
SelectedValue (string, optional),
SelectedText (string, optional),
Name (string, optional),
Visible (boolean, optional),
Disabled (boolean, optional),
Required (boolean, optional),
InfoText (string, optional)
}
BoolViewData {
BoolValue (boolean, optional),
Name (string, optional),
Visible (boolean, optional),
InfoText (string, optional)
}
DateViewData {
DateValue (string, optional),
Name (string, optional),
Visible (boolean, optional),
Disabled (boolean, optional),
Required (boolean, optional),
InfoText (string, optional)
}
GeneralAttributeLine {
Category (string, optional),
Group (string, optional),
CategoryValue (CellData, optional),
GroupValue (CellData, optional),
Value (CellData, optional),
Delete (CellData, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (GeneralAttributeKey, optional),
CurrentKey (GeneralAttributeKey, optional),
Key (GeneralAttributeKey, optional),
Index (integer, optional)
}
GeneralToDoLine {
Description (string, optional),
Details (string, optional),
NoteTypeId (integer, optional),
NoteType (string, optional),
NoteStatusId (integer, optional),
NoteStatus (string, optional),
DoById (integer, optional),
CreatedByID (integer, optional),
DoBy (string, optional),
KeyTable (string, optional),
EntityDescription (string, optional),
DoByDate (string, optional),
Completed (boolean, optional),
Select (CellData, optional),
DescriptionValue (CellData, optional),
DetailsValue (CellData, optional),
NoteTypeValue (CellData, optional),
NoteStatusValue (CellData, optional),
DoByValue (CellData, optional),
EntityValue (CellData, optional),
EntityDescriptionValue (CellData, optional),
DoByDateValue (CellData, optional),
CompletedValue (CellData, optional),
Delete (CellData, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (GeneralToDoKey, optional),
CurrentKey (GeneralToDoKey, optional),
Key (GeneralToDoKey, optional),
Index (integer, optional)
}
GeneralNoteLine {
Description (string, optional),
Details (string, optional),
NoteTypeId (integer, optional),
NoteType (string, optional),
CreatedById (integer, optional),
CreatedBy (string, optional),
CreatedDate (string, optional),
KeyTable (string, optional),
EntityDescription (string, optional),
Select (CellData, optional),
DescriptionValue (CellData, optional),
DetailsValue (CellData, optional),
NoteTypeValue (CellData, optional),
CreatedByValue (CellData, optional),
CreatedDateValue (CellData, optional),
EntityValue (CellData, optional),
EntityDescriptionValue (CellData, optional),
Delete (CellData, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (GeneralNoteKey, optional),
CurrentKey (GeneralNoteKey, optional),
Key (GeneralNoteKey, optional),
Index (integer, optional)
}
DatasheetsDatasheetModelLine {
Datasheet (CellData, optional),
Template (CellData, optional),
Date (string, optional),
Name (string, optional),
KeyTable (string, optional),
Subject (string, optional),
Rating (number, optional),
Complete (boolean, optional),
JSON (string, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (DatasheetsDatasheetKey, optional),
CurrentKey (DatasheetsDatasheetKey, optional),
Key (DatasheetsDatasheetKey, optional),
Index (integer, optional)
}
CellData {
CellId (string, optional),
CellValue (string, optional),
CellNumValue (number, optional),
CellBoolValue (boolean, optional),
CellTag (string, optional),
CellValueDate (string, optional),
CellValueInt (integer, optional)
}
GeneralAttributeKey {
Category (string, optional),
Group (string, optional)
}
GeneralToDoKey {
ToDoNoteId (integer, optional),
KeyTable (string, optional)
}
GeneralNoteKey {
ToDoNoteId (integer, optional),
KeyTable (string, optional),
GridId (string, optional)
}
DatasheetsDatasheetKey {
DatasheetId (integer, optional),
DatasheetTemplateId (integer, optional),
KeyStr (string, optional),
KeyInt (integer, optional)
}

Response

{
  "Key": {
    "JobCode": "string"
  },
  "Main": {
    "JobCode": {
      "StringValue": "string",
      "Name": "string",
      "Visible": true,
      "Disabled": true,
      "Required": true
    },
    "Description": {
      "StringValue": "string",
      "Name": "string",
      "Visible": true,
      "Disabled": true,
      "Required": true
    },
    "JobLevel": {
      "StringValue": "string",
      "Name": "string",
      "Visible": true,
      "Disabled": true,
      "Required": true
    },
    "ParentJob": {
      "StringValue": "string",
      "Name": "string",
      "Visible": true,
      "Disabled": true,
      "Required": true
    },
    "Client": {
      "StringValue": "string",
      "Name": "string",
      "Visible": true,
      "Disabled": true,
      "Required": true
    },
    "ProfitCentre": {
      "SelectedValue": "string",
      "SelectedText": "string",
      "Name": "string",
      "Visible": true,
      "Disabled": true,
      "Required": true,
      "InfoText": "string"
    },
    "JobManager": {
      "SelectedValue": "string",
      "SelectedText": "string",
      "Name": "string",
      "Visible": true,
      "Disabled": true,
      "Required": true,
      "InfoText": "string"
    },
    "AccountManager": {
      "SelectedValue": "string",
      "SelectedText": "string",
      "Name": "string",
      "Visible": true,
      "Disabled": true,
      "Required": true,
      "InfoText": "string"
    },
    "PriceCode": {
      "SelectedValue": "string",
      "SelectedText": "string",
      "Name": "string",
      "Visible": true,
      "Disabled": true,
      "Required": true,
      "InfoText": "string"
    },
    "JobType": {
      "SelectedValue": "string",
      "SelectedText": "string",
      "Name": "string",
      "Visible": true,
      "Disabled": true,
      "Required": true,
      "InfoText": "string"
    },
    "JobStatus": {
      "SelectedValue": "string",
      "SelectedText": "string",
      "Name": "string",
      "Visible": true,
      "Disabled": true,
      "Required": true,
      "InfoText": "string"
    },
    "Closed": {
      "BoolValue": true,
      "Name": "string",
      "Visible": true,
      "InfoText": "string"
    },
    "ClosedSubJobs": {
      "BoolValue": true,
      "Name": "string",
      "Visible": true,
      "InfoText": "string"
    },
    "Finalised": {
      "BoolValue": true,
      "Name": "string",
      "Visible": true,
      "InfoText": "string"
    },
    "FinalisedSubJobs": {
      "BoolValue": true,
      "Name": "string",
      "Visible": true,
      "InfoText": "string"
    },
    "Details": {
      "StringValue": "string",
      "Name": "string",
      "Visible": true,
      "Disabled": true,
      "Required": true
    },
    "CurrencyValid": true,
    "Company": {
      "SelectedValue": "string",
      "SelectedText": "string",
      "Name": "string",
      "Visible": true,
      "Disabled": true,
      "Required": true,
      "InfoText": "string"
    },
    "ChargeType": {
      "SelectedValue": "string",
      "SelectedText": "string",
      "Name": "string",
      "Visible": true,
      "Disabled": true,
      "Required": true,
      "InfoText": "string"
    },
    "InvoiceType": {
      "SelectedValue": "string",
      "SelectedText": "string",
      "Name": "string",
      "Visible": true,
      "Disabled": true,
      "Required": true,
      "InfoText": "string"
    },
    "CurrencyCode": {
      "SelectedValue": "string",
      "SelectedText": "string",
      "Name": "string",
      "Visible": true,
      "Disabled": true,
      "Required": true,
      "InfoText": "string"
    },
    "ScheduleCode": {
      "SelectedValue": "string",
      "SelectedText": "string",
      "Name": "string",
      "Visible": true,
      "Disabled": true,
      "Required": true,
      "InfoText": "string"
    },
    "ActivityGroup": {
      "SelectedValue": "string",
      "SelectedText": "string",
      "Name": "string",
      "Visible": true,
      "Disabled": true,
      "Required": true,
      "InfoText": "string"
    },
    "UseGST": {
      "BoolValue": true,
      "Name": "string",
      "Visible": true,
      "InfoText": "string"
    },
    "CreatedDate": {
      "DateValue": "2024-04-09T20:49:33.631Z",
      "Name": "string",
      "Visible": true,
      "Disabled": true,
      "Required": true,
      "InfoText": "string"
    }
  },
  "Attributes": {
    "Rows": [
      {
        "Category": "string",
        "Group": "string",
        "CategoryValue": {
          "CellId": "string",
          "CellValue": "string",
          "CellNumValue": 0,
          "CellBoolValue": true,
          "CellTag": "string",
          "CellValueDate": "2024-04-09T20:49:33.631Z",
          "CellValueInt": 0
        },
        "GroupValue": {
          "CellId": "string",
          "CellValue": "string",
          "CellNumValue": 0,
          "CellBoolValue": true,
          "CellTag": "string",
          "CellValueDate": "2024-04-09T20:49:33.631Z",
          "CellValueInt": 0
        },
        "Value": {
          "CellId": "string",
          "CellValue": "string",
          "CellNumValue": 0,
          "CellBoolValue": true,
          "CellTag": "string",
          "CellValueDate": "2024-04-09T20:49:33.631Z",
          "CellValueInt": 0
        },
        "Delete": {
          "CellId": "string",
          "CellValue": "string",
          "CellNumValue": 0,
          "CellBoolValue": true,
          "CellTag": "string",
          "CellValueDate": "2024-04-09T20:49:33.631Z",
          "CellValueInt": 0
        },
        "Status": "string",
        "ReadonlyFlag": 0,
        "ReadonlyMessage": "string",
        "OriginalKey": {
          "Category": "string",
          "Group": "string"
        },
        "CurrentKey": {
          "Category": "string",
          "Group": "string"
        },
        "Key": {
          "Category": "string",
          "Group": "string"
        },
        "Index": 0
      }
    ]
  },
  "ToDoItems": {
    "Rows": [
      {
        "Description": "string",
        "Details": "string",
        "NoteTypeId": 0,
        "NoteType": "string",
        "NoteStatusId": 0,
        "NoteStatus": "string",
        "DoById": 0,
        "CreatedByID": 0,
        "DoBy": "string",
        "KeyTable": "string",
        "EntityDescription": "string",
        "DoByDate": "2024-04-09T20:49:33.631Z",
        "Completed": true,
        "Select": {
          "CellId": "string",
          "CellValue": "string",
          "CellNumValue": 0,
          "CellBoolValue": true,
          "CellTag": "string",
          "CellValueDate": "2024-04-09T20:49:33.631Z",
          "CellValueInt": 0
        },
        "DescriptionValue": {
          "CellId": "string",
          "CellValue": "string",
          "CellNumValue": 0,
          "CellBoolValue": true,
          "CellTag": "string",
          "CellValueDate": "2024-04-09T20:49:33.631Z",
          "CellValueInt": 0
        },
        "DetailsValue": {
          "CellId": "string",
          "CellValue": "string",
          "CellNumValue": 0,
          "CellBoolValue": true,
          "CellTag": "string",
          "CellValueDate": "2024-04-09T20:49:33.631Z",
          "CellValueInt": 0
        },
        "NoteTypeValue": {
          "CellId": "string",
          "CellValue": "string",
          "CellNumValue": 0,
          "CellBoolValue": true,
          "CellTag": "string",
          "CellValueDate": "2024-04-09T20:49:33.631Z",
          "CellValueInt": 0
        },
        "NoteStatusValue": {
          "CellId": "string",
          "CellValue": "string",
          "CellNumValue": 0,
          "CellBoolValue": true,
          "CellTag": "string",
          "CellValueDate": "2024-04-09T20:49:33.631Z",
          "CellValueInt": 0
        },
        "DoByValue": {
          "CellId": "string",
          "CellValue": "string",
          "CellNumValue": 0,
          "CellBoolValue": true,
          "CellTag": "string",
          "CellValueDate": "2024-04-09T20:49:33.631Z",
          "CellValueInt": 0
        },
        "EntityValue": {
          "CellId": "string",
          "CellValue": "string",
          "CellNumValue": 0,
          "CellBoolValue": true,
          "CellTag": "string",
          "CellValueDate": "2024-04-09T20:49:33.631Z",
          "CellValueInt": 0
        },
        "EntityDescriptionValue": {
          "CellId": "string",
          "CellValue": "string",
          "CellNumValue": 0,
          "CellBoolValue": true,
          "CellTag": "string",
          "CellValueDate": "2024-04-09T20:49:33.633Z",
          "CellValueInt": 0
        },
        "DoByDateValue": {
          "CellId": "string",
          "CellValue": "string",
          "CellNumValue": 0,
          "CellBoolValue": true,
          "CellTag": "string",
          "CellValueDate": "2024-04-09T20:49:33.633Z",
          "CellValueInt": 0
        },
        "CompletedValue": {
          "CellId": "string",
          "CellValue": "string",
          "CellNumValue": 0,
          "CellBoolValue": true,
          "CellTag": "string",
          "CellValueDate": "2024-04-09T20:49:33.633Z",
          "CellValueInt": 0
        },
        "Delete": {
          "CellId": "string",
          "CellValue": "string",
          "CellNumValue": 0,
          "CellBoolValue": true,
          "CellTag": "string",
          "CellValueDate": "2024-04-09T20:49:33.633Z",
          "CellValueInt": 0
        },
        "Status": "string",
        "ReadonlyFlag": 0,
        "ReadonlyMessage": "string",
        "OriginalKey": {
          "ToDoNoteId": 0,
          "KeyTable": "string"
        },
        "CurrentKey": {
          "ToDoNoteId": 0,
          "KeyTable": "string"
        },
        "Key": {
          "ToDoNoteId": 0,
          "KeyTable": "string"
        },
        "Index": 0
      }
    ]
  },
  "Notes": {
    "Rows": [
      {
        "Description": "string",
        "Details": "string",
        "NoteTypeId": 0,
        "NoteType": "string",
        "CreatedById": 0,
        "CreatedBy": "string",
        "CreatedDate": "2024-04-09T20:49:33.633Z",
        "KeyTable": "string",
        "EntityDescription": "string",
        "Select": {
          "CellId": "string",
          "CellValue": "string",
          "CellNumValue": 0,
          "CellBoolValue": true,
          "CellTag": "string",
          "CellValueDate": "2024-04-09T20:49:33.633Z",
          "CellValueInt": 0
        },
        "DescriptionValue": {
          "CellId": "string",
          "CellValue": "string",
          "CellNumValue": 0,
          "CellBoolValue": true,
          "CellTag": "string",
          "CellValueDate": "2024-04-09T20:49:33.633Z",
          "CellValueInt": 0
        },
        "DetailsValue": {
          "CellId": "string",
          "CellValue": "string",
          "CellNumValue": 0,
          "CellBoolValue": true,
          "CellTag": "string",
          "CellValueDate": "2024-04-09T20:49:33.633Z",
          "CellValueInt": 0
        },
        "NoteTypeValue": {
          "CellId": "string",
          "CellValue": "string",
          "CellNumValue": 0,
          "CellBoolValue": true,
          "CellTag": "string",
          "CellValueDate": "2024-04-09T20:49:33.633Z",
          "CellValueInt": 0
        },
        "CreatedByValue": {
          "CellId": "string",
          "CellValue": "string",
          "CellNumValue": 0,
          "CellBoolValue": true,
          "CellTag": "string",
          "CellValueDate": "2024-04-09T20:49:33.633Z",
          "CellValueInt": 0
        },
        "CreatedDateValue": {
          "CellId": "string",
          "CellValue": "string",
          "CellNumValue": 0,
          "CellBoolValue": true,
          "CellTag": "string",
          "CellValueDate": "2024-04-09T20:49:33.633Z",
          "CellValueInt": 0
        },
        "EntityValue": {
          "CellId": "string",
          "CellValue": "string",
          "CellNumValue": 0,
          "CellBoolValue": true,
          "CellTag": "string",
          "CellValueDate": "2024-04-09T20:49:33.633Z",
          "CellValueInt": 0
        },
        "EntityDescriptionValue": {
          "CellId": "string",
          "CellValue": "string",
          "CellNumValue": 0,
          "CellBoolValue": true,
          "CellTag": "string",
          "CellValueDate": "2024-04-09T20:49:33.633Z",
          "CellValueInt": 0
        },
        "Delete": {
          "CellId": "string",
          "CellValue": "string",
          "CellNumValue": 0,
          "CellBoolValue": true,
          "CellTag": "string",
          "CellValueDate": "2024-04-09T20:49:33.633Z",
          "CellValueInt": 0
        },
        "Status": "string",
        "ReadonlyFlag": 0,
        "ReadonlyMessage": "string",
        "OriginalKey": {
          "ToDoNoteId": 0,
          "KeyTable": "string",
          "GridId": "string"
        },
        "CurrentKey": {
          "ToDoNoteId": 0,
          "KeyTable": "string",
          "GridId": "string"
        },
        "Key": {
          "ToDoNoteId": 0,
          "KeyTable": "string",
          "GridId": "string"
        },
        "Index": 0
      }
    ]
  },
  "Reporting": {
    "ParameterName": "string",
    "ParameterValue": "string"
  },
  "Datasheets": {
    "Rows": [
      {
        "Datasheet": {
          "CellId": "string",
          "CellValue": "string",
          "CellNumValue": 0,
          "CellBoolValue": true,
          "CellTag": "string",
          "CellValueDate": "2024-04-09T20:49:33.633Z",
          "CellValueInt": 0
        },
        "Template": {
          "CellId": "string",
          "CellValue": "string",
          "CellNumValue": 0,
          "CellBoolValue": true,
          "CellTag": "string",
          "CellValueDate": "2024-04-09T20:49:33.633Z",
          "CellValueInt": 0
        },
        "Date": "string",
        "Name": "string",
        "KeyTable": "string",
        "Subject": "string",
        "Rating": 0,
        "Complete": true,
        "JSON": "string",
        "Status": "string",
        "ReadonlyFlag": 0,
        "ReadonlyMessage": "string",
        "OriginalKey": {
          "DatasheetId": 0,
          "DatasheetTemplateId": 0,
          "KeyStr": "string",
          "KeyInt": 0
        },
        "CurrentKey": {
          "DatasheetId": 0,
          "DatasheetTemplateId": 0,
          "KeyStr": "string",
          "KeyInt": 0
        },
        "Key": {
          "DatasheetId": 0,
          "DatasheetTemplateId": 0,
          "KeyStr": "string",
          "KeyInt": 0
        },
        "Index": 0
      }
    ]
  },
  "ValidationErrors": [
    {
      "n": "string",
      "m": "string"
    }
  ]
}

Response sample

{
  "Key": {
    "JobCode": "BTJ-Q"
  },
  "Main": {
    "JobCode": {
      "StringValue": "BTJ-Q",
      "Name": "Job Code",
      "Visible": true,
      "Disabled": false,
      "Required": true
    },
    "Description": {
      "StringValue": "BTJ - Install new Aircon",
      "Name": "Description",
      "Visible": true,
      "Disabled": false,
      "Required": true
    },
    "JobLevel": {
      "StringValue": "1",
      "Name": "Job Level",
      "Visible": true,
      "Disabled": false,
      "Required": false
    },
    "ParentJob": {
      "Name": "Parent Job",
      "Visible": true,
      "Disabled": false,
      "Required": false
    },
    "Client": {
      "StringValue": "Client A",
      "Name": "Client",
      "Visible": true,
      "Disabled": false,
      "Required": false
    },
    "ProfitCentre": {
      "SelectedValue": "BTPCEN",
      "SelectedText": "BTPCEN : BaoT profit center for job BRJ",
      "Name": "Profit Centre",
      "Visible": true,
      "Disabled": false,
      "Required": true
    },
    "JobManager": {
      "SelectedValue": "380",
      "SelectedText": "Bao TRINH",
      "Name": "Job Manager",
      "Visible": true,
      "Disabled": false,
      "Required": true
    },
    "AccountManager": {
      "SelectedValue": "380",
      "SelectedText": "Bao TRINH",
      "Name": "Account Manager",
      "Visible": true,
      "Disabled": false,
      "Required": true
    },
    "PriceCode": {
      "SelectedValue": "BTJQ",
      "Name": "Price Code",
      "Visible": true,
      "Disabled": false,
      "Required": true
    },
    "JobType": {
      "SelectedValue": "INTS",
      "SelectedText": "INTS : Installation",
      "Name": "Job Type",
      "Visible": true,
      "Disabled": false,
      "Required": true
    },
    "JobStatus": {
      "SelectedValue": "Invoiced",
      "Name": "Job Status",
      "Visible": true,
      "Disabled": false,
      "Required": true
    },
    "Closed": {
      "BoolValue": false,
      "Name": "Closed",
      "Visible": true,
      "Disabled": false,
      "Required": false
    },
    "ClosedSubJobs": {
      "BoolValue": false,
      "Name": "{{Main.Closed.BoolValue ? 'Close' : 'Unclose'}} Sub Jobs",
      "Visible": true,
      "Disabled": false,
      "Required": false
    },
    "Finalised": {
      "BoolValue": false,
      "Name": "Finalised",
      "Visible": true,
      "Disabled": false,
      "Required": false
    },
    "FinalisedSubJobs": {
      "BoolValue": false,
      "Name": "{{Main.Finalised.BoolValue ? 'Finalise' : 'Unfinalise'}} Sub Jobs",
      "Visible": true,
      "Disabled": false,
      "Required": false
    },
    "Details": {
      "StringValue": "Install new Aircons for client A. Testing ",
      "Name": "Details",
      "Visible": true,
      "Disabled": false,
      "Required": false
    },
    "CurrencyValid": true,
    "Company": {
      "SelectedValue": "747",
      "Visible": true,
      "Disabled": false,
      "Required": false
    },
    "ChargeType": {
      "SelectedValue": "QUOT",
      "Visible": true,
      "Disabled": false,
      "Required": false
    },
    "InvoiceType": {
      "SelectedValue": "IT02",
      "Visible": true,
      "Disabled": false,
      "Required": false
    },
    "CurrencyCode": {
      "SelectedValue": "NZD",
      "Visible": true,
      "Disabled": false,
      "Required": false
    },
    "ScheduleCode": {
      "Visible": true,
      "Disabled": false,
      "Required": false
    },
    "ActivityGroup": {
      "SelectedValue": "BTGRP",
      "Visible": true,
      "Disabled": false,
      "Required": false
    },
    "UseGST": {
      "BoolValue": true,
      "Name": "BoolValue",
      "Visible": true,
      "Disabled": false,
      "Required": false
    }
  },
  "Attributes": {
    "Rows": []
  },
  "ToDoItems": {},
  "Notes": {},
  "Reporting": {
    "ParameterName": "JobCode",
    "ParameterValue": "BTJ-Q"
  },
  "Datasheets": {}
}

Sample of JobDetailApi POST

Click to view

Request

Response

JobApiModel {
Key (GeneralJobKey, optional),
Main (GeneralJobMainFields, optional),
Attributes (JobApiFields_GeneralAttributeLine, optional),
ToDoItems (JobApiFields_GeneralToDoLine, optional),
Notes (JobApiFields_GeneralNoteLine, optional),
Reporting (JobApiReportsFields, optional),
Datasheets (JobApiFields_DatasheetsDatasheetModelLine, optional),
ValidationErrors (Array[MvcValidationError], optional)
}
GeneralJobKey {
JobCode (string, optional)
}
GeneralJobMainFields {
JobCode (StringViewData, optional),
Description (StringViewData, optional),
JobLevel (StringViewData, optional),
ParentJob (StringViewData, optional),
Client (StringViewData, optional),
ProfitCentre (PickerViewData, optional),
JobManager (PickerViewData, optional),
AccountManager (PickerViewData, optional),
PriceCode (PickerViewData, optional),
JobType (PickerViewData, optional),
JobStatus (PickerViewData, optional),
Closed (BoolViewData, optional),
ClosedSubJobs (BoolViewData, optional),
Finalised (BoolViewData, optional),
FinalisedSubJobs (BoolViewData, optional),
Details (StringViewData, optional),
CurrencyValid (boolean, optional),
Company (PickerViewData, optional),
ChargeType (PickerViewData, optional),
InvoiceType (PickerViewData, optional),
CurrencyCode (PickerViewData, optional),
ScheduleCode (PickerViewData, optional),
ActivityGroup (PickerViewData, optional),
UseGST (BoolViewData, optional),
CreatedDate (DateViewData, optional)
}
JobApiFields_GeneralAttributeLine {
Rows (Array[GeneralAttributeLine], optional)
}
JobApiFields_GeneralToDoLine {
Rows (Array[GeneralToDoLine], optional)
}
JobApiFields_GeneralNoteLine {
Rows (Array[GeneralNoteLine], optional)
}
JobApiReportsFields {
ParameterName (string, optional),
ParameterValue (string, optional)
}
JobApiFields_DatasheetsDatasheetModelLine {
Rows (Array[DatasheetsDatasheetModelLine], optional)
}
MvcValidationError {
n (string, optional),
m (string, optional)
}
StringViewData {
StringValue (string, optional),
Name (string, optional),
Visible (boolean, optional),
Disabled (boolean, optional),
Required (boolean, optional)
}
PickerViewData {
SelectedValue (string, optional),
SelectedText (string, optional),
Name (string, optional),
Visible (boolean, optional),
Disabled (boolean, optional),
Required (boolean, optional),
InfoText (string, optional)
}
BoolViewData {
BoolValue (boolean, optional),
Name (string, optional),
Visible (boolean, optional),
InfoText (string, optional)
}
DateViewData {
DateValue (string, optional),
Name (string, optional),
Visible (boolean, optional),
Disabled (boolean, optional),
Required (boolean, optional),
InfoText (string, optional)
}
GeneralAttributeLine {
Category (string, optional),
Group (string, optional),
CategoryValue (CellData, optional),
GroupValue (CellData, optional),
Value (CellData, optional),
Delete (CellData, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (GeneralAttributeKey, optional),
CurrentKey (GeneralAttributeKey, optional),
Key (GeneralAttributeKey, optional),
Index (integer, optional)
}
GeneralToDoLine {
Description (string, optional),
Details (string, optional),
NoteTypeId (integer, optional),
NoteType (string, optional),
NoteStatusId (integer, optional),
NoteStatus (string, optional),
DoById (integer, optional),
CreatedByID (integer, optional),
DoBy (string, optional),
KeyTable (string, optional),
EntityDescription (string, optional),
DoByDate (string, optional),
Completed (boolean, optional),
Select (CellData, optional),
DescriptionValue (CellData, optional),
DetailsValue (CellData, optional),
NoteTypeValue (CellData, optional),
NoteStatusValue (CellData, optional),
DoByValue (CellData, optional),
EntityValue (CellData, optional),
EntityDescriptionValue (CellData, optional),
DoByDateValue (CellData, optional),
CompletedValue (CellData, optional),
Delete (CellData, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (GeneralToDoKey, optional),
CurrentKey (GeneralToDoKey, optional),
Key (GeneralToDoKey, optional),
Index (integer, optional)
}
GeneralNoteLine {
Description (string, optional),
Details (string, optional),
NoteTypeId (integer, optional),
NoteType (string, optional),
CreatedById (integer, optional),
CreatedBy (string, optional),
CreatedDate (string, optional),
KeyTable (string, optional),
EntityDescription (string, optional),
Select (CellData, optional),
DescriptionValue (CellData, optional),
DetailsValue (CellData, optional),
NoteTypeValue (CellData, optional),
CreatedByValue (CellData, optional),
CreatedDateValue (CellData, optional),
EntityValue (CellData, optional),
EntityDescriptionValue (CellData, optional),
Delete (CellData, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (GeneralNoteKey, optional),
CurrentKey (GeneralNoteKey, optional),
Key (GeneralNoteKey, optional),
Index (integer, optional)
}
DatasheetsDatasheetModelLine {
Datasheet (CellData, optional),
Template (CellData, optional),
Date (string, optional),
Name (string, optional),
KeyTable (string, optional),
Subject (string, optional),
Rating (number, optional),
Complete (boolean, optional),
JSON (string, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (DatasheetsDatasheetKey, optional),
CurrentKey (DatasheetsDatasheetKey, optional),
Key (DatasheetsDatasheetKey, optional),
Index (integer, optional)
}
CellData {
CellId (string, optional),
CellValue (string, optional),
CellNumValue (number, optional),
CellBoolValue (boolean, optional),
CellTag (string, optional),
CellValueDate (string, optional),
CellValueInt (integer, optional)
}
GeneralAttributeKey {
Category (string, optional),
Group (string, optional)
}
GeneralToDoKey {
ToDoNoteId (integer, optional),
KeyTable (string, optional)
}
GeneralNoteKey {
ToDoNoteId (integer, optional),
KeyTable (string, optional),
GridId (string, optional)
}
DatasheetsDatasheetKey {
DatasheetId (integer, optional),
DatasheetTemplateId (integer, optional),
KeyStr (string, optional),
KeyInt (integer, optional)
}

Job

Overview

Endpoints

JobBudgetDetailApi

DELETE Parameters

GET Parameters

POST Parameters

JobBudgetListApi

JobDetailApi

GET Parameters

JobListApi

JobMaintenanceApi - here

GET Parameters

Models

BudgetBudgetLine

BudgetBudgetLineKey

BudgetJobBudgetLine

BudgetBudgetSubLine

BudgetBudgetSubLineKey

BudgetJobBudgetKey

GeneralJobKey

GeneralJobLine

GeneralJobMainFields

JobsAddressesFields

JobApiFields_DatasheetsDatasheetModelLine

JobApiFields_GeneralAttributeLine

JobApiFields_GeneralToDoLine

JobApiFields_GeneralNoteLine

JobApiModel

JobApiReportsFields

JobsBillingFields

JobBudgetApiModel

JobsContractFields

JobsDocketCostSchedulesFields

JobsDocketCostScheduleKey

JobsDocketCostScheduleLine

JobsGeneralFields

JobsJobFields

JobsJobGroupsFields

JobsJobGroupKey

JobsJobGroupLine

JobsJobSchedulesFields

JobsJobScheduleKey

JobsJobScheduleLine

JobsJobWorkCentresFields

JobsJobWorkCentreKey

JobsJobWorkCentreLine

JobMaintenanceApiModel

JobsMaintenanceKey

JobsReferencesFields

JobsStandardOutputsFields

JobsStandardOutputKey

JobsStandardOutputLine

JobsWizardFields

Examples

Example of JobBudgetDetailApi DELETE

Request

Response

Response sample

Sample of JobBudgetDetailApi GET

Request

Response

Response sample

Sample of JobBudgetDetailApi POST

Request

Response

Response sample

Sample of JobDetailApi DELETE

Request

Response

Response sample

Sample of getting details of a job

Request

Response

Response sample

Sample of JobDetailApi POST

Request

Response

Response sample

Sample of JobMaintenanceApi GET