module BookingSync::API::Client::Taxes

Public Instance Methods

tax(tax, options = {}) click to toggle source

Get a single tax

@param tax [BookingSync::API::Resource|Integer] Tax or ID

of the tax.

@param options [Hash] A customizable set of query options. @option options [Array] fields: List of fields to be fetched. @return [BookingSync::API::Resource]

# File lib/bookingsync/api/client/taxes.rb, line 28
def tax(tax, options = {})
  get("taxes/#{tax}", options).pop
end
taxes(options = {}, &block) click to toggle source

List taxes

Returns taxes for the account user is authenticated with. @param options [Hash] A customizable set of options. @option options [Array] fields: List of fields to be fetched. @return [Array<BookingSync::API::Resource>] Array of taxes.

@example Get the list of taxes for the current account

taxes = @api.taxes
taxes.first.percentage # => 20.0

@example Get the list of taxes only with percentage for smaller response

@api.taxes(fields: [:percentage])

@see developers.bookingsync.com/reference/endpoints/taxes/#list-taxes

# File lib/bookingsync/api/client/taxes.rb, line 17
def taxes(options = {}, &block)
  paginate :taxes, options, &block
end