Skip to content

AgreementTypeWorkTypeExclusionsApi.md

Latest commit

 

History

History
391 lines (288 loc) · 14.5 KB

AgreementTypeWorkTypeExclusionsApi.md

File metadata and controls

391 lines (288 loc) · 14.5 KB

ConnectWise::AgreementTypeWorkTypeExclusionsApi

All URIs are relative to http://na.myconnectwise.net/v4_6_release/apis/3.0

Method HTTP request Description
delete_finance_agreement_types_by_parent_id_work_type_exclusions_by_id DELETE /finance/agreementTypes/{parentId}/workTypeExclusions/{id} Delete AgreementTypeWorkTypeExclusion
get_finance_agreement_types_by_parent_id_work_type_exclusions GET /finance/agreementTypes/{parentId}/workTypeExclusions Get List of AgreementTypeWorkTypeExclusion
get_finance_agreement_types_by_parent_id_work_type_exclusions_by_id GET /finance/agreementTypes/{parentId}/workTypeExclusions/{id} Get AgreementTypeWorkTypeExclusion
get_finance_agreement_types_by_parent_id_work_type_exclusions_count GET /finance/agreementTypes/{parentId}/workTypeExclusions/count Get Count of AgreementTypeWorkTypeExclusion
post_finance_agreement_types_by_parent_id_work_type_exclusions POST /finance/agreementTypes/{parentId}/workTypeExclusions Post AgreementTypeWorkTypeExclusion

delete_finance_agreement_types_by_parent_id_work_type_exclusions_by_id

delete_finance_agreement_types_by_parent_id_work_type_exclusions_by_id(id, parent_id, client_id)

Delete AgreementTypeWorkTypeExclusion

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::AgreementTypeWorkTypeExclusionsApi.new
id = 56 # Integer | workTypeExclusionId
parent_id = 56 # Integer | agreementTypeId
client_id = 'client_id_example' # String | 

begin
  # Delete AgreementTypeWorkTypeExclusion
  api_instance.delete_finance_agreement_types_by_parent_id_work_type_exclusions_by_id(id, parent_id, client_id)
rescue ConnectWise::ApiError => e
  puts "Error when calling AgreementTypeWorkTypeExclusionsApi->delete_finance_agreement_types_by_parent_id_work_type_exclusions_by_id: #{e}"
end

Using the delete_finance_agreement_types_by_parent_id_work_type_exclusions_by_id_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> delete_finance_agreement_types_by_parent_id_work_type_exclusions_by_id_with_http_info(id, parent_id, client_id)

begin
  # Delete AgreementTypeWorkTypeExclusion
  data, status_code, headers = api_instance.delete_finance_agreement_types_by_parent_id_work_type_exclusions_by_id_with_http_info(id, parent_id, client_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue ConnectWise::ApiError => e
  puts "Error when calling AgreementTypeWorkTypeExclusionsApi->delete_finance_agreement_types_by_parent_id_work_type_exclusions_by_id_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id Integer workTypeExclusionId
parent_id Integer agreementTypeId
client_id String

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

get_finance_agreement_types_by_parent_id_work_type_exclusions

<Array> get_finance_agreement_types_by_parent_id_work_type_exclusions(parent_id, client_id, opts)

Get List of AgreementTypeWorkTypeExclusion

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::AgreementTypeWorkTypeExclusionsApi.new
parent_id = 56 # Integer | agreementTypeId
client_id = 'client_id_example' # String | 
opts = {
  conditions: 'conditions_example', # String | 
  child_conditions: 'child_conditions_example', # String | 
  custom_field_conditions: 'custom_field_conditions_example', # String | 
  order_by: 'order_by_example', # String | 
  fields: 'fields_example', # String | 
  page: 56, # Integer | 
  page_size: 56, # Integer | 
  page_id: 56 # Integer | 
}

begin
  # Get List of AgreementTypeWorkTypeExclusion
  result = api_instance.get_finance_agreement_types_by_parent_id_work_type_exclusions(parent_id, client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling AgreementTypeWorkTypeExclusionsApi->get_finance_agreement_types_by_parent_id_work_type_exclusions: #{e}"
end

Using the get_finance_agreement_types_by_parent_id_work_type_exclusions_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<Array>, Integer, Hash)> get_finance_agreement_types_by_parent_id_work_type_exclusions_with_http_info(parent_id, client_id, opts)

begin
  # Get List of AgreementTypeWorkTypeExclusion
  data, status_code, headers = api_instance.get_finance_agreement_types_by_parent_id_work_type_exclusions_with_http_info(parent_id, client_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<AgreementTypeWorkTypeExclusion>>
rescue ConnectWise::ApiError => e
  puts "Error when calling AgreementTypeWorkTypeExclusionsApi->get_finance_agreement_types_by_parent_id_work_type_exclusions_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
parent_id Integer agreementTypeId
client_id String
conditions String [optional]
child_conditions String [optional]
custom_field_conditions String [optional]
order_by String [optional]
fields String [optional]
page Integer [optional]
page_size Integer [optional]
page_id Integer [optional]

Return type

Array<AgreementTypeWorkTypeExclusion>

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.connectwise.com+json; version=2025.1

get_finance_agreement_types_by_parent_id_work_type_exclusions_by_id

get_finance_agreement_types_by_parent_id_work_type_exclusions_by_id(id, parent_id, client_id, opts)

Get AgreementTypeWorkTypeExclusion

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::AgreementTypeWorkTypeExclusionsApi.new
id = 56 # Integer | workTypeExclusionId
parent_id = 56 # Integer | agreementTypeId
client_id = 'client_id_example' # String | 
opts = {
  conditions: 'conditions_example', # String | 
  child_conditions: 'child_conditions_example', # String | 
  custom_field_conditions: 'custom_field_conditions_example', # String | 
  order_by: 'order_by_example', # String | 
  fields: 'fields_example', # String | 
  page: 56, # Integer | 
  page_size: 56, # Integer | 
  page_id: 56 # Integer | 
}

begin
  # Get AgreementTypeWorkTypeExclusion
  result = api_instance.get_finance_agreement_types_by_parent_id_work_type_exclusions_by_id(id, parent_id, client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling AgreementTypeWorkTypeExclusionsApi->get_finance_agreement_types_by_parent_id_work_type_exclusions_by_id: #{e}"
end

Using the get_finance_agreement_types_by_parent_id_work_type_exclusions_by_id_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_finance_agreement_types_by_parent_id_work_type_exclusions_by_id_with_http_info(id, parent_id, client_id, opts)

begin
  # Get AgreementTypeWorkTypeExclusion
  data, status_code, headers = api_instance.get_finance_agreement_types_by_parent_id_work_type_exclusions_by_id_with_http_info(id, parent_id, client_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AgreementTypeWorkTypeExclusion>
rescue ConnectWise::ApiError => e
  puts "Error when calling AgreementTypeWorkTypeExclusionsApi->get_finance_agreement_types_by_parent_id_work_type_exclusions_by_id_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id Integer workTypeExclusionId
parent_id Integer agreementTypeId
client_id String
conditions String [optional]
child_conditions String [optional]
custom_field_conditions String [optional]
order_by String [optional]
fields String [optional]
page Integer [optional]
page_size Integer [optional]
page_id Integer [optional]

Return type

AgreementTypeWorkTypeExclusion

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.connectwise.com+json; version=2025.1

get_finance_agreement_types_by_parent_id_work_type_exclusions_count

get_finance_agreement_types_by_parent_id_work_type_exclusions_count(parent_id, client_id, opts)

Get Count of AgreementTypeWorkTypeExclusion

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::AgreementTypeWorkTypeExclusionsApi.new
parent_id = 56 # Integer | agreementTypeId
client_id = 'client_id_example' # String | 
opts = {
  conditions: 'conditions_example', # String | 
  child_conditions: 'child_conditions_example', # String | 
  custom_field_conditions: 'custom_field_conditions_example', # String | 
  order_by: 'order_by_example', # String | 
  fields: 'fields_example', # String | 
  page: 56, # Integer | 
  page_size: 56, # Integer | 
  page_id: 56 # Integer | 
}

begin
  # Get Count of AgreementTypeWorkTypeExclusion
  result = api_instance.get_finance_agreement_types_by_parent_id_work_type_exclusions_count(parent_id, client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling AgreementTypeWorkTypeExclusionsApi->get_finance_agreement_types_by_parent_id_work_type_exclusions_count: #{e}"
end

Using the get_finance_agreement_types_by_parent_id_work_type_exclusions_count_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_finance_agreement_types_by_parent_id_work_type_exclusions_count_with_http_info(parent_id, client_id, opts)

begin
  # Get Count of AgreementTypeWorkTypeExclusion
  data, status_code, headers = api_instance.get_finance_agreement_types_by_parent_id_work_type_exclusions_count_with_http_info(parent_id, client_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Count>
rescue ConnectWise::ApiError => e
  puts "Error when calling AgreementTypeWorkTypeExclusionsApi->get_finance_agreement_types_by_parent_id_work_type_exclusions_count_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
parent_id Integer agreementTypeId
client_id String
conditions String [optional]
child_conditions String [optional]
custom_field_conditions String [optional]
order_by String [optional]
fields String [optional]
page Integer [optional]
page_size Integer [optional]
page_id Integer [optional]

Return type

Count

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.connectwise.com+json; version=2025.1

post_finance_agreement_types_by_parent_id_work_type_exclusions

post_finance_agreement_types_by_parent_id_work_type_exclusions(parent_id, client_id, agreement_type_work_type_exclusion)

Post AgreementTypeWorkTypeExclusion

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::AgreementTypeWorkTypeExclusionsApi.new
parent_id = 56 # Integer | agreementTypeId
client_id = 'client_id_example' # String | 
agreement_type_work_type_exclusion = ConnectWise::AgreementTypeWorkTypeExclusion.new({work_type: ConnectWise::WorkTypeReference.new}) # AgreementTypeWorkTypeExclusion | workTypeExclusion

begin
  # Post AgreementTypeWorkTypeExclusion
  result = api_instance.post_finance_agreement_types_by_parent_id_work_type_exclusions(parent_id, client_id, agreement_type_work_type_exclusion)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling AgreementTypeWorkTypeExclusionsApi->post_finance_agreement_types_by_parent_id_work_type_exclusions: #{e}"
end

Using the post_finance_agreement_types_by_parent_id_work_type_exclusions_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> post_finance_agreement_types_by_parent_id_work_type_exclusions_with_http_info(parent_id, client_id, agreement_type_work_type_exclusion)

begin
  # Post AgreementTypeWorkTypeExclusion
  data, status_code, headers = api_instance.post_finance_agreement_types_by_parent_id_work_type_exclusions_with_http_info(parent_id, client_id, agreement_type_work_type_exclusion)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AgreementTypeWorkTypeExclusion>
rescue ConnectWise::ApiError => e
  puts "Error when calling AgreementTypeWorkTypeExclusionsApi->post_finance_agreement_types_by_parent_id_work_type_exclusions_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
parent_id Integer agreementTypeId
client_id String
agreement_type_work_type_exclusion AgreementTypeWorkTypeExclusion workTypeExclusion

Return type

AgreementTypeWorkTypeExclusion

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.connectwise.com+json; version=2025.1