Overview

Provides access to Job and Job Budget data.

Endpoints

The resources available in this module.

JobListApi

Provides API access to the Jobs (#/General/JobList.aspx) Web Workbench screen.

/api/JobListApi

/api/JobListApi

Method

Performed As

Request Query

Request Body

Response

POST

Retrieve a filtered list of Jobs.

Logged in User

-

GridRequestParametersApi

GridResult<JobLine>

JobDetailApi

Provides API access to the Job detail (#/General/JobList.aspx) dialog Web Workbench screen.

/api/JobDetailApi

/api/JobDetailApi

Method

Performed As

Request Query

Request Body

Response

GET
Retrieve a specific Job.

Admin User

JobKey

-

JobApiModel

POST

Update an existing Job, or create a new Job.

Admin User

-

JobApiModel

JobMaintenanceApi

Provides API access to the Job maintenance (#/General/JobList.aspx) dialog Web Workbench screen .

/api/JobMaintenanceApi

/api/JobMaintenanceApi
Method	Performed As	Request Query	Request Body	Response
GET Retrieve a specific Job (including Job Work Centres and Job Groups).	Admin User	JobMaintenanceKey	-	JobMaintenanceApiModel
POST Update an existing Job.	Admin User	-	JobMaintenanceApiModel	JobMaintenanceApiModel

JobBudgetListApi

Provides API access to the Job Budget List (#/General/JobList.aspx/JobBudgetList) Web Workbench screen.

/api/JobBudgetListApi

/api/JobBudgetListApi
Method	Performed As	Request Query	Request Body	Response
POST Retrieve a filtered list of Job Budgets, for a specific Job.	Logged in User	-	GridRequestParametersApi (StringValue is required as a Job Code)	GridResult<JobBudgetLine>

JobBudgetDetailApi

Provides API access to the Job Budget detail Web Workbench screen.

/api/JobBudgetDetailApi

/api/JobBudgetDetailApi
Method	Performed As	Request Query	Request Body	Response
GET Retrieve a specific Job Budget	Admin User	JobBudgetKey	-	JobBudgetApiModel
POST Update an existing, or create a new, Job Budget	Admin User	-	JobBudgetApiModel	JobBudgetApiModel
DELETE Delete a specific Job Budget	Admin User	-	JobBudgetKey	JobBudgetApiModel

Models

The definitions of models specific to endpoints in this module.

JobKey

Property	Type	Description

Property	Type	Description
JobCode	String	The unique Code of the Job.

Back to top

JobLine

Property	Type	Description

Property	Type	Description
Key	JobKey	The unique key for the line.
JobCode	String	The unique Code of the Job.
JobCodeValue	CellData	The unique Code of the Job.
Description	String	The description of the Job.
DescriptionValue	CellData	The description of the Job.
CodeDescription	String	The Job Code and Description.
Company	String	The name of the client Company for this Job.
CompanyId	Integer	The unique ID of the client Company.
CompanyValue	CellData	The client Company for this Job.
Level	Integer	The tier or hierarchy that this Job or Subjob was created at. Jobs can be 5 levels deep.
LevelValue	CellData	The tier or hierarchy that this Job or Subjob was created at. Jobs can be 5 levels deep.
JobLevel	Integer	The tier or hierarchy that this Job or Subjob was created at. Jobs can be 5 levels deep.
FinancialCompany	String	The Financial Company of the Job.
ProfitCentre	String	The Profit Centre Code this Job sits under.
ProfitCentreDescription	String	Profit Centre description.
ProfitCentreValue	CellData	The Profit Centre this Job sits under.
Finalised	Boolean	The Finalised flag on the Job.
OpenClosed	String	Either “Finalised”, “Closed”, or “Open”.
OpenClosedCode	Integer	Either 3 (finalised), 2 (closed), or 1 (open).
OpenClosedValue	CellData	Either “Finalised”, “Closed”, or “Open”.
Status	String	The Job Status.
StatusValue	CellData	The Job Status
JobManager	String	The name of the Job Manager.
JobManagerId	Integer	The ID of the Job Manager.
JobManagerValue	CellData	The person nominated to be the central manager of the Job.
AccountManager	String	The name of the Account Manager.
AccountManagerId	Integer	The ID of the Account Manager.
AccountManagerValue	CellData	The person nominated to be the manager of the client account for the Job.
JobType	String	The category that this Job is assigned to.
JobTypeValue	CellData	The Job Type
ChargeType	String	The Charge Type of the job.
ChargeTypeValue	CellData	The Charge type of the job.
HasContract	Boolean	The flag to indicate if the Job has a contract.
HasContractValue	CellData	The flag to indicate if the Job has a contract.
HasSubcontract	Boolean	The flag to indicate if the Job has any subcontracts.
JobScheduler	Integer	The flag to indicate if the Job requires scheduling, enabling this job to be used with the Datasheet Scheduling module.
SyncUpvise		Sync Upvise.
JobSiteAddressID	Integer	the ID of the Site Address of the Job.
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	The Asset Reference on the Job.
CreatedDate	String	The date the Job was created.
FinalisedDate	String	The date the Job was finalised.
StartDate	String	The date the Job was started.
CompletedDate	String	The date the Job was completed.
HierarchyCode1	String	The HierarchyCode1 of the Job.
HierarchyCode2	String	The HierarchyCode2 of the Job.
HierarchyCode3	String	The HierarchyCode3 of the Job.
HierarchyCode4	String	The HierarchyCode4 of the Job.
HierarchyCode5	String	The HierarchyCode5 of the Job.
HierarchyCode6	String	The HierarchyCode6 of the Job.
Group1	String	The Attribute Group of the first Attribute Category filter
Group2	String	The Attribute Group of the second Attribute Category filter
Group3	String	The Attribute Group of the third Attribute Category filter
UpdatedDate	String	The Date this record was last updated.

Back to top

JobApiModel

Property	Type	Description

Property	Type	Description
Key	JobKey	The unique key of the Job.
Main	JobMainFields	General data associated with the Job.
Attributes.Rows	Array<AttributeLine>	Attributes associated with the Job.
Notes.Rows	Array<NoteLine>	Notes associated with the Job.
ToDoItems.Rows	Array<ToDoLine>	To Do Items associated with the Job.
Datasheets.Rows	Array<DatasheetModelLine>	Datasheets associated withe the Job.
ValidationErrors	Array<MvcValidationError>	A list of specific validation errors if the save was unsuccessful.

Back to top

JobMainFields

Property	Type	Description

Property	Type	Description
JobCode	StringViewData	The unique Code of the Job.
Description	StringViewData	The Description of the Job.
JobLevel	StringViewData	The Job level
ParentJob	StringViewData	The Parent Job.
Client	StringViewData	The Client of the Job.
ProfitCentre	PickerViewData	The Profit Centre that Job sits under.
JobManager	PickerViewData	The Job Manager.
AccountManager	PickerViewData	The Account Manager.
PriceCode	PickerViewData	The Price code.
JobType	PickerViewData	The Job type.
JobStatus	PickerViewData	The Job status.
Closed	BoolViewData	The Closed flag.
ClosedSubJobs	BoolViewData	(Used with Closed) The flag to indicate if the Sub-Jobs should be closed/unclosed as well.
Finalised	BoolViewData	The Finalised flag.
FinalisedSubJobs	BoolViewData	(Used with Finalised) The flag to indicate if the Sub-Jobs should be finalised/unfinalised as well.
Details	StringViewData	The Details of the Job.
Company	PickerViewData	The Client Company.
ChargeType	PickerViewData	The Charge type.
InvoiceType	PickerViewData	The Invoice Type.
CurrencyCode	PickerViewData	The Currency Code.
ScheduleCode	PickerViewData	The Schedule Code.
ActivityGroup	PickerViewData	The Activity Group.
UseGST	BoolViewData	The flag to indicate if the Job uses tax.
CreatedDate	DateViewData	The date the Job was created.

Back to top

JobMaintenanceKey

Property	Type	Description

Property	Type	Description
JobCode	String	The unique Code of the Job.

Back to top

JobMaintenanceApiModel

Property	Type	Description

Property	Type	Description
Key	JobMaintenanceKey	The unique key of the Job.
JobFields	JobFields	Data associated with the Job.
ValidationErrors	Array<MvcValidationError>	A list of specific validation errors if the save was unsuccessful.

Back to top

JobFields

Property	Type	Description

Property	Type	Description
JobCode	String	The unique Code of the Job.
ContractCode	String	The Code of the Contract of the Job.
HasContract	Boolean	A flag to indicate if the Job has a Contract.
CurrencyValid	Boolean	A flag to indicate if the Job’s Price Code is valid for its Currency.
GeneralFields	GeneralFields	General data associated with the Company.
Extensions	ExtensionFields	Extension data associated with the Company.
BillingFields	BillingFields	Billing data associated with the Company.
ReferencesFields	ReferencesFields	Reference data associated with the Company.
AddressesFields	AddressesFields	Address data associated with the Company.
JobGroupsFields.Rows	Array<JobGroupLine>	Job Groups associated with the Company.
JobWorkCentresFields.Rows	Array<JobWorkCentreLine>	Job Work Centres associated with the Company.
JobSchedulesFields.Rows	Array<JobScheduleLine>	Job Schedules associated with the Company.
DocketCostSchedulesFields.Rows	Array<DocketCostScheduleLine>	Docket Cost Schedules associated with the Company.
StandardOutputsFields.Rows	Array<StandardOutputLine>	Standard Outputs associated with the Company.

Back to top

GeneralFields

Property	Type	Description

Property	Type	Description
Name	StringViewData	The Description of the Job.
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	Job type
Contract	StringViewData	Job contract
ParentJob	PickerViewData	Parent job.
JobHierarchy	StringViewData	The hierachy.
JobLevel	StringViewData	Job level.
JobStatus	DropDownViewData	Job status.
CostActivityGroup	PickerViewData	Cost activity group.
BudgetActivityGroup	PickerViewData	Budget Activity Group
ForecastActivityGroup	PickerViewData	Forecast Activity Group
BillingCurrency	PickerViewData	Currency for billing
StockLocation	PickerViewData	Stock location.
CheckAgainstBudget	DropDownViewData	Either 0 (No check), 1 (Warn if no budget), or 2 (Enforce budget).
JobDetails	StringViewData	Details
UseGst	BoolViewData	Use tax or not.
AdminJob	BoolViewData	Admin job or not.
ReqSched	BoolViewData	Required Schedule.
TemplateCode	String	Job template code.

Back to top

BillingFields

Property	Type	Description

Property	Type	Description
PriceCode	PickerViewData	Price code
ChargeType	PickerViewData	Charge type.
WipCode	PickerViewData	WIP code
InvoiceType	PickerViewData	Invoice type.
ClientCreditStatus	StringViewData	Client credit status.
JobValue	DecimalViewData	How much the Job is to be billed to the client
DrAccount	StringViewData	Debit account
CrAccount	StringViewData	Credit account
InvoiceTitle	StringViewData	Custom invoice title.
InvoiceText	StringViewData	Custom invoice text
EmployeeAgreementScheme	DropdownViewData	Employee Agreement Scheme
EbaTags	MultiPickerViewData	EBA tag
LabourCostingGroup	DropdownViewData	Labour Costing Group
ForecastRevenue	BoolViewData	Forecast revenuce
ChargeToJob	PickerViewData	The Charge To Job
ChargeToActivity	PickerViewData	The Charge To Activity
ChargeToLog	PickerViewData	The Charge To Log
AllowInternalSales	Boolean	Internal sale status.

Back to top

ReferencesFields

Property	Type	Description

Property	Type	Description
OrderNumber	StringViewData	Order number
JobReference	StringViewData	Job reference
ClientReference	StringViewData	Client reference
QuoteReference	StringViewData	Quote reference
AssetReference	StringViewData	Asset reference
CreatedDate	StringViewData	Created date
StartDate	DateViewData	Start date.
ClosedDate	DateViewData	Closed date
RequiredDate	DateViewData	Required date
ExpectedDate	DateViewData	Expected date
FinalisedDate	DateViewData	Finalised date
Asset	PickerViewData	Asset related.

Back to top

AddressesFields

Property	Type	Description

Property	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.

Back to top

JobGroupKey

Property	Type	Description

Property	Type	Description
Job	String	The Job Code
Category	String	The Job Category
Group	String	The Job Group Code

Back to top

JobGroupLine

Property	Type	Description

Property	Type	Description
Key	JobGroupKey	The unique key of the line.
Category	CellData	The Job Category.
Group	CellData	The Job Group.
Value	CellData	The value of the Job Group Line.

Back to top

JobWorkCentreKey

Property	Type	Description

Property	Type	Description
JobCode	String	The Job Code.
WorkCentreCode	String	The Work Centre Code.

Back to top

JobWorkCentreLine

Property		Type

Property		Type
Key	JobWorkCentreKey	The unique key of the line.
Job	CellData	Job
WorkCentre	CellData	Work Centre.
Description	CellData	Description.
BalanceOfBudget	CellData	Balance of budget.
CashflowByActivity	CellData	Cashflow by activity.
Closed	Boolean	Closing status.
Complete	Boolean	Complete status.
StartDate	String	Start date.
EndDate	String	End date.

Back to top

JobScheduleKey

Property	Type	Description

Property	Type	Description
Job	String	The Job Code.
Schedule	String	The Schedule Code.

Back to top

JobScheduleLine

Property	Type	Description

Property	Type	Description
Key	JobScheduleKey	The unique key of the line.
Schedule	CellData	The Job Schedule.
Type	CellData	The Schedule Type.

Back to top

DocketCostScheduleKey

Property	Type	Description

Property	Type	Description
Job	String	The Job Code.
Catalogue	Integer	The Catalogue ID.

Back to top

DocketCostScheduleLine

Property	Type	Description

Property	Type	Description
Key	DocketCostScheduleKey	The unique key of the line.
Catalogue	CellData	Supplier catalogue.
ActivityGroup	CellData	Activity group

Back to top

StandardOutputKey

Property	Type	Description

Property	Type	Description
StandardOutputId	Integer	The ID of the Schedule Output.
JobCode	String	The Job Code.
ScheduleCode	String	The Schedule Code.
OutputCode	String	The Schedule Output Code.
ScheduleOutputRate	Number	The Rate of the Schedule Output.

Back to top

StandardOutputLine

Property	Type	Description

Property	Type	Description
Key	StandardOutputKey	The unique key of the line.
FixedRate	Boolean	Fixed Rate
ScheduleCode	CellData	Schedule code
OutputCode	CellData	Output code
Description	CellData	Description.
Unit	CellData	Unit measurements
Rate	CellData	Rate
Quantity	CellData	Quantity
Amount	CellData	Amount
SpecialRate	CellData	Special rate

Back to top

JobBudgetKey

Property	Type	Description

Property	Type	Description
JobCode	String	The Code of Job.
EstimateId	Integer	The ID of the Job Budget.

Back to top

JobBudgetLine

Property	Type	Description

Property	Type	Description
Key	JobBudgetKey	The unique key for the line.
BudgetOrder	Integer	The Sequence Number of the line.
BudgetType	String	Budget type
BudgetTypeValue	CellData	Budget type
BudgetHeader	String	The Job Code and Description.
BudgetHeaderValue	CellData	The Job Code and Description.
InternalReference	String	The sequence number that defines what the variation relates to. More details
InternalReferenceValue	CellData	Internal reference
ClientReference	String	To label the budget something that your external stakeholders refer to it as.
ClientReferenceValue	CellData	Client reference
Description	Description	Description text.
DescriptionValue	CellData	Description text.
Year	Integer	Year
Period	Integer	Financial period
YearPeriodIndex	Integer	The unique index of the Year/Period of the Batch.
YearPeriodValue	CellData	Year period.
EstimateDate	String	Estimated date.
EstimateDateValue	CellData	Estimated date.
CostRate	Number	Cost rate.
CostRateValue	CellData	Cost rate
Cost	Number	is the Qty multiplied by the Cost Rate field.
CostValue	CellData	Cost.
RetailRate	Number	The total Local Currency retail rates of the underlying budget lines.
RetailRateValue	CellData	Retail rate
Revenue	Number	the total Local Currency revenue amount of all underlying lines that this budget contains.
RevenueValue	CellData	Revenue
Approved	Boolean	Approval status.
ApprovedDate	String	Approved date.
ApprovedDateValue	CellData	Approved date.

Back to top

JobBudgetApiModel

Property	Type	Description

Property	Type	Description
Key	JobBudgetKey	The unique key of the Job Budget.
Rows	Array<BudgetLine>	The Budget lines
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.
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>	A list of specific validation errors if the save was unsuccessful.

Back to top

BudgetLineKey

Field	Type	Description

Field	Type	Description
ParentLine	Integer	Code of parent line.
ChildLine	Integer	Code of child line.
EstimateId	Integer	The ID of the Job Budget.
EstimateLineId	Integer	The ID of the Job Budget Line.
JobCode	String	The Job Code.
ActivityCode	String	The Code of the Activity.
WorkCentreCode	String	The Code of Work Centre of the line.
Type	String	The Line Type.
LineCode	String	The Line Code.
UseRate	Boolean	A flag to indicate if the line uses a Markup.

Back top top

BudgetLine

Property	Type	Description

Property	Type	Description
Key	BudgetLineKey	The unique key of the line.
Approved	CellData	A flag to approve the line.
SequenceNo	CellData	The Sequence Number.
JobCode	CellData	Code of the job.
BudgetType	CellData	Type of the budget.
Type	CellData	The 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	Sell value.
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.

Back to top

BudgetSubLineKey

Property	Type	Description

Property	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

Back to top

BudgetSubLine

Property	Type	Description

Property	Type	Description
Key	BudgetBudgetSubLineKey	The unique key of the line.
Approved	CellData	Approval status.
SequenceNo	CellData	The Sequence Number.
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.
Details	CellData	Explanation or comment text.
YearNo	CellData	The Year No.
PeriodNo	CellData	Number of financial period.

Back to top

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

Sample of JobMaintenanceApi GET

Sample of JobMaintenanceApi POST

Back to top

On this page

1 Overview
2 Endpoints
- 2.1 JobListApi
- 2.2 JobDetailApi
- 2.3 JobMaintenanceApi
- 2.4 JobBudgetListApi
- 2.5 JobBudgetDetailApi
3 Models
- 3.1 JobKey
- 3.2 JobLine
- 3.3 JobApiModel
- 3.4 JobMainFields
- 3.5 JobMaintenanceKey
- 3.6 JobMaintenanceApiModel
- 3.7 JobFields
- 3.8 GeneralFields
- 3.9 BillingFields
- 3.10 ReferencesFields
- 3.11 AddressesFields
- 3.12 JobGroupKey
- 3.13 JobGroupLine
- 3.14 JobWorkCentreKey
- 3.15 JobWorkCentreLine
- 3.16 JobScheduleKey
- 3.17 JobScheduleLine
- 3.18 DocketCostScheduleKey
- 3.19 DocketCostScheduleLine
- 3.20 StandardOutputKey
- 3.21 StandardOutputLine
- 3.22 JobBudgetKey
- 3.23 JobBudgetLine
- 3.24 JobBudgetApiModel
- 3.25 BudgetLineKey
- 3.26 BudgetLine
- 3.27 BudgetSubLineKey
- 3.28 BudgetSubLine
4 Examples