Skip to content

Latest commit

 

History

History
681 lines (498 loc) · 19.4 KB

CurrenciesApi.md

File metadata and controls

681 lines (498 loc) · 19.4 KB

ConnectWise::CurrenciesApi

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

Method HTTP request Description
delete_finance_currencies_by_id DELETE /finance/currencies/{id} Delete Currency
get_finance_currencies GET /finance/currencies Get List of Currency
get_finance_currencies_by_id GET /finance/currencies/{id} Get Currency
get_finance_currencies_by_id_usages GET /finance/currencies/{id}/usages Get List of Usage Count
get_finance_currencies_by_id_usages_list GET /finance/currencies/{id}/usages/list Get List of Usage
get_finance_currencies_count GET /finance/currencies/count Get Count of Currency
patch_finance_currencies_by_id PATCH /finance/currencies/{id} Patch Currency
post_finance_currencies POST /finance/currencies Post Currency
put_finance_currencies_by_id PUT /finance/currencies/{id} Put Currency

delete_finance_currencies_by_id

delete_finance_currencies_by_id(id, client_id)

Delete Currency

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::CurrenciesApi.new
id = 56 # Integer | currencyId
client_id = 'client_id_example' # String | 

begin
  # Delete Currency
  api_instance.delete_finance_currencies_by_id(id, client_id)
rescue ConnectWise::ApiError => e
  puts "Error when calling CurrenciesApi->delete_finance_currencies_by_id: #{e}"
end

Using the delete_finance_currencies_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_currencies_by_id_with_http_info(id, client_id)

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

Parameters

Name Type Description Notes
id Integer currencyId
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_currencies

<Array> get_finance_currencies(client_id, opts)

Get List of Currency

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::CurrenciesApi.new
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 Currency
  result = api_instance.get_finance_currencies(client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling CurrenciesApi->get_finance_currencies: #{e}"
end

Using the get_finance_currencies_with_http_info variant

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

<Array(<Array>, Integer, Hash)> get_finance_currencies_with_http_info(client_id, opts)

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

Parameters

Name Type Description Notes
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<FinanceCurrency>

Authorization

No authorization required

HTTP request headers

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

get_finance_currencies_by_id

get_finance_currencies_by_id(id, client_id, opts)

Get Currency

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::CurrenciesApi.new
id = 56 # Integer | currencyId
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 Currency
  result = api_instance.get_finance_currencies_by_id(id, client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling CurrenciesApi->get_finance_currencies_by_id: #{e}"
end

Using the get_finance_currencies_by_id_with_http_info variant

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

<Array(, Integer, Hash)> get_finance_currencies_by_id_with_http_info(id, client_id, opts)

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

Parameters

Name Type Description Notes
id Integer currencyId
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

FinanceCurrency

Authorization

No authorization required

HTTP request headers

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

get_finance_currencies_by_id_usages

<Array> get_finance_currencies_by_id_usages(id, client_id, opts)

Get List of Usage Count

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::CurrenciesApi.new
id = 56 # Integer | currencyId
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 Usage Count
  result = api_instance.get_finance_currencies_by_id_usages(id, client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling CurrenciesApi->get_finance_currencies_by_id_usages: #{e}"
end

Using the get_finance_currencies_by_id_usages_with_http_info variant

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

<Array(<Array>, Integer, Hash)> get_finance_currencies_by_id_usages_with_http_info(id, client_id, opts)

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

Parameters

Name Type Description Notes
id Integer currencyId
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<Usage>

Authorization

No authorization required

HTTP request headers

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

get_finance_currencies_by_id_usages_list

<Array> get_finance_currencies_by_id_usages_list(id, client_id, opts)

Get List of Usage

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::CurrenciesApi.new
id = 56 # Integer | currencyId
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 Usage
  result = api_instance.get_finance_currencies_by_id_usages_list(id, client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling CurrenciesApi->get_finance_currencies_by_id_usages_list: #{e}"
end

Using the get_finance_currencies_by_id_usages_list_with_http_info variant

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

<Array(<Array>, Integer, Hash)> get_finance_currencies_by_id_usages_list_with_http_info(id, client_id, opts)

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

Parameters

Name Type Description Notes
id Integer currencyId
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<Usage>

Authorization

No authorization required

HTTP request headers

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

get_finance_currencies_count

get_finance_currencies_count(client_id, opts)

Get Count of Currency

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::CurrenciesApi.new
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 Currency
  result = api_instance.get_finance_currencies_count(client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling CurrenciesApi->get_finance_currencies_count: #{e}"
end

Using the get_finance_currencies_count_with_http_info variant

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

<Array(, Integer, Hash)> get_finance_currencies_count_with_http_info(client_id, opts)

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

Parameters

Name Type Description Notes
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=2022.1

patch_finance_currencies_by_id

patch_finance_currencies_by_id(id, client_id, patch_operation)

Patch Currency

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::CurrenciesApi.new
id = 56 # Integer | currencyId
client_id = 'client_id_example' # String | 
patch_operation = [ConnectWise::PatchOperation.new] # Array<PatchOperation> | List of PatchOperation

begin
  # Patch Currency
  result = api_instance.patch_finance_currencies_by_id(id, client_id, patch_operation)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling CurrenciesApi->patch_finance_currencies_by_id: #{e}"
end

Using the patch_finance_currencies_by_id_with_http_info variant

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

<Array(, Integer, Hash)> patch_finance_currencies_by_id_with_http_info(id, client_id, patch_operation)

begin
  # Patch Currency
  data, status_code, headers = api_instance.patch_finance_currencies_by_id_with_http_info(id, client_id, patch_operation)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <FinanceCurrency>
rescue ConnectWise::ApiError => e
  puts "Error when calling CurrenciesApi->patch_finance_currencies_by_id_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id Integer currencyId
client_id String
patch_operation Array<PatchOperation> List of PatchOperation

Return type

FinanceCurrency

Authorization

No authorization required

HTTP request headers

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

post_finance_currencies

post_finance_currencies(client_id, finance_currency)

Post Currency

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::CurrenciesApi.new
client_id = 'client_id_example' # String | 
finance_currency = ConnectWise::FinanceCurrency.new({currency_identifier: 'currency_identifier_example', name: 'name_example'}) # FinanceCurrency | currency

begin
  # Post Currency
  result = api_instance.post_finance_currencies(client_id, finance_currency)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling CurrenciesApi->post_finance_currencies: #{e}"
end

Using the post_finance_currencies_with_http_info variant

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

<Array(, Integer, Hash)> post_finance_currencies_with_http_info(client_id, finance_currency)

begin
  # Post Currency
  data, status_code, headers = api_instance.post_finance_currencies_with_http_info(client_id, finance_currency)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <FinanceCurrency>
rescue ConnectWise::ApiError => e
  puts "Error when calling CurrenciesApi->post_finance_currencies_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
client_id String
finance_currency FinanceCurrency currency

Return type

FinanceCurrency

Authorization

No authorization required

HTTP request headers

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

put_finance_currencies_by_id

put_finance_currencies_by_id(id, client_id, finance_currency)

Put Currency

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::CurrenciesApi.new
id = 56 # Integer | currencyId
client_id = 'client_id_example' # String | 
finance_currency = ConnectWise::FinanceCurrency.new({currency_identifier: 'currency_identifier_example', name: 'name_example'}) # FinanceCurrency | currency

begin
  # Put Currency
  result = api_instance.put_finance_currencies_by_id(id, client_id, finance_currency)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling CurrenciesApi->put_finance_currencies_by_id: #{e}"
end

Using the put_finance_currencies_by_id_with_http_info variant

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

<Array(, Integer, Hash)> put_finance_currencies_by_id_with_http_info(id, client_id, finance_currency)

begin
  # Put Currency
  data, status_code, headers = api_instance.put_finance_currencies_by_id_with_http_info(id, client_id, finance_currency)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <FinanceCurrency>
rescue ConnectWise::ApiError => e
  puts "Error when calling CurrenciesApi->put_finance_currencies_by_id_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id Integer currencyId
client_id String
finance_currency FinanceCurrency currency

Return type

FinanceCurrency

Authorization

No authorization required

HTTP request headers

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