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

Tools

ToolDescription
buildops-master-data_batch_activate_employeesBatch activate employees
buildops-master-data_batch_create_employeesBatch create Employees
buildops-master-data_batch_deactivate_employeesBatch deactivate employees
buildops-master-data_batch_disable_login_for_employeesDisable login for employees
buildops-master-data_batch_enable_login_for_employeesEnable login for employees
buildops-master-data_batch_invite_employeesBatch invite employees
buildops-master-data_batch_resent_invite_email_to_employeesResend invite emails to employees
buildops-master-data_batch_update_employeesBatch update Employees
buildops-master-data_batch_update_passwords_syncUpdate passwords
buildops-master-data_batch_update_usernames_or_emails_syncUpdate usernames or emails
buildops-master-data_delete_v1_customers_id_tags_tag_idDisassociate a Customer Tag for a Customer
buildops-master-data_fetch_employees_by_emailFetch employees by email
buildops-master-data_fetch_employees_by_idsFetch employees by IDs
buildops-master-data_fetch_sso_statusGet SSO status for employees
buildops-master-data_find_by_user_nameFind employee by username
buildops-master-data_get_employees_paginatedList of Employees
buildops-master-data_get_v1_addressesGet Addresses List by TenantId
buildops-master-data_get_v1_addresses_idGet Address by ID
buildops-master-data_get_v1_customersGet Customers List
buildops-master-data_get_v1_customers_idGet Customer by ID
buildops-master-data_get_v1_customers_id_propertiesGet Properties List by customerId
buildops-master-data_get_v1_employeesGet Employees List
buildops-master-data_get_v1_employees_employee_idGet Employee by Employee ID
buildops-master-data_get_v1_settings_custom_fields_customer_tagsGet Customer Tags by TenantId
buildops-master-data_post_v1_customersCreate a customer
buildops-master-data_post_v1_customers_id_tagsAssociate Customer Tag to a Customer
buildops-master-data_put_v1_addressesUpdate Address By Address ID
buildops-master-data_put_v1_customers_idUpdate a Customer by ID
buildops-master-data_update_my_passwordUpdate my password

buildops-master-data_batch_activate_employees

Batch activate employees Parameters:
ParameterTypeRequiredDefaultDescription
bodystring[]YesRequest body

buildops-master-data_batch_create_employees

Batch create Employees Parameters:
ParameterTypeRequiredDefaultDescription
bodyobject[]YesRequest body

buildops-master-data_batch_deactivate_employees

Batch deactivate employees Parameters:
ParameterTypeRequiredDefaultDescription
bodystring[]YesRequest body

buildops-master-data_batch_disable_login_for_employees

Disable login for employees Parameters:
ParameterTypeRequiredDefaultDescription
bodystring[]YesRequest body

buildops-master-data_batch_enable_login_for_employees

Enable login for employees Parameters:
ParameterTypeRequiredDefaultDescription
bodystring[]YesRequest body

buildops-master-data_batch_invite_employees

Batch invite employees Parameters:
ParameterTypeRequiredDefaultDescription
bodystring[]YesRequest body

buildops-master-data_batch_resent_invite_email_to_employees

Resend invite emails to employees Parameters:
ParameterTypeRequiredDefaultDescription
bodystring[]YesRequest body

buildops-master-data_batch_update_employees

Batch update Employees Parameters:
ParameterTypeRequiredDefaultDescription
bodyobject[]YesRequest body

buildops-master-data_batch_update_passwords_sync

Update passwords Parameters:
ParameterTypeRequiredDefaultDescription
bodyobject[]YesRequest body

buildops-master-data_batch_update_usernames_or_emails_sync

Update usernames or emails Parameters:
ParameterTypeRequiredDefaultDescription
bodyobject[]YesRequest body

buildops-master-data_delete_v1_customers_id_tags_tag_id

Disassociate a Customer Tag for a Customer Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesCustomer ID
tagIdstringYesTag ID

buildops-master-data_fetch_employees_by_email

Fetch employees by email Parameters:
ParameterTypeRequiredDefaultDescription
emailstringYesThe email value

buildops-master-data_fetch_employees_by_ids

Fetch employees by IDs Parameters:
ParameterTypeRequiredDefaultDescription
bodystring[]YesRequest body

buildops-master-data_fetch_sso_status

Get SSO status for employees Parameters:
ParameterTypeRequiredDefaultDescription
bodystring[]YesRequest body

buildops-master-data_find_by_user_name

Find employee by username Parameters:
ParameterTypeRequiredDefaultDescription
userNamestringYesUser Name

buildops-master-data_get_employees_paginated

List of Employees Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination
limitintegerNoMaximum number of results to return
sortBystringNoSort By
sortOrderstringNoSort Order
filtersobject[]NoThe filters value

buildops-master-data_get_v1_addresses

Get Addresses List by TenantId Parameters:
ParameterTypeRequiredDefaultDescription
pagenumberNoPage number for pagination
page_sizeintegerNoNumber of items per page

buildops-master-data_get_v1_addresses_id

Get Address by ID Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesAddress ID

buildops-master-data_get_v1_customers

Get Customers List Parameters:
ParameterTypeRequiredDefaultDescription
pagenumberNoPage number for pagination
limitintegerNoNumber of items per page
include_inactivestringNoif true the list will return all customers including inactive ones

buildops-master-data_get_v1_customers_id

Get Customer by ID Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesCustomer ID

buildops-master-data_get_v1_customers_id_properties

Get Properties List by customerId Parameters:
ParameterTypeRequiredDefaultDescription
pagenumberNoPage number for pagination
page_sizeintegerNoNumber of items per page
include_inactivebooleanNoInclude inactive records in results
idstringYesCustomer ID
include_addressesbooleanNoAllows to return properties with his addresses.

buildops-master-data_get_v1_employees

Get Employees List Parameters:
ParameterTypeRequiredDefaultDescription
pagenumberNoPage number for pagination
page_sizeintegerNoNumber of items per page
include_inactivebooleanNoInclude inactive records in results
namestringNoEmployee Name

buildops-master-data_get_v1_employees_employee_id

Get Employee by Employee ID Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdstringYesEmployee ID

buildops-master-data_get_v1_settings_custom_fields_customer_tags

Get Customer Tags by TenantId Parameters:
ParameterTypeRequiredDefaultDescription
pagenumberNoPage number for pagination
page_sizeintegerNoNumber of items per page

buildops-master-data_post_v1_customers

Create a customer Parameters:
ParameterTypeRequiredDefaultDescription
accountingAttributesobjectNoAccounting Attributes
accountNumberstringNoAccount Number
addressesobject[]NoThe addresses value
creditLimitnumberNoCredit Limit
customerNumberstringNoCustomer Number
customerTypestringNoCustomer Type
emailstringNoThe email value
invoiceDeliveryPrefstringNoInvoice Delivery Pref
invoicePresetIdstringNoInvoice Preset Id
isActivebooleanNoIs Active
isTaxablebooleanNoIs Taxable
namestringYesThe name value
paymentTermIdstringNoPayment Term Id
phoneAlternatestringNoPhone Alternate
phonePrimarystringNoPhone Primary
priceBookIdstringNoPrice Book Id
receiveSMSbooleanNoReceive SMS
sameAddressbooleanNoSame Address
statusstringNoThe status value
taxCodeIdstringNoTax Code Id
taxExemptIdValuestringNoTax Exempt Id Value
taxRateIdstringNoTax Rate Id
taxRateValuenumberNoTax Rate Value

buildops-master-data_post_v1_customers_id_tags

Associate Customer Tag to a Customer Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesCustomer ID
bodystring[]NoRequest body

buildops-master-data_put_v1_addresses

Update Address By Address ID Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesAddress ID
addressLine1stringNoAddress Line1
addressLine2stringNoAddress Line2
addressTypeobjectNoAddress Type
billTostringNoBill To
citystringNoThe city value
countrystringNoThe country value
isActivebooleanNoIs Active
latitudestringNoThe latitude value
longitudestringNoThe longitude value
shipTostringNoShip To
statestringNoThe state value
statusstringNoThe status value
versionnumberNoThe version value
zipcodestringNoThe zipcode value

buildops-master-data_put_v1_customers_id

Update a Customer by ID Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesCustomer ID
accountingAttributesobjectNoAccounting Attributes
accountNumberstringNoAccount Number
creditLimitnumberNoCredit Limit
customerNumberstringNoCustomer Number
customerTypestringNoCustomer Type
customerTypeValuestringNoDeprecated: use customerType instead
emailstringNoThe email value
invoiceDeliveryPrefstringNoInvoice Delivery Pref
invoicePresetIdstringNoInvoice Preset Id
isActivebooleanNoIs Active
isTaxablebooleanNoIs Taxable
namestringNoThe name value
paymentTermIdstringNoPayment Term Id
phoneAlternatestringNoPhone Alternate
phonePrimarystringNoPhone Primary
priceBookIdstringNoPrice Book Id
receiveSMSbooleanNoReceive SMS
sameAddressbooleanNoSame Address
statusstringNoThe status value
taxCodeIdstringNoTax Code Id
taxExemptIdValuestringNoTax Exempt Id Value
taxRateIdstringNoTax Rate Id
taxRateValuenumberNoTax Rate Value

buildops-master-data_update_my_password

Update my password Parameters:
ParameterTypeRequiredDefaultDescription
newPasswordstringYesNew Password