freeagentrb 0.1.3 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (100) hide show
  1. checksums.yaml +4 -4
  2. data/.env.example +3 -1
  3. data/CHANGELOG.md +65 -0
  4. data/Gemfile +3 -3
  5. data/Gemfile.lock +78 -59
  6. data/README.md +747 -3
  7. data/bin/console +2 -0
  8. data/bin/fixtures +148 -0
  9. data/freeagentrb.gemspec +4 -4
  10. data/lib/free_agent/client.rb +164 -4
  11. data/lib/free_agent/error_generator.rb +4 -3
  12. data/lib/free_agent/oauth.rb +48 -0
  13. data/lib/free_agent/object.rb +113 -17
  14. data/lib/free_agent/objects/account_lock.rb +4 -0
  15. data/lib/free_agent/objects/account_manager.rb +4 -0
  16. data/lib/free_agent/objects/balance_sheet.rb +4 -0
  17. data/lib/free_agent/objects/bank_feed.rb +4 -0
  18. data/lib/free_agent/objects/bank_transaction.rb +7 -12
  19. data/lib/free_agent/objects/bill.rb +1 -0
  20. data/lib/free_agent/objects/capital_asset.rb +4 -0
  21. data/lib/free_agent/objects/capital_asset_type.rb +4 -0
  22. data/lib/free_agent/objects/cashflow.rb +5 -0
  23. data/lib/free_agent/objects/cis_band.rb +4 -0
  24. data/lib/free_agent/objects/cis_settings.rb +4 -0
  25. data/lib/free_agent/objects/corporation_tax_return.rb +5 -0
  26. data/lib/free_agent/objects/credit_note.rb +1 -0
  27. data/lib/free_agent/objects/credit_note_reconciliation.rb +5 -0
  28. data/lib/free_agent/objects/estimate.rb +1 -0
  29. data/lib/free_agent/objects/expense.rb +5 -0
  30. data/lib/free_agent/objects/final_accounts_report.rb +4 -0
  31. data/lib/free_agent/objects/hire_purchase.rb +4 -0
  32. data/lib/free_agent/objects/invoice.rb +1 -9
  33. data/lib/free_agent/objects/journal_set.rb +4 -0
  34. data/lib/free_agent/objects/note.rb +4 -0
  35. data/lib/free_agent/objects/payroll_period.rb +4 -0
  36. data/lib/free_agent/objects/payroll_profile.rb +5 -0
  37. data/lib/free_agent/objects/practice.rb +4 -0
  38. data/lib/free_agent/objects/practice_client.rb +4 -0
  39. data/lib/free_agent/objects/price_list_item.rb +5 -0
  40. data/lib/free_agent/objects/profit_and_loss.rb +6 -0
  41. data/lib/free_agent/objects/property.rb +4 -0
  42. data/lib/free_agent/objects/recurring_invoice.rb +5 -0
  43. data/lib/free_agent/objects/sales_tax_period.rb +4 -0
  44. data/lib/free_agent/objects/self_assessment_return.rb +4 -0
  45. data/lib/free_agent/objects/stock_item.rb +5 -0
  46. data/lib/free_agent/objects/tax_timeline_item.rb +5 -0
  47. data/lib/free_agent/objects/timeline_item.rb +5 -0
  48. data/lib/free_agent/objects/transaction.rb +5 -0
  49. data/lib/free_agent/objects/trial_balance_item.rb +5 -0
  50. data/lib/free_agent/objects/vat_return.rb +4 -0
  51. data/lib/free_agent/rate_limiter.rb +67 -0
  52. data/lib/free_agent/resource.rb +6 -2
  53. data/lib/free_agent/resources/account_locks.rb +24 -0
  54. data/lib/free_agent/resources/account_managers.rb +19 -0
  55. data/lib/free_agent/resources/balance_sheet.rb +15 -0
  56. data/lib/free_agent/resources/bank_accounts.rb +5 -7
  57. data/lib/free_agent/resources/bank_feeds.rb +13 -0
  58. data/lib/free_agent/resources/bank_transaction_explanations.rb +41 -1
  59. data/lib/free_agent/resources/bank_transactions.rb +1 -1
  60. data/lib/free_agent/resources/capital_asset_types.rb +28 -0
  61. data/lib/free_agent/resources/capital_assets.rb +14 -0
  62. data/lib/free_agent/resources/cashflow.rb +8 -0
  63. data/lib/free_agent/resources/categories.rb +33 -0
  64. data/lib/free_agent/resources/cis_bands.rb +8 -0
  65. data/lib/free_agent/resources/cis_settings.rb +15 -0
  66. data/lib/free_agent/resources/clients.rb +8 -0
  67. data/lib/free_agent/resources/company.rb +12 -0
  68. data/lib/free_agent/resources/contacts.rb +2 -2
  69. data/lib/free_agent/resources/corporation_tax_returns.rb +34 -0
  70. data/lib/free_agent/resources/credit_note_reconciliations.rb +31 -0
  71. data/lib/free_agent/resources/credit_notes.rb +0 -10
  72. data/lib/free_agent/resources/email_addresses.rb +9 -0
  73. data/lib/free_agent/resources/estimate_items.rb +3 -4
  74. data/lib/free_agent/resources/estimates.rb +30 -3
  75. data/lib/free_agent/resources/expenses.rb +45 -0
  76. data/lib/free_agent/resources/final_accounts_reports.rb +24 -0
  77. data/lib/free_agent/resources/hire_purchases.rb +13 -0
  78. data/lib/free_agent/resources/invoices.rb +22 -0
  79. data/lib/free_agent/resources/journal_sets.rb +37 -0
  80. data/lib/free_agent/resources/notes.rb +37 -0
  81. data/lib/free_agent/resources/payroll.rb +32 -0
  82. data/lib/free_agent/resources/payroll_profiles.rb +9 -0
  83. data/lib/free_agent/resources/practice.rb +10 -0
  84. data/lib/free_agent/resources/price_list_items.rb +30 -0
  85. data/lib/free_agent/resources/profit_and_loss.rb +10 -0
  86. data/lib/free_agent/resources/projects.rb +2 -2
  87. data/lib/free_agent/resources/properties.rb +29 -0
  88. data/lib/free_agent/resources/recurring_invoices.rb +23 -0
  89. data/lib/free_agent/resources/sales_tax_periods.rb +37 -0
  90. data/lib/free_agent/resources/self_assessment_returns.rb +36 -0
  91. data/lib/free_agent/resources/stock_items.rb +13 -0
  92. data/lib/free_agent/resources/tasks.rb +5 -4
  93. data/lib/free_agent/resources/timeslips.rb +20 -3
  94. data/lib/free_agent/resources/transactions.rb +15 -0
  95. data/lib/free_agent/resources/trial_balance.rb +13 -0
  96. data/lib/free_agent/resources/users.rb +3 -3
  97. data/lib/free_agent/resources/vat_returns.rb +35 -0
  98. data/lib/free_agent/version.rb +1 -1
  99. data/lib/free_agent.rb +67 -0
  100. metadata +83 -10
@@ -0,0 +1,5 @@
1
+ module FreeAgent
2
+ class CorporationTaxReturn < Object
3
+ decimal_attributes :amount_due
4
+ end
5
+ end
@@ -1,4 +1,5 @@
1
1
  module FreeAgent
2
2
  class CreditNote < Object
3
+ decimal_attributes :net_value, :total_value, :refunded_value, :due_value, :sales_tax_value
3
4
  end
4
5
  end
@@ -0,0 +1,5 @@
1
+ module FreeAgent
2
+ class CreditNoteReconciliation < Object
3
+ decimal_attributes :gross_value
4
+ end
5
+ end
@@ -1,4 +1,5 @@
1
1
  module FreeAgent
2
2
  class Estimate < Object
3
+ decimal_attributes :net_value, :total_value, :sales_tax_value
3
4
  end
4
5
  end
@@ -0,0 +1,5 @@
1
+ module FreeAgent
2
+ class Expense < Object
3
+ decimal_attributes :gross_value, :native_gross_value, :sales_tax_value
4
+ end
5
+ end
@@ -0,0 +1,4 @@
1
+ module FreeAgent
2
+ class FinalAccountsReport < Object
3
+ end
4
+ end
@@ -0,0 +1,4 @@
1
+ module FreeAgent
2
+ class HirePurchase < Object
3
+ end
4
+ end
@@ -1,13 +1,5 @@
1
1
  module FreeAgent
2
2
  class Invoice < Object
3
- def initialize(attributes)
4
- super to_ostruct(attributes)
5
-
6
- # Convert amounts to BigDecimal
7
- self.net_value = BigDecimal(self.net_value.to_s).to_f if self.net_value
8
- self.total_value = BigDecimal(self.total_value.to_s).to_f if self.total_value
9
- self.paid_value = BigDecimal(self.paid_value.to_s).to_f if self.paid_value
10
- self.due_value = BigDecimal(self.due_value.to_s).to_f if self.due_value
11
- end
3
+ decimal_attributes :net_value, :total_value, :paid_value, :due_value, :sales_tax_value
12
4
  end
13
5
  end
@@ -0,0 +1,4 @@
1
+ module FreeAgent
2
+ class JournalSet < Object
3
+ end
4
+ end
@@ -0,0 +1,4 @@
1
+ module FreeAgent
2
+ class Note < Object
3
+ end
4
+ end
@@ -0,0 +1,4 @@
1
+ module FreeAgent
2
+ class PayrollPeriod < Object
3
+ end
4
+ end
@@ -0,0 +1,5 @@
1
+ module FreeAgent
2
+ class PayrollProfile < Object
3
+ decimal_attributes :total_pay_in_previous_employment, :total_tax_in_previous_employment
4
+ end
5
+ end
@@ -0,0 +1,4 @@
1
+ module FreeAgent
2
+ class Practice < Object
3
+ end
4
+ end
@@ -0,0 +1,4 @@
1
+ module FreeAgent
2
+ class PracticeClient < Object
3
+ end
4
+ end
@@ -0,0 +1,5 @@
1
+ module FreeAgent
2
+ class PriceListItem < Object
3
+ decimal_attributes :price
4
+ end
5
+ end
@@ -0,0 +1,6 @@
1
+ module FreeAgent
2
+ class ProfitAndLoss < Object
3
+ decimal_attributes :income, :expenses, :operating_profit, :retained_profit,
4
+ :retained_profit_brought_forward, :retained_profit_carried_forward
5
+ end
6
+ end
@@ -0,0 +1,4 @@
1
+ module FreeAgent
2
+ class Property < Object
3
+ end
4
+ end
@@ -0,0 +1,5 @@
1
+ module FreeAgent
2
+ class RecurringInvoice < Object
3
+ decimal_attributes :net_value, :total_value, :sales_tax_value
4
+ end
5
+ end
@@ -0,0 +1,4 @@
1
+ module FreeAgent
2
+ class SalesTaxPeriod < Object
3
+ end
4
+ end
@@ -0,0 +1,4 @@
1
+ module FreeAgent
2
+ class SelfAssessmentReturn < Object
3
+ end
4
+ end
@@ -0,0 +1,5 @@
1
+ module FreeAgent
2
+ class StockItem < Object
3
+ decimal_attributes :opening_quantity, :opening_balance, :cost_of_sale_value
4
+ end
5
+ end
@@ -0,0 +1,5 @@
1
+ module FreeAgent
2
+ class TaxTimelineItem < Object
3
+ decimal_attributes :amount_due
4
+ end
5
+ end
@@ -0,0 +1,5 @@
1
+ module FreeAgent
2
+ class TimelineItem < Object
3
+ decimal_attributes :amount
4
+ end
5
+ end
@@ -0,0 +1,5 @@
1
+ module FreeAgent
2
+ class Transaction < Object
3
+ decimal_attributes :debit_value, :credit_value, :running_total
4
+ end
5
+ end
@@ -0,0 +1,5 @@
1
+ module FreeAgent
2
+ class TrialBalanceItem < Object
3
+ decimal_attributes :total
4
+ end
5
+ end
@@ -0,0 +1,4 @@
1
+ module FreeAgent
2
+ class VatReturn < Object
3
+ end
4
+ end
@@ -0,0 +1,67 @@
1
+ module FreeAgent
2
+ class RateLimiter
3
+ # FreeAgent API rate limit header
4
+ RETRY_AFTER_HEADER = "retry-after".freeze
5
+
6
+ attr_reader :retry_after, :rate_limited_at, :logger
7
+
8
+ def initialize(logger: nil)
9
+ @retry_after = nil
10
+ @rate_limited_at = nil
11
+ @logger = logger
12
+ end
13
+
14
+ # Update rate limit info from response headers (called on 429 responses)
15
+ def update(response_headers)
16
+ return unless response_headers
17
+
18
+ @retry_after = response_headers[RETRY_AFTER_HEADER]&.to_i
19
+ @rate_limited_at = Time.now if @retry_after
20
+ end
21
+
22
+ # Check if currently rate limited
23
+ def rate_limited?
24
+ return false if retry_after.nil? || rate_limited_at.nil?
25
+
26
+ # Check if we're still within the retry-after window
27
+ (Time.now - rate_limited_at) < retry_after
28
+ end
29
+
30
+ # Get seconds until rate limit resets
31
+ def reset_in
32
+ return nil if retry_after.nil? || rate_limited_at.nil?
33
+
34
+ seconds = retry_after - (Time.now - rate_limited_at)
35
+ [ seconds, 0 ].max.ceil # Ensure non-negative and round up
36
+ end
37
+
38
+ # Wait if rate limited
39
+ def wait_if_rate_limited
40
+ return unless rate_limited?
41
+
42
+ wait_seconds = reset_in
43
+ return if wait_seconds.nil? || wait_seconds.zero?
44
+
45
+ if logger
46
+ logger.warn("Rate limited. Waiting #{wait_seconds} seconds before retrying")
47
+ end
48
+
49
+ sleep(wait_seconds)
50
+ end
51
+
52
+ # Reset rate limit tracking
53
+ def reset
54
+ @retry_after = nil
55
+ @rate_limited_at = nil
56
+ end
57
+
58
+ # Get formatted status string
59
+ def status
60
+ if rate_limited?
61
+ "Rate limited. Retry in #{reset_in} seconds"
62
+ else
63
+ "Not rate limited"
64
+ end
65
+ end
66
+ end
67
+ end
@@ -29,7 +29,11 @@ module FreeAgent
29
29
  end
30
30
 
31
31
  def handle_response(response)
32
- return true if response.status == 204
32
+ # Update rate limiter on 429 responses
33
+ if response.status == 429
34
+ client.rate_limiter.update(response.headers)
35
+ end
36
+
33
37
  return response unless error?(response)
34
38
 
35
39
  raise_error(response)
@@ -37,7 +41,7 @@ module FreeAgent
37
41
 
38
42
  def error?(response)
39
43
  [ 400, 401, 403, 404, 409, 422, 429, 500, 501, 503 ].include?(response.status) ||
40
- response.body&.key?("error")
44
+ (response.body.is_a?(Hash) && response.body.key?("error"))
41
45
  end
42
46
 
43
47
  def raise_error(response)
@@ -0,0 +1,24 @@
1
+ module FreeAgent
2
+ class AccountLocksResource < Resource
3
+ # Returns the company's account locks, along with earliest_lock_date and
4
+ # latest_lock_date, the range a user account lock can be set within
5
+ def retrieve
6
+ response = get_request("account_locks")
7
+ locks = FreeAgent::Object.new(response.body)
8
+ locks.account_locks = response.body["account_locks"].map { |attributes| AccountLock.new(attributes) }
9
+ locks
10
+ end
11
+
12
+ # Creates or updates the user account lock
13
+ def update(locked_to_date:)
14
+ response = put_request("account_locks", body: { account_lock: { locked_to_date: locked_to_date } })
15
+ response.success?
16
+ end
17
+
18
+ # Removes the user account lock
19
+ def delete
20
+ response = delete_request("account_locks")
21
+ response.success?
22
+ end
23
+ end
24
+ end
@@ -0,0 +1,19 @@
1
+ module FreeAgent
2
+ class AccountManagersResource < Resource
3
+ def list(**params)
4
+ response = get_request("account_managers", params: params)
5
+ Collection.from_response(response, type: AccountManager)
6
+ end
7
+
8
+ def retrieve(id:)
9
+ response = get_request("account_managers/#{id}")
10
+ AccountManager.new(response.body["account_manager"])
11
+ end
12
+
13
+ # The account manager the access token belongs to
14
+ def me
15
+ response = get_request("account_managers/me")
16
+ AccountManager.new(response.body["account_manager"])
17
+ end
18
+ end
19
+ end
@@ -0,0 +1,15 @@
1
+ module FreeAgent
2
+ class BalanceSheetResource < Resource
3
+ # Defaults to today. Pass as_at_date or accounting_period (e.g. "2022/23")
4
+ # for another date.
5
+ def retrieve(**params)
6
+ response = get_request("accounting/balance_sheet", params: params)
7
+ BalanceSheet.new(response.body["balance_sheet"])
8
+ end
9
+
10
+ def opening_balances
11
+ response = get_request("accounting/balance_sheet/opening_balances")
12
+ BalanceSheet.new(response.body["balance_sheet"])
13
+ end
14
+ end
15
+ end
@@ -1,9 +1,7 @@
1
1
  module FreeAgent
2
2
  class BankAccountsResource < Resource
3
- def list(view: nil)
4
- url = view.nil? ? "bank_accounts" : "bank_accounts?view=#{view}"
5
-
6
- response = get_request(url)
3
+ def list(**params)
4
+ response = get_request("bank_accounts", params: params)
7
5
  Collection.from_response(response, type: BankAccount)
8
6
  end
9
7
 
@@ -12,14 +10,14 @@ module FreeAgent
12
10
  BankAccount.new(response.body["bank_account"])
13
11
  end
14
12
 
15
- def create(type:, name:, opening_balance:, **params)
13
+ def create(type: "StandardBankAccount", name:, opening_balance:, **params)
16
14
  attributes = { type: type, name: name, opening_balance: opening_balance }
17
- response = post_request("bank_accounts", body: attributes.merge(params))
15
+ response = post_request("bank_accounts", body: { bank_account: attributes.merge(params) })
18
16
  BankAccount.new(response.body["bank_account"]) if response.success?
19
17
  end
20
18
 
21
19
  def update(id:, **params)
22
- response = put_request("bank_accounts/#{id}", body: params)
20
+ response = put_request("bank_accounts/#{id}", body: { bank_account: params })
23
21
  BankAccount.new(response.body["bank_account"]) if response.success?
24
22
  end
25
23
 
@@ -0,0 +1,13 @@
1
+ module FreeAgent
2
+ class BankFeedsResource < Resource
3
+ def list(**params)
4
+ response = get_request("bank_feeds", params: params)
5
+ Collection.from_response(response, type: BankFeed)
6
+ end
7
+
8
+ def retrieve(id:)
9
+ response = get_request("bank_feeds/#{id}")
10
+ BankFeed.new(response.body["bank_feed"])
11
+ end
12
+ end
13
+ end
@@ -1,5 +1,8 @@
1
1
  module FreeAgent
2
2
  class BankTransactionExplanationsResource < Resource
3
+ # The attachments endpoints only exist from this API version onwards
4
+ ATTACHMENTS_API_VERSION = "2026-09-01"
5
+
3
6
  def list(bank_account:, **params)
4
7
  attributes = { bank_account: bank_account }
5
8
 
@@ -14,13 +17,50 @@ module FreeAgent
14
17
 
15
18
  def create(**params)
16
19
  raise "bank_account or bank_transaction is required" unless !params[:bank_account].nil? || !params[:bank_transaction].nil?
17
- response = post_request("bank_transaction_explanations", body: params)
20
+ response = post_request("bank_transaction_explanations", body: { bank_transaction_explanation: params })
18
21
  BankTransactionExplanation.new(response.body["bank_transaction_explanation"])
19
22
  end
20
23
 
24
+ def update(id:, **params)
25
+ response = put_request("bank_transaction_explanations/#{id}", body: { bank_transaction_explanation: params })
26
+ BankTransactionExplanation.new(response.body["bank_transaction_explanation"]) if response.success?
27
+ end
28
+
21
29
  def delete(id:)
22
30
  response = delete_request("bank_transaction_explanations/#{id}")
23
31
  response.success?
24
32
  end
33
+
34
+ def attachments(id:)
35
+ response = get_request("bank_transaction_explanations/#{id}/attachments", headers: attachments_headers)
36
+ Collection.from_response(response, type: Attachment)
37
+ end
38
+
39
+ # Each attachment is a hash of data (Base64-encoded), file_name,
40
+ # content_type and optionally description. Up to 10 per call, 50 in total.
41
+ # Returns every attachment on the explanation.
42
+ def add_attachments(id:, attachments:)
43
+ response = post_request("bank_transaction_explanations/#{id}/attachments", body: { attachments: attachments }, headers: attachments_headers)
44
+ Collection.from_response(response, type: Attachment)
45
+ end
46
+
47
+ # Each attachment is identified by its url. Pass _destroy: true to remove
48
+ # one. Creates, updates and removals can be mixed in one call.
49
+ def update_attachments(id:, attachments:)
50
+ response = put_request("bank_transaction_explanations/#{id}/attachments", body: { attachments: attachments }, headers: attachments_headers)
51
+ Collection.from_response(response, type: Attachment)
52
+ end
53
+
54
+ def delete_attachments(id:)
55
+ response = delete_request("bank_transaction_explanations/#{id}/attachments", headers: attachments_headers)
56
+ response.success?
57
+ end
58
+
59
+ private
60
+
61
+ # Keep the client's version if it's newer than the minimum
62
+ def attachments_headers
63
+ { "X-Api-Version" => [ client.api_version, ATTACHMENTS_API_VERSION ].compact.max }
64
+ end
25
65
  end
26
66
  end
@@ -21,7 +21,7 @@ module FreeAgent
21
21
  def upload(bank_account:, statement:)
22
22
  # This method uses Faraday Multipart (lostisland/faraday-multipart)
23
23
  payload = {}
24
- payload[:statement] = Faraday::Multipart::FilePart.new(statement, "text/x-ruby")
24
+ payload[:statement] = Faraday::Multipart::FilePart.new(statement, "application/octet-stream")
25
25
 
26
26
  response = client.connection_upload.post "bank_transactions/statement?bank_account=#{bank_account}", payload
27
27
  response.success?
@@ -0,0 +1,28 @@
1
+ module FreeAgent
2
+ class CapitalAssetTypesResource < Resource
3
+ def list(**params)
4
+ response = get_request("capital_asset_types", params: params)
5
+ Collection.from_response(response, type: CapitalAssetType)
6
+ end
7
+
8
+ def retrieve(id:)
9
+ response = get_request("capital_asset_types/#{id}")
10
+ CapitalAssetType.new(response.body["capital_asset_type"])
11
+ end
12
+
13
+ def create(name:, **params)
14
+ response = post_request("capital_asset_types", body: { capital_asset_type: { name: name }.merge(params) })
15
+ CapitalAssetType.new(response.body["capital_asset_type"]) if response.success?
16
+ end
17
+
18
+ def update(id:, **params)
19
+ response = put_request("capital_asset_types/#{id}", body: { capital_asset_type: params })
20
+ CapitalAssetType.new(response.body["capital_asset_type"]) if response.success?
21
+ end
22
+
23
+ def delete(id:)
24
+ response = delete_request("capital_asset_types/#{id}")
25
+ response.success?
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,14 @@
1
+ module FreeAgent
2
+ class CapitalAssetsResource < Resource
3
+ # Pass include_history: true to include each asset's depreciation history
4
+ def list(**params)
5
+ response = get_request("capital_assets", params: params)
6
+ Collection.from_response(response, type: CapitalAsset)
7
+ end
8
+
9
+ def retrieve(id:, **params)
10
+ response = get_request("capital_assets/#{id}", params: params)
11
+ CapitalAsset.new(response.body["capital_asset"])
12
+ end
13
+ end
14
+ end
@@ -0,0 +1,8 @@
1
+ module FreeAgent
2
+ class CashflowResource < Resource
3
+ def retrieve(**params)
4
+ response = get_request("cashflow", params: params)
5
+ Cashflow.new(response.body["cashflow"])
6
+ end
7
+ end
8
+ end
@@ -14,5 +14,38 @@ module FreeAgent
14
14
 
15
15
  responses
16
16
  end
17
+
18
+ def retrieve(nominal_code:)
19
+ response = get_request("categories/#{nominal_code}")
20
+ category_from(response.body)
21
+ end
22
+
23
+ # category_group is one of income, cost_of_sales, admin_expenses,
24
+ # current_assets, liabilities or equities
25
+ def create(description:, nominal_code:, category_group:, **params)
26
+ attributes = { description: description, nominal_code: nominal_code, category_group: category_group }
27
+
28
+ response = post_request("categories", body: { category: attributes.merge(params) })
29
+ category_from(response.body) if response.success?
30
+ end
31
+
32
+ def update(nominal_code:, **params)
33
+ response = put_request("categories/#{nominal_code}", body: { category: params })
34
+ category_from(response.body) if response.success?
35
+ end
36
+
37
+ def delete(nominal_code:)
38
+ response = delete_request("categories/#{nominal_code}")
39
+ response.success?
40
+ end
41
+
42
+ private
43
+
44
+ # A single category is returned under the type it belongs to, e.g.
45
+ # { "income_categories" => { ... } }
46
+ def category_from(body)
47
+ category_type, attributes = body.first
48
+ Category.new(attributes.merge("category_type" => category_type))
49
+ end
17
50
  end
18
51
  end
@@ -0,0 +1,8 @@
1
+ module FreeAgent
2
+ class CisBandsResource < Resource
3
+ def list(**params)
4
+ response = get_request("cis_bands", params: params)
5
+ Collection.from_response(response, type: CisBand)
6
+ end
7
+ end
8
+ end
@@ -0,0 +1,15 @@
1
+ module FreeAgent
2
+ class CisSettingsResource < Resource
3
+ def retrieve
4
+ response = get_request("cis_settings")
5
+ CisSettings.new(response.body["cis_settings"])
6
+ end
7
+
8
+ # Keys left out are unchanged. Set contractor_details or
9
+ # subcontractor_details to nil to deregister.
10
+ def update(**params)
11
+ response = put_request("cis_settings", body: { cis_settings: params })
12
+ CisSettings.new(response.body["cis_settings"]) if response.success?
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,8 @@
1
+ module FreeAgent
2
+ class ClientsResource < Resource
3
+ def list(**params)
4
+ response = get_request("clients", params: params)
5
+ Collection.from_response(response, type: PracticeClient)
6
+ end
7
+ end
8
+ end
@@ -4,5 +4,17 @@ module FreeAgent
4
4
  response = get_request("company")
5
5
  Company.new(response.body["company"])
6
6
  end
7
+
8
+ # The business categories a company can choose from, as strings
9
+ def business_categories
10
+ response = get_request("company/business_categories")
11
+ response.body["business_categories"]
12
+ end
13
+
14
+ # Upcoming tax deadlines and payments
15
+ def tax_timeline
16
+ response = get_request("company/tax_timeline")
17
+ Collection.from_response(response, type: TaxTimelineItem)
18
+ end
7
19
  end
8
20
  end
@@ -13,12 +13,12 @@ module FreeAgent
13
13
  def create(**params)
14
14
  raise "first_name and last_name or organisation_name is required" unless !params[:first_name].nil? || !params[:organisation_name].nil?
15
15
 
16
- response = post_request("contacts", body: params)
16
+ response = post_request("contacts", body: { contact: params })
17
17
  Contact.new(response.body["contact"]) if response.success?
18
18
  end
19
19
 
20
20
  def update(id:, **params)
21
- response = put_request("contacts/#{id}", body: params)
21
+ response = put_request("contacts/#{id}", body: { contact: params })
22
22
  Contact.new(response.body["contact"]) if response.success?
23
23
  end
24
24
 
@@ -0,0 +1,34 @@
1
+ module FreeAgent
2
+ class CorporationTaxReturnsResource < Resource
3
+ def list(**params)
4
+ response = get_request("corporation_tax_returns", params: params)
5
+ Collection.from_response(response, type: CorporationTaxReturn)
6
+ end
7
+
8
+ # Returns are identified by the date their period ends, not by an id
9
+ def retrieve(period_ends_on:)
10
+ response = get_request("corporation_tax_returns/#{period_ends_on}")
11
+ CorporationTaxReturn.new(response.body["corporation_tax_return"])
12
+ end
13
+
14
+ def mark_as_filed(period_ends_on:, **params)
15
+ response = put_request("corporation_tax_returns/#{period_ends_on}/mark_as_filed", body: params)
16
+ response.success?
17
+ end
18
+
19
+ def mark_as_unfiled(period_ends_on:)
20
+ response = put_request("corporation_tax_returns/#{period_ends_on}/mark_as_unfiled", body: {})
21
+ response.success?
22
+ end
23
+
24
+ def mark_as_paid(period_ends_on:, **params)
25
+ response = put_request("corporation_tax_returns/#{period_ends_on}/mark_as_paid", body: params)
26
+ response.success?
27
+ end
28
+
29
+ def mark_as_unpaid(period_ends_on:)
30
+ response = put_request("corporation_tax_returns/#{period_ends_on}/mark_as_unpaid", body: {})
31
+ response.success?
32
+ end
33
+ end
34
+ end