- Created by Bao TRINH, last modified by Cam Mackay on Jul 15, 2024
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 12 Next »
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 | ||||
|---|---|---|---|---|
Method | Performed As | Request Query | Request Body | Response |
POST Retrieve a filtered list of Jobs. | Logged in User | - | ||
JobDetailApi
Provides API access to the Job detail (#/General/JobList.aspx) dialog Web Workbench screen.
/api/JobDetailApi | ||||
|---|---|---|---|---|
Method | Performed As | Request Query | Request Body | Response |
GET | Admin User | - | ||
POST Update an existing Job, or create a new Job. | Admin User | - | ||
JobMaintenanceApi
Provides API access to the Job maintenance (#/General/JobList.aspx) dialog Web Workbench screen .
/api/JobMaintenanceApi | ||||
|---|---|---|---|---|
Method | Performed As | Request Query | Request Body | Response |
GET | Admin User | - | ||
POST | Admin User | - | ||
JobBudgetListApi
Provides API access to the Job Budget List (#/General/JobList.aspx/JobBudgetList) Web Workbench screen.
/api/JobBudgetListApi | ||||
|---|---|---|---|---|
Method | Performed As | Request Query | Request Body | Response |
POST | Logged in User | - | GridRequestParametersApi (StringValue is required as a Job Code) | |
JobBudgetDetailApi
Provides API access to the Job Budget detail Web Workbench screen.
/api/JobBudgetDetailApi | ||||
|---|---|---|---|---|
Method | Performed As | Request Query | Request Body | Response |
GET Retrieve a specific Job Budget | Admin User | - | ||
POST Update an existing, or create a new, Job Budget | Admin User | - | ||
DELETE Delete a specific Job Budget | Admin User | - | ||
Models
The definitions of models specific to endpoints in this module.
BudgetBudgetLine
Property | Type | Description |
|---|---|---|
Approved | ||
SequenceNo | ||
JobCode | Code of the job. | |
BudgetType | ||
Type | ||
LineCode | Code of the line. | |
LineRef | Line reference. | |
PlantRate | Rates of the selected plant. | |
ActivityCode | Code of Activity. | |
ActivityType | Type of Activity. | |
WorkCentreCode | Code of Work Centre of the line. | |
YearPeriod | The financial year and period in which this budget was created. | |
Description | Description text. | |
Unit | The unit of measurement for the line. | |
Quantity | the quantity of units being budgeted. | |
CostRate | Cost rate. | |
Cost | 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 | Sell value. | |
SellingRate | Sell rate. | |
Markup | Default value will be based on the configured Markup or Sell Rate for the specific context of the line type. | |
FCRetailRate | the Foreign Currency Retail Rate if Foreign Currency is used. | |
FCRevenue | is the Qty multiplied by the FC Retail Rate field | |
PoNumber | Related Purchase Order number | |
Details | Explanation or comment text. | |
SubGridResult | GridResult_BudgetBudgetSubLine | |
Delete | ||
Status | String | |
ReadonlyFlag | Integer | |
ReadonlyMessage | ||
OriginalKey | ||
CurrentKey | ||
Key | ||
Index | Integer |
⬆️ Back to top
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 |
⬆️ Back top top
BudgetJobBudgetLine
Property | Type | Description |
|---|---|---|
BudgetOrder | Integer | |
BudgetHeader | String | |
BudgetType | String | |
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 | Estimated date. |
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 | Approval status. |
ApprovedDate | String | Approved date. |
Select | ||
BudgetTypeValue | Budget type | |
BudgetHeaderValue | Budger header | |
InternalReferenceValue | Internal reference | |
ClientReferenceValue | Client reference | |
DescriptionValue | Description text. | |
YearPeriodValue | Year period. | |
EstimateDateValue | ||
CostRateValue | Cost rate | |
CostValue | Cost. | |
RetailRateValue | Retail rate | |
RevenueValue | Revenue | |
ApprovedDateValue | Approval date. | |
Status | String | |
ReadonlyFlag | Boolean | Read Only status. |
ReadonlyMessage | String | Read Only message. |
OriginalKey | ||
CurrentKey | ||
Key | ||
Index | Integer |
⬆️ Back to top
BudgetBudgetSubLine
Property | Type | Description |
|---|---|---|
Approved | Approval status. | |
SequenceNo | ||
JobCode | Code of the job. | |
Type | The cost element is being used for this line. | |
LineCode | Code of the line | |
LineRef | Line reference. | |
PlantRate | Plant Rate if applied. | |
ActivityCode | Activity code of the line. | |
ActivityType | Activity type of the line. | |
WorkCentreCode | Code of the Work Centre of the line | |
YearPeriod | The financial year and period in which this budget was created. | |
Description | Description text. | |
Unit | The unit of measurement for the line | |
Quantity | The quantity of units being budgeted | |
CostRate | Cost rate. | |
Cost | is the Qty multiplied by the Cost Rate field. | |
Fix | Boolean | Data won’t be changed. |
SellingRate | Selling rate. | |
Markup | default value will be based on the configured Markup or Sell Rate for the specific context of the line type. | |
FCRetailRate | The Foreign Currency Retail Rate. | |
FCRevenue | is the Qty multiplied by the FC Retail Rate field. | |
PoNumber | ||
Details | Explanation or comment text. | |
Delete | ||
YearNo | ||
PeriodNo | Number of financial period. | |
Status | String | |
ReadonlyFlag | Integer | |
ReadonlyMessage | String | |
OriginalKey | ||
CurrentKey | ||
Key | ||
Index | Integer |
⬆️ Back to top
BudgetBudgetSubLineKey
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 |
⬆️ Back to top
BudgetJobBudgetKey
Property | Type | Description |
|---|---|---|
JobCode | String | Code of job. |
EstimateId | Integer | |
BomQuantity | Number |
⬆️ Back to top
GeneralJobKey
Property | Type | Description |
|---|---|---|
JobCode | String | Code of job. |
⬆️ Back to top
GeneralJobLine
Property | 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 | ||
JobCodeValue | Job code | |
DescriptionValue | Job description | |
CompanyValue | The client Company for this Job. | |
LevelValue | The job level | |
ProfitCentreValue | The Profit Centre this Job sits under. | |
OpenClosedValue | ||
StatusValue | Job status | |
JobManagerValue | Job manager | |
AccountManagerValue | Account mananger | |
JobTypeValue | Job type | |
ChargeTypeValue | Charge type of the job. | |
HasContractValue | Does the job have a contract or not. | |
Group1 | String | |
Group2 | String | |
Group3 | String | |
UpdatedDate | String | Updated date |
ReadonlyFlag | Integer | |
ReadonlyMessage | String | |
OriginalKey | ||
CurrentKey | ||
Key | ||
Index | Integer |
⬆️ Back to top
GeneralJobMainFields
Property | Type | Description |
|---|---|---|
JobCode | Code of the job. | |
Description | Description text. | |
JobLevel | Job level | |
ParentJob | Parent job if applied. | |
Client | The Client of the job. | |
ProfitCentre | The Profit Centre that Job sits under. | |
JobManager | Job manager person. | |
AccountManager | Account manager person. | |
PriceCode | ||
JobType | ||
JobStatus | Job status. | |
Closed | Closed status. | |
ClosedSubJobs | ||
Finalised | Job finalised status. | |
FinalisedSubJobs | ||
Details | Details text. | |
CurrencyValid | Boolean | Currency. |
Company | Client comany. | |
ChargeType | ||
InvoiceType | Invoice type. | |
CurrencyCode | Code of using currency. | |
ScheduleCode | Schedule code. | |
ActivityGroup | Activity group. | |
UseGST | Use tax or not. | |
CreatedDate | Created date. |
⬆️ Back to top
JobsAddressesFields
Property | Type | Description |
|---|---|---|
BillingAddress | The client company's billing address. | |
SiteAddress | The client company's Site address. | |
SiteAddressDetails | Site Address details. | |
BillingContact | The client company's billing contact. | |
SiteContact | Site contact person. | |
StreetLine1 | Part of street address. | |
StreetLine2 | Part of street address. | |
Suburb | Part of street address. | |
City | Part of street address. | |
State | Part of street address. | |
Country | Part of street address. | |
PostCode | Post code of the address. |
⬆️ Back to top
JobApiFields_DatasheetsDatasheetModelLine
Property | Type | Description |
|---|---|---|
Row | Array [DatasheetsDatasheetModelLine] |
⬆️ Back to top
JobApiFields_GeneralAttributeLine
Property | Type | Description |
|---|---|---|
Row | Array [GeneralAttributeLine] |
⬆️ Back to top
JobApiFields_GeneralToDoLine
Property | Type | Description |
|---|---|---|
Row | Array [GeneralToDoLine] |
⬆️ Back to top
JobApiFields_GeneralNoteLine
Property | Type | Description |
|---|---|---|
Row | Array [GeneralToDoLine] |
⬆️ Back to top
JobApiModel
Property | Type | Description |
|---|---|---|
Key | GeneralJobKey | |
Main | GeneralJobMainFields | |
Attributes | JobApiFields_GeneralAttributeLine | |
ToDoItems | JobApiFields_GeneralToDoLine | |
Notes | JobApiFields_GeneralNoteLine | |
Reporting | JobApiReportsFields | |
Datasheets | JobApiFields_DatasheetsDatasheetModelLine | |
ValidationErrors | Array [MvcValidationError] |
⬆️ Back to top
JobApiReportsFields
Property | Type | Description |
|---|---|---|
ParameterName | String | |
ParameterValue | String |
⬆️ Back to top
JobsBillingFields
Property | Type | Description |
|---|---|---|
PriceCode | Price code | |
ChargeType | ||
WipCode | ||
InvoiceType | Invoice type. | |
ClientCreditStatus | Client credit status. | |
JobValue | How much the Job is to be billed to the client | |
DrAccount | Debit account | |
CrAccount | Credit account | |
InvoiceTitle | Custom invoice title. | |
InvoiceText | Custom invoice text | |
EmployeeAgreementScheme | Employee Agreement Scheme | |
EbaTags | ||
LabourCostingGroup | Labour Costing Group | |
ForecastRevenue | Forecast revenuce | |
ChargeToJob | ||
ChargeToActivity | ||
ChargeToLog | ||
AllowInternalSales | Boolean | Internal sale status. |
⬆️ Back to top
JobBudgetApiModel
Property | Type | Description |
|---|---|---|
Key | ||
Rows | Array [BudgetBudgetLine] | |
BudgetType | ||
Job | Related job | |
Client | The client name. | |
Contact | Client contact who is responsible for the contract or variation. | |
Description | Description to define what the budget container represents | |
Details | Additional definition or explanation to the budget. | |
InternalReference | The sequence number that defines what the variation relates to, .More details | |
ClientReference | To label the budget something that your external stakeholders refer to it as | |
BudgetDate | The date that was entered as the creation date for this budget. | |
YearPeriod | The financial year and period in which this budget was created. | |
Currency | Defaults from the Contract Settings currency field | |
CurrencyRate | The manual exchange rate when dealing with foreign currency | |
CreatedBy | Created person. | |
Approved | The person who approved. | |
GridSort | ||
GridStructure | ||
BillOfMaterials | Bill of Material lines with the At Cost Element and At Revenue and Cost Element Input methods. | |
WorkflowType | The Workflow for approval purposes | |
ValidationErrors | Array [MvcValidationError] |
⬆️ Back to top
JobsContractFields
Property | Type | Description |
|---|---|---|
HaveContract | Job has contract or not. | |
Status | Job status. | |
BriefConfirmed | ||
ContractType | Type of contract. | |
RetentionType | Type of retention applied. | |
Site | The site address. | |
ForeignCurrency | The foreign currency. | |
ForeignCurrencyCode | ||
CurrencyRateType | ||
CurrencyRate | ||
NonContractBilling | ||
AncestorHasContract | Boolean |
⬆️ Back to top
JobsDocketCostSchedulesFields
Property | Type | Description |
|---|---|---|
Layout | Layour | |
Rows | Array [JobsDocketCostScheduleLine] |
⬆️ Back to top
JobsDocketCostScheduleKey
Property | Type | Description |
|---|---|---|
Job | String | Job |
Catalogue | Integer | Catalogue. |
⬆️ Back to top
JobsDocketCostScheduleLine
Property | Type | Description |
|---|---|---|
Catalogue | ||
ActivityGroup | Activity group | |
Delete | ||
Status | String | Status. |
ReadonlyFlag | Integer | |
ReadonlyMessage | String | |
OriginalKey | ||
CurrentKey | ||
Key | ||
Index | integer |
⬆️ Back to top
JobsGeneralFields
Property | Type | Description |
|---|---|---|
Name | ||
Company | The client of the job. | |
JobManager | The person nominated to be the central manager of the Job. | |
AccountManager | The person nominated to be the manager of the client account for the Job. | |
ProfitCentre | The Profit Centre the Job sits under. | |
JobType | Job type | |
Contract | ||
ParentJob | Parent job. | |
JobHierarchy | The hierachy. | |
JobLevel | Job level. | |
JobStatus | Job status. | |
CostActivityGroup | Cost activity group. | |
BudgetActivityGroup | Budget Activity Group | |
ForecastActivityGroup | Forecast Activity Group | |
BillingCurrency | Currency for billing | |
StockLocation | Stock location. | |
CheckAgainstBudget | ||
JobDetails | Details | |
UseGst | Use tax or not. | |
AdminJob | Admin job or not. | |
ReqSched | Required Schedule. | |
TemplateCode | String | Job template code. |
⬆️ Back to top
JobsJobFields
Property | Type | Description |
|---|---|---|
JobCode | String | Code of job. |
ContractCode | String | Code of the contract of the job. |
HasContract | Boolean | Id of the contract. |
CurrencyValid | Boolean | Call function. |
GeneralFields | Call function. | |
Extensions | Call function. | |
BillingFields | Call function. | |
ReferencesFields | Call function. | |
AddressesFields | Call function. | |
JobGroupsFields | Call function. | |
JobWorkCentresFields | Call function. | |
JobSchedulesFields | Call function. | |
DocketCostSchedulesFields | Call function. | |
StandardOutputsFields | Call function. |
⬆️ Back to top
JobsJobGroupsFields
Property | Type | Description |
|---|---|---|
Layout | Layout | |
Rows | Array [JobsJobGroupLine] |
⬆️ Back to top
JobsJobGroupKey
Property | Type | Description |
|---|---|---|
Job | String | Job |
Category | String | Category |
Group | String | Group |
⬆️ Back to top
JobsJobGroupLine
Property | Type | Description |
|---|---|---|
Category | Category. | |
Group | Group. | |
Value | Value. | |
Delete | ||
Status | String | Status |
ReadonlyFlag | Integer | Read Only status. |
ReadonlyMessage | String | Read Only message. |
OriginalKey | ||
CurrentKey | ||
Key | ||
Index | Index |
⬆️ Back to top
JobsJobSchedulesFields
Property | Type | Description |
|---|---|---|
Layout | Layout | |
Rows | Array [JobsJobScheduleLine] |
⬆️ Back to top
JobsJobScheduleKey
Property | Type | Description |
|---|---|---|
Job | String | Job |
Schedule | String | Schedule. |
⬆️ Back to top
JobsJobScheduleLine
Property | Type | Description |
|---|---|---|
Schedule | ||
Type | ||
Delete | ||
Status | ||
ReadonlyFlag | Integer | Read Only status. |
ReadonlyMessage | String | Read Only message. |
OriginalKey | ||
CurrentKey | ||
Key | ||
Index | Integer |
⬆️ Back to top
JobsJobWorkCentresFields
Property | Type | Description |
|---|---|---|
Layout | Layout | |
Rows | Array [JobsJobWorkCentreLine] |
⬆️ Back to top
JobsJobWorkCentreKey
Property | Type | Description |
|---|---|---|
JobCode | String | Job code. |
WorkCentreCode | String | Code of Work centre. |
⬆️ Back to top
JobsJobWorkCentreLine
Property | Type | Description | |
|---|---|---|---|
Job | Job | ||
WorkCentre | Work Centre. | ||
Description | Description. | ||
BalanceOfBudget | Balance of budget. | ||
CashflowByActivity | Cashflow by activity. | ||
Closed | Boolean | Closing status. | |
Complete | Boolean | Complete status. | |
StartDate | String | Start date. | |
EndDate | String | End date. | |
ExtensionFields | Extension fields | ||
Delete | |||
Status | String | ||
ReadonlyFlag | Integer | Read Only status. | |
ReadonlyMessage | String | Read Only message | |
OriginalKey | |||
CurrentKey | |||
Key | |||
Index | Integer |
⬆️ Back to top
JobMaintenanceApiModel
Property | Type | Description |
|---|---|---|
Key | ||
JobFields | Generate data fields. | |
WizardFields | Generate data fields. | |
ContractFields | Generate data fields. | |
ValidationErrors | Array [MvcValidationError] |
⬆️ Back to top
JobsMaintenanceKey
Property | Type | Description |
|---|---|---|
JobCode | String | Code of the job. |
JobDescription | String | Job description. |
QuoteID | Integer | Quote id. |
⬆️ Back to top
JobsReferencesFields
Property | Type | Description |
|---|---|---|
OrderNumber | Order number | |
JobReference | Job reference | |
ClientReference | Client reference | |
QuoteReference | Quote reference | |
AssetReference | Asset reference | |
CreatedDate | Created date | |
StartDate | Start date. | |
ClosedDate | Closed date | |
RequiredDate | Required date | |
ExpectedDate | Expected date | |
FinalisedDate | Finalised date | |
Asset | Asset related. |
⬆️ Back to top
JobsStandardOutputsFields
Property | Type | Description |
|---|---|---|
Layout | Layout | |
Rows | Array [JobsStandardOutputLine] |
⬆️ Back to top
JobsStandardOutputKey
Property | Type | Description |
|---|---|---|
StandardOutputId | Integer | |
JobCode | String | Job code |
ScheduleCode | String | Schedule code |
OutputCode | String | Output code |
ScheduleOutputRate | Number |
⬆️ Back to top
JobsStandardOutputLine
Property | Type | Description |
|---|---|---|
FixedRate | Boolean | Fixed Rate |
ScheduleCode | Schedule code | |
OutputCode | Output code | |
Description | Description. | |
Unit | Unit measurements | |
Rate | Rate | |
Quantity | Quantity | |
Amount | Amount | |
SpecialRate | Special rate | |
AuditDetails | Audit details | |
Delete | ||
Status | String | Status |
ReadonlyFlag | Integer | |
ReadonlyMessage | String | |
OriginalKey | JobsStandardOutputKey | |
CurrentKey | JobsStandardOutputKey | |
Key | JobsStandardOutputKey | |
Index | Integer |
⬆️ Back to top
JobsWizardFields
Property | Type | Description |
|---|---|---|
Level | Job level. | |
Name | Job name | |
Client | Client name | |
ParentJob | Parent job | |
CreateJob | ||
JobTemplate | ||
Template | Job templates | |
JobCode | Code of the job. |
⬆️ Back to top
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)
}
Response sample
Sample of JobMaintenanceApi GET
Click to view
Request
Response
JobMaintenanceApiModel {
Key (JobsMaintenanceKey, optional),
JobFields (JobsJobFields, optional),
WizardFields (JobsWizardFields, optional),
ContractFields (JobsContractFields, optional),
ValidationErrors (Array[MvcValidationError], optional)
}
JobsMaintenanceKey {
JobCode (string, optional),
JobDescription (string, optional),
QuoteID (integer, optional)
}
JobsJobFields {
JobCode (string, optional),
ContractCode (string, optional),
HasContract (boolean, optional),
CurrencyValid (boolean, optional),
GeneralFields (JobsGeneralFields, optional),
Extensions (GeneralExtensionFields, optional),
BillingFields (JobsBillingFields, optional),
ReferencesFields (JobsReferencesFields, optional),
AddressesFields (JobsAddressesFields, optional),
JobGroupsFields (JobsJobGroupsFields, optional),
JobWorkCentresFields (JobsJobWorkCentresFields, optional),
JobSchedulesFields (JobsJobSchedulesFields, optional),
DocketCostSchedulesFields (JobsDocketCostSchedulesFields, optional),
StandardOutputsFields (JobsStandardOutputsFields, optional)
}
JobsWizardFields {
Level (OptionsViewData, optional),
Name (StringViewData, optional),
Client (PickerViewData, optional),
ParentJob (PickerViewData, optional),
CreateJob (OptionsViewData, optional),
JobTemplate (PickerViewData, optional),
Template (PickerViewData, optional),
JobCode (StringViewData, optional)
}
JobsContractFields {
HaveContract (OptionsViewData, optional),
Status (DropdownViewData, optional),
BriefConfirmed (BoolViewData, optional),
ContractType (DropdownViewData, optional),
RetentionType (DropdownViewData, optional),
Site (StringViewData, optional),
ForeignCurrency (StringViewData, optional),
ForeignCurrencyCode (string, optional),
CurrencyRateType (DropdownViewData, optional),
CurrencyRate (DecimalViewData, optional),
NonContractBilling (DropdownViewData, optional),
AncestorHasContract (boolean, optional)
}
MvcValidationError {
n (string, optional),
m (string, optional)
}
JobsGeneralFields {
Name (StringViewData, optional),
Company (PickerViewData, optional),
JobManager (PickerViewData, optional),
AccountManager (PickerViewData, optional),
ProfitCentre (PickerViewData, optional),
JobType (PickerViewData, optional),
Contract (StringViewData, optional),
ParentJob (PickerViewData, optional),
JobHierarchy (StringViewData, optional),
JobLevel (StringViewData, optional),
JobStatus (DropdownViewData, optional),
CostActivityGroup (PickerViewData, optional),
BudgetActivityGroup (PickerViewData, optional),
ForecastActivityGroup (PickerViewData, optional),
BillingCurrency (PickerViewData, optional),
StockLocation (PickerViewData, optional),
CheckAgainstBudget (DropdownViewData, optional),
JobDetails (StringViewData, optional),
UseGst (BoolViewData, optional),
AdminJob (BoolViewData, optional),
ReqSched (BoolViewData, optional),
TemplateCode (string, optional)
}
GeneralExtensionFields {
Fields (Array[FieldViewData], optional),
ReturnFields (Array[FormItem], optional)
}
JobsBillingFields {
PriceCode (PickerViewData, optional),
ChargeType (PickerViewData, optional),
WipCode (PickerViewData, optional),
InvoiceType (PickerViewData, optional),
ClientCreditStatus (StringViewData, optional),
JobValue (DecimalViewData, optional),
DrAccount (StringViewData, optional),
CrAccount (StringViewData, optional),
InvoiceTitle (StringViewData, optional),
InvoiceText (StringViewData, optional),
EmployeeAgreementScheme (DropdownViewData, optional),
EbaTags (MultiPickerViewData, optional),
LabourCostingGroup (DropdownViewData, optional),
ForecastRevenue (BoolViewData, optional),
ChargeToJob (PickerViewData, optional),
ChargeToActivity (PickerViewData, optional),
ChargeToLog (PickerViewData, optional),
AllowInternalSales (boolean, optional)
}
JobsReferencesFields {
OrderNumber (StringViewData, optional),
JobReference (StringViewData, optional),
ClientReference (StringViewData, optional),
QuoteReference (StringViewData, optional),
AssetReference (StringViewData, optional),
CreatedDate (StringViewData, optional),
StartDate (DateViewData, optional),
ClosedDate (DateViewData, optional),
RequiredDate (DateViewData, optional),
ExpectedDate (DateViewData, optional),
FinalisedDate (DateViewData, optional),
Asset (PickerViewData, optional)
}
JobsAddressesFields {
BillingAddress (PickerViewData, optional),
SiteAddress (PickerViewData, optional),
SiteAddressDetails (StringViewData, optional),
BillingContact (PickerViewData, optional),
SiteContact (PickerViewData, optional),
StreetLine1 (StringViewData, optional),
StreetLine2 (StringViewData, optional),
Suburb (StringViewData, optional),
City (StringViewData, optional),
State (StringViewData, optional),
Country (StringViewData, optional),
PostCode (StringViewData, optional)
}
JobsJobGroupsFields {
Layout (Layout, optional),
Rows (Array[JobsJobGroupLine], optional)
}
JobsJobWorkCentresFields {
Layout (Layout, optional),
Rows (Array[JobsJobWorkCentreLine], optional)
}
JobsJobSchedulesFields {
Layout (Layout, optional),
Rows (Array[JobsJobScheduleLine], optional)
}
JobsDocketCostSchedulesFields {
Layout (Layout, optional),
Rows (Array[JobsDocketCostScheduleLine], optional)
}
JobsStandardOutputsFields {
Layout (Layout, optional),
Rows (Array[JobsStandardOutputLine], optional)
}
OptionsViewData {
SelectedOption (string, optional),
Settings (Array[KeyValuePair], 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)
}
PickerViewData {
SelectedValue (string, optional),
SelectedText (string, optional),
Name (string, optional),
Visible (boolean, optional),
Disabled (boolean, optional),
Required (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)
}
BoolViewData {
BoolValue (boolean, optional),
Name (string, optional),
Visible (boolean, optional),
InfoText (string, optional)
}
DecimalViewData {
DecimalValue (number, optional),
Name (string, optional),
Visible (boolean, optional),
InfoText (string, optional)
}
FieldViewData {
Name (string, optional),
Visible (boolean, optional),
Disabled (boolean, optional),
Required (boolean, optional),
InfoText (string, optional)
}
FormItem {
Name (string, optional),
Value (string, optional)
}
MultiPickerViewData {
InputWidth (string, optional) = ['None', 'Small', 'Medium', 'Large', 'MoreLarge', 'ExtraLarge', 'SuperLarge'],
KeyProperty (string, optional),
TagDisplayProperty (string, optional),
Template (string, optional),
AllowedTagsPattern (string, optional),
MinTags (integer, optional),
AutoCompleteOnly (boolean, optional),
NgSource (string, optional),
MinAutocompleteLength (integer, optional),
AutocompleteDisplayProperty (string, optional),
LoadOnFocus (boolean, optional),
LoadOnEmpty (boolean, optional),
MaxAutocompleteResults (integer, optional),
OnTagAdding (string, optional),
OnTagAdded (string, optional),
OnTagRemoved (string, optional),
StringValue (string, optional),
Name (string, optional),
Visible (boolean, optional),
Disabled (boolean, optional),
Required (boolean, optional),
InfoText (string, optional)
}
DateViewData {
DateValue (string, optional),
Name (string, optional),
Visible (boolean, optional),
Disabled (boolean, optional),
Required (boolean, optional),
InfoText (string, optional)
}
Layout {
Caption (string, optional)
}
JobsJobGroupLine {
Category (CellData, optional),
Group (CellData, optional),
Value (CellData, optional),
Delete (CellData, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (JobsJobGroupKey, optional),
CurrentKey (JobsJobGroupKey, optional),
Key (JobsJobGroupKey, optional),
Index (integer, optional)
}
JobsJobWorkCentreLine {
Job (CellData, optional),
WorkCentre (CellData, optional),
Description (CellData, optional),
BalanceOfBudget (CellData, optional),
CashflowByActivity (boolean, optional),
Closed (boolean, optional),
Complete (boolean, optional),
StartDate (string, optional),
EndDate (string, optional),
ExtensionFields (CellData, optional),
Delete (CellData, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (JobsJobWorkCentreKey, optional),
CurrentKey (JobsJobWorkCentreKey, optional),
Key (JobsJobWorkCentreKey, optional),
Index (integer, optional)
}
JobsJobScheduleLine {
Schedule (CellData, optional),
Type (CellData, optional),
Delete (CellData, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (JobsJobScheduleKey, optional),
CurrentKey (JobsJobScheduleKey, optional),
Key (JobsJobScheduleKey, optional),
Index (integer, optional)
}
JobsDocketCostScheduleLine {
Catalogue (CellData, optional),
ActivityGroup (CellData, optional),
Delete (CellData, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (JobsDocketCostScheduleKey, optional),
CurrentKey (JobsDocketCostScheduleKey, optional),
Key (JobsDocketCostScheduleKey, optional),
Index (integer, optional)
}
JobsStandardOutputLine {
FixedRate (boolean, optional),
ScheduleCode (CellData, optional),
OutputCode (CellData, optional),
Description (CellData, optional),
Unit (CellData, optional),
Rate (CellData, optional),
Quantity (CellData, optional),
Amount (CellData, optional),
SpecialRate (CellData, optional),
AuditDetails (CellData, optional),
Delete (CellData, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (JobsStandardOutputKey, optional),
CurrentKey (JobsStandardOutputKey, optional),
Key (JobsStandardOutputKey, optional),
Index (integer, optional)
}
KeyValuePair {
Key (string, optional, read only),
Value (string, optional, read only)
}
CellData {
CellId (string, optional),
CellValue (string, optional),
CellNumValue (number, optional),
CellBoolValue (boolean, optional),
CellTag (string, optional),
CellValueDate (string, optional),
CellValueInt (integer, optional)
}
JobsJobGroupKey {
Job (string, optional),
Category (string, optional),
Group (string, optional)
}
JobsJobWorkCentreKey {
JobCode (string, optional),
WorkCentreCode (string, optional)
}
JobsJobScheduleKey {
Job (string, optional),
Schedule (string, optional)
}
JobsDocketCostScheduleKey {
Job (string, optional),
Catalogue (integer, optional)
}
JobsStandardOutputKey {
StandardOutputId (integer, optional),
JobCode (string, optional),
ScheduleCode (string, optional),
OutputCode (string, optional),
ScheduleOutputRate (number, optional)
}
Response sample
{
"Key": {
"JobCode": "BTJ-Q"
},
"JobFields": {
"JobCode": "BTJ-Q",
"HasContract": false,
"CurrencyValid": true,
"GeneralFields": {
"Name": {
"StringValue": "BTJ - Install new Aircon",
"Name": "Name",
"Visible": true,
"Disabled": false,
"Required": true
},
"Company": {
"SelectedValue": "747",
"SelectedText": "Client A",
"Name": "Client Account",
"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
},
"ProfitCentre": {
"SelectedValue": "BTPCEN",
"SelectedText": "BTPCEN : BaoT profit center for job BRJ",
"Name": "Profit Centre",
"Visible": true,
"Disabled": false,
"Required": true
},
"JobType": {
"SelectedValue": "INTS",
"SelectedText": "INTS : Installation",
"Name": "Job Type",
"Visible": true,
"Disabled": false,
"Required": true
},
"Contract": {
"Name": "Contract",
"Visible": true,
"Disabled": false,
"Required": false
},
"ParentJob": {
"Name": "Parent Job",
"Visible": true,
"Disabled": false,
"Required": false
},
"JobHierarchy": {
"StringValue": "1: BTJ-Q",
"Name": "Job Hierarchy",
"Visible": true,
"Disabled": true,
"Required": false
},
"JobLevel": {
"StringValue": "1",
"Name": "Job Level",
"Visible": true,
"Disabled": false,
"Required": true
},
"JobStatus": {
"SelectedValue": "Invoiced",
"Name": "Job Status",
"Visible": true,
"Disabled": false,
"Required": true
},
"CostActivityGroup": {
"SelectedValue": "BTGRP",
"SelectedText": "BaoT group",
"Name": "Cost Activity Group",
"Visible": true,
"Disabled": false,
"Required": true
},
"BudgetActivityGroup": {
"SelectedValue": "BTGRP",
"SelectedText": "BaoT group",
"Name": "Budget Activity Group",
"Visible": true,
"Disabled": false,
"Required": true
},
"ForecastActivityGroup": {
"SelectedValue": "BTGRP",
"SelectedText": "BaoT group",
"Name": "Forecast Activity Group",
"Visible": false,
"Disabled": false,
"Required": true
},
"BillingCurrency": {
"SelectedValue": "NZD",
"SelectedText": "NZD : New Zealand Dollar",
"Name": "Billing Currency",
"Visible": true,
"Disabled": false,
"Required": true
},
"StockLocation": {
"Name": "Stock Location",
"Visible": true,
"Disabled": false,
"Required": false
},
"CheckAgainstBudget": {
"SelectedValue": "0",
"Name": "Check Against Budget",
"Visible": true,
"Disabled": false,
"Required": false
},
"JobDetails": {
"StringValue": "Install new Aircons for client A. Testing ",
"Name": "Job Details",
"Visible": true,
"Disabled": false,
"Required": false
},
"UseGst": {
"BoolValue": true,
"Name": "Use GST",
"Visible": true,
"Disabled": false,
"Required": false
},
"AdminJob": {
"BoolValue": false,
"Name": "Admin Job",
"Visible": true,
"Disabled": false,
"Required": false
},
"ReqSched": {
"BoolValue": false,
"Name": "Req. Sched.",
"Visible": true,
"Disabled": false,
"Required": false
}
},
"Extensions": {
"Fields": [
{
"Name": "State",
"Visible": true,
"Disabled": false,
"Required": false
},
{
"Name": "New Display Column",
"Visible": true,
"Disabled": false,
"Required": false
},
{
"Name": "Blank",
"Visible": true,
"Disabled": false,
"Required": false
},
{
"Name": "Quantity",
"Visible": true,
"Disabled": false,
"Required": false
},
{
"Name": "Xtracta GroupId",
"Visible": true,
"Disabled": false,
"Required": false
},
{
"SelectedValue": "Required One",
"Name": "Test Required Combo",
"Visible": true,
"Disabled": false,
"Required": false
}
]
},
"BillingFields": {
"PriceCode": {
"SelectedValue": "BTJQ",
"SelectedText": "BTJQ : Default rate in NZD",
"Name": "Price Code",
"Visible": true,
"Disabled": false,
"Required": true
},
"ChargeType": {
"SelectedValue": "QUOT",
"SelectedText": "QUOT : Quoted",
"Name": "Charge Type",
"Visible": true,
"Disabled": false,
"Required": true
},
"WipCode": {
"Name": "WIP Code",
"Visible": true,
"Disabled": false,
"Required": false
},
"InvoiceType": {
"SelectedValue": "IT02",
"SelectedText": "IT02 : WEB - AR Invoice Summary",
"Name": "Invoice Type",
"Visible": true,
"Disabled": false,
"Required": true
},
"ClientCreditStatus": {
"Name": "Client Credit Status",
"Visible": true,
"Disabled": false,
"Required": true
},
"JobValue": {
"DecimalValue": 15000,
"Name": "Job Value",
"Visible": true,
"Disabled": false,
"Required": false
},
"DrAccount": {
"Name": "DR GL Account",
"Visible": true,
"Disabled": false,
"Required": false
},
"CrAccount": {
"Name": "CR GL Account",
"Visible": true,
"Disabled": false,
"Required": false
},
"InvoiceTitle": {
"StringValue": "BTJ - Install new Aircon",
"Name": "Invoice Title",
"Visible": true,
"Disabled": false,
"Required": false
},
"InvoiceText": {
"Name": "Invoice Text",
"Visible": true,
"Disabled": false,
"Required": false
},
"EmployeeAgreementScheme": {
"SelectedValue": "",
"Name": "EBA Scheme",
"Visible": true,
"Disabled": false,
"Required": false
},
"EbaTags": {
"InputWidth": 0,
"KeyProperty": "value",
"TagDisplayProperty": "label",
"Template": "generic",
"MinTags": 0,
"AutoCompleteOnly": true,
"NgSource": "loadJobTags",
"MinAutocompleteLength": 1,
"AutocompleteDisplayProperty": "label",
"LoadOnFocus": false,
"LoadOnEmpty": false,
"MaxAutocompleteResults": 20,
"OnTagAdded": "onTagAdded",
"OnTagRemoved": "onTagRemoved",
"Name": "EBA Tags",
"Visible": true,
"Disabled": false,
"Required": false
},
"LabourCostingGroup": {
"Name": "Labour Costing Group",
"Visible": true,
"Disabled": false,
"Required": false
},
"ForecastRevenue": {
"BoolValue": false,
"Name": "Forecast Revenue",
"Visible": true,
"Disabled": false,
"Required": false
},
"ChargeToJob": {
"Name": "Charge To Job",
"Visible": true,
"Disabled": false,
"Required": false
},
"ChargeToActivity": {
"Name": "Charge To Activity",
"Visible": true,
"Disabled": false,
"Required": false
},
"ChargeToLog": {
"Name": "Charge To Log",
"Visible": true,
"Disabled": false,
"Required": false
},
"AllowInternalSales": false
},
"ReferencesFields": {
"OrderNumber": {
"Name": "Order Number",
"Visible": true,
"Disabled": false,
"Required": false
},
"JobReference": {
"Name": "Job Reference",
"Visible": true,
"Disabled": false,
"Required": false
},
"ClientReference": {
"Name": "Client Reference",
"Visible": true,
"Disabled": false,
"Required": false
},
"QuoteReference": {
"Name": "Quote Reference",
"Visible": true,
"Disabled": false,
"Required": false
},
"AssetReference": {
"Name": "Asset Reference",
"Visible": true,
"Disabled": false,
"Required": false
},
"CreatedDate": {
"StringValue": "29-Feb-2024",
"Name": "Created Date",
"Visible": true,
"Disabled": false,
"Required": false
},
"StartDate": {
"Name": "Start Date",
"Visible": true,
"Disabled": false,
"Required": false
},
"ClosedDate": {
"Name": "Closed Date",
"Visible": true,
"Disabled": false,
"Required": false
},
"RequiredDate": {
"Name": "Required Date",
"Visible": true,
"Disabled": false,
"Required": false
},
"ExpectedDate": {
"Name": "Expected Date",
"Visible": true,
"Disabled": false,
"Required": false
},
"FinalisedDate": {
"Name": "Finalised Date",
"Visible": true,
"Disabled": false,
"Required": false
},
"Asset": {
"Name": "Asset",
"Visible": true,
"Disabled": false,
"Required": false
}
},
"AddressesFields": {
"BillingAddress": {
"Name": "Billing Address",
"Visible": true,
"Disabled": false,
"Required": false
},
"SiteAddress": {
"Name": "Site Address",
"Visible": true,
"Disabled": false,
"Required": false
},
"SiteAddressDetails": {
"Name": "Site Address Details",
"Visible": false,
"Disabled": false,
"Required": false
},
"BillingContact": {
"Name": "Billing Contact",
"Visible": true,
"Disabled": false,
"Required": false
},
"SiteContact": {
"Name": "Site Contact",
"Visible": true,
"Disabled": false,
"Required": false
},
"StreetLine1": {
"Name": "Street Line 1",
"Visible": true,
"Disabled": false,
"Required": false
},
"StreetLine2": {
"Name": "Street Line 2",
"Visible": true,
"Disabled": false,
"Required": false
},
"Suburb": {
"Name": "Suburb",
"Visible": true,
"Disabled": false,
"Required": false
},
"City": {
"Name": "City",
"Visible": true,
"Disabled": false,
"Required": false
},
"State": {
"Name": "State",
"Visible": true,
"Disabled": false,
"Required": false
},
"Country": {
"Name": "Country",
"Visible": true,
"Disabled": false,
"Required": false
},
"PostCode": {
"Name": "Post Code",
"Visible": true,
"Disabled": false,
"Required": false
}
},
"JobGroupsFields": {
"Layout": {},
"Rows": []
},
"JobWorkCentresFields": {
"Layout": {},
"Rows": [
{
"Job": {
"CellId": "BTJ-Q",
"CellValue": "BTJ-Q : BTJ - Install new Aircon"
},
"WorkCentre": {
"CellId": "BTQ",
"CellValue": "BTQ : Installation machines"
},
"Description": {
"CellValue": "Installation machines"
},
"BalanceOfBudget": {
"CellId": "1",
"CellValue": "By Work Centre"
},
"CashflowByActivity": false,
"Closed": false,
"Complete": false,
"StartDate": "2024-02-01T00:00:00",
"EndDate": "2024-02-29T00:00:00",
"ExtensionFields": {
"CellValue": "View",
"CellTag": "openJobWorkCentreDialog('BTJ-Q', 'BTQ')"
},
"OriginalKey": {
"JobCode": "BTJ-Q",
"WorkCentreCode": "BTQ"
},
"CurrentKey": {
"JobCode": "BTJ-Q",
"WorkCentreCode": "BTQ"
},
"Key": {
"JobCode": "BTJ-Q",
"WorkCentreCode": "BTQ"
},
"Index": 0
}
]
},
"JobSchedulesFields": {
"Layout": {},
"Rows": []
},
"DocketCostSchedulesFields": {
"Layout": {},
"Rows": []
},
"StandardOutputsFields": {
"Layout": {},
"Rows": []
}
}
}
Sample of JobMaintenanceApi POST
Click to view
Request
{
"WizardFields": {
"Level": {
"SelectedOption": "0"
},
"ParentJob": {
"SelectedValue": null
},
"Name": {
"StringValue": "AG005"
},
"Client": {
"SelectedValue": "1339",
"SelectedText": "Workbench Internal"
},
"CreateJob": {
"SelectedOption": "1"
},
"Template": {
"SelectedValue": null
},
"JobCode": {
"StringValue": "AG005"
},
"JobTemplate": {
"SelectedValue": null,
"SelectedText": null
}
},
"Key": {
"JobCode": null
},
"JobFields": {
"JobCode": null,
"HasContract": "False",
"GeneralFields": {
"Name": {
"StringValue": "AG005"
},
"Company": {
"SelectedValue": "1339",
"SelectedText": "Workbench Internal"
},
"JobManager": {
"SelectedValue": "7990",
"SelectedText": "Anton Greb"
},
"AccountManager": {
"SelectedValue": "7990",
"SelectedText": "Anton Greb"
},
"ProfitCentre": {
"SelectedValue": "AK",
"SelectedText": "AK : Auckland"
},
"JobType": {
"SelectedValue": "DEV",
"SelectedText": "DEV : Development"
},
"UseGst": {
"BoolValue": true
},
"JobStatus": {
"SelectedValue": "Active"
},
"CostActivityGroup": {
"SelectedValue": "PS",
"SelectedText": "PS : Professional Services"
},
"CheckAgainstBudget": {
"SelectedValue": "0"
},
"ParentJob": {
"SelectedValue": null,
"SelectedText": null
},
"JobHierarchy": {
"StringValue": null
},
"JobDetails": {
"StringValue": null
},
"AdminJob": {
"BoolValue": false
},
"ReqSched": {
"BoolValue": false
},
"StockLocation": {
"SelectedValue": null,
"SelectedText": null
},
"BillingCurrency": {
"SelectedValue": null,
"SelectedText": null
},
"BudgetActivityGroup": {
"SelectedValue": null,
"SelectedText": null
},
"BillingCurrency": {
"SelectedValue": "NZD"
}
},
"BillingFields": {
"PriceCode": {
"SelectedValue": "0",
"SelectedText": "0 : Default Price Code"
},
"ChargeType": {
"SelectedValue": "02",
"SelectedText": "02 : Input"
},
"WipCode": {
"SelectedValue": null,
"SelectedText": null
},
"InvoiceType": {
"SelectedValue": "1",
"SelectedText": "1 : Sales Lines"
},
"JobValue": {
"DecimalValue": null
},
"DrAccount": {
"StringValue": null
},
"ForecastRevenue": {
"BoolValue": false
},
"CrAccount": {
"StringValue": null
},
"ChargeToJob": {
"SelectedValue": null
},
"ChargeToActivity": {
"SelectedValue": null
},
"ChargeToLog": {
"SelectedValue": null
},
"InvoiceTitle": {
"StringValue": "AG004"
},
"InvoiceText": {
"StringValue": null
}
},
"ReferencesFields": {
"OrderNumber": {
"StringValue": null
},
"JobReference": {
"StringValue": null
},
"ClientReference": {
"StringValue": null
},
"QuoteReference": {
"StringValue": null
},
"StartDate": {
"DateValue": null
},
"ClosedDate": {
"DateValue": null
},
"RequiredDate": {
"DateValue": null
},
"ExpectedDate": {
"DateValue": null
},
"FinalisedDate": {
"DateValue": null
},
"Asset": {
"SelectedValue": null
}
},
"AddressesFields": {
"BillingAddress": {
"SelectedValue": "553",
"SelectedText": "Task Management Ltd"
},
"SiteAddress": {
"SelectedValue": "553",
"SelectedText": "Task Management Ltd"
},
"BillingContact": {
"SelectedValue": null,
"SelectedText": null
},
"SiteContact": {
"SelectedValue": null,
"SelectedText": null
},
"SiteAddressDetails": {
"StringValue": null
}
},
"JobGroupsFields": {
"rows": [],
"footers": []
},
"JobWorkCentresFields": {
"rows": [],
"footers": []
},
"JobSchedulesFields": {
"rows": [],
"footers": []
}
},
"ContractFields": {
"HaveContract": {
"SelectedOption": "0"
},
"Status": {
"SelectedValue": null
},
"ContractType": {
"SelectedValue": null
},
"RetentionType": {
"SelectedValue": null
},
"Site": {
"StringValue": null
},
"CurrencyRateType": {
"SelectedValue": null
},
"NonContractBilling": {
"SelectedValue": null
},
"BriefConfirmed": {
"BoolValue": false
}
},
"Perform": "Save"
}
Response
JobMaintenanceApiModel {
Key (JobsMaintenanceKey, optional),
JobFields (JobsJobFields, optional),
WizardFields (JobsWizardFields, optional),
ContractFields (JobsContractFields, optional),
ValidationErrors (Array[MvcValidationError], optional)
}
JobsMaintenanceKey {
JobCode (string, optional),
JobDescription (string, optional),
QuoteID (integer, optional)
}
JobsJobFields {
JobCode (string, optional),
ContractCode (string, optional),
HasContract (boolean, optional),
CurrencyValid (boolean, optional),
GeneralFields (JobsGeneralFields, optional),
Extensions (GeneralExtensionFields, optional),
BillingFields (JobsBillingFields, optional),
ReferencesFields (JobsReferencesFields, optional),
AddressesFields (JobsAddressesFields, optional),
JobGroupsFields (JobsJobGroupsFields, optional),
JobWorkCentresFields (JobsJobWorkCentresFields, optional),
JobSchedulesFields (JobsJobSchedulesFields, optional),
DocketCostSchedulesFields (JobsDocketCostSchedulesFields, optional),
StandardOutputsFields (JobsStandardOutputsFields, optional)
}
JobsWizardFields {
Level (OptionsViewData, optional),
Name (StringViewData, optional),
Client (PickerViewData, optional),
ParentJob (PickerViewData, optional),
CreateJob (OptionsViewData, optional),
JobTemplate (PickerViewData, optional),
Template (PickerViewData, optional),
JobCode (StringViewData, optional)
}
JobsContractFields {
HaveContract (OptionsViewData, optional),
Status (DropdownViewData, optional),
BriefConfirmed (BoolViewData, optional),
ContractType (DropdownViewData, optional),
RetentionType (DropdownViewData, optional),
Site (StringViewData, optional),
ForeignCurrency (StringViewData, optional),
ForeignCurrencyCode (string, optional),
CurrencyRateType (DropdownViewData, optional),
CurrencyRate (DecimalViewData, optional),
NonContractBilling (DropdownViewData, optional),
AncestorHasContract (boolean, optional)
}
MvcValidationError {
n (string, optional),
m (string, optional)
}
JobsGeneralFields {
Name (StringViewData, optional),
Company (PickerViewData, optional),
JobManager (PickerViewData, optional),
AccountManager (PickerViewData, optional),
ProfitCentre (PickerViewData, optional),
JobType (PickerViewData, optional),
Contract (StringViewData, optional),
ParentJob (PickerViewData, optional),
JobHierarchy (StringViewData, optional),
JobLevel (StringViewData, optional),
JobStatus (DropdownViewData, optional),
CostActivityGroup (PickerViewData, optional),
BudgetActivityGroup (PickerViewData, optional),
ForecastActivityGroup (PickerViewData, optional),
BillingCurrency (PickerViewData, optional),
StockLocation (PickerViewData, optional),
CheckAgainstBudget (DropdownViewData, optional),
JobDetails (StringViewData, optional),
UseGst (BoolViewData, optional),
AdminJob (BoolViewData, optional),
ReqSched (BoolViewData, optional),
TemplateCode (string, optional)
}
GeneralExtensionFields {
Fields (Array[FieldViewData], optional),
ReturnFields (Array[FormItem], optional)
}
JobsBillingFields {
PriceCode (PickerViewData, optional),
ChargeType (PickerViewData, optional),
WipCode (PickerViewData, optional),
InvoiceType (PickerViewData, optional),
ClientCreditStatus (StringViewData, optional),
JobValue (DecimalViewData, optional),
DrAccount (StringViewData, optional),
CrAccount (StringViewData, optional),
InvoiceTitle (StringViewData, optional),
InvoiceText (StringViewData, optional),
EmployeeAgreementScheme (DropdownViewData, optional),
EbaTags (MultiPickerViewData, optional),
LabourCostingGroup (DropdownViewData, optional),
ForecastRevenue (BoolViewData, optional),
ChargeToJob (PickerViewData, optional),
ChargeToActivity (PickerViewData, optional),
ChargeToLog (PickerViewData, optional),
AllowInternalSales (boolean, optional)
}
JobsReferencesFields {
OrderNumber (StringViewData, optional),
JobReference (StringViewData, optional),
ClientReference (StringViewData, optional),
QuoteReference (StringViewData, optional),
AssetReference (StringViewData, optional),
CreatedDate (StringViewData, optional),
StartDate (DateViewData, optional),
ClosedDate (DateViewData, optional),
RequiredDate (DateViewData, optional),
ExpectedDate (DateViewData, optional),
FinalisedDate (DateViewData, optional),
Asset (PickerViewData, optional)
}
JobsAddressesFields {
BillingAddress (PickerViewData, optional),
SiteAddress (PickerViewData, optional),
SiteAddressDetails (StringViewData, optional),
BillingContact (PickerViewData, optional),
SiteContact (PickerViewData, optional),
StreetLine1 (StringViewData, optional),
StreetLine2 (StringViewData, optional),
Suburb (StringViewData, optional),
City (StringViewData, optional),
State (StringViewData, optional),
Country (StringViewData, optional),
PostCode (StringViewData, optional)
}
JobsJobGroupsFields {
Layout (Layout, optional),
Rows (Array[JobsJobGroupLine], optional)
}
JobsJobWorkCentresFields {
Layout (Layout, optional),
Rows (Array[JobsJobWorkCentreLine], optional)
}
JobsJobSchedulesFields {
Layout (Layout, optional),
Rows (Array[JobsJobScheduleLine], optional)
}
JobsDocketCostSchedulesFields {
Layout (Layout, optional),
Rows (Array[JobsDocketCostScheduleLine], optional)
}
JobsStandardOutputsFields {
Layout (Layout, optional),
Rows (Array[JobsStandardOutputLine], optional)
}
OptionsViewData {
SelectedOption (string, optional),
Settings (Array[KeyValuePair], 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)
}
PickerViewData {
SelectedValue (string, optional),
SelectedText (string, optional),
Name (string, optional),
Visible (boolean, optional),
Disabled (boolean, optional),
Required (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)
}
BoolViewData {
BoolValue (boolean, optional),
Name (string, optional),
Visible (boolean, optional),
InfoText (string, optional)
}
DecimalViewData {
DecimalValue (number, optional),
Name (string, optional),
Visible (boolean, optional),
InfoText (string, optional)
}
FieldViewData {
Name (string, optional),
Visible (boolean, optional),
Disabled (boolean, optional),
Required (boolean, optional),
InfoText (string, optional)
}
FormItem {
Name (string, optional),
Value (string, optional)
}
MultiPickerViewData {
InputWidth (string, optional) = ['None', 'Small', 'Medium', 'Large', 'MoreLarge', 'ExtraLarge', 'SuperLarge'],
KeyProperty (string, optional),
TagDisplayProperty (string, optional),
Template (string, optional),
AllowedTagsPattern (string, optional),
MinTags (integer, optional),
AutoCompleteOnly (boolean, optional),
NgSource (string, optional),
MinAutocompleteLength (integer, optional),
AutocompleteDisplayProperty (string, optional),
LoadOnFocus (boolean, optional),
LoadOnEmpty (boolean, optional),
MaxAutocompleteResults (integer, optional),
OnTagAdding (string, optional),
OnTagAdded (string, optional),
OnTagRemoved (string, optional),
StringValue (string, optional),
Name (string, optional),
Visible (boolean, optional),
Disabled (boolean, optional),
Required (boolean, optional),
InfoText (string, optional)
}
DateViewData {
DateValue (string, optional),
Name (string, optional),
Visible (boolean, optional),
Disabled (boolean, optional),
Required (boolean, optional),
InfoText (string, optional)
}
Layout {
Caption (string, optional)
}
JobsJobGroupLine {
Category (CellData, optional),
Group (CellData, optional),
Value (CellData, optional),
Delete (CellData, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (JobsJobGroupKey, optional),
CurrentKey (JobsJobGroupKey, optional),
Key (JobsJobGroupKey, optional),
Index (integer, optional)
}
JobsJobWorkCentreLine {
Job (CellData, optional),
WorkCentre (CellData, optional),
Description (CellData, optional),
BalanceOfBudget (CellData, optional),
CashflowByActivity (boolean, optional),
Closed (boolean, optional),
Complete (boolean, optional),
StartDate (string, optional),
EndDate (string, optional),
ExtensionFields (CellData, optional),
Delete (CellData, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (JobsJobWorkCentreKey, optional),
CurrentKey (JobsJobWorkCentreKey, optional),
Key (JobsJobWorkCentreKey, optional),
Index (integer, optional)
}
JobsJobScheduleLine {
Schedule (CellData, optional),
Type (CellData, optional),
Delete (CellData, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (JobsJobScheduleKey, optional),
CurrentKey (JobsJobScheduleKey, optional),
Key (JobsJobScheduleKey, optional),
Index (integer, optional)
}
JobsDocketCostScheduleLine {
Catalogue (CellData, optional),
ActivityGroup (CellData, optional),
Delete (CellData, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (JobsDocketCostScheduleKey, optional),
CurrentKey (JobsDocketCostScheduleKey, optional),
Key (JobsDocketCostScheduleKey, optional),
Index (integer, optional)
}
JobsStandardOutputLine {
FixedRate (boolean, optional),
ScheduleCode (CellData, optional),
OutputCode (CellData, optional),
Description (CellData, optional),
Unit (CellData, optional),
Rate (CellData, optional),
Quantity (CellData, optional),
Amount (CellData, optional),
SpecialRate (CellData, optional),
AuditDetails (CellData, optional),
Delete (CellData, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (JobsStandardOutputKey, optional),
CurrentKey (JobsStandardOutputKey, optional),
Key (JobsStandardOutputKey, optional),
Index (integer, optional)
}
KeyValuePair {
Key (string, optional, read only),
Value (string, optional, read only)
}
CellData {
CellId (string, optional),
CellValue (string, optional),
CellNumValue (number, optional),
CellBoolValue (boolean, optional),
CellTag (string, optional),
CellValueDate (string, optional),
CellValueInt (integer, optional)
}
JobsJobGroupKey {
Job (string, optional),
Category (string, optional),
Group (string, optional)
}
JobsJobWorkCentreKey {
JobCode (string, optional),
WorkCentreCode (string, optional)
}
JobsJobScheduleKey {
Job (string, optional),
Schedule (string, optional)
}
JobsDocketCostScheduleKey {
Job (string, optional),
Catalogue (integer, optional)
}
JobsStandardOutputKey {
StandardOutputId (integer, optional),
JobCode (string, optional),
ScheduleCode (string, optional),
OutputCode (string, optional),
ScheduleOutputRate (number, optional)
}
Response sample
{
"Key": {
"JobCode": "string",
"JobDescription": "string",
"QuoteID": 0
},
"JobFields": {
"JobCode": "string",
"ContractCode": "string",
"HasContract": true,
"CurrencyValid": true,
"GeneralFields": {
"Name": {
"StringValue": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true
},
"Company": {
"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"
},
"ProfitCentre": {
"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"
},
"Contract": {
"StringValue": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true
},
"ParentJob": {
"SelectedValue": "string",
"SelectedText": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"JobHierarchy": {
"StringValue": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true
},
"JobLevel": {
"StringValue": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true
},
"JobStatus": {
"SelectedValue": "string",
"SelectedText": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"CostActivityGroup": {
"SelectedValue": "string",
"SelectedText": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"BudgetActivityGroup": {
"SelectedValue": "string",
"SelectedText": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"ForecastActivityGroup": {
"SelectedValue": "string",
"SelectedText": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"BillingCurrency": {
"SelectedValue": "string",
"SelectedText": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"StockLocation": {
"SelectedValue": "string",
"SelectedText": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"CheckAgainstBudget": {
"SelectedValue": "string",
"SelectedText": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"JobDetails": {
"StringValue": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true
},
"UseGst": {
"BoolValue": true,
"Name": "string",
"Visible": true,
"InfoText": "string"
},
"AdminJob": {
"BoolValue": true,
"Name": "string",
"Visible": true,
"InfoText": "string"
},
"ReqSched": {
"BoolValue": true,
"Name": "string",
"Visible": true,
"InfoText": "string"
},
"TemplateCode": "string"
},
"Extensions": {
"Fields": [
{
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
}
],
"ReturnFields": [
{
"Name": "string",
"Value": "string"
}
]
},
"BillingFields": {
"PriceCode": {
"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"
},
"WipCode": {
"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"
},
"ClientCreditStatus": {
"StringValue": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true
},
"JobValue": {
"DecimalValue": 0,
"Name": "string",
"Visible": true,
"InfoText": "string"
},
"DrAccount": {
"StringValue": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true
},
"CrAccount": {
"StringValue": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true
},
"InvoiceTitle": {
"StringValue": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true
},
"InvoiceText": {
"StringValue": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true
},
"EmployeeAgreementScheme": {
"SelectedValue": "string",
"SelectedText": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"EbaTags": {
"InputWidth": "None",
"KeyProperty": "string",
"TagDisplayProperty": "string",
"Template": "string",
"AllowedTagsPattern": "string",
"MinTags": 0,
"AutoCompleteOnly": true,
"NgSource": "string",
"MinAutocompleteLength": 0,
"AutocompleteDisplayProperty": "string",
"LoadOnFocus": true,
"LoadOnEmpty": true,
"MaxAutocompleteResults": 0,
"OnTagAdding": "string",
"OnTagAdded": "string",
"OnTagRemoved": "string",
"StringValue": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"LabourCostingGroup": {
"SelectedValue": "string",
"SelectedText": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"ForecastRevenue": {
"BoolValue": true,
"Name": "string",
"Visible": true,
"InfoText": "string"
},
"ChargeToJob": {
"SelectedValue": "string",
"SelectedText": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"ChargeToActivity": {
"SelectedValue": "string",
"SelectedText": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"ChargeToLog": {
"SelectedValue": "string",
"SelectedText": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"AllowInternalSales": true
},
"ReferencesFields": {
"OrderNumber": {
"StringValue": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true
},
"JobReference": {
"StringValue": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true
},
"ClientReference": {
"StringValue": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true
},
"QuoteReference": {
"StringValue": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true
},
"AssetReference": {
"StringValue": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true
},
"CreatedDate": {
"StringValue": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true
},
"StartDate": {
"DateValue": "2024-04-11T23:20:03.889Z",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"ClosedDate": {
"DateValue": "2024-04-11T23:20:03.889Z",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"RequiredDate": {
"DateValue": "2024-04-11T23:20:03.889Z",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"ExpectedDate": {
"DateValue": "2024-04-11T23:20:03.889Z",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"FinalisedDate": {
"DateValue": "2024-04-11T23:20:03.889Z",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"Asset": {
"SelectedValue": "string",
"SelectedText": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
}
},
"AddressesFields": {
"BillingAddress": {
"SelectedValue": "string",
"SelectedText": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"SiteAddress": {
"SelectedValue": "string",
"SelectedText": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"SiteAddressDetails": {
"StringValue": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true
},
"BillingContact": {
"SelectedValue": "string",
"SelectedText": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"SiteContact": {
"SelectedValue": "string",
"SelectedText": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"StreetLine1": {
"StringValue": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true
},
"StreetLine2": {
"StringValue": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true
},
"Suburb": {
"StringValue": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true
},
"City": {
"StringValue": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true
},
"State": {
"StringValue": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true
},
"Country": {
"StringValue": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true
},
"PostCode": {
"StringValue": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true
}
},
"JobGroupsFields": {
"Layout": {
"Caption": "string"
},
"Rows": [
{
"Category": {
"CellId": "string",
"CellValue": "string",
"CellNumValue": 0,
"CellBoolValue": true,
"CellTag": "string",
"CellValueDate": "2024-04-11T23:20:03.889Z",
"CellValueInt": 0
},
"Group": {
"CellId": "string",
"CellValue": "string",
"CellNumValue": 0,
"CellBoolValue": true,
"CellTag": "string",
"CellValueDate": "2024-04-11T23:20:03.889Z",
"CellValueInt": 0
},
"Value": {
"CellId": "string",
"CellValue": "string",
"CellNumValue": 0,
"CellBoolValue": true,
"CellTag": "string",
"CellValueDate": "2024-04-11T23:20:03.889Z",
"CellValueInt": 0
},
"Delete": {
"CellId": "string",
"CellValue": "string",
"CellNumValue": 0,
"CellBoolValue": true,
"CellTag": "string",
"CellValueDate": "2024-04-11T23:20:03.889Z",
"CellValueInt": 0
},
"Status": "string",
"ReadonlyFlag": 0,
"ReadonlyMessage": "string",
"OriginalKey": {
"Job": "string",
"Category": "string",
"Group": "string"
},
"CurrentKey": {
"Job": "string",
"Category": "string",
"Group": "string"
},
"Key": {
"Job": "string",
"Category": "string",
"Group": "string"
},
"Index": 0
}
]
},
"JobWorkCentresFields": {
"Layout": {
"Caption": "string"
},
"Rows": [
{
"Job": {
"CellId": "string",
"CellValue": "string",
"CellNumValue": 0,
"CellBoolValue": true,
"CellTag": "string",
"CellValueDate": "2024-04-11T23:20:03.889Z",
"CellValueInt": 0
},
"WorkCentre": {
"CellId": "string",
"CellValue": "string",
"CellNumValue": 0,
"CellBoolValue": true,
"CellTag": "string",
"CellValueDate": "2024-04-11T23:20:03.889Z",
"CellValueInt": 0
},
"Description": {
"CellId": "string",
"CellValue": "string",
"CellNumValue": 0,
"CellBoolValue": true,
"CellTag": "string",
"CellValueDate": "2024-04-11T23:20:03.889Z",
"CellValueInt": 0
},
"BalanceOfBudget": {
"CellId": "string",
"CellValue": "string",
"CellNumValue": 0,
"CellBoolValue": true,
"CellTag": "string",
"CellValueDate": "2024-04-11T23:20:03.889Z",
"CellValueInt": 0
},
"CashflowByActivity": true,
"Closed": true,
"Complete": true,
"StartDate": "2024-04-11T23:20:03.889Z",
"EndDate": "2024-04-11T23:20:03.889Z",
"ExtensionFields": {
"CellId": "string",
"CellValue": "string",
"CellNumValue": 0,
"CellBoolValue": true,
"CellTag": "string",
"CellValueDate": "2024-04-11T23:20:03.889Z",
"CellValueInt": 0
},
"Delete": {
"CellId": "string",
"CellValue": "string",
"CellNumValue": 0,
"CellBoolValue": true,
"CellTag": "string",
"CellValueDate": "2024-04-11T23:20:03.889Z",
"CellValueInt": 0
},
"Status": "string",
"ReadonlyFlag": 0,
"ReadonlyMessage": "string",
"OriginalKey": {
"JobCode": "string",
"WorkCentreCode": "string"
},
"CurrentKey": {
"JobCode": "string",
"WorkCentreCode": "string"
},
"Key": {
"JobCode": "string",
"WorkCentreCode": "string"
},
"Index": 0
}
]
},
"JobSchedulesFields": {
"Layout": {
"Caption": "string"
},
"Rows": [
{
"Schedule": {
"CellId": "string",
"CellValue": "string",
"CellNumValue": 0,
"CellBoolValue": true,
"CellTag": "string",
"CellValueDate": "2024-04-11T23:20:03.889Z",
"CellValueInt": 0
},
"Type": {
"CellId": "string",
"CellValue": "string",
"CellNumValue": 0,
"CellBoolValue": true,
"CellTag": "string",
"CellValueDate": "2024-04-11T23:20:03.889Z",
"CellValueInt": 0
},
"Delete": {
"CellId": "string",
"CellValue": "string",
"CellNumValue": 0,
"CellBoolValue": true,
"CellTag": "string",
"CellValueDate": "2024-04-11T23:20:03.889Z",
"CellValueInt": 0
},
"Status": "string",
"ReadonlyFlag": 0,
"ReadonlyMessage": "string",
"OriginalKey": {
"Job": "string",
"Schedule": "string"
},
"CurrentKey": {
"Job": "string",
"Schedule": "string"
},
"Key": {
"Job": "string",
"Schedule": "string"
},
"Index": 0
}
]
},
"DocketCostSchedulesFields": {
"Layout": {
"Caption": "string"
},
"Rows": [
{
"Catalogue": {
"CellId": "string",
"CellValue": "string",
"CellNumValue": 0,
"CellBoolValue": true,
"CellTag": "string",
"CellValueDate": "2024-04-11T23:20:03.889Z",
"CellValueInt": 0
},
"ActivityGroup": {
"CellId": "string",
"CellValue": "string",
"CellNumValue": 0,
"CellBoolValue": true,
"CellTag": "string",
"CellValueDate": "2024-04-11T23:20:03.889Z",
"CellValueInt": 0
},
"Delete": {
"CellId": "string",
"CellValue": "string",
"CellNumValue": 0,
"CellBoolValue": true,
"CellTag": "string",
"CellValueDate": "2024-04-11T23:20:03.889Z",
"CellValueInt": 0
},
"Status": "string",
"ReadonlyFlag": 0,
"ReadonlyMessage": "string",
"OriginalKey": {
"Job": "string",
"Catalogue": 0
},
"CurrentKey": {
"Job": "string",
"Catalogue": 0
},
"Key": {
"Job": "string",
"Catalogue": 0
},
"Index": 0
}
]
},
"StandardOutputsFields": {
"Layout": {
"Caption": "string"
},
"Rows": [
{
"FixedRate": true,
"ScheduleCode": {
"CellId": "string",
"CellValue": "string",
"CellNumValue": 0,
"CellBoolValue": true,
"CellTag": "string",
"CellValueDate": "2024-04-11T23:20:03.890Z",
"CellValueInt": 0
},
"OutputCode": {
"CellId": "string",
"CellValue": "string",
"CellNumValue": 0,
"CellBoolValue": true,
"CellTag": "string",
"CellValueDate": "2024-04-11T23:20:03.890Z",
"CellValueInt": 0
},
"Description": {
"CellId": "string",
"CellValue": "string",
"CellNumValue": 0,
"CellBoolValue": true,
"CellTag": "string",
"CellValueDate": "2024-04-11T23:20:03.890Z",
"CellValueInt": 0
},
"Unit": {
"CellId": "string",
"CellValue": "string",
"CellNumValue": 0,
"CellBoolValue": true,
"CellTag": "string",
"CellValueDate": "2024-04-11T23:20:03.890Z",
"CellValueInt": 0
},
"Rate": {
"CellId": "string",
"CellValue": "string",
"CellNumValue": 0,
"CellBoolValue": true,
"CellTag": "string",
"CellValueDate": "2024-04-11T23:20:03.890Z",
"CellValueInt": 0
},
"Quantity": {
"CellId": "string",
"CellValue": "string",
"CellNumValue": 0,
"CellBoolValue": true,
"CellTag": "string",
"CellValueDate": "2024-04-11T23:20:03.890Z",
"CellValueInt": 0
},
"Amount": {
"CellId": "string",
"CellValue": "string",
"CellNumValue": 0,
"CellBoolValue": true,
"CellTag": "string",
"CellValueDate": "2024-04-11T23:20:03.890Z",
"CellValueInt": 0
},
"SpecialRate": {
"CellId": "string",
"CellValue": "string",
"CellNumValue": 0,
"CellBoolValue": true,
"CellTag": "string",
"CellValueDate": "2024-04-11T23:20:03.890Z",
"CellValueInt": 0
},
"AuditDetails": {
"CellId": "string",
"CellValue": "string",
"CellNumValue": 0,
"CellBoolValue": true,
"CellTag": "string",
"CellValueDate": "2024-04-11T23:20:03.890Z",
"CellValueInt": 0
},
"Delete": {
"CellId": "string",
"CellValue": "string",
"CellNumValue": 0,
"CellBoolValue": true,
"CellTag": "string",
"CellValueDate": "2024-04-11T23:20:03.890Z",
"CellValueInt": 0
},
"Status": "string",
"ReadonlyFlag": 0,
"ReadonlyMessage": "string",
"OriginalKey": {
"StandardOutputId": 0,
"JobCode": "string",
"ScheduleCode": "string",
"OutputCode": "string",
"ScheduleOutputRate": 0
},
"CurrentKey": {
"StandardOutputId": 0,
"JobCode": "string",
"ScheduleCode": "string",
"OutputCode": "string",
"ScheduleOutputRate": 0
},
"Key": {
"StandardOutputId": 0,
"JobCode": "string",
"ScheduleCode": "string",
"OutputCode": "string",
"ScheduleOutputRate": 0
},
"Index": 0
}
]
}
},
"WizardFields": {
"Level": {
"SelectedOption": "string",
"Settings": [
{
"Key": "string",
"Value": "string"
}
],
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"Name": {
"StringValue": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true
},
"Client": {
"SelectedValue": "string",
"SelectedText": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"ParentJob": {
"SelectedValue": "string",
"SelectedText": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"CreateJob": {
"SelectedOption": "string",
"Settings": [
{
"Key": "string",
"Value": "string"
}
],
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"JobTemplate": {
"SelectedValue": "string",
"SelectedText": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"Template": {
"SelectedValue": "string",
"SelectedText": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"JobCode": {
"StringValue": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true
}
},
"ContractFields": {
"HaveContract": {
"SelectedOption": "string",
"Settings": [
{
"Key": "string",
"Value": "string"
}
],
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"Status": {
"SelectedValue": "string",
"SelectedText": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"BriefConfirmed": {
"BoolValue": true,
"Name": "string",
"Visible": true,
"InfoText": "string"
},
"ContractType": {
"SelectedValue": "string",
"SelectedText": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"RetentionType": {
"SelectedValue": "string",
"SelectedText": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"Site": {
"StringValue": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true
},
"ForeignCurrency": {
"StringValue": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true
},
"ForeignCurrencyCode": "string",
"CurrencyRateType": {
"SelectedValue": "string",
"SelectedText": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"CurrencyRate": {
"DecimalValue": 0,
"Name": "string",
"Visible": true,
"InfoText": "string"
},
"NonContractBilling": {
"SelectedValue": "string",
"SelectedText": "string",
"Name": "string",
"Visible": true,
"Disabled": true,
"Required": true,
"InfoText": "string"
},
"AncestorHasContract": true
},
"ValidationErrors": [
{
"n": "string",
"m": "string"
}
]
}
⬆️ Back to top
On this page
Unable to render {include} The included page could not be found.
- No labels