Skip to content

Latest commit

 

History

History
386 lines (283 loc) · 10.8 KB

GLCaptionsApi.md

File metadata and controls

386 lines (283 loc) · 10.8 KB

ConnectWise::GLCaptionsApi

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

Method HTTP request Description
get_finance_gl_captions GET /finance/glCaptions Get List of GLCaption
get_finance_gl_captions_by_id GET /finance/glCaptions/{id} Get GLCaption
get_finance_gl_captions_count GET /finance/glCaptions/count Get Count of GLCaption
patch_finance_gl_captions_by_id PATCH /finance/glCaptions/{id} Patch GLCaption
put_finance_gl_captions_by_id PUT /finance/glCaptions/{id} Put GLCaption

get_finance_gl_captions

<Array> get_finance_gl_captions(client_id, opts)

Get List of GLCaption

Examples

require 'time'
require 'connect_wise'

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

Using the get_finance_gl_captions_with_http_info variant

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

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

begin
  # Get List of GLCaption
  data, status_code, headers = api_instance.get_finance_gl_captions_with_http_info(client_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<GLCaption>>
rescue ConnectWise::ApiError => e
  puts "Error when calling GLCaptionsApi->get_finance_gl_captions_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<GLCaption>

Authorization

No authorization required

HTTP request headers

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

get_finance_gl_captions_by_id

get_finance_gl_captions_by_id(id, client_id, opts)

Get GLCaption

Examples

require 'time'
require 'connect_wise'

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

Using the get_finance_gl_captions_by_id_with_http_info variant

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

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

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

Parameters

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

GLCaption

Authorization

No authorization required

HTTP request headers

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

get_finance_gl_captions_count

get_finance_gl_captions_count(client_id, opts)

Get Count of GLCaption

Examples

require 'time'
require 'connect_wise'

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

Using the get_finance_gl_captions_count_with_http_info variant

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

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

begin
  # Get Count of GLCaption
  data, status_code, headers = api_instance.get_finance_gl_captions_count_with_http_info(client_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Count>
rescue ConnectWise::ApiError => e
  puts "Error when calling GLCaptionsApi->get_finance_gl_captions_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_gl_captions_by_id

patch_finance_gl_captions_by_id(id, client_id, patch_operation)

Patch GLCaption

Examples

require 'time'
require 'connect_wise'

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

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

Using the patch_finance_gl_captions_by_id_with_http_info variant

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

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

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

Parameters

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

Return type

GLCaption

Authorization

No authorization required

HTTP request headers

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

put_finance_gl_captions_by_id

put_finance_gl_captions_by_id(id, client_id, gl_caption)

Put GLCaption

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::GLCaptionsApi.new
id = 56 # Integer | glCaptionId
client_id = 'client_id_example' # String | 
gl_caption = ConnectWise::GLCaption.new # GLCaption | glCaption

begin
  # Put GLCaption
  result = api_instance.put_finance_gl_captions_by_id(id, client_id, gl_caption)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling GLCaptionsApi->put_finance_gl_captions_by_id: #{e}"
end

Using the put_finance_gl_captions_by_id_with_http_info variant

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

<Array(, Integer, Hash)> put_finance_gl_captions_by_id_with_http_info(id, client_id, gl_caption)

begin
  # Put GLCaption
  data, status_code, headers = api_instance.put_finance_gl_captions_by_id_with_http_info(id, client_id, gl_caption)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <GLCaption>
rescue ConnectWise::ApiError => e
  puts "Error when calling GLCaptionsApi->put_finance_gl_captions_by_id_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id Integer glCaptionId
client_id String
gl_caption GLCaption glCaption

Return type

GLCaption

Authorization

No authorization required

HTTP request headers

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