/buildops-master-data | Type: Application | PCID required: Yes
Tools
buildops-master-data_batch_activate_employees
Batch activate employees Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | string[] | Yes | — | Request body |
buildops-master-data_batch_create_employees
Batch create Employees Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | object[] | Yes | — | Request body |
buildops-master-data_batch_deactivate_employees
Batch deactivate employees Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | string[] | Yes | — | Request body |
buildops-master-data_batch_disable_login_for_employees
Disable login for employees Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | string[] | Yes | — | Request body |
buildops-master-data_batch_enable_login_for_employees
Enable login for employees Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | string[] | Yes | — | Request body |
buildops-master-data_batch_invite_employees
Batch invite employees Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | string[] | Yes | — | Request body |
buildops-master-data_batch_resent_invite_email_to_employees
Resend invite emails to employees Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | string[] | Yes | — | Request body |
buildops-master-data_batch_update_employees
Batch update Employees Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | object[] | Yes | — | Request body |
buildops-master-data_batch_update_passwords_sync
Update passwords Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | object[] | Yes | — | Request body |
buildops-master-data_batch_update_usernames_or_emails_sync
Update usernames or emails Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | object[] | Yes | — | Request body |
buildops-master-data_delete_v1_customers_id_tags_tag_id
Disassociate a Customer Tag for a Customer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Customer ID |
tagId | string | Yes | — | Tag ID |
buildops-master-data_fetch_employees_by_email
Fetch employees by email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | Yes | — | The email value |
buildops-master-data_fetch_employees_by_ids
Fetch employees by IDs Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | string[] | Yes | — | Request body |
buildops-master-data_fetch_sso_status
Get SSO status for employees Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | string[] | Yes | — | Request body |
buildops-master-data_find_by_user_name
Find employee by username Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userName | string | Yes | — | User Name |
buildops-master-data_get_employees_paginated
List of Employees Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
limit | integer | No | — | Maximum number of results to return |
sortBy | string | No | — | Sort By |
sortOrder | string | No | — | Sort Order |
filters | object[] | No | — | The filters value |
buildops-master-data_get_v1_addresses
Get Addresses List by TenantId Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | number | No | — | Page number for pagination |
page_size | integer | No | — | Number of items per page |
buildops-master-data_get_v1_addresses_id
Get Address by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Address ID |
buildops-master-data_get_v1_customers
Get Customers List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | number | No | — | Page number for pagination |
limit | integer | No | — | Number of items per page |
include_inactive | string | No | — | if true the list will return all customers including inactive ones |
buildops-master-data_get_v1_customers_id
Get Customer by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Customer ID |
buildops-master-data_get_v1_customers_id_properties
Get Properties List by customerId Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | number | No | — | Page number for pagination |
page_size | integer | No | — | Number of items per page |
include_inactive | boolean | No | — | Include inactive records in results |
id | string | Yes | — | Customer ID |
include_addresses | boolean | No | — | Allows to return properties with his addresses. |
buildops-master-data_get_v1_employees
Get Employees List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | number | No | — | Page number for pagination |
page_size | integer | No | — | Number of items per page |
include_inactive | boolean | No | — | Include inactive records in results |
name | string | No | — | Employee Name |
buildops-master-data_get_v1_employees_employee_id
Get Employee by Employee ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
employeeId | string | Yes | — | Employee ID |
buildops-master-data_get_v1_settings_custom_fields_customer_tags
Get Customer Tags by TenantId Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | number | No | — | Page number for pagination |
page_size | integer | No | — | Number of items per page |
buildops-master-data_post_v1_customers
Create a customer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountingAttributes | object | No | — | Accounting Attributes |
accountNumber | string | No | — | Account Number |
addresses | object[] | No | — | The addresses value |
creditLimit | number | No | — | Credit Limit |
customerNumber | string | No | — | Customer Number |
customerType | string | No | — | Customer Type |
email | string | No | — | The email value |
invoiceDeliveryPref | string | No | — | Invoice Delivery Pref |
invoicePresetId | string | No | — | Invoice Preset Id |
isActive | boolean | No | — | Is Active |
isTaxable | boolean | No | — | Is Taxable |
name | string | Yes | — | The name value |
paymentTermId | string | No | — | Payment Term Id |
phoneAlternate | string | No | — | Phone Alternate |
phonePrimary | string | No | — | Phone Primary |
priceBookId | string | No | — | Price Book Id |
receiveSMS | boolean | No | — | Receive SMS |
sameAddress | boolean | No | — | Same Address |
status | string | No | — | The status value |
taxCodeId | string | No | — | Tax Code Id |
taxExemptIdValue | string | No | — | Tax Exempt Id Value |
taxRateId | string | No | — | Tax Rate Id |
taxRateValue | number | No | — | Tax Rate Value |
buildops-master-data_post_v1_customers_id_tags
Associate Customer Tag to a Customer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Customer ID |
body | string[] | No | — | Request body |
buildops-master-data_put_v1_addresses
Update Address By Address ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Address ID |
addressLine1 | string | No | — | Address Line1 |
addressLine2 | string | No | — | Address Line2 |
addressType | object | No | — | Address Type |
billTo | string | No | — | Bill To |
city | string | No | — | The city value |
country | string | No | — | The country value |
isActive | boolean | No | — | Is Active |
latitude | string | No | — | The latitude value |
longitude | string | No | — | The longitude value |
shipTo | string | No | — | Ship To |
state | string | No | — | The state value |
status | string | No | — | The status value |
version | number | No | — | The version value |
zipcode | string | No | — | The zipcode value |
buildops-master-data_put_v1_customers_id
Update a Customer by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Customer ID |
accountingAttributes | object | No | — | Accounting Attributes |
accountNumber | string | No | — | Account Number |
creditLimit | number | No | — | Credit Limit |
customerNumber | string | No | — | Customer Number |
customerType | string | No | — | Customer Type |
customerTypeValue | string | No | — | Deprecated: use customerType instead |
email | string | No | — | The email value |
invoiceDeliveryPref | string | No | — | Invoice Delivery Pref |
invoicePresetId | string | No | — | Invoice Preset Id |
isActive | boolean | No | — | Is Active |
isTaxable | boolean | No | — | Is Taxable |
name | string | No | — | The name value |
paymentTermId | string | No | — | Payment Term Id |
phoneAlternate | string | No | — | Phone Alternate |
phonePrimary | string | No | — | Phone Primary |
priceBookId | string | No | — | Price Book Id |
receiveSMS | boolean | No | — | Receive SMS |
sameAddress | boolean | No | — | Same Address |
status | string | No | — | The status value |
taxCodeId | string | No | — | Tax Code Id |
taxExemptIdValue | string | No | — | Tax Exempt Id Value |
taxRateId | string | No | — | Tax Rate Id |
taxRateValue | number | No | — | Tax Rate Value |
buildops-master-data_update_my_password
Update my password Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
newPassword | string | Yes | — | New Password |

