Skip to main content
Server path: /buildops-service-config | Type: Application | PCID required: Yes

Tools

ToolDescription
buildops-service-config_get_v1_adjustments_adjustment_id_line_itemsGet Adjustment Items List by adjustmentId
buildops-service-config_get_v1_adjustments_adjustment_id_line_items_adjustment_item_idGet Adjustment Item by adjusmentItemId at Adjustment Level
buildops-service-config_get_v1_adjustments_idGet Adjustment by ID
buildops-service-config_get_v1_classes_idGet Class by ID
buildops-service-config_get_v1_cost_codesGet Cost Codes List
buildops-service-config_get_v1_cost_codes_cost_code_idGet Cost Code by ID
buildops-service-config_get_v1_cost_typesGet Cost Types List
buildops-service-config_get_v1_cost_types_cost_type_idGet Cost Type by ID
buildops-service-config_get_v1_inventory_productsGet Inventory Product List
buildops-service-config_get_v1_job_tagsGet Job Tags
buildops-service-config_get_v1_job_tags_job_tag_idGet Job Tag by ID
buildops-service-config_get_v1_job_typesList Job Types by Tenant ID
buildops-service-config_get_v1_job_types_job_type_idGet Job Type by ID
buildops-service-config_get_v1_sales_tax_idGet Sales Tax by ID
buildops-service-config_get_v1_tax_codesGet Tax Codes List
buildops-service-config_get_v1_tax_codes_idGet Tax Code By ID
buildops-service-config_get_v1_tenant_tenant_idGet Tenant by ID
buildops-service-config_get_v1_util_entity_accounting_ref_idGet Entity ID by accountingRefId
buildops-service-config_get_v1_util_tenant_settingsGet settings from Tenant or Company
buildops-service-config_post_v1_adjustments_adjustment_id_line_itemsCreate new Adjustment Item
buildops-service-config_post_v1_classesSync Classes
buildops-service-config_post_v1_inventory_productsCreate Inventory Product
buildops-service-config_post_v1_job_tagCreate Job Tag
buildops-service-config_post_v1_sales_taxCreate Sales Tax
buildops-service-config_post_v1_tax_codesCreate Tax Code
buildops-service-config_put_v1_adjustments_adjustment_id_line_items_adjustment_item_idUpdate Adjustment Items
buildops-service-config_put_v1_inventory_products_idUpdate Inventory Product by ID
buildops-service-config_put_v1_sales_tax_sales_tax_idUpdate Sales Tax By Tax ID
buildops-service-config_put_v1_tax_codes_idUpdate Tax Code by ID

buildops-service-config_get_v1_adjustments_adjustment_id_line_items

Get Adjustment Items List by adjustmentId Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination
page_sizeintegerNoNumber of items per page
adjustmentIdstringYesadjustmentId identifier

buildops-service-config_get_v1_adjustments_adjustment_id_line_items_adjustment_item_id

Get Adjustment Item by adjusmentItemId at Adjustment Level Parameters:
ParameterTypeRequiredDefaultDescription
adjustmentIdstringYesadjustmentId identifier
adjustmentItemIdstringYesadjustmentItemId identifier

buildops-service-config_get_v1_adjustments_id

Get Adjustment by ID Parameters:
ParameterTypeRequiredDefaultDescription
include_line_itemsbooleanNoincludes adjustment line items and transactions
adjustmentIdstringYesadjustmentId identifier

buildops-service-config_get_v1_classes_id

Get Class by ID Parameters:
ParameterTypeRequiredDefaultDescription
classIdstringYesclassId identifier

buildops-service-config_get_v1_cost_codes

Get Cost Codes List Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination
page_sizeintegerNoNumber of items per page

buildops-service-config_get_v1_cost_codes_cost_code_id

Get Cost Code by ID Parameters:
ParameterTypeRequiredDefaultDescription
costCodeIdstringYesCost Code Id

buildops-service-config_get_v1_cost_types

Get Cost Types List Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination
page_sizeintegerNoNumber of items per page

buildops-service-config_get_v1_cost_types_cost_type_id

Get Cost Type by ID Parameters:
ParameterTypeRequiredDefaultDescription
costTypeIdstringYesCost Type Id

buildops-service-config_get_v1_inventory_products

Get Inventory Product List Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination
page_sizeintegerNoNumber of items per page
productIdstringNoproductId identifier if needed

buildops-service-config_get_v1_job_tags

Get Job Tags

buildops-service-config_get_v1_job_tags_job_tag_id

Get Job Tag by ID Parameters:
ParameterTypeRequiredDefaultDescription
tagIdstringYesJob Tag ID

buildops-service-config_get_v1_job_types

List Job Types by Tenant ID Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination
page_sizeintegerNoNumber of items per page

buildops-service-config_get_v1_job_types_job_type_id

Get Job Type by ID Parameters:
ParameterTypeRequiredDefaultDescription
jobTypeIdstringYesJob Type ID

buildops-service-config_get_v1_sales_tax_id

Get Sales Tax by ID Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesSales Tax ID

buildops-service-config_get_v1_tax_codes

Get Tax Codes List Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination
page_sizeintegerNoNumber of items per page

buildops-service-config_get_v1_tax_codes_id

Get Tax Code By ID Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesTax Code ID

buildops-service-config_get_v1_tenant_tenant_id

Get Tenant by ID Parameters:
ParameterTypeRequiredDefaultDescription
tenantIdstringYesTenant ID

buildops-service-config_get_v1_util_entity_accounting_ref_id

Get Entity ID by accountingRefId Parameters:
ParameterTypeRequiredDefaultDescription
accountingRefIdstringYesaccountingRefId identifier
entitystringYesThe entity value

buildops-service-config_get_v1_util_tenant_settings

Get settings from Tenant or Company Parameters:
ParameterTypeRequiredDefaultDescription
settingKeystringNosettingKey for Tenant or Company settings

buildops-service-config_post_v1_adjustments_adjustment_id_line_items

Create new Adjustment Item Parameters:
ParameterTypeRequiredDefaultDescription
adjustmentIdstringYesadjustmentId identifier
amountnumberNoThe amount value
costCodeIdstringNoCost Code Id
departmentIdstringNoDepartment Id
descriptionstringNoThe description value
jobCostTypeIdstringNoJob Cost Type Id
ledgerAccountIdstringNoLedger Account Id
namestringNoThe name value
quantitynumberNoThe quantity value
revenueTypeIdstringNoRevenue Type Id
sortOrdernumberNoSort Order
taxablebooleanNoThe taxable value
taxCodeIdstringNoTax Code Id
unitCostnumberNoUnit Cost
unitPricenumberNoUnit Price

buildops-service-config_post_v1_classes

Sync Classes Parameters:
ParameterTypeRequiredDefaultDescription
classesobject[]YesThe classes value

buildops-service-config_post_v1_inventory_products

Create Inventory Product Parameters:
ParameterTypeRequiredDefaultDescription
accountingRefIdstringNoAccounting Ref Id
accountingVersionstringNoAccounting Version
codestringYesThe code value
namestringYesThe name value
productIdstringYesProduct Id

buildops-service-config_post_v1_job_tag

Create Job Tag Parameters:
ParameterTypeRequiredDefaultDescription
colorstringNoThe color value
notestringNoThe note value
showOnMobilebooleanNoShow On Mobile
sortOrdernumberNoSort Order
tagNamestringYesTag Name

buildops-service-config_post_v1_sales_tax

Create Sales Tax Parameters:
ParameterTypeRequiredDefaultDescription
accountingApplicationstringNoAccounting Application
accountingRefIdstringNoAccounting Ref Id
accountTypeobjectNoAccount Type
citystringNoThe city value
countystringNoThe county value
namestringNoThe name value
statestringNoThe state value
taxRatenumberNoTax Rate

buildops-service-config_post_v1_tax_codes

Create Tax Code Parameters:
ParameterTypeRequiredDefaultDescription
accountingRefIdstringNoAccounting Ref Id
accountingVersionstringNoAccounting Version
effectivePurchaseTaxRatenumberNoEffective Purchase Tax Rate
effectiveSalesTaxRatenumberNoEffective Sales Tax Rate
isActivebooleanNoIs Active
namestringYesThe name value
purchaseTaxRatesobject[]NoPurchase Tax Rates
salesTaxRatesobject[]NoSales Tax Rates

buildops-service-config_put_v1_adjustments_adjustment_id_line_items_adjustment_item_id

Update Adjustment Items Parameters:
ParameterTypeRequiredDefaultDescription
adjustmentIdstringYesadjustmentId identifier
adjustmentItemIdstringYesadjustmentItemId identifier
amountnumberNoThe amount value
costCodeIdstringNoCost Code Id
departmentIdstringNoDepartment Id
descriptionstringNoThe description value
idstringNoThe id value
jobCostTypeIdstringNoJob Cost Type Id
ledgerAccountIdstringNoLedger Account Id
namestringNoThe name value
quantitynumberNoThe quantity value
revenueTypeIdstringNoRevenue Type Id
sortOrdernumberNoSort Order
taxablebooleanNoThe taxable value
taxCodeIdstringNoTax Code Id
unitCostnumberNoUnit Cost
unitPricenumberNoUnit Price

buildops-service-config_put_v1_inventory_products_id

Update Inventory Product by ID Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesInventory Product ID
accountingVersionstringNoAccounting Version
codestringNoThe code value
namestringNoThe name value
syncStatusstringNoSync Status
versionnumberNoThe version value

buildops-service-config_put_v1_sales_tax_sales_tax_id

Update Sales Tax By Tax ID Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesSales Tax ID
accountingApplicationstringNoAccounting Application
accountingRefIdstringNoAccounting Ref Id
accountTypeobjectNoAccount Type
citystringNoThe city value
countystringNoThe county value
namestringNoThe name value
statestringNoThe state value
taxRatenumberNoTax Rate

buildops-service-config_put_v1_tax_codes_id

Update Tax Code by ID Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesTax Code ID
accountingVersionstringNoAccounting Version
accoutingRefIdstringNoAccouting Ref Id
effectivePurchaseTaxRatenumberNoEffective Purchase Tax Rate
effectiveSalesTaxRatenumberNoEffective Sales Tax Rate
isActivebooleanNoIs Active
namestringNoThe name value
purchaseTaxRatesobject[]NoPurchase Tax Rates
salesTaxRatesobject[]NoSales Tax Rates
versionnumberNoThe version value