Skip to content

Latest commit

 

History

History
393 lines (257 loc) · 9.42 KB

AccountingBatchesApi.md

File metadata and controls

393 lines (257 loc) · 9.42 KB
Raw

ConnectWise::AccountingBatchesApi

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

Method HTTP request Description
finance_accounting_batches_count_get GET /finance/accounting/batches/count
finance_accounting_batches_get GET /finance/accounting/batches
finance_accounting_batches_id_delete DELETE /finance/accounting/batches/{id}
finance_accounting_batches_id_export_post POST /finance/accounting/batches/{id}/export
finance_accounting_batches_id_get GET /finance/accounting/batches/{id}
finance_accounting_batches_post POST /finance/accounting/batches
finance_accounting_export_post POST /finance/accounting/export

finance_accounting_batches_count_get

Count finance_accounting_batches_count_get(opts)

Get Batches 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::AccountingBatchesApi.new

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

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

Parameters

Name Type Description Notes
conditions String [optional]

Return type

Count

Authorization

BasicAuth

HTTP request headers

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

finance_accounting_batches_get

Array<AccountingBatch> finance_accounting_batches_get(opts)

Get Batches

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::AccountingBatchesApi.new

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_accounting_batches_get(opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Exception when calling AccountingBatchesApi->finance_accounting_batches_get: #{e}"
end

Parameters

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

Return type

Array<AccountingBatch>

Authorization

BasicAuth

HTTP request headers

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

finance_accounting_batches_id_delete

finance_accounting_batches_id_delete(id)

Delete Batch 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::AccountingBatchesApi.new

id = 56 # Integer | 


begin
  api_instance.finance_accounting_batches_id_delete(id)
rescue ConnectWise::ApiError => e
  puts "Exception when calling AccountingBatchesApi->finance_accounting_batches_id_delete: #{e}"
end

Parameters

Name Type Description Notes
id Integer

Return type

nil (empty response body)

Authorization

BasicAuth

HTTP request headers

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

finance_accounting_batches_id_export_post

GLExport finance_accounting_batches_id_export_post(id, batch_export_parameters)

Re-export the payload data from an existing batch (RecreateBatch in SOAP)

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::AccountingBatchesApi.new

id = 56 # Integer | 

batch_export_parameters = ConnectWise::ExportAccountingBatchRequest.new # ExportAccountingBatchRequest | 


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

Parameters

Name Type Description Notes
id Integer
batch_export_parameters ExportAccountingBatchRequest

Return type

GLExport

Authorization

BasicAuth

HTTP request headers

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

finance_accounting_batches_id_get

AccountingBatch finance_accounting_batches_id_get(id)

Get Batch 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::AccountingBatchesApi.new

id = 56 # Integer | 


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

Parameters

Name Type Description Notes
id Integer

Return type

AccountingBatch

Authorization

BasicAuth

HTTP request headers

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

finance_accounting_batches_post

GLExport finance_accounting_batches_post(accounting_batch_parameters)

Creates the Accounting Batch and updates GL Records (UpdateBatch in SOAP)

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::AccountingBatchesApi.new

accounting_batch_parameters = ConnectWise::CreateAccountingBatchRequest.new # CreateAccountingBatchRequest | 


begin
  result = api_instance.finance_accounting_batches_post(accounting_batch_parameters)
  p result
rescue ConnectWise::ApiError => e
  puts "Exception when calling AccountingBatchesApi->finance_accounting_batches_post: #{e}"
end

Parameters

Name Type Description Notes
accounting_batch_parameters CreateAccountingBatchRequest

Return type

GLExport

Authorization

BasicAuth

HTTP request headers

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

finance_accounting_export_post

GLExport finance_accounting_export_post(batch_export_parameters)

Exports accouting batch payload based on parameters (CreateBatch in SOAP)

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::AccountingBatchesApi.new

batch_export_parameters = ConnectWise::ExportAccountingBatchRequest.new # ExportAccountingBatchRequest | 


begin
  result = api_instance.finance_accounting_export_post(batch_export_parameters)
  p result
rescue ConnectWise::ApiError => e
  puts "Exception when calling AccountingBatchesApi->finance_accounting_export_post: #{e}"
end

Parameters

Name Type Description Notes
batch_export_parameters ExportAccountingBatchRequest

Return type

GLExport

Authorization

BasicAuth

HTTP request headers

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