Skip to content

Latest commit

 

History

History
417 lines (273 loc) · 11.9 KB

TaxCodeProductTypeExemptionsApi.md

File metadata and controls

417 lines (273 loc) · 11.9 KB
Raw

ConnectWise::TaxCodeProductTypeExemptionsApi

All URIs are relative to https://api-na.myconnectwise.net/v4_6_release/apis/3.0

Method HTTP request Description
finance_tax_codes_id_product_type_exemptions_count_get GET /finance/taxCodes/{id}/productTypeExemptions/count
finance_tax_codes_id_product_type_exemptions_get GET /finance/taxCodes/{id}/productTypeExemptions
finance_tax_codes_id_product_type_exemptions_post POST /finance/taxCodes/{id}/productTypeExemptions
finance_tax_codes_id_product_type_exemptions_product_type_exemption_id_delete DELETE /finance/taxCodes/{id}/productTypeExemptions/{productTypeExemptionId}
finance_tax_codes_id_product_type_exemptions_product_type_exemption_id_get GET /finance/taxCodes/{id}/productTypeExemptions/{productTypeExemptionId}
finance_tax_codes_id_product_type_exemptions_product_type_exemption_id_patch PATCH /finance/taxCodes/{id}/productTypeExemptions/{productTypeExemptionId}
finance_tax_codes_id_product_type_exemptions_product_type_exemption_id_put PUT /finance/taxCodes/{id}/productTypeExemptions/{productTypeExemptionId}

finance_tax_codes_id_product_type_exemptions_count_get

Count finance_tax_codes_id_product_type_exemptions_count_get(id, opts)

Get Tax Code Product Type Exemption Count

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
ConnectWise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = ConnectWise::TaxCodeProductTypeExemptionsApi.new

id = 56 # Integer | 

opts = { 
  conditions: "conditions_example" # String | 
}

begin
  result = api_instance.finance_tax_codes_id_product_type_exemptions_count_get(id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Exception when calling TaxCodeProductTypeExemptionsApi->finance_tax_codes_id_product_type_exemptions_count_get: #{e}"
end

Parameters

Name Type Description Notes
id Integer
conditions String [optional]

Return type

Count

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

finance_tax_codes_id_product_type_exemptions_get

Array<ProductTypeExemption> finance_tax_codes_id_product_type_exemptions_get(id, opts)

Get Tax Code Product Type Exemption

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
ConnectWise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = ConnectWise::TaxCodeProductTypeExemptionsApi.new

id = 56 # Integer | 

opts = { 
  conditions: "conditions_example" # String | 
  order_by: "order_by_example", # String | 
  childconditions: "childconditions_example", # String | 
  customfieldconditions: "customfieldconditions_example", # String | 
  page: 56, # Integer | 
  page_size: 56 # Integer | 
}

begin
  result = api_instance.finance_tax_codes_id_product_type_exemptions_get(id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Exception when calling TaxCodeProductTypeExemptionsApi->finance_tax_codes_id_product_type_exemptions_get: #{e}"
end

Parameters

Name Type Description Notes
id Integer
conditions String [optional]
order_by String [optional]
childconditions String [optional]
customfieldconditions String [optional]
page Integer [optional]
page_size Integer [optional]

Return type

Array<ProductTypeExemption>

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

finance_tax_codes_id_product_type_exemptions_post

ProductTypeExemption finance_tax_codes_id_product_type_exemptions_post(id, product_type_exemption)

Create Tax Code Product Type Exemption

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
ConnectWise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = ConnectWise::TaxCodeProductTypeExemptionsApi.new

id = 56 # Integer | 

product_type_exemption = ConnectWise::ProductTypeExemption.new # ProductTypeExemption | 


begin
  result = api_instance.finance_tax_codes_id_product_type_exemptions_post(id, product_type_exemption)
  p result
rescue ConnectWise::ApiError => e
  puts "Exception when calling TaxCodeProductTypeExemptionsApi->finance_tax_codes_id_product_type_exemptions_post: #{e}"
end

Parameters

Name Type Description Notes
id Integer
product_type_exemption ProductTypeExemption

Return type

ProductTypeExemption

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

finance_tax_codes_id_product_type_exemptions_product_type_exemption_id_delete

finance_tax_codes_id_product_type_exemptions_product_type_exemption_id_delete(id, product_type_exemption_id)

Delete Tax Code Product Type Exemption By Id

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
ConnectWise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = ConnectWise::TaxCodeProductTypeExemptionsApi.new

id = 56 # Integer | 

product_type_exemption_id = 56 # Integer | 


begin
  api_instance.finance_tax_codes_id_product_type_exemptions_product_type_exemption_id_delete(id, product_type_exemption_id)
rescue ConnectWise::ApiError => e
  puts "Exception when calling TaxCodeProductTypeExemptionsApi->finance_tax_codes_id_product_type_exemptions_product_type_exemption_id_delete: #{e}"
end

Parameters

Name Type Description Notes
id Integer
product_type_exemption_id Integer

Return type

nil (empty response body)

Authorization

BasicAuth

HTTP request headers

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

finance_tax_codes_id_product_type_exemptions_product_type_exemption_id_get

ProductTypeExemption finance_tax_codes_id_product_type_exemptions_product_type_exemption_id_get(id, product_type_exemption_id)

Get Tax Code Product Type Exemption By Id

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
ConnectWise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = ConnectWise::TaxCodeProductTypeExemptionsApi.new

id = 56 # Integer | 

product_type_exemption_id = 56 # Integer | 


begin
  result = api_instance.finance_tax_codes_id_product_type_exemptions_product_type_exemption_id_get(id, product_type_exemption_id)
  p result
rescue ConnectWise::ApiError => e
  puts "Exception when calling TaxCodeProductTypeExemptionsApi->finance_tax_codes_id_product_type_exemptions_product_type_exemption_id_get: #{e}"
end

Parameters

Name Type Description Notes
id Integer
product_type_exemption_id Integer

Return type

ProductTypeExemption

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

finance_tax_codes_id_product_type_exemptions_product_type_exemption_id_patch

ProductTypeExemption finance_tax_codes_id_product_type_exemptions_product_type_exemption_id_patch(id, product_type_exemption_id, operations)

Update Tax Code Product Type Exemption

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
ConnectWise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = ConnectWise::TaxCodeProductTypeExemptionsApi.new

id = 56 # Integer | 

product_type_exemption_id = 56 # Integer | 

operations = [ConnectWise::PatchOperation.new] # Array<PatchOperation> | 


begin
  result = api_instance.finance_tax_codes_id_product_type_exemptions_product_type_exemption_id_patch(id, product_type_exemption_id, operations)
  p result
rescue ConnectWise::ApiError => e
  puts "Exception when calling TaxCodeProductTypeExemptionsApi->finance_tax_codes_id_product_type_exemptions_product_type_exemption_id_patch: #{e}"
end

Parameters

Name Type Description Notes
id Integer
product_type_exemption_id Integer
operations Array<PatchOperation>

Return type

ProductTypeExemption

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

finance_tax_codes_id_product_type_exemptions_product_type_exemption_id_put

ProductTypeExemption finance_tax_codes_id_product_type_exemptions_product_type_exemption_id_put(id, product_type_exemption_id, product_type_exemption)

Replace Tax Code Product Type Exemption

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
ConnectWise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = ConnectWise::TaxCodeProductTypeExemptionsApi.new

id = 56 # Integer | 

product_type_exemption_id = 56 # Integer | 

product_type_exemption = ConnectWise::ProductTypeExemption.new # ProductTypeExemption | 


begin
  result = api_instance.finance_tax_codes_id_product_type_exemptions_product_type_exemption_id_put(id, product_type_exemption_id, product_type_exemption)
  p result
rescue ConnectWise::ApiError => e
  puts "Exception when calling TaxCodeProductTypeExemptionsApi->finance_tax_codes_id_product_type_exemptions_product_type_exemption_id_put: #{e}"
end

Parameters

Name Type Description Notes
id Integer
product_type_exemption_id Integer
product_type_exemption ProductTypeExemption

Return type

ProductTypeExemption

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json