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.