Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
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.
JobKey
Property | Type | Description |
|---|---|---|
JobCode | String | The unique Code of the Job. |
⬆️ Back to top
JobLine
Property | Type | Description |
|---|---|---|
Key | The unique key for the line. | |
JobCode | String | The unique Code of the Job. |
JobCodeValue | The unique Code of the Job. | |
Description | String | The description of the Job. |
DescriptionValue | The description of the Job. | |
CodeDescription | String | The Job Code and Description. |
Company | String | The name of the client Company for this Job. |
CompanyId | Integer | The unique ID of the client Company. |
CompanyValue | The client Company for this Job. | |
Level | Integer | The tier or hierarchy that this Job or Subjob was created at. Jobs can be 5 levels deep. |
LevelValue | The tier or hierarchy that this Job or Subjob was created at. Jobs can be 5 levels deep. | |
JobLevel | Integer | The tier or hierarchy that this Job or Subjob was created at. Jobs can be 5 levels deep. |
FinancialCompany | String | The Financial Company of the Job. |
ProfitCentre | String | The Profit Centre Code this Job sits under. |
ProfitCentreDescription | String | Profit Centre description. |
ProfitCentreValue | The Profit Centre this Job sits under. | |
Finalised | Boolean | The Finalised flag on the Job. |
OpenClosed | String | Either “Finalised”, “Closed”, or “Open”. |
OpenClosedCode | Integer | Either 3 (finalised), 2 (closed), or 1 (open). |
OpenClosedValue | Either “Finalised”, “Closed”, or “Open”. | |
Status | String | The Job Status. |
StatusValue | The Job Status | |
JobManager | String | The name of the Job Manager. |
JobManagerId | Integer | The ID of the Job Manager. |
JobManagerValue | The person nominated to be the central manager of the Job. | |
AccountManager | String | The name of the Account Manager. |
AccountManagerId | Integer | The ID of the Account Manager. |
AccountManagerValue | The person nominated to be the manager of the client account for the Job. | |
JobType | String | The category that this Job is assigned to. |
JobTypeValue | The Job Type | |
ChargeType | String | The Charge Type of the job. |
ChargeTypeValue | The Charge type of the job. | |
HasContract | Boolean | The flag to indicate if the Job has a contract. |
HasContractValue | The flag to indicate if the Job has a contract. | |
HasSubcontract | Boolean | The flag to indicate if the Job has any subcontracts. |
JobScheduler | Integer | The flag to indicate if the Job requires scheduling, enabling this job to be used with the Datasheet Scheduling module. |
SyncUpvise | Sync Upvise. | |
JobSiteAddressID | Integer | the ID of the Site Address of the Job. |
JobSiteAddress | String | The Client Company's default site address |
JobSiteAddressDetails | String | The custom text field to enter a specific site address or other details. |
OrderNumber | String | An optional field to place a client Purchase Order number, which will be shown on the claim/invoice. |
ClientReference | String | To label the budget something that your external stakeholders refer to it as. |
QuoteReference | String | An optional field for custom text, used for tracking quote numbers given to the client for this Job. |
JobReference | String | An optional field for custom text |
AssetReference | String | The Asset Reference on the Job. |
CreatedDate | String | The date the Job was created. |
FinalisedDate | String | The date the Job was finalised. |
StartDate | String | The date the Job was started. |
CompletedDate | String | The date the Job was completed. |
HierarchyCode1 | String | The HierarchyCode1 of the Job. |
HierarchyCode2 | String | The HierarchyCode2 of the Job. |
HierarchyCode3 | String | The HierarchyCode3 of the Job. |
HierarchyCode4 | String | The HierarchyCode4 of the Job. |
HierarchyCode5 | String | The HierarchyCode5 of the Job. |
HierarchyCode6 | String | The HierarchyCode6 of the Job. |
Group1 | String | The Attribute Group of the first Attribute Category filter |
Group2 | String | The Attribute Group of the second Attribute Category filter |
Group3 | String | The Attribute Group of the third Attribute Category filter |
UpdatedDate | String | The Date this record was last updated. |
⬆️ Back to top
JobApiModel
Property | Type | Description |
|---|---|---|
Key | The unique key of the Job. | |
Main | General data associated with the Job. | |
Attributes.Rows | Array<AttributeLine> | Attributes associated with the Job. |
Notes.Rows | Array<NoteLine> | Notes associated with the Job. |
ToDoItems.Rows | Array<ToDoLine> | To Do Items associated with the Job. |
Datasheets.Rows | Array<DatasheetModelLine> | Datasheets associated withe the Job. |
ValidationErrors | Array<MvcValidationError> | A list of specific validation errors if the save was unsuccessful. |
⬆️ Back to top
JobMainFields
Property | Type | Description |
|---|---|---|
JobCode | The unique Code of the Job. | |
Description | The Description of the Job. | |
JobLevel | The Job level | |
ParentJob | The Parent Job. | |
Client | The Client of the Job. | |
ProfitCentre | The Profit Centre that Job sits under. | |
JobManager | The Job Manager. | |
AccountManager | The Account Manager. | |
PriceCode | The Price code. | |
JobType | The Job type. | |
JobStatus | The Job status. | |
Closed | The Closed flag. | |
ClosedSubJobs | (Used with Closed) The flag to indicate if the Sub-Jobs should be closed/unclosed as well. | |
Finalised | The Finalised flag. | |
FinalisedSubJobs | (Used with Finalised) The flag to indicate if the Sub-Jobs should be finalised/unfinalised as well. | |
Details | The Details of the Job. | |
Company | The Client Company. | |
ChargeType | The Charge type. | |
InvoiceType | The Invoice Type. | |
CurrencyCode | The Currency Code. | |
ScheduleCode | The Schedule Code. | |
ActivityGroup | The Activity Group. | |
UseGST | The flag to indicate if the Job uses tax. | |
CreatedDate | The date the Job was created. |
⬆️ Back to top
JobMaintenanceKey
Property | Type | Description |
|---|---|---|
JobCode | String | The unique Code of the Job. |
⬆️ Back to top
JobMaintenanceApiModel
Property | Type | Description |
|---|---|---|
Key | The unique key of the Job. | |
JobFields | Data associated with the Job. | |
ValidationErrors | Array<MvcValidationError> | A list of specific validation errors if the save was unsuccessful. |
⬆️ Back to top
JobFields
Property | Type | Description |
|---|---|---|
JobCode | String | The unique Code of the Job. |
ContractCode | String | The Code of the Contract of the Job. |
HasContract | Boolean | A flag to indicate if the Job has a Contract. |
CurrencyValid | Boolean | A flag to indicate if the Job’s Price Code is valid for its Currency. |
GeneralFields | General data associated with the Company. | |
Extensions | Extension data associated with the Company. | |
BillingFields | Billing data associated with the Company. | |
ReferencesFields | Reference data associated with the Company. | |
AddressesFields | Address data associated with the Company. | |
JobGroupsFields.Rows | Array<JobGroupLine> | Job Groups associated with the Company. |
JobWorkCentresFields.Rows | Array<JobWorkCentreLine> | Job Work Centres associated with the Company. |
JobSchedulesFields.Rows | Array<JobScheduleLine> | Job Schedules associated with the Company. |
DocketCostSchedulesFields.Rows | Array<DocketCostScheduleLine> | Docket Cost Schedules associated with the Company. |
StandardOutputsFields.Rows | Array<StandardOutputLine> | Standard Outputs associated with the Company. |
⬆️ Back to top
GeneralFields
Property | Type | Description |
|---|---|---|
Name | The Description of the Job. | |
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 | Either 0 (No check), 1 (Warn if no budget), or 2 (Enforce budget). | |
JobDetails | Details | |
UseGst | Use tax or not. | |
AdminJob | Admin job or not. | |
ReqSched | Required Schedule. | |
TemplateCode | String | Job template code. |
⬆️ Back to top
BillingFields
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 | The Charge To Job | |
ChargeToActivity | The Charge To Activity | |
ChargeToLog | The Charge To Log | |
AllowInternalSales | Boolean | Internal sale status. |
⬆️ Back to top
ReferencesFields
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
AddressesFields
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
JobGroupKey
Property | Type | Description |
|---|---|---|
Job | String | The Job Code |
Category | String | The Job Category |
Group | String | The Job Group Code |
⬆️ Back to top
JobGroupLine
Property | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
Key | The unique key of the line. | |||||||
Category | The Job Category. | |||||||
Group | The Job Group. | |||||||
Value | Value. | Delete | ||||||
Status | String | Status | ||||||
ReadonlyFlag | Integer | Read Only status. | ||||||
ReadonlyMessage | String | Read Only message. | ||||||
OriginalKey | CurrentKey | Key | Index | Index | The value of the Job Group Line. |
⬆️ Back to top
JobWorkCentreKey
Property | Type | Description |
|---|---|---|
JobCode | String | The Job codeCode. |
WorkCentreCode | String | The Work Centre Code of Work centre. |
⬆️ Back to top
JobWorkCentreLine
Property | TypeDescription | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Key | The unique key of the line. | ||||||||||||||||||||||
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
JobScheduleKey
Property
⬆️ Back to top
JobScheduleKey
Property | Type | Description |
|---|---|---|
Job | String | The Job Code. |
Schedule | String | The Schedule Code. |
⬆️ Back to top
JobScheduleLine
Property | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
ScheduleKey | Type | Delete | Status | |||||
ReadonlyFlag | Integer | Read Only status. | ||||||
ReadonlyMessage | String | Read Only message. | ||||||
OriginalKey | CurrentKey | Key | Index | IntegerJobScheduleKey | The unique key of the line. | |||
Schedule | The Job Schedule. | |||||||
Type | The Schedule Type. |
⬆️ Back to top
DocketCostScheduleKey
Property | Type | Description |
|---|---|---|
Job | String | The Job Code. |
Catalogue | Integer | The Catalogue ID. |
⬆️ Back to top
DocketCostScheduleLine
Property | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Key | The unique key of the line. | ||||||||||
Catalogue | |||||||||||
ActivityGroup | Activity group | Delete | |||||||||
Status | String | Status. | |||||||||
ReadonlyFlag | Integer | ReadonlyMessage | String | OriginalKey | CurrentKey | Key | Index | integer |
⬆️ Back to top
StandardOutputKey
Property | Type | Description |
|---|---|---|
StandardOutputId | Integer | The ID of the Schedule Output. |
JobCode | String | The Job codeCode. |
ScheduleCode | String | The Schedule codeCode. |
OutputCode | String | The Schedule Output codeCode. |
ScheduleOutputRate | Number | The Rate of the Schedule Output. |
⬆️ Back to top
StandardOutputLine
Property | Type | Description |
|---|---|---|
Key | The unique key of the line. | |
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
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
⬆️ Back to top
JobBudgetKey
Property | Type | Description |
|---|---|---|
JobCode | String | The Code of Job. |
EstimateId | Integer | The ID of the Job Budget. |
⬆️ Back to top
JobBudgetLine
Property | Type | Description |
|---|---|---|
Key | The unique key for the line. | |
BudgetOrder | Integer | The Sequence Number of the line. |
BudgetType | String | |
BudgetTypeValue | Budget type | |
BudgetHeader | String | The Job Code and Description. |
BudgetHeaderValue | The Job Code and Description. | |
InternalReference | String | The sequence number that defines what the variation relates to. More details |
InternalReferenceValue | Internal reference | |
ClientReference | String | To label the budget something that your external stakeholders refer to it as. |
ClientReferenceValue | Client reference | |
Description | Description | Description text. |
DescriptionValue | Description text. | |
Year | Integer | Year |
Period | Integer | Financial period |
YearPeriodIndex | Integer | The unique index of the Year/Period of the Batch. |
YearPeriodValue | Year period. | |
EstimateDate | String | Estimated date. |
EstimateDateValue | Estimated date. | |
CostRate | Number | Cost rate. |
CostRateValue | Cost rate | |
Cost | Number | is the Qty multiplied by the Cost Rate |
field. |
CostValue |
Boolean
Cost. |
Delete
Status
String
ReadonlyFlag
Integer
ReadonlyMessage
OriginalKey
CurrentKey
Key
Index
RetailRate |
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
Number | The total Local Currency retail rates of the underlying budget lines. | |
RetailRateValue | Retail rate | |
Revenue | Number | the total Local Currency revenue amount of all underlying lines that this budget contains. |
RevenueValue | Revenue | |
Approved | Boolean | Approval status. |
ApprovedDate | String | Approved date. |
ApprovedDateValue | Approved date. |
⬆️ Back to top
BudgetBudgetLineKeyJobBudgetApiModel
Field
ParentLine
Integer
Property | Type | Description |
|---|
Key |
Property
Type
Description
BudgetOrder
Integer
BudgetHeader
String
BudgetType
String
InternalReference
String
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
The unique key of the Job Budget. | ||
Rows | Array<BudgetLine> | The Budget lines |
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 |
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
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. | |
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> | A list of specific validation errors if the save was unsuccessful. |
⬆️ Back to top
BudgetLineKey
Field | Type | Description |
|---|---|---|
ParentLine | Integer | Code of parent line. |
ChildLine | Integer | Code of child line. |
EstimateId | Integer | The ID of the Job Budget. |
EstimateLineId | Integer | The ID of the Job Budget Line. |
JobCode | String | The Job Code. |
ActivityCode | String | The Code of the Activity. |
WorkCentreCode | String | The Code of Work Centre of the line. |
Type | String | The Line Type. |
LineCode | String | The Line Code. |
UseRate | Boolean | A flag to indicate if the line uses a Markup. |
⬆️ Back top top
BudgetLine
Property | Type | Description |
|---|---|---|
Key | The unique key of the line. | |
Approved | A flag to approve the line. | |
SequenceNo | The Sequence Number. | |
JobCode | Code of the job. | |
BudgetType | ||
Type | The |
Line 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. |
Delete
YearNo
PeriodNo
Number of financial period.
Status
String
ReadonlyFlag
Integer
ReadonlyMessage
String
OriginalKey
CurrentKey
Key
Integer
⬆️ Back to top
BudgetBudgetSubLineKeyBudgetSubLineKey
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
BudgetJobBudgetKeyBudgetSubLine
Property | Type | Description |
|---|
Key |
The unique key of the line. |
Approved |
Approval status. |
Number
⬆️ 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
SequenceNo | The Sequence Number. | |
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. |
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
Unit |
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
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. | |
Details | Explanation or comment text. | |
YearNo | The Year No. | |
PeriodNo | Number of financial period. |
⬆️ Back to top
Examples
Example of JobBudgetDetailApi DELETE
| Expand | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Request
Response
Response sample
|
Sample of JobBudgetDetailApi GET
| Expand | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Request
Response
Response sample
|
Sample of JobBudgetDetailApi POST
| Expand | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Request
Response
Response sample
|
Sample of JobDetailApi DELETE
| Expand | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Request
Response
Response sample
|
Sample of getting details of a job
| Expand | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Request
Response
Response sample
|
Sample of JobDetailApi POST
| Expand | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Request
Response
Response sample
|
Sample of JobMaintenanceApi GET
| Expand | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Request
Response
Response sample
|
Sample of JobMaintenanceApi POST
| Expand | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Request
Response
Response sample
|
⬆️ Back to top
On this page
| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| Include Page | ||||
|---|---|---|---|---|
|