merge_accounting_client 1.0.4 → 1.0.5
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/README.md +61 -5
- data/docs/Account.md +12 -8
- data/docs/AccountEndpointRequest.md +18 -0
- data/docs/AccountIntegration.md +1 -1
- data/docs/AccountRequest.md +40 -0
- data/docs/AccountResponse.md +24 -0
- data/docs/AccountingAttachment.md +7 -3
- data/docs/AccountingAttachmentEndpointRequest.md +18 -0
- data/docs/AccountingAttachmentRequest.md +26 -0
- data/docs/AccountingAttachmentResponse.md +24 -0
- data/docs/AccountingPhoneNumberRequest.md +24 -0
- data/docs/AccountsApi.md +163 -5
- data/docs/Address.md +5 -3
- data/docs/AddressesApi.md +4 -2
- data/docs/AttachmentsApi.md +154 -0
- data/docs/BalanceSheet.md +11 -7
- data/docs/BalanceSheetsApi.md +2 -0
- data/docs/CashFlowStatement.md +11 -7
- data/docs/CashFlowStatementsApi.md +2 -0
- data/docs/CommonModelScopeData.md +20 -0
- data/docs/CommonModelScopes.md +20 -0
- data/docs/CommonModelScopesApi.md +157 -0
- data/docs/CommonModelScopesBodyRequest.md +22 -0
- data/docs/CommonModelScopesDisabledModels.md +26 -0
- data/docs/CommonModelScopesDisabledModelsEnabledActionsEnum.md +15 -0
- data/docs/CommonModelScopesPostInnerDeserializerRequest.md +22 -0
- data/docs/CommonModelScopesUpdateSerializer.md +18 -0
- data/docs/CompanyInfo.md +6 -4
- data/docs/CompanyInfoApi.md +0 -4
- data/docs/ConditionSchema.md +30 -0
- data/docs/ConditionTypeEnum.md +15 -0
- data/docs/Contact.md +8 -4
- data/docs/ContactEndpointRequest.md +18 -0
- data/docs/ContactRequest.md +40 -0
- data/docs/ContactResponse.md +24 -0
- data/docs/ContactsApi.md +163 -9
- data/docs/CreditNote.md +12 -8
- data/docs/CreditNoteLineItem.md +7 -3
- data/docs/CreditNotesApi.md +15 -9
- data/docs/DataPassthroughRequest.md +1 -1
- data/docs/EnabledActionsEnum.md +15 -0
- data/docs/EndUserDetailsRequest.md +3 -1
- data/docs/Expense.md +18 -12
- data/docs/ExpenseEndpointRequest.md +18 -0
- data/docs/ExpenseLine.md +11 -5
- data/docs/ExpenseLineRequest.md +38 -0
- data/docs/ExpenseRequest.md +38 -0
- data/docs/ExpenseResponse.md +24 -0
- data/docs/ExpensesApi.md +159 -5
- data/docs/IncomeStatement.md +15 -11
- data/docs/IncomeStatementsApi.md +2 -0
- data/docs/Invoice.md +21 -15
- data/docs/InvoiceLineItem.md +15 -5
- data/docs/InvoiceLineItemRequest.md +15 -3
- data/docs/InvoiceRequest.md +17 -11
- data/docs/InvoicesApi.md +16 -10
- data/docs/Issue.md +9 -7
- data/docs/IssuesApi.md +2 -2
- data/docs/Item.md +11 -7
- data/docs/ItemsApi.md +11 -9
- data/docs/JournalEntriesApi.md +7 -5
- data/docs/JournalEntry.md +18 -10
- data/docs/JournalEntryRequest.md +14 -8
- data/docs/JournalLine.md +6 -4
- data/docs/JournalLineRequest.md +10 -4
- data/docs/LinkToken.md +1 -1
- data/docs/LinkedAccountCondition.md +28 -0
- data/docs/LinkedAccountConditionRequest.md +22 -0
- data/docs/LinkedAccountSelectiveSyncConfiguration.md +18 -0
- data/docs/LinkedAccountSelectiveSyncConfigurationListRequest.md +18 -0
- data/docs/LinkedAccountSelectiveSyncConfigurationRequest.md +18 -0
- data/docs/LinkedAccountsApi.md +2 -2
- data/docs/MetaResponse.md +2 -0
- data/docs/MultipartFormFieldRequest.md +1 -1
- data/docs/OperatorSchema.md +20 -0
- data/docs/PaginatedConditionSchemaList.md +22 -0
- data/docs/Payment.md +14 -6
- data/docs/PaymentEndpointRequest.md +18 -0
- data/docs/PaymentRequest.md +34 -0
- data/docs/PaymentResponse.md +24 -0
- data/docs/PaymentsApi.md +159 -5
- data/docs/PostingStatusEnum.md +15 -0
- data/docs/PurchaseOrder.md +19 -13
- data/docs/PurchaseOrderEndpointRequest.md +18 -0
- data/docs/PurchaseOrderLineItem.md +10 -2
- data/docs/PurchaseOrderLineItemRequest.md +44 -0
- data/docs/PurchaseOrderRequest.md +44 -0
- data/docs/PurchaseOrderResponse.md +24 -0
- data/docs/PurchaseOrdersApi.md +167 -9
- data/docs/ReportItem.md +3 -1
- data/docs/SelectiveSyncApi.md +233 -0
- data/docs/SelectiveSyncConfigurationsUsageEnum.md +15 -0
- data/docs/SyncStatus.md +5 -3
- data/docs/TaxRate.md +11 -7
- data/docs/TaxRatesApi.md +2 -0
- data/docs/TrackingCategoriesApi.md +11 -5
- data/docs/TrackingCategory.md +13 -9
- data/docs/Transaction.md +20 -14
- data/docs/TransactionLineItem.md +9 -3
- data/docs/TransactionsApi.md +7 -5
- data/docs/VendorCredit.md +13 -7
- data/docs/VendorCreditLine.md +6 -2
- data/docs/VendorCreditsApi.md +7 -5
- data/lib/merge_accounting_client/api/accounts_api.rb +159 -4
- data/lib/merge_accounting_client/api/addresses_api.rb +9 -2
- data/lib/merge_accounting_client/api/attachments_api.rb +141 -0
- data/lib/merge_accounting_client/api/balance_sheets_api.rb +3 -0
- data/lib/merge_accounting_client/api/cash_flow_statements_api.rb +3 -0
- data/lib/merge_accounting_client/api/common_model_scopes_api.rb +146 -0
- data/lib/merge_accounting_client/api/company_info_api.rb +0 -14
- data/lib/merge_accounting_client/api/contacts_api.rb +159 -18
- data/lib/merge_accounting_client/api/credit_notes_api.rb +27 -18
- data/lib/merge_accounting_client/api/expenses_api.rb +147 -14
- data/lib/merge_accounting_client/api/income_statements_api.rb +3 -0
- data/lib/merge_accounting_client/api/invoices_api.rb +29 -20
- data/lib/merge_accounting_client/api/issues_api.rb +2 -2
- data/lib/merge_accounting_client/api/items_api.rb +21 -18
- data/lib/merge_accounting_client/api/journal_entries_api.rb +9 -14
- data/lib/merge_accounting_client/api/linked_accounts_api.rb +3 -3
- data/lib/merge_accounting_client/api/payments_api.rb +147 -14
- data/lib/merge_accounting_client/api/purchase_orders_api.rb +165 -18
- data/lib/merge_accounting_client/api/selective_sync_api.rb +225 -0
- data/lib/merge_accounting_client/api/tax_rates_api.rb +3 -0
- data/lib/merge_accounting_client/api/tracking_categories_api.rb +21 -4
- data/lib/merge_accounting_client/api/transactions_api.rb +9 -14
- data/lib/merge_accounting_client/api/vendor_credits_api.rb +9 -14
- data/lib/merge_accounting_client/models/account.rb +45 -21
- data/lib/merge_accounting_client/models/account_endpoint_request.rb +223 -0
- data/lib/merge_accounting_client/models/account_integration.rb +1 -1
- data/lib/merge_accounting_client/models/account_request.rb +344 -0
- data/lib/merge_accounting_client/models/account_response.rb +266 -0
- data/lib/merge_accounting_client/models/accounting_attachment.rb +39 -16
- data/lib/merge_accounting_client/models/accounting_attachment_endpoint_request.rb +223 -0
- data/lib/merge_accounting_client/models/accounting_attachment_request.rb +282 -0
- data/lib/merge_accounting_client/models/accounting_attachment_response.rb +266 -0
- data/lib/merge_accounting_client/models/accounting_phone_number_request.rb +256 -0
- data/lib/merge_accounting_client/models/address.rb +16 -5
- data/lib/merge_accounting_client/models/balance_sheet.rb +41 -18
- data/lib/merge_accounting_client/models/cash_flow_statement.rb +41 -18
- data/lib/merge_accounting_client/models/categories_enum.rb +3 -1
- data/lib/merge_accounting_client/models/category_enum.rb +3 -1
- data/lib/merge_accounting_client/models/common_model_scope_data.rb +234 -0
- data/lib/merge_accounting_client/models/common_model_scopes.rb +234 -0
- data/lib/merge_accounting_client/models/common_model_scopes_body_request.rb +274 -0
- data/lib/merge_accounting_client/models/common_model_scopes_disabled_models.rb +283 -0
- data/lib/merge_accounting_client/models/common_model_scopes_disabled_models_enabled_actions_enum.rb +45 -0
- data/lib/merge_accounting_client/models/common_model_scopes_post_inner_deserializer_request.rb +274 -0
- data/lib/merge_accounting_client/models/common_model_scopes_update_serializer.rb +226 -0
- data/lib/merge_accounting_client/models/company_info.rb +29 -17
- data/lib/merge_accounting_client/models/condition_schema.rb +298 -0
- data/lib/merge_accounting_client/models/condition_type_enum.rb +50 -0
- data/lib/merge_accounting_client/models/contact.rb +41 -18
- data/lib/merge_accounting_client/models/contact_endpoint_request.rb +223 -0
- data/lib/merge_accounting_client/models/contact_request.rb +346 -0
- data/lib/merge_accounting_client/models/contact_response.rb +266 -0
- data/lib/merge_accounting_client/models/credit_note.rb +43 -20
- data/lib/merge_accounting_client/models/credit_note_line_item.rb +40 -12
- data/lib/merge_accounting_client/models/data_passthrough_request.rb +1 -0
- data/lib/merge_accounting_client/models/enabled_actions_enum.rb +45 -0
- data/lib/merge_accounting_client/models/end_user_details_request.rb +18 -5
- data/lib/merge_accounting_client/models/expense.rb +91 -38
- data/lib/merge_accounting_client/models/expense_endpoint_request.rb +223 -0
- data/lib/merge_accounting_client/models/expense_line.rb +51 -17
- data/lib/merge_accounting_client/models/expense_line_request.rb +332 -0
- data/lib/merge_accounting_client/models/expense_request.rb +350 -0
- data/lib/merge_accounting_client/models/expense_response.rb +266 -0
- data/lib/merge_accounting_client/models/income_statement.rb +44 -21
- data/lib/merge_accounting_client/models/invoice.rb +94 -42
- data/lib/merge_accounting_client/models/invoice_line_item.rb +99 -26
- data/lib/merge_accounting_client/models/invoice_line_item_request.rb +102 -17
- data/lib/merge_accounting_client/models/invoice_request.rb +85 -32
- data/lib/merge_accounting_client/models/issue.rb +15 -4
- data/lib/merge_accounting_client/models/item.rb +44 -19
- data/lib/merge_accounting_client/models/journal_entry.rb +100 -38
- data/lib/merge_accounting_client/models/journal_entry_request.rb +92 -40
- data/lib/merge_accounting_client/models/journal_line.rb +28 -17
- data/lib/merge_accounting_client/models/journal_line_request.rb +52 -17
- data/lib/merge_accounting_client/models/link_token.rb +0 -5
- data/lib/merge_accounting_client/models/linked_account_condition.rb +282 -0
- data/lib/merge_accounting_client/models/linked_account_condition_request.rb +269 -0
- data/lib/merge_accounting_client/models/linked_account_selective_sync_configuration.rb +221 -0
- data/lib/merge_accounting_client/models/linked_account_selective_sync_configuration_list_request.rb +226 -0
- data/lib/merge_accounting_client/models/linked_account_selective_sync_configuration_request.rb +226 -0
- data/lib/merge_accounting_client/models/meta_response.rb +12 -1
- data/lib/merge_accounting_client/models/multipart_form_field_request.rb +1 -1
- data/lib/merge_accounting_client/models/operator_schema.rb +229 -0
- data/lib/merge_accounting_client/models/paginated_condition_schema_list.rb +240 -0
- data/lib/merge_accounting_client/models/payment.rb +82 -18
- data/lib/merge_accounting_client/models/payment_endpoint_request.rb +223 -0
- data/lib/merge_accounting_client/models/payment_request.rb +328 -0
- data/lib/merge_accounting_client/models/payment_response.rb +266 -0
- data/lib/merge_accounting_client/models/posting_status_enum.rb +45 -0
- data/lib/merge_accounting_client/models/purchase_order.rb +92 -41
- data/lib/merge_accounting_client/models/purchase_order_endpoint_request.rb +223 -0
- data/lib/merge_accounting_client/models/purchase_order_line_item.rb +79 -12
- data/lib/merge_accounting_client/models/purchase_order_line_item_request.rb +422 -0
- data/lib/merge_accounting_client/models/purchase_order_request.rb +383 -0
- data/lib/merge_accounting_client/models/purchase_order_response.rb +266 -0
- data/lib/merge_accounting_client/models/report_item.rb +15 -4
- data/lib/merge_accounting_client/models/selective_sync_configurations_usage_enum.rb +45 -0
- data/lib/merge_accounting_client/models/sync_status.rb +13 -4
- data/lib/merge_accounting_client/models/tax_rate.rb +59 -36
- data/lib/merge_accounting_client/models/tracking_category.rb +62 -38
- data/lib/merge_accounting_client/models/transaction.rb +97 -46
- data/lib/merge_accounting_client/models/transaction_line_item.rb +75 -19
- data/lib/merge_accounting_client/models/vendor_credit.rb +70 -18
- data/lib/merge_accounting_client/models/vendor_credit_line.rb +34 -6
- data/lib/merge_accounting_client/version.rb +1 -1
- data/lib/merge_accounting_client.rb +42 -1
- data/spec/api/accounts_api_spec.rb +30 -2
- data/spec/api/addresses_api_spec.rb +2 -1
- data/spec/api/attachments_api_spec.rb +26 -0
- data/spec/api/balance_sheets_api_spec.rb +1 -0
- data/spec/api/cash_flow_statements_api_spec.rb +1 -0
- data/spec/api/common_model_scopes_api_spec.rb +58 -0
- data/spec/api/company_info_api_spec.rb +0 -2
- data/spec/api/contacts_api_spec.rb +30 -4
- data/spec/api/credit_notes_api_spec.rb +7 -4
- data/spec/api/expenses_api_spec.rb +28 -2
- data/spec/api/income_statements_api_spec.rb +1 -0
- data/spec/api/invoices_api_spec.rb +8 -5
- data/spec/api/issues_api_spec.rb +1 -1
- data/spec/api/items_api_spec.rb +5 -4
- data/spec/api/journal_entries_api_spec.rb +3 -2
- data/spec/api/linked_accounts_api_spec.rb +1 -1
- data/spec/api/payments_api_spec.rb +28 -2
- data/spec/api/purchase_orders_api_spec.rb +32 -4
- data/spec/api/selective_sync_api_spec.rb +72 -0
- data/spec/api/tax_rates_api_spec.rb +1 -0
- data/spec/api/tracking_categories_api_spec.rb +5 -2
- data/spec/api/transactions_api_spec.rb +3 -2
- data/spec/api/vendor_credits_api_spec.rb +3 -2
- data/spec/models/account_endpoint_request_spec.rb +34 -0
- data/spec/models/account_request_spec.rb +100 -0
- data/spec/models/account_response_spec.rb +52 -0
- data/spec/models/account_spec.rb +18 -6
- data/spec/models/accounting_attachment_endpoint_request_spec.rb +34 -0
- data/spec/models/accounting_attachment_request_spec.rb +58 -0
- data/spec/models/accounting_attachment_response_spec.rb +52 -0
- data/spec/models/accounting_attachment_spec.rb +15 -3
- data/spec/models/accounting_phone_number_request_spec.rb +52 -0
- data/spec/models/address_spec.rb +6 -0
- data/spec/models/balance_sheet_spec.rb +15 -3
- data/spec/models/cash_flow_statement_spec.rb +15 -3
- data/spec/models/common_model_scope_data_spec.rb +40 -0
- data/spec/models/common_model_scopes_body_request_spec.rb +46 -0
- data/spec/models/common_model_scopes_disabled_models_enabled_actions_enum_spec.rb +28 -0
- data/spec/models/common_model_scopes_disabled_models_spec.rb +58 -0
- data/spec/models/common_model_scopes_post_inner_deserializer_request_spec.rb +46 -0
- data/spec/models/common_model_scopes_spec.rb +40 -0
- data/spec/models/common_model_scopes_update_serializer_spec.rb +34 -0
- data/spec/models/company_info_spec.rb +12 -6
- data/spec/models/condition_schema_spec.rb +70 -0
- data/spec/models/condition_type_enum_spec.rb +28 -0
- data/spec/models/contact_endpoint_request_spec.rb +34 -0
- data/spec/models/contact_request_spec.rb +100 -0
- data/spec/models/contact_response_spec.rb +52 -0
- data/spec/models/contact_spec.rb +18 -6
- data/spec/models/credit_note_line_item_spec.rb +12 -0
- data/spec/models/credit_note_spec.rb +17 -5
- data/spec/models/enabled_actions_enum_spec.rb +28 -0
- data/spec/models/end_user_details_request_spec.rb +6 -0
- data/spec/models/expense_endpoint_request_spec.rb +34 -0
- data/spec/models/expense_line_request_spec.rb +94 -0
- data/spec/models/expense_line_spec.rb +22 -4
- data/spec/models/expense_request_spec.rb +94 -0
- data/spec/models/expense_response_spec.rb +52 -0
- data/spec/models/expense_spec.rb +30 -12
- data/spec/models/income_statement_spec.rb +15 -3
- data/spec/models/invoice_line_item_request_spec.rb +41 -5
- data/spec/models/invoice_line_item_spec.rb +36 -6
- data/spec/models/invoice_request_spec.rb +26 -8
- data/spec/models/invoice_spec.rb +34 -16
- data/spec/models/issue_spec.rb +6 -0
- data/spec/models/item_spec.rb +18 -6
- data/spec/models/journal_entry_request_spec.rb +25 -7
- data/spec/models/journal_entry_spec.rb +35 -11
- data/spec/models/journal_line_request_spec.rb +22 -4
- data/spec/models/journal_line_spec.rb +10 -4
- data/spec/models/linked_account_condition_request_spec.rb +46 -0
- data/spec/models/linked_account_condition_spec.rb +64 -0
- data/spec/models/linked_account_selective_sync_configuration_list_request_spec.rb +34 -0
- data/spec/models/linked_account_selective_sync_configuration_request_spec.rb +34 -0
- data/spec/models/linked_account_selective_sync_configuration_spec.rb +34 -0
- data/spec/models/meta_response_spec.rb +6 -0
- data/spec/models/operator_schema_spec.rb +40 -0
- data/spec/models/paginated_condition_schema_list_spec.rb +46 -0
- data/spec/models/payment_endpoint_request_spec.rb +34 -0
- data/spec/models/payment_request_spec.rb +82 -0
- data/spec/models/payment_response_spec.rb +52 -0
- data/spec/models/payment_spec.rb +28 -4
- data/spec/models/posting_status_enum_spec.rb +28 -0
- data/spec/models/purchase_order_endpoint_request_spec.rb +34 -0
- data/spec/models/purchase_order_line_item_request_spec.rb +112 -0
- data/spec/models/purchase_order_line_item_spec.rb +24 -0
- data/spec/models/purchase_order_request_spec.rb +112 -0
- data/spec/models/purchase_order_response_spec.rb +52 -0
- data/spec/models/purchase_order_spec.rb +34 -16
- data/spec/models/report_item_spec.rb +6 -0
- data/spec/models/selective_sync_configurations_usage_enum_spec.rb +28 -0
- data/spec/models/sync_status_spec.rb +6 -0
- data/spec/models/tax_rate_spec.rb +19 -7
- data/spec/models/tracking_category_spec.rb +20 -8
- data/spec/models/transaction_line_item_spec.rb +19 -1
- data/spec/models/transaction_spec.rb +30 -12
- data/spec/models/vendor_credit_line_spec.rb +12 -0
- data/spec/models/vendor_credit_spec.rb +24 -6
- metadata +283 -115
data/docs/AccountsApi.md
CHANGED
@@ -4,10 +4,91 @@ All URIs are relative to *https://api.merge.dev/api/accounting/v1*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
+
| [**accounts_create**](AccountsApi.md#accounts_create) | **POST** /accounts | |
|
7
8
|
| [**accounts_list**](AccountsApi.md#accounts_list) | **GET** /accounts | |
|
9
|
+
| [**accounts_meta_post_retrieve**](AccountsApi.md#accounts_meta_post_retrieve) | **GET** /accounts/meta/post | |
|
8
10
|
| [**accounts_retrieve**](AccountsApi.md#accounts_retrieve) | **GET** /accounts/{id} | |
|
9
11
|
|
10
12
|
|
13
|
+
## accounts_create
|
14
|
+
|
15
|
+
> <AccountResponse> accounts_create(x_account_token, account_endpoint_request, opts)
|
16
|
+
|
17
|
+
|
18
|
+
|
19
|
+
Creates an `Account` object with the given values.
|
20
|
+
|
21
|
+
### Examples
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
require 'time'
|
25
|
+
require 'merge_accounting_client'
|
26
|
+
# setup authorization
|
27
|
+
MergeAccountingClient.configure do |config|
|
28
|
+
# Configure API key authorization: tokenAuth
|
29
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
30
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
31
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
32
|
+
end
|
33
|
+
|
34
|
+
api_instance = MergeAccountingClient::AccountsApi.new
|
35
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
36
|
+
account_endpoint_request = MergeAccountingClient::AccountEndpointRequest.new({model: MergeAccountingClient::AccountRequest.new}) # AccountEndpointRequest |
|
37
|
+
opts = {
|
38
|
+
is_debug_mode: true, # Boolean | Whether to include debug fields (such as log file links) in the response.
|
39
|
+
run_async: true # Boolean | Whether or not third-party updates should be run asynchronously.
|
40
|
+
}
|
41
|
+
|
42
|
+
begin
|
43
|
+
|
44
|
+
result = api_instance.accounts_create(x_account_token, account_endpoint_request, opts)
|
45
|
+
p result
|
46
|
+
rescue MergeAccountingClient::ApiError => e
|
47
|
+
puts "Error when calling AccountsApi->accounts_create: #{e}"
|
48
|
+
end
|
49
|
+
```
|
50
|
+
|
51
|
+
#### Using the accounts_create_with_http_info variant
|
52
|
+
|
53
|
+
This returns an Array which contains the response data, status code and headers.
|
54
|
+
|
55
|
+
> <Array(<AccountResponse>, Integer, Hash)> accounts_create_with_http_info(x_account_token, account_endpoint_request, opts)
|
56
|
+
|
57
|
+
```ruby
|
58
|
+
begin
|
59
|
+
|
60
|
+
data, status_code, headers = api_instance.accounts_create_with_http_info(x_account_token, account_endpoint_request, opts)
|
61
|
+
p status_code # => 2xx
|
62
|
+
p headers # => { ... }
|
63
|
+
p data # => <AccountResponse>
|
64
|
+
rescue MergeAccountingClient::ApiError => e
|
65
|
+
puts "Error when calling AccountsApi->accounts_create_with_http_info: #{e}"
|
66
|
+
end
|
67
|
+
```
|
68
|
+
|
69
|
+
### Parameters
|
70
|
+
|
71
|
+
| Name | Type | Description | Notes |
|
72
|
+
| ---- | ---- | ----------- | ----- |
|
73
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
74
|
+
| **account_endpoint_request** | [**AccountEndpointRequest**](AccountEndpointRequest.md) | | |
|
75
|
+
| **is_debug_mode** | **Boolean** | Whether to include debug fields (such as log file links) in the response. | [optional] |
|
76
|
+
| **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
|
77
|
+
|
78
|
+
### Return type
|
79
|
+
|
80
|
+
[**AccountResponse**](AccountResponse.md)
|
81
|
+
|
82
|
+
### Authorization
|
83
|
+
|
84
|
+
[tokenAuth](../README.md#tokenAuth)
|
85
|
+
|
86
|
+
### HTTP request headers
|
87
|
+
|
88
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
89
|
+
- **Accept**: application/json
|
90
|
+
|
91
|
+
|
11
92
|
## accounts_list
|
12
93
|
|
13
94
|
> <PaginatedAccountList> accounts_list(x_account_token, opts)
|
@@ -32,6 +113,7 @@ end
|
|
32
113
|
api_instance = MergeAccountingClient::AccountsApi.new
|
33
114
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
34
115
|
opts = {
|
116
|
+
company_id: 'company_id_example', # String | If provided, will only return accounts for this company.
|
35
117
|
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
36
118
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
37
119
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
@@ -40,8 +122,9 @@ opts = {
|
|
40
122
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
41
123
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
42
124
|
page_size: 56, # Integer | Number of results to return per page.
|
43
|
-
remote_fields: 'classification', # String |
|
44
|
-
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
125
|
+
remote_fields: 'classification', # String | Deprecated. Use show_enum_origins.
|
126
|
+
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
127
|
+
show_enum_origins: 'classification' # String | Which fields should be returned in non-normalized form.
|
45
128
|
}
|
46
129
|
|
47
130
|
begin
|
@@ -76,6 +159,7 @@ end
|
|
76
159
|
| Name | Type | Description | Notes |
|
77
160
|
| ---- | ---- | ----------- | ----- |
|
78
161
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
162
|
+
| **company_id** | **String** | If provided, will only return accounts for this company. | [optional] |
|
79
163
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
80
164
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
81
165
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
@@ -84,8 +168,9 @@ end
|
|
84
168
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
85
169
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
86
170
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
87
|
-
| **remote_fields** | **String** |
|
171
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
88
172
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
173
|
+
| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
89
174
|
|
90
175
|
### Return type
|
91
176
|
|
@@ -101,6 +186,77 @@ end
|
|
101
186
|
- **Accept**: application/json
|
102
187
|
|
103
188
|
|
189
|
+
## accounts_meta_post_retrieve
|
190
|
+
|
191
|
+
> <MetaResponse> accounts_meta_post_retrieve(x_account_token)
|
192
|
+
|
193
|
+
|
194
|
+
|
195
|
+
Returns metadata for `Account` POSTs.
|
196
|
+
|
197
|
+
### Examples
|
198
|
+
|
199
|
+
```ruby
|
200
|
+
require 'time'
|
201
|
+
require 'merge_accounting_client'
|
202
|
+
# setup authorization
|
203
|
+
MergeAccountingClient.configure do |config|
|
204
|
+
# Configure API key authorization: tokenAuth
|
205
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
206
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
207
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
208
|
+
end
|
209
|
+
|
210
|
+
api_instance = MergeAccountingClient::AccountsApi.new
|
211
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
212
|
+
|
213
|
+
begin
|
214
|
+
|
215
|
+
result = api_instance.accounts_meta_post_retrieve(x_account_token)
|
216
|
+
p result
|
217
|
+
rescue MergeAccountingClient::ApiError => e
|
218
|
+
puts "Error when calling AccountsApi->accounts_meta_post_retrieve: #{e}"
|
219
|
+
end
|
220
|
+
```
|
221
|
+
|
222
|
+
#### Using the accounts_meta_post_retrieve_with_http_info variant
|
223
|
+
|
224
|
+
This returns an Array which contains the response data, status code and headers.
|
225
|
+
|
226
|
+
> <Array(<MetaResponse>, Integer, Hash)> accounts_meta_post_retrieve_with_http_info(x_account_token)
|
227
|
+
|
228
|
+
```ruby
|
229
|
+
begin
|
230
|
+
|
231
|
+
data, status_code, headers = api_instance.accounts_meta_post_retrieve_with_http_info(x_account_token)
|
232
|
+
p status_code # => 2xx
|
233
|
+
p headers # => { ... }
|
234
|
+
p data # => <MetaResponse>
|
235
|
+
rescue MergeAccountingClient::ApiError => e
|
236
|
+
puts "Error when calling AccountsApi->accounts_meta_post_retrieve_with_http_info: #{e}"
|
237
|
+
end
|
238
|
+
```
|
239
|
+
|
240
|
+
### Parameters
|
241
|
+
|
242
|
+
| Name | Type | Description | Notes |
|
243
|
+
| ---- | ---- | ----------- | ----- |
|
244
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
245
|
+
|
246
|
+
### Return type
|
247
|
+
|
248
|
+
[**MetaResponse**](MetaResponse.md)
|
249
|
+
|
250
|
+
### Authorization
|
251
|
+
|
252
|
+
[tokenAuth](../README.md#tokenAuth)
|
253
|
+
|
254
|
+
### HTTP request headers
|
255
|
+
|
256
|
+
- **Content-Type**: Not defined
|
257
|
+
- **Accept**: application/json
|
258
|
+
|
259
|
+
|
104
260
|
## accounts_retrieve
|
105
261
|
|
106
262
|
> <Account> accounts_retrieve(x_account_token, id, opts)
|
@@ -127,7 +283,8 @@ x_account_token = 'x_account_token_example' # String | Token identifying the end
|
|
127
283
|
id = TODO # String |
|
128
284
|
opts = {
|
129
285
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
130
|
-
remote_fields: 'classification' # String |
|
286
|
+
remote_fields: 'classification', # String | Deprecated. Use show_enum_origins.
|
287
|
+
show_enum_origins: 'classification' # String | Which fields should be returned in non-normalized form.
|
131
288
|
}
|
132
289
|
|
133
290
|
begin
|
@@ -164,7 +321,8 @@ end
|
|
164
321
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
165
322
|
| **id** | [**String**](.md) | | |
|
166
323
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
167
|
-
| **remote_fields** | **String** |
|
324
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
325
|
+
| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
168
326
|
|
169
327
|
### Return type
|
170
328
|
|
data/docs/Address.md
CHANGED
@@ -4,12 +4,13 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **type** | [**AddressTypeEnum**](AddressTypeEnum.md) | The address type. | [optional] |
|
7
|
+
| **type** | [**AddressTypeEnum**](AddressTypeEnum.md) | The address type. * `BILLING` - BILLING * `SHIPPING` - SHIPPING | [optional] |
|
8
8
|
| **street_1** | **String** | Line 1 of the address's street. | [optional] |
|
9
9
|
| **street_2** | **String** | Line 2 of the address's street. | [optional] |
|
10
10
|
| **city** | **String** | The address's city. | [optional] |
|
11
|
-
| **state** | [**
|
12
|
-
| **
|
11
|
+
| **state** | [**AnyType**](.md) | The address's state or region. | [optional][readonly] |
|
12
|
+
| **country_subdivision** | **String** | The address's state or region. | [optional] |
|
13
|
+
| **country** | [**CountryEnum**](CountryEnum.md) | The address's country. * `AF` - Afghanistan * `AX` - Åland Islands * `AL` - Albania * `DZ` - Algeria * `AS` - American Samoa * `AD` - Andorra * `AO` - Angola * `AI` - Anguilla * `AQ` - Antarctica * `AG` - Antigua and Barbuda * `AR` - Argentina * `AM` - Armenia * `AW` - Aruba * `AU` - Australia * `AT` - Austria * `AZ` - Azerbaijan * `BS` - Bahamas * `BH` - Bahrain * `BD` - Bangladesh * `BB` - Barbados * `BY` - Belarus * `BE` - Belgium * `BZ` - Belize * `BJ` - Benin * `BM` - Bermuda * `BT` - Bhutan * `BO` - Bolivia * `BQ` - Bonaire, Sint Eustatius and Saba * `BA` - Bosnia and Herzegovina * `BW` - Botswana * `BV` - Bouvet Island * `BR` - Brazil * `IO` - British Indian Ocean Territory * `BN` - Brunei * `BG` - Bulgaria * `BF` - Burkina Faso * `BI` - Burundi * `CV` - Cabo Verde * `KH` - Cambodia * `CM` - Cameroon * `CA` - Canada * `KY` - Cayman Islands * `CF` - Central African Republic * `TD` - Chad * `CL` - Chile * `CN` - China * `CX` - Christmas Island * `CC` - Cocos (Keeling) Islands * `CO` - Colombia * `KM` - Comoros * `CG` - Congo * `CD` - Congo (the Democratic Republic of the) * `CK` - Cook Islands * `CR` - Costa Rica * `CI` - Côte d'Ivoire * `HR` - Croatia * `CU` - Cuba * `CW` - Curaçao * `CY` - Cyprus * `CZ` - Czechia * `DK` - Denmark * `DJ` - Djibouti * `DM` - Dominica * `DO` - Dominican Republic * `EC` - Ecuador * `EG` - Egypt * `SV` - El Salvador * `GQ` - Equatorial Guinea * `ER` - Eritrea * `EE` - Estonia * `SZ` - Eswatini * `ET` - Ethiopia * `FK` - Falkland Islands (Malvinas) * `FO` - Faroe Islands * `FJ` - Fiji * `FI` - Finland * `FR` - France * `GF` - French Guiana * `PF` - French Polynesia * `TF` - French Southern Territories * `GA` - Gabon * `GM` - Gambia * `GE` - Georgia * `DE` - Germany * `GH` - Ghana * `GI` - Gibraltar * `GR` - Greece * `GL` - Greenland * `GD` - Grenada * `GP` - Guadeloupe * `GU` - Guam * `GT` - Guatemala * `GG` - Guernsey * `GN` - Guinea * `GW` - Guinea-Bissau * `GY` - Guyana * `HT` - Haiti * `HM` - Heard Island and McDonald Islands * `VA` - Holy See * `HN` - Honduras * `HK` - Hong Kong * `HU` - Hungary * `IS` - Iceland * `IN` - India * `ID` - Indonesia * `IR` - Iran * `IQ` - Iraq * `IE` - Ireland * `IM` - Isle of Man * `IL` - Israel * `IT` - Italy * `JM` - Jamaica * `JP` - Japan * `JE` - Jersey * `JO` - Jordan * `KZ` - Kazakhstan * `KE` - Kenya * `KI` - Kiribati * `KW` - Kuwait * `KG` - Kyrgyzstan * `LA` - Laos * `LV` - Latvia * `LB` - Lebanon * `LS` - Lesotho * `LR` - Liberia * `LY` - Libya * `LI` - Liechtenstein * `LT` - Lithuania * `LU` - Luxembourg * `MO` - Macao * `MG` - Madagascar * `MW` - Malawi * `MY` - Malaysia * `MV` - Maldives * `ML` - Mali * `MT` - Malta * `MH` - Marshall Islands * `MQ` - Martinique * `MR` - Mauritania * `MU` - Mauritius * `YT` - Mayotte * `MX` - Mexico * `FM` - Micronesia (Federated States of) * `MD` - Moldova * `MC` - Monaco * `MN` - Mongolia * `ME` - Montenegro * `MS` - Montserrat * `MA` - Morocco * `MZ` - Mozambique * `MM` - Myanmar * `NA` - Namibia * `NR` - Nauru * `NP` - Nepal * `NL` - Netherlands * `NC` - New Caledonia * `NZ` - New Zealand * `NI` - Nicaragua * `NE` - Niger * `NG` - Nigeria * `NU` - Niue * `NF` - Norfolk Island * `KP` - North Korea * `MK` - North Macedonia * `MP` - Northern Mariana Islands * `NO` - Norway * `OM` - Oman * `PK` - Pakistan * `PW` - Palau * `PS` - Palestine, State of * `PA` - Panama * `PG` - Papua New Guinea * `PY` - Paraguay * `PE` - Peru * `PH` - Philippines * `PN` - Pitcairn * `PL` - Poland * `PT` - Portugal * `PR` - Puerto Rico * `QA` - Qatar * `RE` - Réunion * `RO` - Romania * `RU` - Russia * `RW` - Rwanda * `BL` - Saint Barthélemy * `SH` - Saint Helena, Ascension and Tristan da Cunha * `KN` - Saint Kitts and Nevis * `LC` - Saint Lucia * `MF` - Saint Martin (French part) * `PM` - Saint Pierre and Miquelon * `VC` - Saint Vincent and the Grenadines * `WS` - Samoa * `SM` - San Marino * `ST` - Sao Tome and Principe * `SA` - Saudi Arabia * `SN` - Senegal * `RS` - Serbia * `SC` - Seychelles * `SL` - Sierra Leone * `SG` - Singapore * `SX` - Sint Maarten (Dutch part) * `SK` - Slovakia * `SI` - Slovenia * `SB` - Solomon Islands * `SO` - Somalia * `ZA` - South Africa * `GS` - South Georgia and the South Sandwich Islands * `KR` - South Korea * `SS` - South Sudan * `ES` - Spain * `LK` - Sri Lanka * `SD` - Sudan * `SR` - Suriname * `SJ` - Svalbard and Jan Mayen * `SE` - Sweden * `CH` - Switzerland * `SY` - Syria * `TW` - Taiwan * `TJ` - Tajikistan * `TZ` - Tanzania * `TH` - Thailand * `TL` - Timor-Leste * `TG` - Togo * `TK` - Tokelau * `TO` - Tonga * `TT` - Trinidad and Tobago * `TN` - Tunisia * `TR` - Turkey * `TM` - Turkmenistan * `TC` - Turks and Caicos Islands * `TV` - Tuvalu * `UG` - Uganda * `UA` - Ukraine * `AE` - United Arab Emirates * `GB` - United Kingdom * `UM` - United States Minor Outlying Islands * `US` - United States of America * `UY` - Uruguay * `UZ` - Uzbekistan * `VU` - Vanuatu * `VE` - Venezuela * `VN` - Vietnam * `VG` - Virgin Islands (British) * `VI` - Virgin Islands (U.S.) * `WF` - Wallis and Futuna * `EH` - Western Sahara * `YE` - Yemen * `ZM` - Zambia * `ZW` - Zimbabwe | [optional] |
|
13
14
|
| **zip_code** | **String** | The address's zip code. | [optional] |
|
14
15
|
|
15
16
|
## Example
|
@@ -23,6 +24,7 @@ instance = MergeAccountingClient::Address.new(
|
|
23
24
|
street_2: 2nd Floor,
|
24
25
|
city: New York,
|
25
26
|
state: NY,
|
27
|
+
country_subdivision: NY,
|
26
28
|
country: USA,
|
27
29
|
zip_code: 10027
|
28
30
|
)
|
data/docs/AddressesApi.md
CHANGED
@@ -33,7 +33,8 @@ x_account_token = 'x_account_token_example' # String | Token identifying the end
|
|
33
33
|
id = TODO # String |
|
34
34
|
opts = {
|
35
35
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
36
|
-
remote_fields: 'type' # String |
|
36
|
+
remote_fields: 'type', # String | Deprecated. Use show_enum_origins.
|
37
|
+
show_enum_origins: 'type' # String | Which fields should be returned in non-normalized form.
|
37
38
|
}
|
38
39
|
|
39
40
|
begin
|
@@ -70,7 +71,8 @@ end
|
|
70
71
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
71
72
|
| **id** | [**String**](.md) | | |
|
72
73
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
73
|
-
| **remote_fields** | **String** |
|
74
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
75
|
+
| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
74
76
|
|
75
77
|
### Return type
|
76
78
|
|
data/docs/AttachmentsApi.md
CHANGED
@@ -4,10 +4,91 @@ All URIs are relative to *https://api.merge.dev/api/accounting/v1*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
+
| [**attachments_create**](AttachmentsApi.md#attachments_create) | **POST** /attachments | |
|
7
8
|
| [**attachments_list**](AttachmentsApi.md#attachments_list) | **GET** /attachments | |
|
9
|
+
| [**attachments_meta_post_retrieve**](AttachmentsApi.md#attachments_meta_post_retrieve) | **GET** /attachments/meta/post | |
|
8
10
|
| [**attachments_retrieve**](AttachmentsApi.md#attachments_retrieve) | **GET** /attachments/{id} | |
|
9
11
|
|
10
12
|
|
13
|
+
## attachments_create
|
14
|
+
|
15
|
+
> <AccountingAttachmentResponse> attachments_create(x_account_token, accounting_attachment_endpoint_request, opts)
|
16
|
+
|
17
|
+
|
18
|
+
|
19
|
+
Creates an `AccountingAttachment` object with the given values.
|
20
|
+
|
21
|
+
### Examples
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
require 'time'
|
25
|
+
require 'merge_accounting_client'
|
26
|
+
# setup authorization
|
27
|
+
MergeAccountingClient.configure do |config|
|
28
|
+
# Configure API key authorization: tokenAuth
|
29
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
30
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
31
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
32
|
+
end
|
33
|
+
|
34
|
+
api_instance = MergeAccountingClient::AttachmentsApi.new
|
35
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
36
|
+
accounting_attachment_endpoint_request = MergeAccountingClient::AccountingAttachmentEndpointRequest.new({model: MergeAccountingClient::AccountingAttachmentRequest.new}) # AccountingAttachmentEndpointRequest |
|
37
|
+
opts = {
|
38
|
+
is_debug_mode: true, # Boolean | Whether to include debug fields (such as log file links) in the response.
|
39
|
+
run_async: true # Boolean | Whether or not third-party updates should be run asynchronously.
|
40
|
+
}
|
41
|
+
|
42
|
+
begin
|
43
|
+
|
44
|
+
result = api_instance.attachments_create(x_account_token, accounting_attachment_endpoint_request, opts)
|
45
|
+
p result
|
46
|
+
rescue MergeAccountingClient::ApiError => e
|
47
|
+
puts "Error when calling AttachmentsApi->attachments_create: #{e}"
|
48
|
+
end
|
49
|
+
```
|
50
|
+
|
51
|
+
#### Using the attachments_create_with_http_info variant
|
52
|
+
|
53
|
+
This returns an Array which contains the response data, status code and headers.
|
54
|
+
|
55
|
+
> <Array(<AccountingAttachmentResponse>, Integer, Hash)> attachments_create_with_http_info(x_account_token, accounting_attachment_endpoint_request, opts)
|
56
|
+
|
57
|
+
```ruby
|
58
|
+
begin
|
59
|
+
|
60
|
+
data, status_code, headers = api_instance.attachments_create_with_http_info(x_account_token, accounting_attachment_endpoint_request, opts)
|
61
|
+
p status_code # => 2xx
|
62
|
+
p headers # => { ... }
|
63
|
+
p data # => <AccountingAttachmentResponse>
|
64
|
+
rescue MergeAccountingClient::ApiError => e
|
65
|
+
puts "Error when calling AttachmentsApi->attachments_create_with_http_info: #{e}"
|
66
|
+
end
|
67
|
+
```
|
68
|
+
|
69
|
+
### Parameters
|
70
|
+
|
71
|
+
| Name | Type | Description | Notes |
|
72
|
+
| ---- | ---- | ----------- | ----- |
|
73
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
74
|
+
| **accounting_attachment_endpoint_request** | [**AccountingAttachmentEndpointRequest**](AccountingAttachmentEndpointRequest.md) | | |
|
75
|
+
| **is_debug_mode** | **Boolean** | Whether to include debug fields (such as log file links) in the response. | [optional] |
|
76
|
+
| **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
|
77
|
+
|
78
|
+
### Return type
|
79
|
+
|
80
|
+
[**AccountingAttachmentResponse**](AccountingAttachmentResponse.md)
|
81
|
+
|
82
|
+
### Authorization
|
83
|
+
|
84
|
+
[tokenAuth](../README.md#tokenAuth)
|
85
|
+
|
86
|
+
### HTTP request headers
|
87
|
+
|
88
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
89
|
+
- **Accept**: application/json
|
90
|
+
|
91
|
+
|
11
92
|
## attachments_list
|
12
93
|
|
13
94
|
> <PaginatedAccountingAttachmentList> attachments_list(x_account_token, opts)
|
@@ -32,6 +113,7 @@ end
|
|
32
113
|
api_instance = MergeAccountingClient::AttachmentsApi.new
|
33
114
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
34
115
|
opts = {
|
116
|
+
company_id: 'company_id_example', # String | If provided, will only return accounting attachments for this company.
|
35
117
|
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
36
118
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
37
119
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
@@ -75,6 +157,7 @@ end
|
|
75
157
|
| Name | Type | Description | Notes |
|
76
158
|
| ---- | ---- | ----------- | ----- |
|
77
159
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
160
|
+
| **company_id** | **String** | If provided, will only return accounting attachments for this company. | [optional] |
|
78
161
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
79
162
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
80
163
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
@@ -99,6 +182,77 @@ end
|
|
99
182
|
- **Accept**: application/json
|
100
183
|
|
101
184
|
|
185
|
+
## attachments_meta_post_retrieve
|
186
|
+
|
187
|
+
> <MetaResponse> attachments_meta_post_retrieve(x_account_token)
|
188
|
+
|
189
|
+
|
190
|
+
|
191
|
+
Returns metadata for `AccountingAttachment` POSTs.
|
192
|
+
|
193
|
+
### Examples
|
194
|
+
|
195
|
+
```ruby
|
196
|
+
require 'time'
|
197
|
+
require 'merge_accounting_client'
|
198
|
+
# setup authorization
|
199
|
+
MergeAccountingClient.configure do |config|
|
200
|
+
# Configure API key authorization: tokenAuth
|
201
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
202
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
203
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
204
|
+
end
|
205
|
+
|
206
|
+
api_instance = MergeAccountingClient::AttachmentsApi.new
|
207
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
208
|
+
|
209
|
+
begin
|
210
|
+
|
211
|
+
result = api_instance.attachments_meta_post_retrieve(x_account_token)
|
212
|
+
p result
|
213
|
+
rescue MergeAccountingClient::ApiError => e
|
214
|
+
puts "Error when calling AttachmentsApi->attachments_meta_post_retrieve: #{e}"
|
215
|
+
end
|
216
|
+
```
|
217
|
+
|
218
|
+
#### Using the attachments_meta_post_retrieve_with_http_info variant
|
219
|
+
|
220
|
+
This returns an Array which contains the response data, status code and headers.
|
221
|
+
|
222
|
+
> <Array(<MetaResponse>, Integer, Hash)> attachments_meta_post_retrieve_with_http_info(x_account_token)
|
223
|
+
|
224
|
+
```ruby
|
225
|
+
begin
|
226
|
+
|
227
|
+
data, status_code, headers = api_instance.attachments_meta_post_retrieve_with_http_info(x_account_token)
|
228
|
+
p status_code # => 2xx
|
229
|
+
p headers # => { ... }
|
230
|
+
p data # => <MetaResponse>
|
231
|
+
rescue MergeAccountingClient::ApiError => e
|
232
|
+
puts "Error when calling AttachmentsApi->attachments_meta_post_retrieve_with_http_info: #{e}"
|
233
|
+
end
|
234
|
+
```
|
235
|
+
|
236
|
+
### Parameters
|
237
|
+
|
238
|
+
| Name | Type | Description | Notes |
|
239
|
+
| ---- | ---- | ----------- | ----- |
|
240
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
241
|
+
|
242
|
+
### Return type
|
243
|
+
|
244
|
+
[**MetaResponse**](MetaResponse.md)
|
245
|
+
|
246
|
+
### Authorization
|
247
|
+
|
248
|
+
[tokenAuth](../README.md#tokenAuth)
|
249
|
+
|
250
|
+
### HTTP request headers
|
251
|
+
|
252
|
+
- **Content-Type**: Not defined
|
253
|
+
- **Accept**: application/json
|
254
|
+
|
255
|
+
|
102
256
|
## attachments_retrieve
|
103
257
|
|
104
258
|
> <AccountingAttachment> attachments_retrieve(x_account_token, id, opts)
|
data/docs/BalanceSheet.md
CHANGED
@@ -6,9 +6,9 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
|
-
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
10
9
|
| **name** | **String** | The balance sheet's name. | [optional] |
|
11
|
-
| **currency** | [**CurrencyEnum**](CurrencyEnum.md) | The balance sheet's currency. | [optional] |
|
10
|
+
| **currency** | [**CurrencyEnum**](CurrencyEnum.md) | The balance sheet's currency. * `XUA` - ADB Unit of Account * `AFN` - Afghan Afghani * `AFA` - Afghan Afghani (1927–2002) * `ALL` - Albanian Lek * `ALK` - Albanian Lek (1946–1965) * `DZD` - Algerian Dinar * `ADP` - Andorran Peseta * `AOA` - Angolan Kwanza * `AOK` - Angolan Kwanza (1977–1991) * `AON` - Angolan New Kwanza (1990–2000) * `AOR` - Angolan Readjusted Kwanza (1995–1999) * `ARA` - Argentine Austral * `ARS` - Argentine Peso * `ARM` - Argentine Peso (1881–1970) * `ARP` - Argentine Peso (1983–1985) * `ARL` - Argentine Peso Ley (1970–1983) * `AMD` - Armenian Dram * `AWG` - Aruban Florin * `AUD` - Australian Dollar * `ATS` - Austrian Schilling * `AZN` - Azerbaijani Manat * `AZM` - Azerbaijani Manat (1993–2006) * `BSD` - Bahamian Dollar * `BHD` - Bahraini Dinar * `BDT` - Bangladeshi Taka * `BBD` - Barbadian Dollar * `BYN` - Belarusian Ruble * `BYB` - Belarusian Ruble (1994–1999) * `BYR` - Belarusian Ruble (2000–2016) * `BEF` - Belgian Franc * `BEC` - Belgian Franc (convertible) * `BEL` - Belgian Franc (financial) * `BZD` - Belize Dollar * `BMD` - Bermudan Dollar * `BTN` - Bhutanese Ngultrum * `BOB` - Bolivian Boliviano * `BOL` - Bolivian Boliviano (1863–1963) * `BOV` - Bolivian Mvdol * `BOP` - Bolivian Peso * `BAM` - Bosnia-Herzegovina Convertible Mark * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) * `BWP` - Botswanan Pula * `BRC` - Brazilian Cruzado (1986–1989) * `BRZ` - Brazilian Cruzeiro (1942–1967) * `BRE` - Brazilian Cruzeiro (1990–1993) * `BRR` - Brazilian Cruzeiro (1993–1994) * `BRN` - Brazilian New Cruzado (1989–1990) * `BRB` - Brazilian New Cruzeiro (1967–1986) * `BRL` - Brazilian Real * `GBP` - British Pound * `BND` - Brunei Dollar * `BGL` - Bulgarian Hard Lev * `BGN` - Bulgarian Lev * `BGO` - Bulgarian Lev (1879–1952) * `BGM` - Bulgarian Socialist Lev * `BUK` - Burmese Kyat * `BIF` - Burundian Franc * `XPF` - CFP Franc * `KHR` - Cambodian Riel * `CAD` - Canadian Dollar * `CVE` - Cape Verdean Escudo * `KYD` - Cayman Islands Dollar * `XAF` - Central African CFA Franc * `CLE` - Chilean Escudo * `CLP` - Chilean Peso * `CLF` - Chilean Unit of Account (UF) * `CNX` - Chinese People’s Bank Dollar * `CNY` - Chinese Yuan * `CNH` - Chinese Yuan (offshore) * `COP` - Colombian Peso * `COU` - Colombian Real Value Unit * `KMF` - Comorian Franc * `CDF` - Congolese Franc * `CRC` - Costa Rican Colón * `HRD` - Croatian Dinar * `HRK` - Croatian Kuna * `CUC` - Cuban Convertible Peso * `CUP` - Cuban Peso * `CYP` - Cypriot Pound * `CZK` - Czech Koruna * `CSK` - Czechoslovak Hard Koruna * `DKK` - Danish Krone * `DJF` - Djiboutian Franc * `DOP` - Dominican Peso * `NLG` - Dutch Guilder * `XCD` - East Caribbean Dollar * `DDM` - East German Mark * `ECS` - Ecuadorian Sucre * `ECV` - Ecuadorian Unit of Constant Value * `EGP` - Egyptian Pound * `GQE` - Equatorial Guinean Ekwele * `ERN` - Eritrean Nakfa * `EEK` - Estonian Kroon * `ETB` - Ethiopian Birr * `EUR` - Euro * `XBA` - European Composite Unit * `XEU` - European Currency Unit * `XBB` - European Monetary Unit * `XBC` - European Unit of Account (XBC) * `XBD` - European Unit of Account (XBD) * `FKP` - Falkland Islands Pound * `FJD` - Fijian Dollar * `FIM` - Finnish Markka * `FRF` - French Franc * `XFO` - French Gold Franc * `XFU` - French UIC-Franc * `GMD` - Gambian Dalasi * `GEK` - Georgian Kupon Larit * `GEL` - Georgian Lari * `DEM` - German Mark * `GHS` - Ghanaian Cedi * `GHC` - Ghanaian Cedi (1979–2007) * `GIP` - Gibraltar Pound * `XAU` - Gold * `GRD` - Greek Drachma * `GTQ` - Guatemalan Quetzal * `GWP` - Guinea-Bissau Peso * `GNF` - Guinean Franc * `GNS` - Guinean Syli * `GYD` - Guyanaese Dollar * `HTG` - Haitian Gourde * `HNL` - Honduran Lempira * `HKD` - Hong Kong Dollar * `HUF` - Hungarian Forint * `IMP` - IMP * `ISK` - Icelandic Króna * `ISJ` - Icelandic Króna (1918–1981) * `INR` - Indian Rupee * `IDR` - Indonesian Rupiah * `IRR` - Iranian Rial * `IQD` - Iraqi Dinar * `IEP` - Irish Pound * `ILS` - Israeli New Shekel * `ILP` - Israeli Pound * `ILR` - Israeli Shekel (1980–1985) * `ITL` - Italian Lira * `JMD` - Jamaican Dollar * `JPY` - Japanese Yen * `JOD` - Jordanian Dinar * `KZT` - Kazakhstani Tenge * `KES` - Kenyan Shilling * `KWD` - Kuwaiti Dinar * `KGS` - Kyrgystani Som * `LAK` - Laotian Kip * `LVL` - Latvian Lats * `LVR` - Latvian Ruble * `LBP` - Lebanese Pound * `LSL` - Lesotho Loti * `LRD` - Liberian Dollar * `LYD` - Libyan Dinar * `LTL` - Lithuanian Litas * `LTT` - Lithuanian Talonas * `LUL` - Luxembourg Financial Franc * `LUC` - Luxembourgian Convertible Franc * `LUF` - Luxembourgian Franc * `MOP` - Macanese Pataca * `MKD` - Macedonian Denar * `MKN` - Macedonian Denar (1992–1993) * `MGA` - Malagasy Ariary * `MGF` - Malagasy Franc * `MWK` - Malawian Kwacha * `MYR` - Malaysian Ringgit * `MVR` - Maldivian Rufiyaa * `MVP` - Maldivian Rupee (1947–1981) * `MLF` - Malian Franc * `MTL` - Maltese Lira * `MTP` - Maltese Pound * `MRU` - Mauritanian Ouguiya * `MRO` - Mauritanian Ouguiya (1973–2017) * `MUR` - Mauritian Rupee * `MXV` - Mexican Investment Unit * `MXN` - Mexican Peso * `MXP` - Mexican Silver Peso (1861–1992) * `MDC` - Moldovan Cupon * `MDL` - Moldovan Leu * `MCF` - Monegasque Franc * `MNT` - Mongolian Tugrik * `MAD` - Moroccan Dirham * `MAF` - Moroccan Franc * `MZE` - Mozambican Escudo * `MZN` - Mozambican Metical * `MZM` - Mozambican Metical (1980–2006) * `MMK` - Myanmar Kyat * `NAD` - Namibian Dollar * `NPR` - Nepalese Rupee * `ANG` - Netherlands Antillean Guilder * `TWD` - New Taiwan Dollar * `NZD` - New Zealand Dollar * `NIO` - Nicaraguan Córdoba * `NIC` - Nicaraguan Córdoba (1988–1991) * `NGN` - Nigerian Naira * `KPW` - North Korean Won * `NOK` - Norwegian Krone * `OMR` - Omani Rial * `PKR` - Pakistani Rupee * `XPD` - Palladium * `PAB` - Panamanian Balboa * `PGK` - Papua New Guinean Kina * `PYG` - Paraguayan Guarani * `PEI` - Peruvian Inti * `PEN` - Peruvian Sol * `PES` - Peruvian Sol (1863–1965) * `PHP` - Philippine Peso * `XPT` - Platinum * `PLN` - Polish Zloty * `PLZ` - Polish Zloty (1950–1995) * `PTE` - Portuguese Escudo * `GWE` - Portuguese Guinea Escudo * `QAR` - Qatari Rial * `XRE` - RINET Funds * `RHD` - Rhodesian Dollar * `RON` - Romanian Leu * `ROL` - Romanian Leu (1952–2006) * `RUB` - Russian Ruble * `RUR` - Russian Ruble (1991–1998) * `RWF` - Rwandan Franc * `SVC` - Salvadoran Colón * `WST` - Samoan Tala * `SAR` - Saudi Riyal * `RSD` - Serbian Dinar * `CSD` - Serbian Dinar (2002–2006) * `SCR` - Seychellois Rupee * `SLL` - Sierra Leonean Leone * `XAG` - Silver * `SGD` - Singapore Dollar * `SKK` - Slovak Koruna * `SIT` - Slovenian Tolar * `SBD` - Solomon Islands Dollar * `SOS` - Somali Shilling * `ZAR` - South African Rand * `ZAL` - South African Rand (financial) * `KRH` - South Korean Hwan (1953–1962) * `KRW` - South Korean Won * `KRO` - South Korean Won (1945–1953) * `SSP` - South Sudanese Pound * `SUR` - Soviet Rouble * `ESP` - Spanish Peseta * `ESA` - Spanish Peseta (A account) * `ESB` - Spanish Peseta (convertible account) * `XDR` - Special Drawing Rights * `LKR` - Sri Lankan Rupee * `SHP` - St. Helena Pound * `XSU` - Sucre * `SDD` - Sudanese Dinar (1992–2007) * `SDG` - Sudanese Pound * `SDP` - Sudanese Pound (1957–1998) * `SRD` - Surinamese Dollar * `SRG` - Surinamese Guilder * `SZL` - Swazi Lilangeni * `SEK` - Swedish Krona * `CHF` - Swiss Franc * `SYP` - Syrian Pound * `STN` - São Tomé & Príncipe Dobra * `STD` - São Tomé & Príncipe Dobra (1977–2017) * `TVD` - TVD * `TJR` - Tajikistani Ruble * `TJS` - Tajikistani Somoni * `TZS` - Tanzanian Shilling * `XTS` - Testing Currency Code * `THB` - Thai Baht * `XXX` - The codes assigned for transactions where no currency is involved * `TPE` - Timorese Escudo * `TOP` - Tongan Paʻanga * `TTD` - Trinidad & Tobago Dollar * `TND` - Tunisian Dinar * `TRY` - Turkish Lira * `TRL` - Turkish Lira (1922–2005) * `TMT` - Turkmenistani Manat * `TMM` - Turkmenistani Manat (1993–2009) * `USD` - US Dollar * `USN` - US Dollar (Next day) * `USS` - US Dollar (Same day) * `UGX` - Ugandan Shilling * `UGS` - Ugandan Shilling (1966–1987) * `UAH` - Ukrainian Hryvnia * `UAK` - Ukrainian Karbovanets * `AED` - United Arab Emirates Dirham * `UYW` - Uruguayan Nominal Wage Index Unit * `UYU` - Uruguayan Peso * `UYP` - Uruguayan Peso (1975–1993) * `UYI` - Uruguayan Peso (Indexed Units) * `UZS` - Uzbekistani Som * `VUV` - Vanuatu Vatu * `VES` - Venezuelan Bolívar * `VEB` - Venezuelan Bolívar (1871–2008) * `VEF` - Venezuelan Bolívar (2008–2018) * `VND` - Vietnamese Dong * `VNN` - Vietnamese Dong (1978–1985) * `CHE` - WIR Euro * `CHW` - WIR Franc * `XOF` - West African CFA Franc * `YDD` - Yemeni Dinar * `YER` - Yemeni Rial * `YUN` - Yugoslavian Convertible Dinar (1990–1992) * `YUD` - Yugoslavian Hard Dinar (1966–1990) * `YUM` - Yugoslavian New Dinar (1994–2002) * `YUR` - Yugoslavian Reformed Dinar (1992–1993) * `ZWN` - ZWN * `ZRN` - Zairean New Zaire (1993–1998) * `ZRZ` - Zairean Zaire (1971–1993) * `ZMW` - Zambian Kwacha * `ZMK` - Zambian Kwacha (1968–2012) * `ZWD` - Zimbabwean Dollar (1980–2008) * `ZWR` - Zimbabwean Dollar (2008) * `ZWL` - Zimbabwean Dollar (2009) | [optional] |
|
11
|
+
| **company** | **String** | `Company` object for the given `BalanceSheet` object. | [optional] |
|
12
12
|
| **date** | **Time** | The balance sheet's date. The balance sheet data will reflect the company's financial position this point in time. | [optional] |
|
13
13
|
| **net_assets** | **Float** | The balance sheet's net assets. | [optional] |
|
14
14
|
| **assets** | [**Array<ReportItem>**](ReportItem.md) | | [optional][readonly] |
|
@@ -16,6 +16,8 @@
|
|
16
16
|
| **equity** | [**Array<ReportItem>**](ReportItem.md) | | [optional][readonly] |
|
17
17
|
| **remote_generated_at** | **Time** | The time that balance sheet was generated by the accounting system. | [optional] |
|
18
18
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
19
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
20
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
19
21
|
|
20
22
|
## Example
|
21
23
|
|
@@ -25,16 +27,18 @@ require 'merge_accounting_client'
|
|
25
27
|
instance = MergeAccountingClient::BalanceSheet.new(
|
26
28
|
id: 9871b4a9-f5d2-4f3b-a66b-dfedbed42c46,
|
27
29
|
remote_id: 8937018,
|
28
|
-
remote_data: null,
|
29
30
|
name: BalanceSheet,
|
30
31
|
currency: USD,
|
32
|
+
company: 595c8f97-2ac4-45b7-b000-41bdf43240b5,
|
31
33
|
date: null,
|
32
34
|
net_assets: 1000.0,
|
33
|
-
assets: [{"remote_id":"10010","name":"Assets","value":1000,"sub_items":
|
34
|
-
liabilities: [{"remote_id":"10011","name":"Liabilities","value":500,"sub_items":
|
35
|
-
equity: [{"remote_id":"10012","name":"Equity","value":500,"sub_items":
|
35
|
+
assets: [{"remote_id":"10010","name":"Assets","value":1000,"sub_items":[]}],
|
36
|
+
liabilities: [{"remote_id":"10011","name":"Liabilities","value":500,"sub_items":[]}],
|
37
|
+
equity: [{"remote_id":"10012","name":"Equity","value":500,"sub_items":[]}],
|
36
38
|
remote_generated_at: 2021-10-01T00:00Z,
|
37
|
-
remote_was_deleted: null
|
39
|
+
remote_was_deleted: null,
|
40
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
41
|
+
remote_data: null
|
38
42
|
)
|
39
43
|
```
|
40
44
|
|
data/docs/BalanceSheetsApi.md
CHANGED
@@ -32,6 +32,7 @@ end
|
|
32
32
|
api_instance = MergeAccountingClient::BalanceSheetsApi.new
|
33
33
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
34
34
|
opts = {
|
35
|
+
company_id: 'company_id_example', # String | If provided, will only return balance sheets for this company.
|
35
36
|
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
36
37
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
37
38
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
@@ -75,6 +76,7 @@ end
|
|
75
76
|
| Name | Type | Description | Notes |
|
76
77
|
| ---- | ---- | ----------- | ----- |
|
77
78
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
79
|
+
| **company_id** | **String** | If provided, will only return balance sheets for this company. | [optional] |
|
78
80
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
79
81
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
80
82
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
data/docs/CashFlowStatement.md
CHANGED
@@ -6,9 +6,9 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
|
-
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
10
9
|
| **name** | **String** | The cash flow statement's name. | [optional] |
|
11
|
-
| **currency** | [**CurrencyEnum**](CurrencyEnum.md) | The cash flow statement's currency. | [optional] |
|
10
|
+
| **currency** | [**CurrencyEnum**](CurrencyEnum.md) | The cash flow statement's currency. * `XUA` - ADB Unit of Account * `AFN` - Afghan Afghani * `AFA` - Afghan Afghani (1927–2002) * `ALL` - Albanian Lek * `ALK` - Albanian Lek (1946–1965) * `DZD` - Algerian Dinar * `ADP` - Andorran Peseta * `AOA` - Angolan Kwanza * `AOK` - Angolan Kwanza (1977–1991) * `AON` - Angolan New Kwanza (1990–2000) * `AOR` - Angolan Readjusted Kwanza (1995–1999) * `ARA` - Argentine Austral * `ARS` - Argentine Peso * `ARM` - Argentine Peso (1881–1970) * `ARP` - Argentine Peso (1983–1985) * `ARL` - Argentine Peso Ley (1970–1983) * `AMD` - Armenian Dram * `AWG` - Aruban Florin * `AUD` - Australian Dollar * `ATS` - Austrian Schilling * `AZN` - Azerbaijani Manat * `AZM` - Azerbaijani Manat (1993–2006) * `BSD` - Bahamian Dollar * `BHD` - Bahraini Dinar * `BDT` - Bangladeshi Taka * `BBD` - Barbadian Dollar * `BYN` - Belarusian Ruble * `BYB` - Belarusian Ruble (1994–1999) * `BYR` - Belarusian Ruble (2000–2016) * `BEF` - Belgian Franc * `BEC` - Belgian Franc (convertible) * `BEL` - Belgian Franc (financial) * `BZD` - Belize Dollar * `BMD` - Bermudan Dollar * `BTN` - Bhutanese Ngultrum * `BOB` - Bolivian Boliviano * `BOL` - Bolivian Boliviano (1863–1963) * `BOV` - Bolivian Mvdol * `BOP` - Bolivian Peso * `BAM` - Bosnia-Herzegovina Convertible Mark * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) * `BWP` - Botswanan Pula * `BRC` - Brazilian Cruzado (1986–1989) * `BRZ` - Brazilian Cruzeiro (1942–1967) * `BRE` - Brazilian Cruzeiro (1990–1993) * `BRR` - Brazilian Cruzeiro (1993–1994) * `BRN` - Brazilian New Cruzado (1989–1990) * `BRB` - Brazilian New Cruzeiro (1967–1986) * `BRL` - Brazilian Real * `GBP` - British Pound * `BND` - Brunei Dollar * `BGL` - Bulgarian Hard Lev * `BGN` - Bulgarian Lev * `BGO` - Bulgarian Lev (1879–1952) * `BGM` - Bulgarian Socialist Lev * `BUK` - Burmese Kyat * `BIF` - Burundian Franc * `XPF` - CFP Franc * `KHR` - Cambodian Riel * `CAD` - Canadian Dollar * `CVE` - Cape Verdean Escudo * `KYD` - Cayman Islands Dollar * `XAF` - Central African CFA Franc * `CLE` - Chilean Escudo * `CLP` - Chilean Peso * `CLF` - Chilean Unit of Account (UF) * `CNX` - Chinese People’s Bank Dollar * `CNY` - Chinese Yuan * `CNH` - Chinese Yuan (offshore) * `COP` - Colombian Peso * `COU` - Colombian Real Value Unit * `KMF` - Comorian Franc * `CDF` - Congolese Franc * `CRC` - Costa Rican Colón * `HRD` - Croatian Dinar * `HRK` - Croatian Kuna * `CUC` - Cuban Convertible Peso * `CUP` - Cuban Peso * `CYP` - Cypriot Pound * `CZK` - Czech Koruna * `CSK` - Czechoslovak Hard Koruna * `DKK` - Danish Krone * `DJF` - Djiboutian Franc * `DOP` - Dominican Peso * `NLG` - Dutch Guilder * `XCD` - East Caribbean Dollar * `DDM` - East German Mark * `ECS` - Ecuadorian Sucre * `ECV` - Ecuadorian Unit of Constant Value * `EGP` - Egyptian Pound * `GQE` - Equatorial Guinean Ekwele * `ERN` - Eritrean Nakfa * `EEK` - Estonian Kroon * `ETB` - Ethiopian Birr * `EUR` - Euro * `XBA` - European Composite Unit * `XEU` - European Currency Unit * `XBB` - European Monetary Unit * `XBC` - European Unit of Account (XBC) * `XBD` - European Unit of Account (XBD) * `FKP` - Falkland Islands Pound * `FJD` - Fijian Dollar * `FIM` - Finnish Markka * `FRF` - French Franc * `XFO` - French Gold Franc * `XFU` - French UIC-Franc * `GMD` - Gambian Dalasi * `GEK` - Georgian Kupon Larit * `GEL` - Georgian Lari * `DEM` - German Mark * `GHS` - Ghanaian Cedi * `GHC` - Ghanaian Cedi (1979–2007) * `GIP` - Gibraltar Pound * `XAU` - Gold * `GRD` - Greek Drachma * `GTQ` - Guatemalan Quetzal * `GWP` - Guinea-Bissau Peso * `GNF` - Guinean Franc * `GNS` - Guinean Syli * `GYD` - Guyanaese Dollar * `HTG` - Haitian Gourde * `HNL` - Honduran Lempira * `HKD` - Hong Kong Dollar * `HUF` - Hungarian Forint * `IMP` - IMP * `ISK` - Icelandic Króna * `ISJ` - Icelandic Króna (1918–1981) * `INR` - Indian Rupee * `IDR` - Indonesian Rupiah * `IRR` - Iranian Rial * `IQD` - Iraqi Dinar * `IEP` - Irish Pound * `ILS` - Israeli New Shekel * `ILP` - Israeli Pound * `ILR` - Israeli Shekel (1980–1985) * `ITL` - Italian Lira * `JMD` - Jamaican Dollar * `JPY` - Japanese Yen * `JOD` - Jordanian Dinar * `KZT` - Kazakhstani Tenge * `KES` - Kenyan Shilling * `KWD` - Kuwaiti Dinar * `KGS` - Kyrgystani Som * `LAK` - Laotian Kip * `LVL` - Latvian Lats * `LVR` - Latvian Ruble * `LBP` - Lebanese Pound * `LSL` - Lesotho Loti * `LRD` - Liberian Dollar * `LYD` - Libyan Dinar * `LTL` - Lithuanian Litas * `LTT` - Lithuanian Talonas * `LUL` - Luxembourg Financial Franc * `LUC` - Luxembourgian Convertible Franc * `LUF` - Luxembourgian Franc * `MOP` - Macanese Pataca * `MKD` - Macedonian Denar * `MKN` - Macedonian Denar (1992–1993) * `MGA` - Malagasy Ariary * `MGF` - Malagasy Franc * `MWK` - Malawian Kwacha * `MYR` - Malaysian Ringgit * `MVR` - Maldivian Rufiyaa * `MVP` - Maldivian Rupee (1947–1981) * `MLF` - Malian Franc * `MTL` - Maltese Lira * `MTP` - Maltese Pound * `MRU` - Mauritanian Ouguiya * `MRO` - Mauritanian Ouguiya (1973–2017) * `MUR` - Mauritian Rupee * `MXV` - Mexican Investment Unit * `MXN` - Mexican Peso * `MXP` - Mexican Silver Peso (1861–1992) * `MDC` - Moldovan Cupon * `MDL` - Moldovan Leu * `MCF` - Monegasque Franc * `MNT` - Mongolian Tugrik * `MAD` - Moroccan Dirham * `MAF` - Moroccan Franc * `MZE` - Mozambican Escudo * `MZN` - Mozambican Metical * `MZM` - Mozambican Metical (1980–2006) * `MMK` - Myanmar Kyat * `NAD` - Namibian Dollar * `NPR` - Nepalese Rupee * `ANG` - Netherlands Antillean Guilder * `TWD` - New Taiwan Dollar * `NZD` - New Zealand Dollar * `NIO` - Nicaraguan Córdoba * `NIC` - Nicaraguan Córdoba (1988–1991) * `NGN` - Nigerian Naira * `KPW` - North Korean Won * `NOK` - Norwegian Krone * `OMR` - Omani Rial * `PKR` - Pakistani Rupee * `XPD` - Palladium * `PAB` - Panamanian Balboa * `PGK` - Papua New Guinean Kina * `PYG` - Paraguayan Guarani * `PEI` - Peruvian Inti * `PEN` - Peruvian Sol * `PES` - Peruvian Sol (1863–1965) * `PHP` - Philippine Peso * `XPT` - Platinum * `PLN` - Polish Zloty * `PLZ` - Polish Zloty (1950–1995) * `PTE` - Portuguese Escudo * `GWE` - Portuguese Guinea Escudo * `QAR` - Qatari Rial * `XRE` - RINET Funds * `RHD` - Rhodesian Dollar * `RON` - Romanian Leu * `ROL` - Romanian Leu (1952–2006) * `RUB` - Russian Ruble * `RUR` - Russian Ruble (1991–1998) * `RWF` - Rwandan Franc * `SVC` - Salvadoran Colón * `WST` - Samoan Tala * `SAR` - Saudi Riyal * `RSD` - Serbian Dinar * `CSD` - Serbian Dinar (2002–2006) * `SCR` - Seychellois Rupee * `SLL` - Sierra Leonean Leone * `XAG` - Silver * `SGD` - Singapore Dollar * `SKK` - Slovak Koruna * `SIT` - Slovenian Tolar * `SBD` - Solomon Islands Dollar * `SOS` - Somali Shilling * `ZAR` - South African Rand * `ZAL` - South African Rand (financial) * `KRH` - South Korean Hwan (1953–1962) * `KRW` - South Korean Won * `KRO` - South Korean Won (1945–1953) * `SSP` - South Sudanese Pound * `SUR` - Soviet Rouble * `ESP` - Spanish Peseta * `ESA` - Spanish Peseta (A account) * `ESB` - Spanish Peseta (convertible account) * `XDR` - Special Drawing Rights * `LKR` - Sri Lankan Rupee * `SHP` - St. Helena Pound * `XSU` - Sucre * `SDD` - Sudanese Dinar (1992–2007) * `SDG` - Sudanese Pound * `SDP` - Sudanese Pound (1957–1998) * `SRD` - Surinamese Dollar * `SRG` - Surinamese Guilder * `SZL` - Swazi Lilangeni * `SEK` - Swedish Krona * `CHF` - Swiss Franc * `SYP` - Syrian Pound * `STN` - São Tomé & Príncipe Dobra * `STD` - São Tomé & Príncipe Dobra (1977–2017) * `TVD` - TVD * `TJR` - Tajikistani Ruble * `TJS` - Tajikistani Somoni * `TZS` - Tanzanian Shilling * `XTS` - Testing Currency Code * `THB` - Thai Baht * `XXX` - The codes assigned for transactions where no currency is involved * `TPE` - Timorese Escudo * `TOP` - Tongan Paʻanga * `TTD` - Trinidad & Tobago Dollar * `TND` - Tunisian Dinar * `TRY` - Turkish Lira * `TRL` - Turkish Lira (1922–2005) * `TMT` - Turkmenistani Manat * `TMM` - Turkmenistani Manat (1993–2009) * `USD` - US Dollar * `USN` - US Dollar (Next day) * `USS` - US Dollar (Same day) * `UGX` - Ugandan Shilling * `UGS` - Ugandan Shilling (1966–1987) * `UAH` - Ukrainian Hryvnia * `UAK` - Ukrainian Karbovanets * `AED` - United Arab Emirates Dirham * `UYW` - Uruguayan Nominal Wage Index Unit * `UYU` - Uruguayan Peso * `UYP` - Uruguayan Peso (1975–1993) * `UYI` - Uruguayan Peso (Indexed Units) * `UZS` - Uzbekistani Som * `VUV` - Vanuatu Vatu * `VES` - Venezuelan Bolívar * `VEB` - Venezuelan Bolívar (1871–2008) * `VEF` - Venezuelan Bolívar (2008–2018) * `VND` - Vietnamese Dong * `VNN` - Vietnamese Dong (1978–1985) * `CHE` - WIR Euro * `CHW` - WIR Franc * `XOF` - West African CFA Franc * `YDD` - Yemeni Dinar * `YER` - Yemeni Rial * `YUN` - Yugoslavian Convertible Dinar (1990–1992) * `YUD` - Yugoslavian Hard Dinar (1966–1990) * `YUM` - Yugoslavian New Dinar (1994–2002) * `YUR` - Yugoslavian Reformed Dinar (1992–1993) * `ZWN` - ZWN * `ZRN` - Zairean New Zaire (1993–1998) * `ZRZ` - Zairean Zaire (1971–1993) * `ZMW` - Zambian Kwacha * `ZMK` - Zambian Kwacha (1968–2012) * `ZWD` - Zimbabwean Dollar (1980–2008) * `ZWR` - Zimbabwean Dollar (2008) * `ZWL` - Zimbabwean Dollar (2009) | [optional] |
|
11
|
+
| **company** | **String** | The company the cash flow statement belongs to. | [optional] |
|
12
12
|
| **start_period** | **Time** | The cash flow statement's start period. | [optional] |
|
13
13
|
| **end_period** | **Time** | The cash flow statement's end period. | [optional] |
|
14
14
|
| **cash_at_beginning_of_period** | **Float** | Cash and cash equivalents at the beginning of the cash flow statement's period. | [optional] |
|
@@ -18,6 +18,8 @@
|
|
18
18
|
| **financing_activities** | [**Array<ReportItem>**](ReportItem.md) | | [optional][readonly] |
|
19
19
|
| **remote_generated_at** | **Time** | The time that cash flow statement was generated by the accounting system. | [optional] |
|
20
20
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
21
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
22
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
21
23
|
|
22
24
|
## Example
|
23
25
|
|
@@ -27,18 +29,20 @@ require 'merge_accounting_client'
|
|
27
29
|
instance = MergeAccountingClient::CashFlowStatement.new(
|
28
30
|
id: 5b3c1341-a20f-4e51-b72c-f3830a16c97b,
|
29
31
|
remote_id: 8211088,
|
30
|
-
remote_data: [{"path":"/actions","data":["Varies by platform"]}],
|
31
32
|
name: CashFlow,
|
32
33
|
currency: USD,
|
34
|
+
company: 595c8f97-2ac4-45b7-b000-41bdf43240b5,
|
33
35
|
start_period: 2020-01-01T00:00Z,
|
34
36
|
end_period: 2020-03-31T00:00Z,
|
35
37
|
cash_at_beginning_of_period: 5000.0,
|
36
38
|
cash_at_end_of_period: 4063.52,
|
37
|
-
operating_activities: [{"remote_id":"10299","name":"Operating Activities","value":1000,"sub_items":
|
38
|
-
investing_activities: [{"remote_id":"10230","name":"Investing Activities","value":1000,"sub_items":
|
39
|
-
financing_activities: [{"remote_id":"10231","name":"Financing Activities","value":1000,"sub_items":
|
39
|
+
operating_activities: [{"remote_id":"10299","name":"Operating Activities","value":1000,"sub_items":[]}],
|
40
|
+
investing_activities: [{"remote_id":"10230","name":"Investing Activities","value":1000,"sub_items":[]}],
|
41
|
+
financing_activities: [{"remote_id":"10231","name":"Financing Activities","value":1000,"sub_items":[]}],
|
40
42
|
remote_generated_at: 2020-04-01T00:00Z,
|
41
|
-
remote_was_deleted: null
|
43
|
+
remote_was_deleted: null,
|
44
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
45
|
+
remote_data: [{"path":"/actions","data":["Varies by platform"]}]
|
42
46
|
)
|
43
47
|
```
|
44
48
|
|