/buildops-service-config | Type: Application | PCID required: Yes
Tools
buildops-service-config_get_v1_adjustments_adjustment_id_line_items
Get Adjustment Items List by adjustmentId Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
page_size | integer | No | — | Number of items per page |
adjustmentId | string | Yes | — | adjustmentId identifier |
buildops-service-config_get_v1_adjustments_adjustment_id_line_items_adjustment_item_id
Get Adjustment Item by adjusmentItemId at Adjustment Level Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
adjustmentId | string | Yes | — | adjustmentId identifier |
adjustmentItemId | string | Yes | — | adjustmentItemId identifier |
buildops-service-config_get_v1_adjustments_id
Get Adjustment by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include_line_items | boolean | No | — | includes adjustment line items and transactions |
adjustmentId | string | Yes | — | adjustmentId identifier |
buildops-service-config_get_v1_classes_id
Get Class by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
classId | string | Yes | — | classId identifier |
buildops-service-config_get_v1_cost_codes
Get Cost Codes List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
page_size | integer | No | — | Number of items per page |
buildops-service-config_get_v1_cost_codes_cost_code_id
Get Cost Code by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
costCodeId | string | Yes | — | Cost Code Id |
buildops-service-config_get_v1_cost_types
Get Cost Types List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
page_size | integer | No | — | Number of items per page |
buildops-service-config_get_v1_cost_types_cost_type_id
Get Cost Type by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
costTypeId | string | Yes | — | Cost Type Id |
buildops-service-config_get_v1_inventory_products
Get Inventory Product List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
page_size | integer | No | — | Number of items per page |
productId | string | No | — | productId identifier if needed |
buildops-service-config_get_v1_job_tags
Get Job Tagsbuildops-service-config_get_v1_job_tags_job_tag_id
Get Job Tag by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tagId | string | Yes | — | Job Tag ID |
buildops-service-config_get_v1_job_types
List Job Types by Tenant ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
page_size | integer | No | — | Number of items per page |
buildops-service-config_get_v1_job_types_job_type_id
Get Job Type by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
jobTypeId | string | Yes | — | Job Type ID |
buildops-service-config_get_v1_sales_tax_id
Get Sales Tax by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Sales Tax ID |
buildops-service-config_get_v1_tax_codes
Get Tax Codes List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
page_size | integer | No | — | Number of items per page |
buildops-service-config_get_v1_tax_codes_id
Get Tax Code By ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Tax Code ID |
buildops-service-config_get_v1_tenant_tenant_id
Get Tenant by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tenantId | string | Yes | — | Tenant ID |
buildops-service-config_get_v1_util_entity_accounting_ref_id
Get Entity ID by accountingRefId Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountingRefId | string | Yes | — | accountingRefId identifier |
entity | string | Yes | — | The entity value |
buildops-service-config_get_v1_util_tenant_settings
Get settings from Tenant or Company Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
settingKey | string | No | — | settingKey for Tenant or Company settings |
buildops-service-config_post_v1_adjustments_adjustment_id_line_items
Create new Adjustment Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
adjustmentId | string | Yes | — | adjustmentId identifier |
amount | number | No | — | The amount value |
costCodeId | string | No | — | Cost Code Id |
departmentId | string | No | — | Department Id |
description | string | No | — | The description value |
jobCostTypeId | string | No | — | Job Cost Type Id |
ledgerAccountId | string | No | — | Ledger Account Id |
name | string | No | — | The name value |
quantity | number | No | — | The quantity value |
revenueTypeId | string | No | — | Revenue Type Id |
sortOrder | number | No | — | Sort Order |
taxable | boolean | No | — | The taxable value |
taxCodeId | string | No | — | Tax Code Id |
unitCost | number | No | — | Unit Cost |
unitPrice | number | No | — | Unit Price |
buildops-service-config_post_v1_classes
Sync Classes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
classes | object[] | Yes | — | The classes value |
buildops-service-config_post_v1_inventory_products
Create Inventory Product Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountingRefId | string | No | — | Accounting Ref Id |
accountingVersion | string | No | — | Accounting Version |
code | string | Yes | — | The code value |
name | string | Yes | — | The name value |
productId | string | Yes | — | Product Id |
buildops-service-config_post_v1_job_tag
Create Job Tag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
color | string | No | — | The color value |
note | string | No | — | The note value |
showOnMobile | boolean | No | — | Show On Mobile |
sortOrder | number | No | — | Sort Order |
tagName | string | Yes | — | Tag Name |
buildops-service-config_post_v1_sales_tax
Create Sales Tax Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountingApplication | string | No | — | Accounting Application |
accountingRefId | string | No | — | Accounting Ref Id |
accountType | object | No | — | Account Type |
city | string | No | — | The city value |
county | string | No | — | The county value |
name | string | No | — | The name value |
state | string | No | — | The state value |
taxRate | number | No | — | Tax Rate |
buildops-service-config_post_v1_tax_codes
Create Tax Code Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountingRefId | string | No | — | Accounting Ref Id |
accountingVersion | string | No | — | Accounting Version |
effectivePurchaseTaxRate | number | No | — | Effective Purchase Tax Rate |
effectiveSalesTaxRate | number | No | — | Effective Sales Tax Rate |
isActive | boolean | No | — | Is Active |
name | string | Yes | — | The name value |
purchaseTaxRates | object[] | No | — | Purchase Tax Rates |
salesTaxRates | object[] | No | — | Sales Tax Rates |
buildops-service-config_put_v1_adjustments_adjustment_id_line_items_adjustment_item_id
Update Adjustment Items Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
adjustmentId | string | Yes | — | adjustmentId identifier |
adjustmentItemId | string | Yes | — | adjustmentItemId identifier |
amount | number | No | — | The amount value |
costCodeId | string | No | — | Cost Code Id |
departmentId | string | No | — | Department Id |
description | string | No | — | The description value |
id | string | No | — | The id value |
jobCostTypeId | string | No | — | Job Cost Type Id |
ledgerAccountId | string | No | — | Ledger Account Id |
name | string | No | — | The name value |
quantity | number | No | — | The quantity value |
revenueTypeId | string | No | — | Revenue Type Id |
sortOrder | number | No | — | Sort Order |
taxable | boolean | No | — | The taxable value |
taxCodeId | string | No | — | Tax Code Id |
unitCost | number | No | — | Unit Cost |
unitPrice | number | No | — | Unit Price |
buildops-service-config_put_v1_inventory_products_id
Update Inventory Product by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Inventory Product ID |
accountingVersion | string | No | — | Accounting Version |
code | string | No | — | The code value |
name | string | No | — | The name value |
syncStatus | string | No | — | Sync Status |
version | number | No | — | The version value |
buildops-service-config_put_v1_sales_tax_sales_tax_id
Update Sales Tax By Tax ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Sales Tax ID |
accountingApplication | string | No | — | Accounting Application |
accountingRefId | string | No | — | Accounting Ref Id |
accountType | object | No | — | Account Type |
city | string | No | — | The city value |
county | string | No | — | The county value |
name | string | No | — | The name value |
state | string | No | — | The state value |
taxRate | number | No | — | Tax Rate |
buildops-service-config_put_v1_tax_codes_id
Update Tax Code by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Tax Code ID |
accountingVersion | string | No | — | Accounting Version |
accoutingRefId | string | No | — | Accouting Ref Id |
effectivePurchaseTaxRate | number | No | — | Effective Purchase Tax Rate |
effectiveSalesTaxRate | number | No | — | Effective Sales Tax Rate |
isActive | boolean | No | — | Is Active |
name | string | No | — | The name value |
purchaseTaxRates | object[] | No | — | Purchase Tax Rates |
salesTaxRates | object[] | No | — | Sales Tax Rates |
version | number | No | — | The version value |

