AdvancedBudget

Returns material advanced budgets

This call will return a list of material advanced budgets (i.e., the cartesian product of material cost types and cost codes) for the specified job, purchase order, discontinued status or deleted status.

Securitybearer
Request
path Parameters
jobId
required
string <uuid>

The job id to query by.

query Parameters
purchaseOrderId
string <uuid>

The purchase order id to query by.

isDiscontinued
boolean
Default: false

If true, returns discontinued material advanced budgets.

isDeleted
boolean
Default: false

If true, returns deleted material advanced budgets.

Responses
get/api/v1/jobs/{jobId}/advancedBudgets/material
Request samples 
Response samples 
application/json
[
  • {
    }
]
Creates material advanced budget
Creates a new material advanced budget with the information provided.


Securitybearer 
Request 
Request Body schema: 
The material advanced budget to be created.


costCodeId
required
string <uuid> 
The cost code id.


 
purchaseOrderDetailId
required
string <uuid> 
The purchase order detail id.


 
status
string (MaterialStatus) 
 Enum: "active" "completed" "discontinued"  
quantity
number <double> 
The quantity of the material.


 
Responses 
post/api/v1/advancedBudgets/material
Request samples 
{
  • "costCodeId": "7b2184ad-e3d5-4064-a73d-549deb2c88c2",
  • "purchaseOrderDetailId": "cd9cd863-5229-4c7a-b5a0-ea10508203c9",
  • "status": "active",
  • "quantity": 67.2
}
Response samples 
application/json
{
  • "id": "6d343fd2-8a25-428d-ade7-6309577969cd",
  • "jobMaterialId": "93404c70-18a5-438e-875b-fc47f7031367",
  • "materialDescription": " material description",
  • "purchaseOrderId": "788837e9-492e-47f3-9a28-299f49967f04",
  • "costCode": "cost code",
  • "costCodeDescription": "cost code description",
  • "salesTaxPercent": 8.25,
  • "unitCost": 50.5,
  • "unitOfMeasure": "EA",
  • "vendorId": "ebb2645b-8f2e-4a07-a0c1-9db48723f7e8",
  • "isDeleted": false,
  • "materialBusinessUnitId": "bbc8fc73-87ac-4968-bd43-4809b8291f69",
  • "costCodeId": "cd81addc-ba92-422e-814b-7d2363a167bf",
  • "purchaseOrderDetailId": "7f3fdac4-9a25-4c74-afea-78b4d7bea623",
  • "status": "active",
  • "quantity": 100.1
}
Returns subcontract work item advanced budgets
This call will return a list of subcontract item advanced budgets (i.e., the cartesian product of subcontract cost types and cost codes)
for the specified job.


Securitybearer 
Request 
path Parameters
jobId
required
string <uuid> 
 
query Parameters
vendorContractId
string <uuid> 
 
Responses 
get/api/v1/jobs/{jobId}/advancedBudgets/subcontract
Request samples 
Response samples 
application/json
[
  • {
    }
]
Creates subcontract advanced budget
This call creates a new subcontract advanced budget with the information provided.


Securitybearer 
Request 
Request Body schema: 
The subcontract budget to create.


costCodeId
required
string <uuid> 
The cost code id.


 
vendorContractDetailId
required
string <uuid> 
The vendor contract detail id.


 
status
string (WorkItemStatus) 
 Enum: "active" "completed" "discontinued"  
quantity
number <double> 
The quantity of the subcontract.


 
Responses 
post/api/v1/advancedBudgets/subcontract
Request samples 
{
  • "costCodeId": "7b2184ad-e3d5-4064-a73d-549deb2c88c2",
  • "vendorContractDetailId": "842684f8-48ba-4961-b27a-d6e2cc38d758",
  • "status": "active",
  • "quantity": 25.9
}
Response samples 
application/json
{
  • "id": "7a6560ce-c0b7-429f-9cf7-6fe4589024cd",
  • "jobSubcontractId": "11a1eff4-e213-4036-a49e-2b7d8de66d71",
  • "subcontractDescription": "subcontract description",
  • "vendorContractId": "307a88ff-4171-46fd-8c24-8992907915e0",
  • "costCode": "cost code",
  • "costCodeDescription": "cost code description",
  • "salesTaxPercent": 8.25,
  • "unitCost": 50.5,
  • "unitOfMeasure": "EA",
  • "vendorId": "dd3fd638-e86e-466e-8265-3f688f57573a",
  • "mWorkItemBusinessUnitId": "2dcad479-bacf-47c2-94b7-f2dd830c637b",
  • "costCodeId": "dfb7f751-7839-4dce-ad65-70e6e26f2a7f",
  • "vendorContractDetailId": "b5ac8592-e6c7-4f23-acd7-914a5afb336a",
  • "status": "active",
  • "quantity": 100.1
}
Returns a list of user-defined custom cost-type items advanced budget (i.e., the cartesian product of custom cost types and cost codes).
Securitybearer 
Request 
path Parameters
jobId
required
string <uuid> 
 
query Parameters
purchaseOrderId
string <uuid> 
 
isDiscontinued
boolean
 Default:  false
 
isDeleted
boolean
 Default:  false
 
Responses 
get/api/v1/jobs/{jobId}/advancedBudgets/custom
Request samples 
Response samples 
application/json
[
  • {
    }
]
Creates a new custom-cost-type item advanced budget.
Securitybearer 
Request 
Request Body schema: 
costCodeId
required
string <uuid> 
The cost code id.


 
purchaseOrderDetailId
string or null <uuid> 
The purchase order detail id.


 
status
string (CustomCostTypeStatus) 
 Enum: "active" "completed" "discontinued"  
quantity
number <double> 
The quantity of the custom-cost-type item.


 
Responses 
post/api/v1/advancedBudgets/custom
Request samples 
{
  • "costCodeId": "7b2184ad-e3d5-4064-a73d-549deb2c88c2",
  • "purchaseOrderDetailId": "cd9cd863-5229-4c7a-b5a0-ea10508203c9",
  • "status": "active",
  • "quantity": 12.35
}
Response samples 
application/json
{
  • "costCodeId": "ce2fe38c-f5a9-477c-ad3e-323596814295",
  • "purchaseOrderDetailId": "85558881-5978-47d4-9ba2-d0406f671a77",
  • "status": "active",
  • "quantity": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "jobCustomCostTypeItemId": "5997e37f-1f9f-43d2-85ab-510b4f512322",
  • "customCostTypeItemDescription": "string",
  • "purchaseOrderId": "84a099d9-2935-4997-a6ac-0d3ee9bbef72",
  • "costCode": "string",
  • "costCodeDescription": "string",
  • "salesTaxPercent": 0,
  • "unitCost": 0,
  • "unitOfMeasure": "string",
  • "vendorId": "e9b57fab-1850-44d4-8499-71fd15c845a0",
  • "isDeleted": true,
  • "mCostTypeItemBusinessUnitId": "0d14c3f3-ed75-4059-8d25-0b419cf96d30"
}