merge_accounting_client 1.0.1 → 1.0.2
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 +10 -5
- data/docs/Account.md +1 -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 +1 -1
- data/docs/BalanceSheetsApi.md +2 -2
- data/docs/CashFlowStatement.md +1 -1
- data/docs/CashFlowStatementsApi.md +2 -2
- 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 +1 -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/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 +2 -0
- 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 +1 -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/models/account.rb +1 -1
- 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 +1 -1
- data/lib/merge_accounting_client/models/cash_flow_statement.rb +1 -1
- 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/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 +1 -1
- 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/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_response.rb +13 -2
- data/lib/merge_accounting_client/models/request_format_enum.rb +17 -7
- 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_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 +1 -1
- data/lib/merge_accounting_client/models/transaction.rb +356 -0
- data/lib/merge_accounting_client/models/transaction_line_item.rb +358 -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 +5 -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/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/invoice_line_item_spec.rb +0 -6
- 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 +6 -0
- data/spec/models/transaction_line_item_spec.rb +82 -0
- data/spec/models/transaction_spec.rb +100 -0
- metadata +132 -111
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0ee191d45d96d82e0d23803ab93e2366b54d8154b2ea8473eebd7a41e8192131
|
4
|
+
data.tar.gz: 46ab63341fef9c49437a37c0db633e7d5252512e0d848a674165536ecb12764a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: '0238c356aa3d92f7da211c0e445617d8e699106e32a48969cb3625fddd97097a7018ae617cc54bb3a0c6b78309809343ba6c05e58a8d1a1fd1173239c22e5203'
|
7
|
+
data.tar.gz: 3f997cd424e3ea151d39249d59ca1c9972dce3f4438f7621930b84ef1f645f3ce506cacbbf1cb6b0d3d2f3e3469e1b510527051ade87a581072835cfe57f7284
|
data/LICENSE.md
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
_Last updated: April 21, 2022_
|
2
|
+
|
3
|
+
**Merge SDK & Code Snippets License**
|
4
|
+
|
5
|
+
Merge makes available to Customers various software development kits ("**SDKs**") and code snippets ("**Snippets**") (together, the "**Merge Assets**") to assist with Merge Integrations and making connections to their Customer Application. Merge Assets are deemed Software under the MSA (defined below). All terms applicable to Software under the MSA apply with equal force and effect to the Merge Assets under this Merge SDK and Code Snippets License ("**License**").
|
6
|
+
|
7
|
+
"**Customer**" means a person or entity that uses any of the Merge Assets. By using any Merge Asset, Customer agrees to the terms of this License.
|
8
|
+
|
9
|
+
"**MSA**" for the purpose of this License means: (a) for Merge "Launch" Customers, the Subscriber Agreement (available at: [https://merge.dev/subscriber-agreement](https://merge.dev/subscriber-agreement)); and (b) for Merge "Growth" and/or "Expand" Customers, Merge's Master Services Agreement (available at [https://merge.dev/msa](https://merge.dev/msa)), unless Merge and Customer have entered into a separate written agreement governing the Customer's use of the Service. Customer's use of any Merge Asset will be governed by the applicable MSA as well as the additional terms of this License. Capitalized terms used but not defined herein shall have the meaning as set forth in the MSA. In the event of any inconsistency between the terms of the MSA and this License, the terms of the MSA will prevail.
|
10
|
+
|
11
|
+
Merge reserves the right to modify or update this License in its sole discretion, the effective date of such updates and/or modifications will be the earlier of: (i) 30 days from the date of such update or modification; or (ii) Customer's continued use of any Merge Asset.
|
12
|
+
|
13
|
+
1. **SDK and Snippets License**. Customer's right to access and use the Service under Section 1 of the MSA is extended to include use of the Merge Assets but solely during the Term and subject to the terms of the MSA.
|
14
|
+
2. **Use with the Service Only**. Customer may use the Merge Assets but only in connections with the Service and Merge Integrations. Any other use of the Merge Assets requires Merge's prior written consent.
|
15
|
+
3. **Limitations**. Customer's use of the Merge Assets may be subject to bandwidth limitations that Merge may impose from time to time during the Subscription. Merge will make commercially reasonable efforts to notify Customer of such limitations in advance via the location where Customer gained access to the applicable Merge Asset(s).
|
16
|
+
4. **Merge Assets & Intellectual Property Rights**. Any modifications or derivatives (together, "**Asset Derivatives**") made by Customer to the Merge Assets are deemed "works made for hire" as that term is defined in the United States Copyright Act and are the sole property of Merge. To the extent that ownership of any Asset Derivative does not by operation of law vest in Merge, Customer hereby assigns to Merge all right, title and interest in and to the Asset Derivative, including all related intellectual property rights. Asset Derivatives will be governed by the terms of this License.
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ The unified API for building rich integrations with multiple Accounting & Financ
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: 1.0
|
10
|
-
- Package version: 1.0.
|
10
|
+
- Package version: 1.0.2
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [https://www.merge.dev/](https://www.merge.dev/)
|
13
13
|
|
@@ -24,16 +24,16 @@ gem build merge_accounting_client.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./merge_accounting_client-1.0.
|
27
|
+
gem install ./merge_accounting_client-1.0.2.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./merge_accounting_client-1.0.
|
30
|
+
(for development, run `gem install --dev ./merge_accounting_client-1.0.2.gem` to install the development dependencies)
|
31
31
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
33
|
|
34
34
|
Finally add this to the Gemfile:
|
35
35
|
|
36
|
-
gem 'merge_accounting_client', '~> 1.0.
|
36
|
+
gem 'merge_accounting_client', '~> 1.0.2'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -134,6 +134,8 @@ Class | Method | HTTP request | Description
|
|
134
134
|
*MergeAccountingClient::TaxRatesApi* | [**tax_rates_retrieve**](docs/TaxRatesApi.md#tax_rates_retrieve) | **GET** /tax-rates/{id} |
|
135
135
|
*MergeAccountingClient::TrackingCategoriesApi* | [**tracking_categories_list**](docs/TrackingCategoriesApi.md#tracking_categories_list) | **GET** /tracking-categories |
|
136
136
|
*MergeAccountingClient::TrackingCategoriesApi* | [**tracking_categories_retrieve**](docs/TrackingCategoriesApi.md#tracking_categories_retrieve) | **GET** /tracking-categories/{id} |
|
137
|
+
*MergeAccountingClient::TransactionsApi* | [**transactions_list**](docs/TransactionsApi.md#transactions_list) | **GET** /transactions |
|
138
|
+
*MergeAccountingClient::TransactionsApi* | [**transactions_retrieve**](docs/TransactionsApi.md#transactions_retrieve) | **GET** /transactions/{id} |
|
137
139
|
*MergeAccountingClient::VendorCreditsApi* | [**vendor_credits_list**](docs/VendorCreditsApi.md#vendor_credits_list) | **GET** /vendor-credits |
|
138
140
|
*MergeAccountingClient::VendorCreditsApi* | [**vendor_credits_retrieve**](docs/VendorCreditsApi.md#vendor_credits_retrieve) | **GET** /vendor-credits/{id} |
|
139
141
|
*MergeAccountingClient::WebhookReceiversApi* | [**webhook_receivers_create**](docs/WebhookReceiversApi.md#webhook_receivers_create) | **POST** /webhook-receivers |
|
@@ -164,6 +166,7 @@ Class | Method | HTTP request | Description
|
|
164
166
|
- [MergeAccountingClient::Contact](docs/Contact.md)
|
165
167
|
- [MergeAccountingClient::CountryEnum](docs/CountryEnum.md)
|
166
168
|
- [MergeAccountingClient::CreditNote](docs/CreditNote.md)
|
169
|
+
- [MergeAccountingClient::CreditNoteLineItem](docs/CreditNoteLineItem.md)
|
167
170
|
- [MergeAccountingClient::CreditNoteStatusEnum](docs/CreditNoteStatusEnum.md)
|
168
171
|
- [MergeAccountingClient::CurrencyEnum](docs/CurrencyEnum.md)
|
169
172
|
- [MergeAccountingClient::DataPassthroughRequest](docs/DataPassthroughRequest.md)
|
@@ -217,13 +220,13 @@ Class | Method | HTTP request | Description
|
|
217
220
|
- [MergeAccountingClient::PaginatedSyncStatusList](docs/PaginatedSyncStatusList.md)
|
218
221
|
- [MergeAccountingClient::PaginatedTaxRateList](docs/PaginatedTaxRateList.md)
|
219
222
|
- [MergeAccountingClient::PaginatedTrackingCategoryList](docs/PaginatedTrackingCategoryList.md)
|
223
|
+
- [MergeAccountingClient::PaginatedTransactionList](docs/PaginatedTransactionList.md)
|
220
224
|
- [MergeAccountingClient::PaginatedVendorCreditList](docs/PaginatedVendorCreditList.md)
|
221
225
|
- [MergeAccountingClient::Payment](docs/Payment.md)
|
222
226
|
- [MergeAccountingClient::PurchaseOrder](docs/PurchaseOrder.md)
|
223
227
|
- [MergeAccountingClient::PurchaseOrderLineItem](docs/PurchaseOrderLineItem.md)
|
224
228
|
- [MergeAccountingClient::PurchaseOrderStatusEnum](docs/PurchaseOrderStatusEnum.md)
|
225
229
|
- [MergeAccountingClient::RemoteData](docs/RemoteData.md)
|
226
|
-
- [MergeAccountingClient::RemoteDataRequest](docs/RemoteDataRequest.md)
|
227
230
|
- [MergeAccountingClient::RemoteKey](docs/RemoteKey.md)
|
228
231
|
- [MergeAccountingClient::RemoteKeyForRegenerationRequest](docs/RemoteKeyForRegenerationRequest.md)
|
229
232
|
- [MergeAccountingClient::RemoteResponse](docs/RemoteResponse.md)
|
@@ -235,6 +238,8 @@ Class | Method | HTTP request | Description
|
|
235
238
|
- [MergeAccountingClient::SyncStatusStatusEnum](docs/SyncStatusStatusEnum.md)
|
236
239
|
- [MergeAccountingClient::TaxRate](docs/TaxRate.md)
|
237
240
|
- [MergeAccountingClient::TrackingCategory](docs/TrackingCategory.md)
|
241
|
+
- [MergeAccountingClient::Transaction](docs/Transaction.md)
|
242
|
+
- [MergeAccountingClient::TransactionLineItem](docs/TransactionLineItem.md)
|
238
243
|
- [MergeAccountingClient::ValidationProblemSource](docs/ValidationProblemSource.md)
|
239
244
|
- [MergeAccountingClient::VendorCredit](docs/VendorCredit.md)
|
240
245
|
- [MergeAccountingClient::VendorCreditLine](docs/VendorCreditLine.md)
|
data/docs/Account.md
CHANGED
@@ -15,7 +15,7 @@
|
|
15
15
|
| **current_balance** | **Float** | The account's current balance. | [optional] |
|
16
16
|
| **currency** | [**CurrencyEnum**](CurrencyEnum.md) | The account's currency. | [optional] |
|
17
17
|
| **account_number** | **String** | The account's number. | [optional] |
|
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/AccountDetails.md
CHANGED
@@ -13,6 +13,7 @@
|
|
13
13
|
| **end_user_email_address** | **String** | | [optional][readonly] |
|
14
14
|
| **status** | **String** | | [optional][readonly] |
|
15
15
|
| **webhook_listener_url** | **String** | | [optional][readonly] |
|
16
|
+
| **is_duplicate** | **Boolean** | Whether a Production Linked Account's credentials match another existing Production Linked Account. This field is `null` for Test Linked Accounts, incomplete Production Linked Accounts, and ignored duplicate Production Linked Account sets. | [optional][readonly] |
|
16
17
|
|
17
18
|
## Example
|
18
19
|
|
@@ -28,7 +29,8 @@ instance = MergeAccountingClient::AccountDetails.new(
|
|
28
29
|
end_user_organization_name: Waystar Royco,
|
29
30
|
end_user_email_address: kendall.roy@waystar-royco.com,
|
30
31
|
status: COMPLETE,
|
31
|
-
webhook_listener_url: https://api.merge.dev/api/integrations/webhook-listener/7fc3mee0UW8ecV4
|
32
|
+
webhook_listener_url: https://api.merge.dev/api/integrations/webhook-listener/7fc3mee0UW8ecV4,
|
33
|
+
is_duplicate: true
|
32
34
|
)
|
33
35
|
```
|
34
36
|
|
@@ -12,6 +12,7 @@
|
|
12
12
|
| **end_user_organization_name** | **String** | | |
|
13
13
|
| **end_user_email_address** | **String** | | |
|
14
14
|
| **webhook_listener_url** | **String** | | |
|
15
|
+
| **is_duplicate** | **Boolean** | Whether a Production Linked Account's credentials match another existing Production Linked Account. This field is `null` for Test Linked Accounts, incomplete Production Linked Accounts, and ignored duplicate Production Linked Account sets. | [optional] |
|
15
16
|
| **integration** | [**AccountDetailsAndActionsIntegration**](AccountDetailsAndActionsIntegration.md) | | [optional] |
|
16
17
|
|
17
18
|
## Example
|
@@ -28,6 +29,7 @@ instance = MergeAccountingClient::AccountDetailsAndActions.new(
|
|
28
29
|
end_user_organization_name: Foo Bar, LLC,
|
29
30
|
end_user_email_address: hradmin@foobar.dev,
|
30
31
|
webhook_listener_url: https://api.merge.dev/api/integrations/webhook-listener/7fc3mee0UW8ecV4,
|
32
|
+
is_duplicate: true,
|
31
33
|
integration: null
|
32
34
|
)
|
33
35
|
```
|
@@ -9,7 +9,7 @@
|
|
9
9
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
10
10
|
| **file_name** | **String** | The attachment's name. | [optional] |
|
11
11
|
| **file_url** | **String** | The attachment's url. | [optional] |
|
12
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
12
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
13
13
|
|
14
14
|
## Example
|
15
15
|
|
data/docs/AccountsApi.md
CHANGED
@@ -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: 'classification', # 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::AccountsApi.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: 'classification' # 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
|
|
data/docs/AddressesApi.md
CHANGED
@@ -32,7 +32,8 @@ api_instance = MergeAccountingClient::AddressesApi.new
|
|
32
32
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
33
33
|
id = TODO # String |
|
34
34
|
opts = {
|
35
|
-
include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
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 | Which fields should be returned in non-normalized form.
|
36
37
|
}
|
37
38
|
|
38
39
|
begin
|
@@ -69,6 +70,7 @@ end
|
|
69
70
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
70
71
|
| **id** | [**String**](.md) | | |
|
71
72
|
| **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** | Which fields should be returned in non-normalized form. | [optional] |
|
72
74
|
|
73
75
|
### Return type
|
74
76
|
|
data/docs/AttachmentsApi.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/BalanceSheet.md
CHANGED
@@ -14,7 +14,7 @@
|
|
14
14
|
| **liabilities** | [**Array<ReportItem>**](ReportItem.md) | | [optional][readonly] |
|
15
15
|
| **equity** | [**Array<ReportItem>**](ReportItem.md) | | [optional][readonly] |
|
16
16
|
| **remote_generated_at** | **Time** | The time that balance sheet was generated by the accounting system. | [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/BalanceSheetsApi.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/CashFlowStatement.md
CHANGED
@@ -16,7 +16,7 @@
|
|
16
16
|
| **investing_activities** | [**Array<ReportItem>**](ReportItem.md) | | [optional][readonly] |
|
17
17
|
| **financing_activities** | [**Array<ReportItem>**](ReportItem.md) | | [optional][readonly] |
|
18
18
|
| **remote_generated_at** | **Time** | The time that cash flow statement was generated by the accounting system. | [optional] |
|
19
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
19
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
20
20
|
|
21
21
|
## Example
|
22
22
|
|
@@ -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/CompanyInfo.md
CHANGED
@@ -17,7 +17,7 @@
|
|
17
17
|
| **urls** | **Array<String>** | The company's urls. | [optional] |
|
18
18
|
| **addresses** | [**Array<Address>**](Address.md) | | [optional] |
|
19
19
|
| **phone_numbers** | [**Array<AccountingPhoneNumber>**](AccountingPhoneNumber.md) | | [optional] |
|
20
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
20
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
21
21
|
|
22
22
|
## Example
|
23
23
|
|
data/docs/CompanyInfoApi.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: 'addresses', # 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/Contact.md
CHANGED
@@ -17,7 +17,7 @@
|
|
17
17
|
| **remote_updated_at** | **Time** | When the third party's contact was updated. | [optional] |
|
18
18
|
| **addresses** | **Array<String>** | `Address` object IDs for the given `Contacts` object. | [optional] |
|
19
19
|
| **phone_numbers** | [**Array<AccountingPhoneNumber>**](AccountingPhoneNumber.md) | `AccountingPhoneNumber` object for the given `Contacts` object. | [optional] |
|
20
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
20
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
21
21
|
|
22
22
|
## Example
|
23
23
|
|
data/docs/ContactsApi.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: 'addresses', # 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: 'addresses', # 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/CreditNote.md
CHANGED
@@ -9,13 +9,16 @@
|
|
9
9
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
10
10
|
| **transaction_date** | **Time** | The credit note's transaction date. | [optional] |
|
11
11
|
| **status** | [**CreditNoteStatusEnum**](CreditNoteStatusEnum.md) | The credit note's status. | [optional] |
|
12
|
+
| **number** | **String** | The credit note's number. | [optional] |
|
13
|
+
| **contact** | **String** | The credit note's contact. | [optional] |
|
12
14
|
| **total_amount** | **Float** | The credit note's total amount. | [optional] |
|
13
15
|
| **remaining_credit** | **Float** | The credit note's remaining credit. | [optional] |
|
16
|
+
| **line_items** | [**Array<CreditNoteLineItem>**](CreditNoteLineItem.md) | | [optional][readonly] |
|
14
17
|
| **currency** | [**CurrencyEnum**](CurrencyEnum.md) | The credit note's currency. | [optional] |
|
15
18
|
| **remote_created_at** | **Time** | When the third party's credit note was created. | [optional] |
|
16
19
|
| **remote_updated_at** | **Time** | When the third party's credit note was updated. | [optional] |
|
17
20
|
| **payments** | **Array<String>** | Array of `Payment` object IDs | [optional] |
|
18
|
-
| **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] |
|
19
22
|
|
20
23
|
## Example
|
21
24
|
|
@@ -28,8 +31,11 @@ instance = MergeAccountingClient::CreditNote.new(
|
|
28
31
|
remote_data: [{"path":"/actions","data":["Varies by platform"]}],
|
29
32
|
transaction_date: 2020-03-31T00:00Z,
|
30
33
|
status: PAID,
|
34
|
+
number: CN-29,
|
35
|
+
contact: c6c7b870-bb4d-489a-921e-2f0ee4192ff9,
|
31
36
|
total_amount: 50.0,
|
32
37
|
remaining_credit: 20.0,
|
38
|
+
line_items: [{"item":"0e3fd929-436c-4fd4-a48b-0c61f68d6178","name":"Basic Monthly","description":"prorated amount for items","quantity":1,"memo":"privNote","unit_price":"5.0","tax_rate":"8d9fd929-436c-4fd4-a48b-0c61f68d6178","amount":"5.0","tracking_category":"8d9fd929-436c-4fd4-a48b-0c61f68d6178","account":"8d9fd929-436c-4fd4-a48b-0c61f68d6178"}],
|
33
39
|
currency: USD,
|
34
40
|
remote_created_at: 2020-03-31T00:00Z,
|
35
41
|
remote_updated_at: 2020-03-31T00:00Z,
|
@@ -0,0 +1,38 @@
|
|
1
|
+
# MergeAccountingClient::CreditNoteLineItem
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **item** | **String** | | [optional] |
|
8
|
+
| **name** | **String** | The credit note line item's name. | [optional] |
|
9
|
+
| **description** | **String** | The credit note line item's description. | [optional] |
|
10
|
+
| **quantity** | **String** | The credit note line item's quantity. | [optional] |
|
11
|
+
| **memo** | **String** | The credit note line item's memo. | [optional] |
|
12
|
+
| **unit_price** | **String** | The credit note line item's unit price. | [optional] |
|
13
|
+
| **tax_rate** | **String** | The credit note line item's tax rate. | [optional] |
|
14
|
+
| **total_line_amount** | **String** | The credit note line item's total. | [optional] |
|
15
|
+
| **tracking_category** | **String** | The purchase order line item's associated tracking category. | [optional] |
|
16
|
+
| **account** | **String** | The credit note line item's account. | [optional] |
|
17
|
+
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
18
|
+
|
19
|
+
## Example
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'merge_accounting_client'
|
23
|
+
|
24
|
+
instance = MergeAccountingClient::CreditNoteLineItem.new(
|
25
|
+
item: 0e3fd929-436c-4fd4-a48b-0c61f68d6178,
|
26
|
+
name: Basic Monthly,
|
27
|
+
description: prorated amount for items,
|
28
|
+
quantity: 1,
|
29
|
+
memo: privNote,
|
30
|
+
unit_price: 5.0,
|
31
|
+
tax_rate: 8d9fd929-436c-4fd4-a48b-0c61f68d6178,
|
32
|
+
total_line_amount: 5.0,
|
33
|
+
tracking_category: 8d9fd929-436c-4fd4-a48b-0c61f68d6178,
|
34
|
+
account: 8d9fd929-436c-4fd4-a48b-0c61f68d6178,
|
35
|
+
remote_id: null
|
36
|
+
)
|
37
|
+
```
|
38
|
+
|
data/docs/CreditNotesApi.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: 'payments', # 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: 'payments', # 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
|
|
@@ -11,6 +11,7 @@
|
|
11
11
|
| **multipart_form_data** | [**Array<MultipartFormFieldRequest>**](MultipartFormFieldRequest.md) | Pass an array of `MultipartFormField` objects in here instead of using the `data` param if `request_format` is set to `MULTIPART`. | [optional] |
|
12
12
|
| **headers** | [**Hash<String, AnyType>**](AnyType.md) | The headers to use for the request (Merge will handle the account's authorization headers). `Content-Type` header is required for passthrough. Choose content type corresponding to expected format of receiving server. | [optional] |
|
13
13
|
| **request_format** | [**RequestFormatEnum**](RequestFormatEnum.md) | | [optional] |
|
14
|
+
| **normalize_response** | **Boolean** | | [optional] |
|
14
15
|
|
15
16
|
## Example
|
16
17
|
|
@@ -24,7 +25,8 @@ instance = MergeAccountingClient::DataPassthroughRequest.new(
|
|
24
25
|
data: {"company": "Lime", "model": "Gen 2.5"},
|
25
26
|
multipart_form_data: null,
|
26
27
|
headers: {"EXTRA-HEADER":"value"},
|
27
|
-
request_format: JSON
|
28
|
+
request_format: JSON,
|
29
|
+
normalize_response: null
|
28
30
|
)
|
29
31
|
```
|
30
32
|
|
@@ -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
@@ -17,7 +17,7 @@
|
|
17
17
|
| **net_operating_income** | **Float** | The income statement's net operating profit. | [optional] |
|
18
18
|
| **non_operating_expenses** | [**Array<ReportItem>**](ReportItem.md) | | [optional][readonly] |
|
19
19
|
| **net_income** | **Float** | The income statement's net income. | [optional] |
|
20
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
20
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
21
21
|
|
22
22
|
## Example
|
23
23
|
|