Accounting

(accounting)

Overview

Available Operations

create_accounting_account - Create an account
create_accounting_contact - Create a contact
create_accounting_invoice - Create an invoice
create_accounting_journal - Create a journal
create_accounting_order - Create an order
create_accounting_taxrate - Create a taxrate
create_accounting_transaction - Create a transaction
get_accounting_account - Retrieve an account
get_accounting_contact - Retrieve a contact
get_accounting_invoice - Retrieve an invoice
get_accounting_journal - Retrieve a journal
get_accounting_order - Retrieve an order
get_accounting_organization - Retrieve an organization
get_accounting_taxrate - Retrieve a taxrate
get_accounting_transaction - Retrieve a transaction
list_accounting_accounts - List all accounts
list_accounting_contacts - List all contacts
list_accounting_invoices - List all invoices
list_accounting_journals - List all journals
list_accounting_orders - List all orders
list_accounting_organizations - List all organizations
list_accounting_taxrates - List all taxrates
list_accounting_transactions - List all transactions
patch_accounting_account - Update an account
patch_accounting_contact - Update a contact
patch_accounting_invoice - Update an invoice
patch_accounting_journal - Update a journal
patch_accounting_order - Update an order
patch_accounting_taxrate - Update a taxrate
patch_accounting_transaction - Update a transaction
remove_accounting_account - Remove an account
remove_accounting_contact - Remove a contact
remove_accounting_invoice - Remove an invoice
remove_accounting_journal - Remove a journal
remove_accounting_order - Remove an order
remove_accounting_taxrate - Remove a taxrate
remove_accounting_transaction - Remove a transaction
update_accounting_account - Update an account
update_accounting_contact - Update a contact
update_accounting_invoice - Update an invoice
update_accounting_journal - Update a journal
update_accounting_order - Update an order
update_accounting_taxrate - Update a taxrate
update_accounting_transaction - Update a transaction

create_accounting_account

Create an account

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.create_accounting_account(connection_id="<id>", accounting_account=::UnifiedRubySDK::Shared::AccountingAccount.new(), fields_=[
  "<value>",
])

if ! res.accounting_account.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`accounting_account`	T.nilable(::UnifiedRubySDK::Shared::AccountingAccount)	➖	Chart of accounts
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::CreateAccountingAccountResponse)

create_accounting_contact

Create a contact

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.create_accounting_contact(connection_id="<id>", accounting_contact=::UnifiedRubySDK::Shared::AccountingContact.new(), fields_=[
  "<value>",
])

if ! res.accounting_contact.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`accounting_contact`	T.nilable(::UnifiedRubySDK::Shared::AccountingContact)	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::CreateAccountingContactResponse)

create_accounting_invoice

Create an invoice

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.create_accounting_invoice(connection_id="<id>", accounting_invoice=::UnifiedRubySDK::Shared::AccountingInvoice.new(), fields_=[
  "<value>",
])

if ! res.accounting_invoice.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`accounting_invoice`	T.nilable(::UnifiedRubySDK::Shared::AccountingInvoice)	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::CreateAccountingInvoiceResponse)

create_accounting_journal

Create a journal

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.create_accounting_journal(connection_id="<id>", accounting_journal=::UnifiedRubySDK::Shared::AccountingJournal.new(), fields_=[
  "<value>",
])

if ! res.accounting_journal.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`accounting_journal`	T.nilable(::UnifiedRubySDK::Shared::AccountingJournal)	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::CreateAccountingJournalResponse)

create_accounting_order

Create an order

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.create_accounting_order(connection_id="<id>", accounting_order=::UnifiedRubySDK::Shared::AccountingOrder.new(), fields_=[
  "<value>",
])

if ! res.accounting_order.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`accounting_order`	T.nilable(::UnifiedRubySDK::Shared::AccountingOrder)	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::CreateAccountingOrderResponse)

create_accounting_taxrate

Create a taxrate

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.create_accounting_taxrate(connection_id="<id>", accounting_taxrate=::UnifiedRubySDK::Shared::AccountingTaxrate.new(), fields_=[
  "<value>",
])

if ! res.accounting_taxrate.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`accounting_taxrate`	T.nilable(::UnifiedRubySDK::Shared::AccountingTaxrate)	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::CreateAccountingTaxrateResponse)

create_accounting_transaction

Create a transaction

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.create_accounting_transaction(connection_id="<id>", accounting_transaction=::UnifiedRubySDK::Shared::AccountingTransaction.new(), fields_=[
  "<value>",
])

if ! res.accounting_transaction.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`accounting_transaction`	T.nilable(::UnifiedRubySDK::Shared::AccountingTransaction)	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::CreateAccountingTransactionResponse)

get_accounting_account

Retrieve an account

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.get_accounting_account(connection_id="<id>", id="<id>", fields_=[
  "<value>",
])

if ! res.accounting_account.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Account
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::GetAccountingAccountResponse)

get_accounting_contact

Retrieve a contact

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.get_accounting_contact(connection_id="<id>", id="<id>", fields_=[
  "<value>",
])

if ! res.accounting_contact.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Contact
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::GetAccountingContactResponse)

get_accounting_invoice

Retrieve an invoice

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.get_accounting_invoice(connection_id="<id>", id="<id>", fields_=[
  "<value>",
])

if ! res.accounting_invoice.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Invoice
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::GetAccountingInvoiceResponse)

get_accounting_journal

Retrieve a journal

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.get_accounting_journal(connection_id="<id>", id="<id>", fields_=[
  "<value>",
])

if ! res.accounting_journal.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Journal
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::GetAccountingJournalResponse)

get_accounting_order

Retrieve an order

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.get_accounting_order(connection_id="<id>", id="<id>", fields_=[
  "<value>",
])

if ! res.accounting_order.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Order
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::GetAccountingOrderResponse)

get_accounting_organization

Retrieve an organization

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.get_accounting_organization(connection_id="<id>", id="<id>", fields_=[
  "<value>",
])

if ! res.accounting_organization.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Organization
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::GetAccountingOrganizationResponse)

get_accounting_taxrate

Retrieve a taxrate

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.get_accounting_taxrate(connection_id="<id>", id="<id>", fields_=[
  "<value>",
])

if ! res.accounting_taxrate.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Taxrate
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::GetAccountingTaxrateResponse)

get_accounting_transaction

Retrieve a transaction

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.get_accounting_transaction(connection_id="<id>", id="<id>", fields_=[
  "<value>",
])

if ! res.accounting_transaction.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Transaction
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::GetAccountingTransactionResponse)

list_accounting_accounts

List all accounts

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)


req = ::UnifiedRubySDK::Operations::ListAccountingAccountsRequest.new(
  connection_id: "<id>",
)
    
res = s.accounting.list_accounting_accounts(req)

if ! res.accounting_accounts.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	::UnifiedRubySDK::Operations::ListAccountingAccountsRequest	✔️	The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListAccountingAccountsResponse)

list_accounting_contacts

List all contacts

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)


req = ::UnifiedRubySDK::Operations::ListAccountingContactsRequest.new(
  connection_id: "<id>",
)
    
res = s.accounting.list_accounting_contacts(req)

if ! res.accounting_contacts.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	::UnifiedRubySDK::Operations::ListAccountingContactsRequest	✔️	The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListAccountingContactsResponse)

list_accounting_invoices

List all invoices

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)


req = ::UnifiedRubySDK::Operations::ListAccountingInvoicesRequest.new(
  connection_id: "<id>",
)
    
res = s.accounting.list_accounting_invoices(req)

if ! res.accounting_invoices.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	::UnifiedRubySDK::Operations::ListAccountingInvoicesRequest	✔️	The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListAccountingInvoicesResponse)

list_accounting_journals

List all journals

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)


req = ::UnifiedRubySDK::Operations::ListAccountingJournalsRequest.new(
  connection_id: "<id>",
)
    
res = s.accounting.list_accounting_journals(req)

if ! res.accounting_journals.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	::UnifiedRubySDK::Operations::ListAccountingJournalsRequest	✔️	The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListAccountingJournalsResponse)

list_accounting_orders

List all orders

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)


req = ::UnifiedRubySDK::Operations::ListAccountingOrdersRequest.new(
  connection_id: "<id>",
)
    
res = s.accounting.list_accounting_orders(req)

if ! res.accounting_orders.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	::UnifiedRubySDK::Operations::ListAccountingOrdersRequest	✔️	The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListAccountingOrdersResponse)

list_accounting_organizations

List all organizations

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)


req = ::UnifiedRubySDK::Operations::ListAccountingOrganizationsRequest.new(
  connection_id: "<id>",
)
    
res = s.accounting.list_accounting_organizations(req)

if ! res.accounting_organizations.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	::UnifiedRubySDK::Operations::ListAccountingOrganizationsRequest	✔️	The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListAccountingOrganizationsResponse)

list_accounting_taxrates

List all taxrates

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)


req = ::UnifiedRubySDK::Operations::ListAccountingTaxratesRequest.new(
  connection_id: "<id>",
)
    
res = s.accounting.list_accounting_taxrates(req)

if ! res.accounting_taxrates.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	::UnifiedRubySDK::Operations::ListAccountingTaxratesRequest	✔️	The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListAccountingTaxratesResponse)

list_accounting_transactions

List all transactions

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)


req = ::UnifiedRubySDK::Operations::ListAccountingTransactionsRequest.new(
  connection_id: "<id>",
)
    
res = s.accounting.list_accounting_transactions(req)

if ! res.accounting_transactions.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	::UnifiedRubySDK::Operations::ListAccountingTransactionsRequest	✔️	The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListAccountingTransactionsResponse)

patch_accounting_account

Update an account

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.patch_accounting_account(connection_id="<id>", id="<id>", accounting_account=::UnifiedRubySDK::Shared::AccountingAccount.new(), fields_=[
  "<value>",
])

if ! res.accounting_account.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Account
`accounting_account`	T.nilable(::UnifiedRubySDK::Shared::AccountingAccount)	➖	Chart of accounts
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::PatchAccountingAccountResponse)

patch_accounting_contact

Update a contact

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.patch_accounting_contact(connection_id="<id>", id="<id>", accounting_contact=::UnifiedRubySDK::Shared::AccountingContact.new(), fields_=[
  "<value>",
])

if ! res.accounting_contact.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Contact
`accounting_contact`	T.nilable(::UnifiedRubySDK::Shared::AccountingContact)	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::PatchAccountingContactResponse)

patch_accounting_invoice

Update an invoice

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.patch_accounting_invoice(connection_id="<id>", id="<id>", accounting_invoice=::UnifiedRubySDK::Shared::AccountingInvoice.new(), fields_=[
  "<value>",
])

if ! res.accounting_invoice.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Invoice
`accounting_invoice`	T.nilable(::UnifiedRubySDK::Shared::AccountingInvoice)	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::PatchAccountingInvoiceResponse)

patch_accounting_journal

Update a journal

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.patch_accounting_journal(connection_id="<id>", id="<id>", accounting_journal=::UnifiedRubySDK::Shared::AccountingJournal.new(), fields_=[
  "<value>",
])

if ! res.accounting_journal.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Journal
`accounting_journal`	T.nilable(::UnifiedRubySDK::Shared::AccountingJournal)	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::PatchAccountingJournalResponse)

patch_accounting_order

Update an order

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.patch_accounting_order(connection_id="<id>", id="<id>", accounting_order=::UnifiedRubySDK::Shared::AccountingOrder.new(), fields_=[
  "<value>",
])

if ! res.accounting_order.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Order
`accounting_order`	T.nilable(::UnifiedRubySDK::Shared::AccountingOrder)	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::PatchAccountingOrderResponse)

patch_accounting_taxrate

Update a taxrate

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.patch_accounting_taxrate(connection_id="<id>", id="<id>", accounting_taxrate=::UnifiedRubySDK::Shared::AccountingTaxrate.new(), fields_=[
  "<value>",
])

if ! res.accounting_taxrate.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Taxrate
`accounting_taxrate`	T.nilable(::UnifiedRubySDK::Shared::AccountingTaxrate)	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::PatchAccountingTaxrateResponse)

patch_accounting_transaction

Update a transaction

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.patch_accounting_transaction(connection_id="<id>", id="<id>", accounting_transaction=::UnifiedRubySDK::Shared::AccountingTransaction.new(), fields_=[
  "<value>",
])

if ! res.accounting_transaction.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Transaction
`accounting_transaction`	T.nilable(::UnifiedRubySDK::Shared::AccountingTransaction)	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::PatchAccountingTransactionResponse)

remove_accounting_account

Remove an account

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.remove_accounting_account(connection_id="<id>", id="<id>")

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Account

Response

T.nilable(::UnifiedRubySDK::Operations::RemoveAccountingAccountResponse)

remove_accounting_contact

Remove a contact

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.remove_accounting_contact(connection_id="<id>", id="<id>")

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Contact

Response

T.nilable(::UnifiedRubySDK::Operations::RemoveAccountingContactResponse)

remove_accounting_invoice

Remove an invoice

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.remove_accounting_invoice(connection_id="<id>", id="<id>")

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Invoice

Response

T.nilable(::UnifiedRubySDK::Operations::RemoveAccountingInvoiceResponse)

remove_accounting_journal

Remove a journal

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.remove_accounting_journal(connection_id="<id>", id="<id>")

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Journal

Response

T.nilable(::UnifiedRubySDK::Operations::RemoveAccountingJournalResponse)

remove_accounting_order

Remove an order

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.remove_accounting_order(connection_id="<id>", id="<id>")

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Order

Response

T.nilable(::UnifiedRubySDK::Operations::RemoveAccountingOrderResponse)

remove_accounting_taxrate

Remove a taxrate

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.remove_accounting_taxrate(connection_id="<id>", id="<id>")

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Taxrate

Response

T.nilable(::UnifiedRubySDK::Operations::RemoveAccountingTaxrateResponse)

remove_accounting_transaction

Remove a transaction

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.remove_accounting_transaction(connection_id="<id>", id="<id>")

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Transaction

Response

T.nilable(::UnifiedRubySDK::Operations::RemoveAccountingTransactionResponse)

update_accounting_account

Update an account

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.update_accounting_account(connection_id="<id>", id="<id>", accounting_account=::UnifiedRubySDK::Shared::AccountingAccount.new(), fields_=[
  "<value>",
])

if ! res.accounting_account.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Account
`accounting_account`	T.nilable(::UnifiedRubySDK::Shared::AccountingAccount)	➖	Chart of accounts
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::UpdateAccountingAccountResponse)

update_accounting_contact

Update a contact

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.update_accounting_contact(connection_id="<id>", id="<id>", accounting_contact=::UnifiedRubySDK::Shared::AccountingContact.new(), fields_=[
  "<value>",
])

if ! res.accounting_contact.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Contact
`accounting_contact`	T.nilable(::UnifiedRubySDK::Shared::AccountingContact)	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::UpdateAccountingContactResponse)

update_accounting_invoice

Update an invoice

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.update_accounting_invoice(connection_id="<id>", id="<id>", accounting_invoice=::UnifiedRubySDK::Shared::AccountingInvoice.new(), fields_=[
  "<value>",
])

if ! res.accounting_invoice.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Invoice
`accounting_invoice`	T.nilable(::UnifiedRubySDK::Shared::AccountingInvoice)	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::UpdateAccountingInvoiceResponse)

update_accounting_journal

Update a journal

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.update_accounting_journal(connection_id="<id>", id="<id>", accounting_journal=::UnifiedRubySDK::Shared::AccountingJournal.new(), fields_=[
  "<value>",
])

if ! res.accounting_journal.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Journal
`accounting_journal`	T.nilable(::UnifiedRubySDK::Shared::AccountingJournal)	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::UpdateAccountingJournalResponse)

update_accounting_order

Update an order

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.update_accounting_order(connection_id="<id>", id="<id>", accounting_order=::UnifiedRubySDK::Shared::AccountingOrder.new(), fields_=[
  "<value>",
])

if ! res.accounting_order.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Order
`accounting_order`	T.nilable(::UnifiedRubySDK::Shared::AccountingOrder)	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::UpdateAccountingOrderResponse)

update_accounting_taxrate

Update a taxrate

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.update_accounting_taxrate(connection_id="<id>", id="<id>", accounting_taxrate=::UnifiedRubySDK::Shared::AccountingTaxrate.new(), fields_=[
  "<value>",
])

if ! res.accounting_taxrate.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Taxrate
`accounting_taxrate`	T.nilable(::UnifiedRubySDK::Shared::AccountingTaxrate)	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::UpdateAccountingTaxrateResponse)

update_accounting_transaction

Update a transaction

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.update_accounting_transaction(connection_id="<id>", id="<id>", accounting_transaction=::UnifiedRubySDK::Shared::AccountingTransaction.new(), fields_=[
  "<value>",
])

if ! res.accounting_transaction.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Transaction
`accounting_transaction`	T.nilable(::UnifiedRubySDK::Shared::AccountingTransaction)	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::UpdateAccountingTransactionResponse)

Files

README.md

Latest commit

History

README.md

File metadata and controls

Accounting

Overview

Available Operations

create_accounting_account

Example Usage

Parameters

Response

create_accounting_contact

Example Usage

Parameters

Response

create_accounting_invoice

Example Usage

Parameters

Response

create_accounting_journal

Example Usage

Parameters

Response

create_accounting_order

Example Usage

Parameters

Response

create_accounting_taxrate

Example Usage

Parameters

Response

create_accounting_transaction

Example Usage

Parameters

Response

get_accounting_account

Example Usage

Parameters

Response

get_accounting_contact

Example Usage

Parameters

Response

get_accounting_invoice

Example Usage

Parameters

Response

get_accounting_journal

Example Usage

Parameters

Response

get_accounting_order

Example Usage

Parameters

Response

get_accounting_organization

Example Usage

Parameters

Response

get_accounting_taxrate

Example Usage

Parameters

Response

get_accounting_transaction

Example Usage

Parameters

Response

list_accounting_accounts

Example Usage

Parameters

Response

list_accounting_contacts

Example Usage

Parameters

Response

list_accounting_invoices

Example Usage

Parameters