merge_accounting_client 1.0.1 → 1.0.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE.md +16 -0
- data/README.md +12 -5
- data/docs/Account.md +3 -1
- data/docs/AccountDetails.md +3 -1
- data/docs/AccountDetailsAndActions.md +2 -0
- data/docs/AccountingAttachment.md +1 -1
- data/docs/AccountsApi.md +7 -3
- data/docs/AddressesApi.md +3 -1
- data/docs/AttachmentsApi.md +2 -2
- data/docs/BalanceSheet.md +3 -1
- data/docs/BalanceSheetsApi.md +2 -2
- data/docs/CashFlowStatement.md +3 -1
- data/docs/CashFlowStatementsApi.md +2 -2
- data/docs/CategoryTypeEnum.md +15 -0
- data/docs/CompanyInfo.md +1 -1
- data/docs/CompanyInfoApi.md +2 -2
- data/docs/Contact.md +1 -1
- data/docs/ContactsApi.md +7 -3
- data/docs/CreditNote.md +7 -1
- data/docs/CreditNoteLineItem.md +38 -0
- data/docs/CreditNotesApi.md +7 -3
- data/docs/DataPassthroughRequest.md +3 -1
- data/docs/EndUserDetailsRequest.md +9 -7
- data/docs/Expense.md +1 -1
- data/docs/ExpensesApi.md +2 -2
- data/docs/IncomeStatement.md +3 -1
- data/docs/IncomeStatementsApi.md +2 -2
- data/docs/InvoiceLineItem.md +0 -2
- data/docs/InvoicesApi.md +8 -4
- data/docs/Item.md +1 -1
- data/docs/ItemsApi.md +7 -3
- data/docs/JournalEntriesApi.md +2 -2
- data/docs/JournalEntry.md +2 -0
- data/docs/JournalEntryRequest.md +2 -0
- data/docs/LinkToken.md +3 -1
- data/docs/LinkedAccountsApi.md +2 -0
- data/docs/PaginatedTransactionList.md +22 -0
- data/docs/Payment.md +1 -1
- data/docs/PaymentsApi.md +2 -2
- data/docs/PurchaseOrder.md +8 -2
- data/docs/PurchaseOrderLineItem.md +9 -1
- data/docs/PurchaseOrdersApi.md +7 -3
- data/docs/RemoteResponse.md +5 -1
- data/docs/ResponseTypeEnum.md +15 -0
- data/docs/SyncStatus.md +2 -2
- data/docs/SyncStatusApi.md +1 -1
- data/docs/TaxRate.md +1 -1
- data/docs/TaxRatesApi.md +2 -2
- data/docs/TrackingCategoriesApi.md +7 -3
- data/docs/TrackingCategory.md +3 -1
- data/docs/Transaction.md +40 -0
- data/docs/TransactionLineItem.md +34 -0
- data/docs/TransactionsApi.md +181 -0
- data/docs/VendorCredit.md +1 -1
- data/docs/VendorCreditsApi.md +2 -2
- data/lib/merge_accounting_client/api/accounts_api.rb +16 -2
- data/lib/merge_accounting_client/api/addresses_api.rb +7 -0
- data/lib/merge_accounting_client/api/attachments_api.rb +2 -2
- data/lib/merge_accounting_client/api/balance_sheets_api.rb +2 -2
- data/lib/merge_accounting_client/api/cash_flow_statements_api.rb +2 -2
- data/lib/merge_accounting_client/api/company_info_api.rb +2 -2
- data/lib/merge_accounting_client/api/contacts_api.rb +16 -2
- data/lib/merge_accounting_client/api/credit_notes_api.rb +16 -2
- data/lib/merge_accounting_client/api/expenses_api.rb +2 -2
- data/lib/merge_accounting_client/api/income_statements_api.rb +2 -2
- data/lib/merge_accounting_client/api/invoices_api.rb +17 -3
- data/lib/merge_accounting_client/api/items_api.rb +16 -2
- data/lib/merge_accounting_client/api/journal_entries_api.rb +2 -2
- data/lib/merge_accounting_client/api/linked_accounts_api.rb +3 -0
- data/lib/merge_accounting_client/api/payments_api.rb +2 -2
- data/lib/merge_accounting_client/api/purchase_orders_api.rb +16 -2
- data/lib/merge_accounting_client/api/sync_status_api.rb +2 -2
- data/lib/merge_accounting_client/api/tax_rates_api.rb +2 -2
- data/lib/merge_accounting_client/api/tracking_categories_api.rb +16 -2
- data/lib/merge_accounting_client/api/transactions_api.rb +196 -0
- data/lib/merge_accounting_client/api/vendor_credits_api.rb +2 -2
- data/lib/merge_accounting_client/api_client.rb +3 -0
- data/lib/merge_accounting_client/models/account.rb +12 -2
- data/lib/merge_accounting_client/models/account_details.rb +15 -4
- data/lib/merge_accounting_client/models/account_details_and_actions.rb +12 -1
- data/lib/merge_accounting_client/models/account_details_and_actions_status_enum.rb +17 -7
- data/lib/merge_accounting_client/models/account_status_enum.rb +17 -7
- data/lib/merge_accounting_client/models/accounting_attachment.rb +1 -1
- data/lib/merge_accounting_client/models/address_type_enum.rb +17 -7
- data/lib/merge_accounting_client/models/balance_sheet.rb +13 -2
- data/lib/merge_accounting_client/models/cash_flow_statement.rb +13 -2
- data/lib/merge_accounting_client/models/categories_enum.rb +17 -7
- data/lib/merge_accounting_client/models/category_enum.rb +17 -7
- data/lib/merge_accounting_client/models/category_type_enum.rb +45 -0
- data/lib/merge_accounting_client/models/classification_enum.rb +17 -7
- data/lib/merge_accounting_client/models/company_info.rb +1 -1
- data/lib/merge_accounting_client/models/contact.rb +1 -1
- data/lib/merge_accounting_client/models/country_enum.rb +17 -7
- data/lib/merge_accounting_client/models/credit_note.rb +35 -2
- data/lib/merge_accounting_client/models/credit_note_line_item.rb +380 -0
- data/lib/merge_accounting_client/models/credit_note_status_enum.rb +17 -7
- data/lib/merge_accounting_client/models/currency_enum.rb +17 -7
- data/lib/merge_accounting_client/models/data_passthrough_request.rb +14 -5
- data/lib/merge_accounting_client/models/encoding_enum.rb +18 -7
- data/lib/merge_accounting_client/models/end_user_details_request.rb +28 -11
- data/lib/merge_accounting_client/models/expense.rb +1 -1
- data/lib/merge_accounting_client/models/income_statement.rb +13 -2
- data/lib/merge_accounting_client/models/invoice_line_item.rb +1 -13
- data/lib/merge_accounting_client/models/invoice_type_enum.rb +17 -7
- data/lib/merge_accounting_client/models/issue_status_enum.rb +17 -7
- data/lib/merge_accounting_client/models/item.rb +1 -1
- data/lib/merge_accounting_client/models/journal_entry.rb +12 -1
- data/lib/merge_accounting_client/models/journal_entry_request.rb +12 -1
- data/lib/merge_accounting_client/models/link_token.rb +13 -4
- data/lib/merge_accounting_client/models/method_enum.rb +17 -7
- data/lib/merge_accounting_client/models/paginated_transaction_list.rb +240 -0
- data/lib/merge_accounting_client/models/payment.rb +1 -1
- data/lib/merge_accounting_client/models/purchase_order.rb +35 -2
- data/lib/merge_accounting_client/models/purchase_order_line_item.rb +83 -5
- data/lib/merge_accounting_client/models/purchase_order_status_enum.rb +17 -7
- data/lib/merge_accounting_client/models/remote_data.rb +1 -1
- data/lib/merge_accounting_client/models/remote_response.rb +27 -10
- data/lib/merge_accounting_client/models/request_format_enum.rb +17 -7
- data/lib/merge_accounting_client/models/response_type_enum.rb +45 -0
- data/lib/merge_accounting_client/models/state_enum.rb +17 -7
- data/lib/merge_accounting_client/models/status7d1_enum.rb +17 -7
- data/lib/merge_accounting_client/models/sync_status.rb +0 -10
- data/lib/merge_accounting_client/models/sync_status_status_enum.rb +18 -7
- data/lib/merge_accounting_client/models/tax_rate.rb +1 -1
- data/lib/merge_accounting_client/models/tracking_category.rb +13 -2
- data/lib/merge_accounting_client/models/transaction.rb +357 -0
- data/lib/merge_accounting_client/models/transaction_line_item.rb +359 -0
- data/lib/merge_accounting_client/models/vendor_credit.rb +1 -1
- data/lib/merge_accounting_client/version.rb +1 -1
- data/lib/merge_accounting_client.rb +7 -1
- data/merge_accounting_client.gemspec +1 -1
- data/spec/api/accounts_api_spec.rb +3 -1
- data/spec/api/addresses_api_spec.rb +1 -0
- data/spec/api/attachments_api_spec.rb +1 -1
- data/spec/api/balance_sheets_api_spec.rb +1 -1
- data/spec/api/cash_flow_statements_api_spec.rb +1 -1
- data/spec/api/company_info_api_spec.rb +1 -1
- data/spec/api/contacts_api_spec.rb +3 -1
- data/spec/api/credit_notes_api_spec.rb +3 -1
- data/spec/api/expenses_api_spec.rb +1 -1
- data/spec/api/income_statements_api_spec.rb +1 -1
- data/spec/api/invoices_api_spec.rb +3 -1
- data/spec/api/items_api_spec.rb +3 -1
- data/spec/api/journal_entries_api_spec.rb +1 -1
- data/spec/api/linked_accounts_api_spec.rb +1 -0
- data/spec/api/payments_api_spec.rb +1 -1
- data/spec/api/purchase_orders_api_spec.rb +3 -1
- data/spec/api/sync_status_api_spec.rb +1 -1
- data/spec/api/tax_rates_api_spec.rb +1 -1
- data/spec/api/tracking_categories_api_spec.rb +3 -1
- data/spec/api/transactions_api_spec.rb +70 -0
- data/spec/api/vendor_credits_api_spec.rb +1 -1
- data/spec/models/account_details_and_actions_spec.rb +6 -0
- data/spec/models/account_details_spec.rb +6 -0
- data/spec/models/account_spec.rb +6 -0
- data/spec/models/balance_sheet_spec.rb +6 -0
- data/spec/models/cash_flow_statement_spec.rb +6 -0
- data/spec/models/category_type_enum_spec.rb +28 -0
- data/spec/models/credit_note_line_item_spec.rb +94 -0
- data/spec/models/credit_note_spec.rb +18 -0
- data/spec/models/data_passthrough_request_spec.rb +6 -0
- data/spec/models/end_user_details_request_spec.rb +6 -0
- data/spec/models/income_statement_spec.rb +6 -0
- data/spec/models/invoice_line_item_spec.rb +0 -6
- data/spec/models/journal_entry_request_spec.rb +6 -0
- data/spec/models/journal_entry_spec.rb +6 -0
- data/spec/models/link_token_spec.rb +6 -0
- data/spec/models/paginated_transaction_list_spec.rb +46 -0
- data/spec/models/purchase_order_line_item_spec.rb +24 -0
- data/spec/models/purchase_order_spec.rb +18 -0
- data/spec/models/remote_response_spec.rb +12 -0
- data/spec/models/response_type_enum_spec.rb +28 -0
- data/spec/models/tracking_category_spec.rb +6 -0
- data/spec/models/transaction_line_item_spec.rb +82 -0
- data/spec/models/transaction_spec.rb +100 -0
- metadata +136 -107
@@ -4,12 +4,13 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **end_user_email_address** | **String** |
|
8
|
-
| **end_user_organization_name** | **String** |
|
9
|
-
| **end_user_origin_id** | **String** |
|
10
|
-
| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) |
|
11
|
-
| **integration** | **String** | The slug of a specific pre-selected integration for this linking flow token
|
12
|
-
| **link_expiry_mins** | **Integer** | An integer number of minutes between [30, 720] for how long this token is valid. Defaults to 30 | [optional][default to 30] |
|
7
|
+
| **end_user_email_address** | **String** | Your end user's email address. | |
|
8
|
+
| **end_user_organization_name** | **String** | Your end user's organization. | |
|
9
|
+
| **end_user_origin_id** | **String** | Unique ID for your end user. | |
|
10
|
+
| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) | The integration categories to show in Merge Link. | |
|
11
|
+
| **integration** | **String** | The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://www.merge.dev/docs/basics/integration-metadata/. | [optional] |
|
12
|
+
| **link_expiry_mins** | **Integer** | An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30. | [optional][default to 30] |
|
13
|
+
| **should_create_magic_link_url** | **Boolean** | Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/product/integrations,-fast.-say-hello-to-magic-link/. | [optional][default to false] |
|
13
14
|
|
14
15
|
## Example
|
15
16
|
|
@@ -22,7 +23,8 @@ instance = MergeAccountingClient::EndUserDetailsRequest.new(
|
|
22
23
|
end_user_origin_id: null,
|
23
24
|
categories: null,
|
24
25
|
integration: null,
|
25
|
-
link_expiry_mins: null
|
26
|
+
link_expiry_mins: null,
|
27
|
+
should_create_magic_link_url: null
|
26
28
|
)
|
27
29
|
```
|
28
30
|
|
data/docs/Expense.md
CHANGED
@@ -15,7 +15,7 @@
|
|
15
15
|
| **currency** | [**CurrencyEnum**](CurrencyEnum.md) | The expense's currency. | [optional] |
|
16
16
|
| **memo** | **String** | The expense's private note. | [optional] |
|
17
17
|
| **lines** | [**Array<ExpenseLine>**](ExpenseLine.md) | | [optional][readonly] |
|
18
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
18
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
19
19
|
|
20
20
|
## Example
|
21
21
|
|
data/docs/ExpensesApi.md
CHANGED
@@ -36,7 +36,7 @@ opts = {
|
|
36
36
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
37
37
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
38
38
|
expand: 'account', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
39
|
-
include_deleted_data: true, # Boolean | Whether to include data that was deleted
|
39
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
40
40
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
41
41
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
42
42
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
@@ -80,7 +80,7 @@ end
|
|
80
80
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
81
81
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
82
82
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
83
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
83
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
84
84
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
85
85
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
86
86
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
data/docs/IncomeStatement.md
CHANGED
@@ -8,6 +8,7 @@
|
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
9
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
10
10
|
| **name** | **String** | The income statement's name. | [optional] |
|
11
|
+
| **currency** | [**CurrencyEnum**](CurrencyEnum.md) | The income statement's currency. | [optional] |
|
11
12
|
| **start_period** | **Time** | The income statement's start period. | [optional] |
|
12
13
|
| **end_period** | **Time** | The income statement's end period. | [optional] |
|
13
14
|
| **income** | [**Array<ReportItem>**](ReportItem.md) | | [optional][readonly] |
|
@@ -17,7 +18,7 @@
|
|
17
18
|
| **net_operating_income** | **Float** | The income statement's net operating profit. | [optional] |
|
18
19
|
| **non_operating_expenses** | [**Array<ReportItem>**](ReportItem.md) | | [optional][readonly] |
|
19
20
|
| **net_income** | **Float** | The income statement's net income. | [optional] |
|
20
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
21
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
21
22
|
|
22
23
|
## Example
|
23
24
|
|
@@ -29,6 +30,7 @@ instance = MergeAccountingClient::IncomeStatement.new(
|
|
29
30
|
remote_id: 1342348,
|
30
31
|
remote_data: [{"path":"/actions","data":["Varies by platform"]}],
|
31
32
|
name: IncomeStatement,
|
33
|
+
currency: USD,
|
32
34
|
start_period: null,
|
33
35
|
end_period: null,
|
34
36
|
income: [{"remote_id":"10299","name":"Total Income","value":325.0,"sub_items":[{"remote_id":"10200","name":"Landscaping Services","value":425,"sub_items":null},{"remote_id":"10201","name":"Pest Control Services","value":-100,"sub_items":null}]}],
|
data/docs/IncomeStatementsApi.md
CHANGED
@@ -35,7 +35,7 @@ opts = {
|
|
35
35
|
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
36
36
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
37
37
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
38
|
-
include_deleted_data: true, # Boolean | Whether to include data that was deleted
|
38
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
39
39
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
40
40
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
41
41
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
@@ -78,7 +78,7 @@ end
|
|
78
78
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
79
79
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
80
80
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
81
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
81
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
82
82
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
83
83
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
84
84
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
data/docs/InvoiceLineItem.md
CHANGED
@@ -6,7 +6,6 @@
|
|
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
|
| **description** | **String** | The line item's description. | [optional] |
|
11
10
|
| **unit_price** | **Float** | The line item's unit price. | [optional] |
|
12
11
|
| **quantity** | **Float** | The line item's quantity. | [optional] |
|
@@ -23,7 +22,6 @@ require 'merge_accounting_client'
|
|
23
22
|
instance = MergeAccountingClient::InvoiceLineItem.new(
|
24
23
|
id: 022a2bef-57e5-4def-8ed2-7c41bd9a5ed8,
|
25
24
|
remote_id: 8765432,
|
26
|
-
remote_data: [{"path":"/actions","data":["Varies by platform"]}],
|
27
25
|
description: Pickleball lessons,
|
28
26
|
unit_price: 50.0,
|
29
27
|
quantity: 1.0,
|
data/docs/InvoicesApi.md
CHANGED
@@ -118,13 +118,14 @@ opts = {
|
|
118
118
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
119
119
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
120
120
|
expand: 'contact', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
121
|
-
include_deleted_data: true, # Boolean | Whether to include data that was deleted
|
121
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
122
122
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
123
123
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
124
124
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
125
125
|
page_size: 56, # Integer | Number of results to return per page.
|
126
|
+
remote_fields: 'type', # String | Which fields should be returned in non-normalized form.
|
126
127
|
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
127
|
-
type: '
|
128
|
+
type: 'ACCOUNTS_PAYABLE' # String | If provided, will only return Invoices with this type
|
128
129
|
}
|
129
130
|
|
130
131
|
begin
|
@@ -164,11 +165,12 @@ end
|
|
164
165
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
165
166
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
166
167
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
167
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
168
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
168
169
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
169
170
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
170
171
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
171
172
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
173
|
+
| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
172
174
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
173
175
|
| **type** | **String** | If provided, will only return Invoices with this type | [optional] |
|
174
176
|
|
@@ -283,7 +285,8 @@ x_account_token = 'x_account_token_example' # String | Token identifying the end
|
|
283
285
|
id = TODO # String |
|
284
286
|
opts = {
|
285
287
|
expand: 'contact', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
286
|
-
include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
288
|
+
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
289
|
+
remote_fields: 'type' # String | Which fields should be returned in non-normalized form.
|
287
290
|
}
|
288
291
|
|
289
292
|
begin
|
@@ -321,6 +324,7 @@ end
|
|
321
324
|
| **id** | [**String**](.md) | | |
|
322
325
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
323
326
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
327
|
+
| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
324
328
|
|
325
329
|
### Return type
|
326
330
|
|
data/docs/Item.md
CHANGED
@@ -14,7 +14,7 @@
|
|
14
14
|
| **purchase_account** | **String** | | [optional] |
|
15
15
|
| **sales_account** | **String** | | [optional] |
|
16
16
|
| **remote_updated_at** | **Time** | When the third party's item note was updated. | [optional] |
|
17
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
17
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
18
18
|
|
19
19
|
## Example
|
20
20
|
|
data/docs/ItemsApi.md
CHANGED
@@ -36,11 +36,12 @@ opts = {
|
|
36
36
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
37
37
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
38
38
|
expand: 'purchase_account', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
39
|
-
include_deleted_data: true, # Boolean | Whether to include data that was deleted
|
39
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
40
40
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
41
41
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
42
42
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
43
43
|
page_size: 56, # Integer | Number of results to return per page.
|
44
|
+
remote_fields: 'status', # String | Which fields should be returned in non-normalized form.
|
44
45
|
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
45
46
|
}
|
46
47
|
|
@@ -80,11 +81,12 @@ end
|
|
80
81
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
81
82
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
82
83
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
83
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
84
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
84
85
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
85
86
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
86
87
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
87
88
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
89
|
+
| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
88
90
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
89
91
|
|
90
92
|
### Return type
|
@@ -127,7 +129,8 @@ x_account_token = 'x_account_token_example' # String | Token identifying the end
|
|
127
129
|
id = TODO # String |
|
128
130
|
opts = {
|
129
131
|
expand: 'purchase_account', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
130
|
-
include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
132
|
+
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
133
|
+
remote_fields: 'status' # String | Which fields should be returned in non-normalized form.
|
131
134
|
}
|
132
135
|
|
133
136
|
begin
|
@@ -165,6 +168,7 @@ end
|
|
165
168
|
| **id** | [**String**](.md) | | |
|
166
169
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
167
170
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
171
|
+
| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
168
172
|
|
169
173
|
### Return type
|
170
174
|
|
data/docs/JournalEntriesApi.md
CHANGED
@@ -117,7 +117,7 @@ opts = {
|
|
117
117
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
118
118
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
119
119
|
expand: 'lines', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
120
|
-
include_deleted_data: true, # Boolean | Whether to include data that was deleted
|
120
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
121
121
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
122
122
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
123
123
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
@@ -161,7 +161,7 @@ end
|
|
161
161
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
162
162
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
163
163
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
164
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
164
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
165
165
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
166
166
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
167
167
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
data/docs/JournalEntry.md
CHANGED
@@ -9,6 +9,7 @@
|
|
9
9
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
10
10
|
| **transaction_date** | **Time** | The journal entry's transaction date. | [optional] |
|
11
11
|
| **remote_created_at** | **Time** | When the third party's journal entry was created. | [optional] |
|
12
|
+
| **remote_updated_at** | **Time** | When the third party's journal entry was updated. | [optional] |
|
12
13
|
| **payments** | **Array<String>** | Array of `Payment` object IDs. | [optional] |
|
13
14
|
| **memo** | **String** | The journal entry's private note. | [optional] |
|
14
15
|
| **currency** | [**CurrencyEnum**](CurrencyEnum.md) | The journal's currency. | [optional] |
|
@@ -26,6 +27,7 @@ instance = MergeAccountingClient::JournalEntry.new(
|
|
26
27
|
remote_data: [{"path":"/actions","data":["Varies by platform"]}],
|
27
28
|
transaction_date: 2020-03-31T00:00Z,
|
28
29
|
remote_created_at: 2020-03-31T00:00Z,
|
30
|
+
remote_updated_at: 2020-03-31T00:00Z,
|
29
31
|
payments: ["b26fd49a-cbae-470a-a8f8-bcbc119e0390"],
|
30
32
|
memo: Weekly Payment,
|
31
33
|
currency: USD,
|
data/docs/JournalEntryRequest.md
CHANGED
@@ -7,6 +7,7 @@
|
|
7
7
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
8
8
|
| **transaction_date** | **Time** | The journal entry's transaction date. | [optional] |
|
9
9
|
| **remote_created_at** | **Time** | When the third party's journal entry was created. | [optional] |
|
10
|
+
| **remote_updated_at** | **Time** | When the third party's journal entry was updated. | [optional] |
|
10
11
|
| **payments** | **Array<String>** | Array of `Payment` object IDs. | [optional] |
|
11
12
|
| **memo** | **String** | The journal entry's private note. | [optional] |
|
12
13
|
| **currency** | [**CurrencyEnum**](CurrencyEnum.md) | The journal's currency. | [optional] |
|
@@ -20,6 +21,7 @@ instance = MergeAccountingClient::JournalEntryRequest.new(
|
|
20
21
|
remote_id: 088899,
|
21
22
|
transaction_date: 2020-03-31T00:00Z,
|
22
23
|
remote_created_at: 2020-03-31T00:00Z,
|
24
|
+
remote_updated_at: 2020-03-31T00:00Z,
|
23
25
|
payments: ["b26fd49a-cbae-470a-a8f8-bcbc119e0390"],
|
24
26
|
memo: Weekly Payment,
|
25
27
|
currency: USD
|
data/docs/LinkToken.md
CHANGED
@@ -6,6 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **link_token** | **String** | | |
|
8
8
|
| **integration_name** | **String** | | |
|
9
|
+
| **magic_link_url** | **String** | | [optional] |
|
9
10
|
|
10
11
|
## Example
|
11
12
|
|
@@ -14,7 +15,8 @@ require 'merge_accounting_client'
|
|
14
15
|
|
15
16
|
instance = MergeAccountingClient::LinkToken.new(
|
16
17
|
link_token: necdP7FtdASl1fQwm62be2_dM4wBG8_GactqoUV0,
|
17
|
-
integration_name: Lever
|
18
|
+
integration_name: Lever,
|
19
|
+
magic_link_url: https://link.merge.dev/asdfjkl12345jsndfgi2i83n
|
18
20
|
)
|
19
21
|
```
|
20
22
|
|
data/docs/LinkedAccountsApi.md
CHANGED
@@ -38,6 +38,7 @@ opts = {
|
|
38
38
|
end_user_origin_ids: 'end_user_origin_ids_example', # String | Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
|
39
39
|
id: TODO, # String |
|
40
40
|
ids: 'ids_example', # String | Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
|
41
|
+
include_duplicates: true, # Boolean | If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
|
41
42
|
integration_name: 'integration_name_example', # String | If provided, will only return linked accounts associated with the given integration name.
|
42
43
|
is_test_account: 'is_test_account_example', # String | If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
|
43
44
|
page_size: 56, # Integer | Number of results to return per page.
|
@@ -83,6 +84,7 @@ end
|
|
83
84
|
| **end_user_origin_ids** | **String** | Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. | [optional] |
|
84
85
|
| **id** | [**String**](.md) | | [optional] |
|
85
86
|
| **ids** | **String** | Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. | [optional] |
|
87
|
+
| **include_duplicates** | **Boolean** | If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account. | [optional] |
|
86
88
|
| **integration_name** | **String** | If provided, will only return linked accounts associated with the given integration name. | [optional] |
|
87
89
|
| **is_test_account** | **String** | If included, will only include test linked accounts. If not included, will only include non-test linked accounts. | [optional] |
|
88
90
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MergeAccountingClient::PaginatedTransactionList
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **_next** | **String** | | [optional] |
|
8
|
+
| **previous** | **String** | | [optional] |
|
9
|
+
| **results** | [**Array<Transaction>**](Transaction.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'merge_accounting_client'
|
15
|
+
|
16
|
+
instance = MergeAccountingClient::PaginatedTransactionList.new(
|
17
|
+
_next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
|
18
|
+
previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
|
19
|
+
results: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/Payment.md
CHANGED
@@ -12,7 +12,7 @@
|
|
12
12
|
| **account** | **String** | | [optional] |
|
13
13
|
| **total_amount** | **Float** | The payment's total amount. | [optional] |
|
14
14
|
| **remote_updated_at** | **Time** | When the third party's payment entry was updated. | [optional] |
|
15
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
15
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
16
16
|
|
17
17
|
## Example
|
18
18
|
|
data/docs/PaymentsApi.md
CHANGED
@@ -38,7 +38,7 @@ opts = {
|
|
38
38
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
39
39
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
40
40
|
expand: 'account', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
41
|
-
include_deleted_data: true, # Boolean | Whether to include data that was deleted
|
41
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
42
42
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
43
43
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
44
44
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
@@ -84,7 +84,7 @@ end
|
|
84
84
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
85
85
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
86
86
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
87
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
87
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
88
88
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
89
89
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
90
90
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
data/docs/PurchaseOrder.md
CHANGED
@@ -11,12 +11,15 @@
|
|
11
11
|
| **issue_date** | **Time** | The purchase order's issue date. | [optional] |
|
12
12
|
| **delivery_date** | **Time** | The purchase order's delivery date. | [optional] |
|
13
13
|
| **delivery_address** | **String** | The purchase order's delivery address. | [optional] |
|
14
|
+
| **customer** | **String** | The purchase order's customer. | [optional] |
|
15
|
+
| **vendor** | **String** | The purchase_order's vendor. | [optional] |
|
16
|
+
| **memo** | **String** | A memo attached to the purchase order. | [optional] |
|
14
17
|
| **total_amount** | **Float** | The purchase order's total amount. | [optional] |
|
15
18
|
| **currency** | [**CurrencyEnum**](CurrencyEnum.md) | The purchase order's currency. | [optional] |
|
16
19
|
| **line_items** | [**Array<PurchaseOrderLineItem>**](PurchaseOrderLineItem.md) | | [optional][readonly] |
|
17
20
|
| **remote_created_at** | **Time** | When the third party's purchase order note was created. | [optional] |
|
18
21
|
| **remote_updated_at** | **Time** | When the third party's purchase order note was updated. | [optional] |
|
19
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
22
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
20
23
|
|
21
24
|
## Example
|
22
25
|
|
@@ -31,9 +34,12 @@ instance = MergeAccountingClient::PurchaseOrder.new(
|
|
31
34
|
issue_date: null,
|
32
35
|
delivery_date: 2020-04-15T00:00Z,
|
33
36
|
delivery_address: null,
|
37
|
+
customer: 3e442c5d-8f51-4103-b5c9-dcee39c30a08,
|
38
|
+
vendor: 2c22ce34-5c6e-4fc7-a594-7f26bb4cf78b,
|
39
|
+
memo: private note,
|
34
40
|
total_amount: 260.0,
|
35
41
|
currency: USD,
|
36
|
-
line_items: [{"description":"Pickleball paddles","unit_price":25.0,"quantity":10.0,"item":"0958cbc6-6040-430a-848e-aafacbadf4ae"},{"description":"Pickleball Balls","unit_price":1.0,"quantity":10.0,"item":"249c9faa-3045-4a31-953b-8f22d3613301"}],
|
42
|
+
line_items: [{"description":"Pickleball paddles","unit_price":25.0,"quantity":10.0,"item":"0958cbc6-6040-430a-848e-aafacbadf4ae","tracking_category":"f1214c24-2702-4617-b74b-3ddecfc0d384","tax_amount":10.0,"total_line_amount":260.0},{"description":"Pickleball Balls","unit_price":1.0,"quantity":10.0,"item":"249c9faa-3045-4a31-953b-8f22d3613301","tracking_category":"f1214c24-2702-4617-b74b-3ddecfc0d384","tax_amount":10.0,"total_line_amount":20.0}],
|
37
43
|
remote_created_at: 2020-03-31T00:00Z,
|
38
44
|
remote_updated_at: 2020-03-31T00:00Z,
|
39
45
|
remote_was_deleted: null
|
@@ -8,6 +8,10 @@
|
|
8
8
|
| **unit_price** | **Float** | The line item's unit price. | [optional] |
|
9
9
|
| **quantity** | **Float** | The line item's quantity. | [optional] |
|
10
10
|
| **item** | **String** | | [optional] |
|
11
|
+
| **account** | **String** | The purchase order line item's account. | [optional] |
|
12
|
+
| **tracking_category** | **String** | The purchase order line item's associated tracking category. | [optional] |
|
13
|
+
| **tax_amount** | **String** | The purchase order line item's tax amount. | [optional] |
|
14
|
+
| **total_line_amount** | **String** | The purchase order line item's total amount. | [optional] |
|
11
15
|
|
12
16
|
## Example
|
13
17
|
|
@@ -18,7 +22,11 @@ instance = MergeAccountingClient::PurchaseOrderLineItem.new(
|
|
18
22
|
description: Pickleball paddles,
|
19
23
|
unit_price: 25.0,
|
20
24
|
quantity: 10.0,
|
21
|
-
item: 0958cbc6-6040-430a-848e-aafacbadf4ae
|
25
|
+
item: 0958cbc6-6040-430a-848e-aafacbadf4ae,
|
26
|
+
account: null,
|
27
|
+
tracking_category: f1214c24-2702-4617-b74b-3ddecfc0d384,
|
28
|
+
tax_amount: 10.0,
|
29
|
+
total_line_amount: 260.0
|
22
30
|
)
|
23
31
|
```
|
24
32
|
|
data/docs/PurchaseOrdersApi.md
CHANGED
@@ -36,11 +36,12 @@ opts = {
|
|
36
36
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
37
37
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
38
38
|
expand: 'delivery_address', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
39
|
-
include_deleted_data: true, # Boolean | Whether to include data that was deleted
|
39
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
40
40
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
41
41
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
42
42
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
43
43
|
page_size: 56, # Integer | Number of results to return per page.
|
44
|
+
remote_fields: 'status', # String | Which fields should be returned in non-normalized form.
|
44
45
|
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
45
46
|
}
|
46
47
|
|
@@ -80,11 +81,12 @@ end
|
|
80
81
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
81
82
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
82
83
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
83
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
84
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
84
85
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
85
86
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
86
87
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
87
88
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
89
|
+
| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
88
90
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
89
91
|
|
90
92
|
### Return type
|
@@ -127,7 +129,8 @@ x_account_token = 'x_account_token_example' # String | Token identifying the end
|
|
127
129
|
id = TODO # String |
|
128
130
|
opts = {
|
129
131
|
expand: 'delivery_address', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
130
|
-
include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
132
|
+
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
133
|
+
remote_fields: 'status' # String | Which fields should be returned in non-normalized form.
|
131
134
|
}
|
132
135
|
|
133
136
|
begin
|
@@ -165,6 +168,7 @@ end
|
|
165
168
|
| **id** | [**String**](.md) | | |
|
166
169
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
167
170
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
171
|
+
| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
168
172
|
|
169
173
|
### Return type
|
170
174
|
|
data/docs/RemoteResponse.md
CHANGED
@@ -7,7 +7,9 @@
|
|
7
7
|
| **method** | **String** | | |
|
8
8
|
| **path** | **String** | | |
|
9
9
|
| **status** | **Integer** | | |
|
10
|
-
| **response** | [**
|
10
|
+
| **response** | [**AnyType**](.md) | | |
|
11
|
+
| **response_headers** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
12
|
+
| **response_type** | [**ResponseTypeEnum**](ResponseTypeEnum.md) | | [optional] |
|
11
13
|
| **headers** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
12
14
|
|
13
15
|
## Example
|
@@ -20,6 +22,8 @@ instance = MergeAccountingClient::RemoteResponse.new(
|
|
20
22
|
path: /scooters,
|
21
23
|
status: 200,
|
22
24
|
response: {"scooters":[{"company":"Lime","model":"Gen 2.5"},{"company":"Bird","model":"Bird Zero"}]},
|
25
|
+
response_headers: {"X-Page-Token":"value"},
|
26
|
+
response_type: JSON,
|
23
27
|
headers: {"EXTRA-HEADER":"value","Authorization":"<redacted>"}
|
24
28
|
)
|
25
29
|
```
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# MergeAccountingClient::ResponseTypeEnum
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
|
8
|
+
## Example
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'merge_accounting_client'
|
12
|
+
|
13
|
+
instance = MergeAccountingClient::ResponseTypeEnum.new()
|
14
|
+
```
|
15
|
+
|
data/docs/SyncStatus.md
CHANGED
@@ -6,8 +6,8 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **model_name** | **String** | | |
|
8
8
|
| **model_id** | **String** | | |
|
9
|
-
| **last_sync_start** | **Time** | |
|
10
|
-
| **next_sync_start** | **Time** | |
|
9
|
+
| **last_sync_start** | **Time** | | [optional] |
|
10
|
+
| **next_sync_start** | **Time** | | [optional] |
|
11
11
|
| **status** | [**SyncStatusStatusEnum**](SyncStatusStatusEnum.md) | | |
|
12
12
|
| **is_initial_sync** | **Boolean** | | |
|
13
13
|
|
data/docs/SyncStatusApi.md
CHANGED
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.merge.dev/api/accounting/v1*
|
|
13
13
|
|
14
14
|
|
15
15
|
|
16
|
-
Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `SYNCING`
|
16
|
+
Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PAUSED`, `SYNCING`
|
17
17
|
|
18
18
|
### Examples
|
19
19
|
|
data/docs/TaxRate.md
CHANGED
@@ -10,7 +10,7 @@
|
|
10
10
|
| **description** | **String** | The tax rate's description. | [optional] |
|
11
11
|
| **total_tax_rate** | **Float** | The tax rate's total tax rate. | [optional] |
|
12
12
|
| **effective_tax_rate** | **Float** | The tax rate's effective tax rate. | [optional] |
|
13
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
13
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
14
14
|
|
15
15
|
## Example
|
16
16
|
|
data/docs/TaxRatesApi.md
CHANGED
@@ -35,7 +35,7 @@ opts = {
|
|
35
35
|
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
36
36
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
37
37
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
38
|
-
include_deleted_data: true, # Boolean | Whether to include data that was deleted
|
38
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
39
39
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
40
40
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
41
41
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
@@ -78,7 +78,7 @@ end
|
|
78
78
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
79
79
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
80
80
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
81
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
81
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
82
82
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
83
83
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
84
84
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
@@ -35,11 +35,12 @@ opts = {
|
|
35
35
|
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
36
36
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
37
37
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
38
|
-
include_deleted_data: true, # Boolean | Whether to include data that was deleted
|
38
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
39
39
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
40
40
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
41
41
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
42
42
|
page_size: 56, # Integer | Number of results to return per page.
|
43
|
+
remote_fields: 'status', # String | Which fields should be returned in non-normalized form.
|
43
44
|
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
44
45
|
}
|
45
46
|
|
@@ -78,11 +79,12 @@ end
|
|
78
79
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
79
80
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
80
81
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
81
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
82
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
82
83
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
83
84
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
84
85
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
85
86
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
87
|
+
| **remote_fields** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
86
88
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
87
89
|
|
88
90
|
### Return type
|
@@ -124,7 +126,8 @@ api_instance = MergeAccountingClient::TrackingCategoriesApi.new
|
|
124
126
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
125
127
|
id = TODO # String |
|
126
128
|
opts = {
|
127
|
-
include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
129
|
+
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
130
|
+
remote_fields: 'status' # String | Which fields should be returned in non-normalized form.
|
128
131
|
}
|
129
132
|
|
130
133
|
begin
|
@@ -161,6 +164,7 @@ end
|
|
161
164
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
162
165
|
| **id** | [**String**](.md) | | |
|
163
166
|
| **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** | Which fields should be returned in non-normalized form. | [optional] |
|
164
168
|
|
165
169
|
### Return type
|
166
170
|
|