sageone_sdk 0.0.1

data/lib/sageone_sdk/client/contacts.rb

@@ -0,0 +1,82 @@
+module SageoneSdk
+  class Client
+    # Represents the contacts for the authenticated user's business.
+    module Contacts
+
+      # @return [object] Returns all contacts for the authenticated user's business.
+      def contacts(options = {})
+        paginate "contacts", options
+      end
+
+      # @return [object] Returns the contact with the given id.
+      def contact(id, options = {})
+        get "contacts/#{id}", options
+      end
+
+      # @return [object] Returns all customers for the authenticated user's business.
+      def customers(options = {})
+        options["contact_type_id"] = ContactTypes::CUSTOMER
+
+        contacts(options)
+      end
+
+      # @return [object] Returns all suppliers for the authenticated user's business.
+      def suppliers(options = {})
+        options["contact_type_id"] = ContactTypes::SUPPLIER
+
+        contacts(options)
+      end
+
+      # Creates a contact record with the data provided.
+      # @example Create a new contact record
+      #   @client.create_contact(1, {"name" => "My new customer",
+      #                              "company_name" => "Sage UK Ltd"})
+      # @param type [integer] The contact type id. 1 = Customer, 2 = Supplier.
+      # @param data [hash] The contact record information.
+      # @param options [hash]
+      def create_contact(type, data, options = {})
+        data['contact_type_id'] = type
+
+        post "contacts", :contact => data
+      end
+
+      # Creates a customer record with the data provided.
+      # @example Create a new customer record
+      #   @client.create_customer({"name" => "My new customer",
+      #                            "company_name" => "Sage UK Ltd"})
+      # @param data [hash] The customer record information.
+      # @param options [hash]
+      def create_customer(data, options = {})
+        create_contact(ContactTypes::CUSTOMER, data, options)
+      end
+
+      # Creates a supplier record with the data provided.
+      # @example Create a new supplier record
+      #   @client.create_supplier({"name" => "My new supplier",
+      #                            "company_name" => "Sage UK Ltd"})
+      # @param data [hash] The supplier record information.
+      # @param options [hash]
+      def create_supplier(data, options = {})
+        create_contact(ContactTypes::SUPPLIER, data, options)
+      end
+
+      # Updates the given contact record with the data provided.
+      # @example Update contact record with id 1234
+      #   @client.update_contact(1234, {"name" => "Updated contact name",
+      #                                 "company_name" => "Updated company name"})
+      # @param id [integer] The id of the contact record to update.
+      # @param data [hash] The contact record information to update.
+      # @param options [hash]
+      def update_contact(id, data, options = {})
+        put "contacts/#{id}", :contact => data
+      end
+
+      # Deletes the given contact record.
+      # @param id [integer] The id of the contact record to delete.
+      # @param options [hash]
+      def delete_contact(id, options = {})
+        delete "contacts/#{id}"
+      end
+    end
+  end
+end

data/lib/sageone_sdk/client/countries.rb

@@ -0,0 +1,18 @@
+module SageoneSdk
+  class Client
+
+    # Represents the countries available to select in Sage One.
+    module Countries
+
+      # @return [object] Returns all countries.
+      def countries(options = {})
+        get "countries", options
+      end
+
+      # @return [object] Returns the country with the given id.
+      def country(id, options = {})
+        get "countries/#{id}", options
+      end
+    end
+  end
+end

data/lib/sageone_sdk/client/expenditures.rb

@@ -0,0 +1,26 @@
+module SageoneSdk
+  class Client
+    # Expenditures
+    module Expenditures
+      def expenditures(options = {})
+        paginate "expenditures", options
+      end
+
+      def expenditure(id, options = {})
+        get "expenditures/#{id}", options
+      end
+
+      def create_expenditure(data, options = {})
+        post "expenditures", :expenditure => data
+      end
+
+      def update_expenditure(id, data, options = {})
+        put "expenditures/#{id}", :expenditure => data
+      end
+
+      def delete_expenditure(id, options = {})
+        delete "expenditures/#{id}"
+      end
+    end
+  end
+end

data/lib/sageone_sdk/client/expense_methods.rb

@@ -0,0 +1,19 @@
+module SageoneSdk
+  class Client
+
+    # Represents the payment methods available when recording a purchase.
+    # For example, credit card payment.
+    module ExpenseMethods
+
+      # @return [object] Returns all payment methods.
+      def expense_methods(options = {})
+        get "expense_methods", options
+      end
+
+      # @return [object] Returns the payment method with the given id.
+      def expense_method(id, options = {})
+        get "expense_methods/#{id}", options
+      end
+    end
+  end
+end

data/lib/sageone_sdk/client/expense_types.rb

@@ -0,0 +1,19 @@
+module SageoneSdk
+  class Client
+
+    # Represents types of expense in Sage One. These are the categories
+    # a user can make purchases against.
+    module ExpenseTypes
+
+      # @return [object] Returns all expense types.
+      def expense_types(options = {})
+        get "expense_types", options
+      end
+
+      # @return [object] Returns the expense type with the given id.
+      def expense_type(id, options = {})
+        get "expense_types/#{id}", options
+      end
+    end
+  end
+end

data/lib/sageone_sdk/client/financial_settings.rb

@@ -0,0 +1,23 @@
+module SageoneSdk
+  class Client
+
+    # Represents the financial settings in Sage One. This includes
+    # year end date and tax schemes.
+    module FinancialSettings
+
+      # @return [object] Returns the financial settings.
+      def financial_settings(options = {})
+        get "financial_settings", options
+      end
+
+      # Updates the financial settings with the data provided.
+      # @example Change the year end date
+      #   @client.update_financial_settings({"year_end_date" => "2016-12-31"})
+      # @param data [hash] The settings information to update.
+      # @param options [hash]
+      def update_financial_settings(data, options = {})
+        put "financial_settings", :financial_settings => data
+      end
+    end
+  end
+end

data/lib/sageone_sdk/client/income_methods.rb

@@ -0,0 +1,19 @@
+module SageoneSdk
+  class Client
+
+    # Represents the payment methods available when recording a sale.
+    # For example, bank receipt.
+    module IncomeMethods
+
+      # @return [object] Returns all payment methods.
+      def income_methods(options = {})
+        get "income_methods", options
+      end
+
+      # @return [object] Returns the payment method with the given id.
+      def income_method(id, options = {})
+        get "income_methods/#{id}", options
+      end
+    end
+  end
+end

data/lib/sageone_sdk/client/income_types.rb

@@ -0,0 +1,19 @@
+module SageoneSdk
+  class Client
+
+    # Represents types of sale in Sage One. These are the categories
+    # a user can make sales against.
+    module IncomeTypes
+
+      # @return [object] Returns all sales types.
+      def income_types(options = {})
+        get "income_types", options
+      end
+
+      # @return [object] Returns the sales type with the given id.
+      def income_type(id, options = {})
+        get "income_types/#{id}", options
+      end
+    end
+  end
+end

data/lib/sageone_sdk/client/incomes.rb

@@ -0,0 +1,51 @@
+module SageoneSdk
+  class Client
+
+    # Represents other income transactions for the authenticated user's business.
+    module Incomes
+
+      # @return [object] Returns all other income transactions for the authenticated user's business.
+      def incomes(options = {})
+        paginate "incomes", options
+      end
+
+      # @return [object] Returns the other income transaction with the given id.
+      def income(id, options = {})
+        get "incomes/#{id}", options
+      end
+
+      # Creates an other income transaction with the data provided.
+      # @example Create a new income transaction
+      #   @client.create_income({"date" => "2016-01-25",
+      #                          "amount" => 100.0,
+      #                          "tax_amount" => 20.0,
+      #                          "tax_percentage_rate" => 20.0,
+      #                          "tax_code_id" => 1,
+      #                          "source_id" => 434,
+      #                          "destination_id" => 415,
+      #                          "payment_method_id" => 2})
+      # @param data [hash] The transaction information.
+      # @param options [hash]
+      def create_income(data, options = {})
+        post "incomes", :income => data
+      end
+
+      # Updates the given transaction with the data provided.
+      # @example Update the date of an income transaction
+      #   @client.update_income(655324, {"date" => "2016-01-31"})
+      # @param id [integer] The id of the income transaction to update.
+      # @param data [hash] The transaction information to update.
+      # @param options [hash]
+      def update_income(id, data, options = {})
+        put "incomes/#{id}", :income => data
+      end
+
+      # Deletes the given income transaction.
+      # @param id [integer] The id of the income transaction to delete.
+      # @param options [hash]
+      def delete_income(id, options = {})
+        delete "incomes/#{id}"
+      end
+    end
+  end
+end

data/lib/sageone_sdk/client/journals.rb

@@ -0,0 +1,27 @@
+module SageoneSdk
+  class Client
+
+    # Represents journal trasnactions in Sage One.
+    module Journals
+
+      # Creates a journal entry with the data provided.
+      # @example Create a new journal transaction
+      #   @client.create_journal({"reference" => "ref001",
+      #                           "description" => "description",
+      #                           "date" => "2016-01-01",
+      #                           "journal_lines[0][credit]" => 50.0,
+      #                           "journal_lines[0][debit]" => 0.0,
+      #                           "journal_lines[0][details]" => "detail",
+      #                           "journal_lines[0][ledger_account][nominal_code]" => 1,
+      #                           "journal_lines[1][credit]" => 0.0,
+      #                           "journal_lines[1][debit]" => 50.0,
+      #                           "journal_lines[1][details]" => "detail",
+      #                           "journal_lines[1][ledger_account][nominal_code]" => 9999})
+      # @param data [hash] The journal entry information.
+      # @param options [hash]
+      def create_journal(data, options = {})
+        post "journals", :journal => data
+      end
+    end
+  end
+end

data/lib/sageone_sdk/client/ledger_accounts.rb

@@ -0,0 +1,52 @@
+module SageoneSdk
+  class Client
+
+    # Represents ledger accounts for the authenticated user's business.
+    module LedgerAccounts
+
+      # @return [object] Returns all ledger accounts for the authenticated user's business.
+      def ledger_accounts(options = {})
+        get "ledger_accounts", options
+      end
+
+      # @return [object] Returns the ledger account with the given id.
+      def ledger_account(id, options = {})
+        get "ledger_accounts/#{id}", options
+      end
+
+      # @return [object] Returns all ledger accounts with a balance for the given date range.
+      # @param options [hash]
+      # @option options [date] from_date The transaction from date.
+      # @option options [date] to_date The transaction to date.
+      # @example Get balances for January 2015
+      #   @client.ledger_account_balances({'from_date' => '2015-01-01', 'to_date' => '2015-01-31'})
+      def ledger_account_balances(options = {})
+        get "ledger_accounts/balances", options
+      end
+
+      # @return [object] Returns the given ledger account and its balance for the given date range.
+      # @param id [integer] The ledger account id.
+      # @param options [hash]
+      # @option options [date] from_date The transaction from date.
+      # @option options [date] to_date The transaction to date.
+      # @example Get balances for ledger account id 1233 for January 2015
+      #   @client.ledger_account_balances(1233, {'from_date' => '2015-01-01', 'to_date' => '2015-01-31'})
+      def ledger_account_balance(id, options = {})
+        get "ledger_accounts/#{id}/balance", options
+      end
+
+      # Creates a ledger account with the data provided.
+      # @example Create a new ledger account
+      #   @client.create_ledger_account({ledger_name: "My new ledger account",
+      #                                  display_name: "My new ledger account",
+      #                                  nominal_code: 1235,
+      #                                  included_in_chart: true,
+      #                                  category_id: 1})
+      # @param data [hash] The ledger account information.
+      # @param options [hash]
+      def create_ledger_account(data, options = {})
+        post "ledger_accounts", :ledger_account => data
+      end
+    end
+  end
+end

data/lib/sageone_sdk/client/payment_statuses.rb

@@ -0,0 +1,18 @@
+module SageoneSdk
+  class Client
+
+    # Represents the payment status of an invoice in Sage One. For example, Paid or Void.
+    module PaymentStatuses
+
+      # @return [object] Returns all payment statuses.
+      def payment_statuses(options = {})
+        get "payment_statuses", options
+      end
+
+      # @return [object] Returns the payment status with the given id.
+      def payment_status(id, options = {})
+        get "payment_statuses/#{id}", options
+      end
+    end
+  end
+end

data/lib/sageone_sdk/client/period_types.rb

@@ -0,0 +1,19 @@
+module SageoneSdk
+  class Client
+
+    # Represents the rate frequency in Sage One and refers to the chargeable
+    # period of a service. For example, hourly or daily.
+    module PeriodTypes
+
+      # @return [object] Returns all rate frequencies.
+      def period_types(options = {})
+        get "period_types", options
+      end
+
+      # @return [object] Returns the rate frequency with the given id.
+      def period_type(id, options = {})
+        get "period_types/#{id}", options
+      end
+    end
+  end
+end

data/lib/sageone_sdk/client/products.rb

@@ -0,0 +1,50 @@
+module SageoneSdk
+  class Client
+
+    # Represents the products for the authenticated user's business.
+    module Products
+
+      # @return [object] Returns all products for the authenticated user's business.
+      def products(options = {})
+        paginate "products", options
+      end
+
+      # @return [object] Returns the product with the given id.
+      def product(id, options = {})
+        get "products/#{id}", options
+      end
+
+      # Creates a product record with the data provided.
+      # @example Create a new product record
+      #   @client.create_product({description: "My new product",
+      #                           sales_price_includes_tax: false,
+      #                           ledger_account_id: 438,
+      #                           tax_code_id: 1,
+      #                           product_code: "PROD001",
+      #                           last_cost_price: 41.5,
+      #                           sales_price: 99.99})
+      # @param data [hash] The product record information.
+      # @param options [hash]
+      def create_product(data, options = {})
+        post "products", :product => data
+      end
+
+      # Updates the given product record with the data provided.
+      # @example Update a product sales price
+      #   @client.update_product(2341, {sales_price: 199.99})
+      # @param id [integer] The id of the product record to update.
+      # @param data [hash] The product information to update.
+      # @param options [hash]
+      def update_product(id, data, options = {})
+        put "products/#{id}", :product => data
+      end
+
+      # Deletes the given product record.
+      # @param id [integer] The id of the product record to delete.
+      # @param options [hash]
+      def delete_product(id, options = {})
+        delete "products/#{id}"
+      end
+    end
+  end
+end