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.
- checksums.yaml +4 -4
- data/.env.example +3 -1
- data/CHANGELOG.md +65 -0
- data/Gemfile +3 -3
- data/Gemfile.lock +78 -59
- data/README.md +747 -3
- data/bin/console +2 -0
- data/bin/fixtures +148 -0
- data/freeagentrb.gemspec +4 -4
- data/lib/free_agent/client.rb +164 -4
- data/lib/free_agent/error_generator.rb +4 -3
- data/lib/free_agent/oauth.rb +48 -0
- data/lib/free_agent/object.rb +113 -17
- data/lib/free_agent/objects/account_lock.rb +4 -0
- data/lib/free_agent/objects/account_manager.rb +4 -0
- data/lib/free_agent/objects/balance_sheet.rb +4 -0
- data/lib/free_agent/objects/bank_feed.rb +4 -0
- data/lib/free_agent/objects/bank_transaction.rb +7 -12
- data/lib/free_agent/objects/bill.rb +1 -0
- data/lib/free_agent/objects/capital_asset.rb +4 -0
- data/lib/free_agent/objects/capital_asset_type.rb +4 -0
- data/lib/free_agent/objects/cashflow.rb +5 -0
- data/lib/free_agent/objects/cis_band.rb +4 -0
- data/lib/free_agent/objects/cis_settings.rb +4 -0
- data/lib/free_agent/objects/corporation_tax_return.rb +5 -0
- data/lib/free_agent/objects/credit_note.rb +1 -0
- data/lib/free_agent/objects/credit_note_reconciliation.rb +5 -0
- data/lib/free_agent/objects/estimate.rb +1 -0
- data/lib/free_agent/objects/expense.rb +5 -0
- data/lib/free_agent/objects/final_accounts_report.rb +4 -0
- data/lib/free_agent/objects/hire_purchase.rb +4 -0
- data/lib/free_agent/objects/invoice.rb +1 -9
- data/lib/free_agent/objects/journal_set.rb +4 -0
- data/lib/free_agent/objects/note.rb +4 -0
- data/lib/free_agent/objects/payroll_period.rb +4 -0
- data/lib/free_agent/objects/payroll_profile.rb +5 -0
- data/lib/free_agent/objects/practice.rb +4 -0
- data/lib/free_agent/objects/practice_client.rb +4 -0
- data/lib/free_agent/objects/price_list_item.rb +5 -0
- data/lib/free_agent/objects/profit_and_loss.rb +6 -0
- data/lib/free_agent/objects/property.rb +4 -0
- data/lib/free_agent/objects/recurring_invoice.rb +5 -0
- data/lib/free_agent/objects/sales_tax_period.rb +4 -0
- data/lib/free_agent/objects/self_assessment_return.rb +4 -0
- data/lib/free_agent/objects/stock_item.rb +5 -0
- data/lib/free_agent/objects/tax_timeline_item.rb +5 -0
- data/lib/free_agent/objects/timeline_item.rb +5 -0
- data/lib/free_agent/objects/transaction.rb +5 -0
- data/lib/free_agent/objects/trial_balance_item.rb +5 -0
- data/lib/free_agent/objects/vat_return.rb +4 -0
- data/lib/free_agent/rate_limiter.rb +67 -0
- data/lib/free_agent/resource.rb +6 -2
- data/lib/free_agent/resources/account_locks.rb +24 -0
- data/lib/free_agent/resources/account_managers.rb +19 -0
- data/lib/free_agent/resources/balance_sheet.rb +15 -0
- data/lib/free_agent/resources/bank_accounts.rb +5 -7
- data/lib/free_agent/resources/bank_feeds.rb +13 -0
- data/lib/free_agent/resources/bank_transaction_explanations.rb +41 -1
- data/lib/free_agent/resources/bank_transactions.rb +1 -1
- data/lib/free_agent/resources/capital_asset_types.rb +28 -0
- data/lib/free_agent/resources/capital_assets.rb +14 -0
- data/lib/free_agent/resources/cashflow.rb +8 -0
- data/lib/free_agent/resources/categories.rb +33 -0
- data/lib/free_agent/resources/cis_bands.rb +8 -0
- data/lib/free_agent/resources/cis_settings.rb +15 -0
- data/lib/free_agent/resources/clients.rb +8 -0
- data/lib/free_agent/resources/company.rb +12 -0
- data/lib/free_agent/resources/contacts.rb +2 -2
- data/lib/free_agent/resources/corporation_tax_returns.rb +34 -0
- data/lib/free_agent/resources/credit_note_reconciliations.rb +31 -0
- data/lib/free_agent/resources/credit_notes.rb +0 -10
- data/lib/free_agent/resources/email_addresses.rb +9 -0
- data/lib/free_agent/resources/estimate_items.rb +3 -4
- data/lib/free_agent/resources/estimates.rb +30 -3
- data/lib/free_agent/resources/expenses.rb +45 -0
- data/lib/free_agent/resources/final_accounts_reports.rb +24 -0
- data/lib/free_agent/resources/hire_purchases.rb +13 -0
- data/lib/free_agent/resources/invoices.rb +22 -0
- data/lib/free_agent/resources/journal_sets.rb +37 -0
- data/lib/free_agent/resources/notes.rb +37 -0
- data/lib/free_agent/resources/payroll.rb +32 -0
- data/lib/free_agent/resources/payroll_profiles.rb +9 -0
- data/lib/free_agent/resources/practice.rb +10 -0
- data/lib/free_agent/resources/price_list_items.rb +30 -0
- data/lib/free_agent/resources/profit_and_loss.rb +10 -0
- data/lib/free_agent/resources/projects.rb +2 -2
- data/lib/free_agent/resources/properties.rb +29 -0
- data/lib/free_agent/resources/recurring_invoices.rb +23 -0
- data/lib/free_agent/resources/sales_tax_periods.rb +37 -0
- data/lib/free_agent/resources/self_assessment_returns.rb +36 -0
- data/lib/free_agent/resources/stock_items.rb +13 -0
- data/lib/free_agent/resources/tasks.rb +5 -4
- data/lib/free_agent/resources/timeslips.rb +20 -3
- data/lib/free_agent/resources/transactions.rb +15 -0
- data/lib/free_agent/resources/trial_balance.rb +13 -0
- data/lib/free_agent/resources/users.rb +3 -3
- data/lib/free_agent/resources/vat_returns.rb +35 -0
- data/lib/free_agent/version.rb +1 -1
- data/lib/free_agent.rb +67 -0
- metadata +83 -10
|
@@ -1,13 +1,5 @@
|
|
|
1
1
|
module FreeAgent
|
|
2
2
|
class Invoice < Object
|
|
3
|
-
|
|
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,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
|
data/lib/free_agent/resource.rb
CHANGED
|
@@ -29,7 +29,11 @@ module FreeAgent
|
|
|
29
29
|
end
|
|
30
30
|
|
|
31
31
|
def handle_response(response)
|
|
32
|
-
|
|
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
|
|
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(
|
|
4
|
-
|
|
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
|
|
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, "
|
|
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
|
|
@@ -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,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
|
|
@@ -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
|