merge_accounting_client 1.0.4 → 1.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +61 -5
- data/docs/Account.md +12 -8
- data/docs/AccountEndpointRequest.md +18 -0
- data/docs/AccountIntegration.md +1 -1
- data/docs/AccountRequest.md +40 -0
- data/docs/AccountResponse.md +24 -0
- data/docs/AccountingAttachment.md +7 -3
- data/docs/AccountingAttachmentEndpointRequest.md +18 -0
- data/docs/AccountingAttachmentRequest.md +26 -0
- data/docs/AccountingAttachmentResponse.md +24 -0
- data/docs/AccountingPhoneNumberRequest.md +24 -0
- data/docs/AccountsApi.md +163 -5
- data/docs/Address.md +5 -3
- data/docs/AddressesApi.md +4 -2
- data/docs/AttachmentsApi.md +154 -0
- data/docs/BalanceSheet.md +11 -7
- data/docs/BalanceSheetsApi.md +2 -0
- data/docs/CashFlowStatement.md +11 -7
- data/docs/CashFlowStatementsApi.md +2 -0
- data/docs/CommonModelScopeData.md +20 -0
- data/docs/CommonModelScopes.md +20 -0
- data/docs/CommonModelScopesApi.md +157 -0
- data/docs/CommonModelScopesBodyRequest.md +22 -0
- data/docs/CommonModelScopesDisabledModels.md +26 -0
- data/docs/CommonModelScopesDisabledModelsEnabledActionsEnum.md +15 -0
- data/docs/CommonModelScopesPostInnerDeserializerRequest.md +22 -0
- data/docs/CommonModelScopesUpdateSerializer.md +18 -0
- data/docs/CompanyInfo.md +6 -4
- data/docs/CompanyInfoApi.md +0 -4
- data/docs/ConditionSchema.md +30 -0
- data/docs/ConditionTypeEnum.md +15 -0
- data/docs/Contact.md +8 -4
- data/docs/ContactEndpointRequest.md +18 -0
- data/docs/ContactRequest.md +40 -0
- data/docs/ContactResponse.md +24 -0
- data/docs/ContactsApi.md +163 -9
- data/docs/CreditNote.md +12 -8
- data/docs/CreditNoteLineItem.md +7 -3
- data/docs/CreditNotesApi.md +15 -9
- data/docs/DataPassthroughRequest.md +1 -1
- data/docs/EnabledActionsEnum.md +15 -0
- data/docs/EndUserDetailsRequest.md +3 -1
- data/docs/Expense.md +18 -12
- data/docs/ExpenseEndpointRequest.md +18 -0
- data/docs/ExpenseLine.md +11 -5
- data/docs/ExpenseLineRequest.md +38 -0
- data/docs/ExpenseRequest.md +38 -0
- data/docs/ExpenseResponse.md +24 -0
- data/docs/ExpensesApi.md +159 -5
- data/docs/IncomeStatement.md +15 -11
- data/docs/IncomeStatementsApi.md +2 -0
- data/docs/Invoice.md +21 -15
- data/docs/InvoiceLineItem.md +15 -5
- data/docs/InvoiceLineItemRequest.md +15 -3
- data/docs/InvoiceRequest.md +17 -11
- data/docs/InvoicesApi.md +16 -10
- data/docs/Issue.md +9 -7
- data/docs/IssuesApi.md +2 -2
- data/docs/Item.md +11 -7
- data/docs/ItemsApi.md +11 -9
- data/docs/JournalEntriesApi.md +7 -5
- data/docs/JournalEntry.md +18 -10
- data/docs/JournalEntryRequest.md +14 -8
- data/docs/JournalLine.md +6 -4
- data/docs/JournalLineRequest.md +10 -4
- data/docs/LinkToken.md +1 -1
- data/docs/LinkedAccountCondition.md +28 -0
- data/docs/LinkedAccountConditionRequest.md +22 -0
- data/docs/LinkedAccountSelectiveSyncConfiguration.md +18 -0
- data/docs/LinkedAccountSelectiveSyncConfigurationListRequest.md +18 -0
- data/docs/LinkedAccountSelectiveSyncConfigurationRequest.md +18 -0
- data/docs/LinkedAccountsApi.md +2 -2
- data/docs/MetaResponse.md +2 -0
- data/docs/MultipartFormFieldRequest.md +1 -1
- data/docs/OperatorSchema.md +20 -0
- data/docs/PaginatedConditionSchemaList.md +22 -0
- data/docs/Payment.md +14 -6
- data/docs/PaymentEndpointRequest.md +18 -0
- data/docs/PaymentRequest.md +34 -0
- data/docs/PaymentResponse.md +24 -0
- data/docs/PaymentsApi.md +159 -5
- data/docs/PostingStatusEnum.md +15 -0
- data/docs/PurchaseOrder.md +19 -13
- data/docs/PurchaseOrderEndpointRequest.md +18 -0
- data/docs/PurchaseOrderLineItem.md +10 -2
- data/docs/PurchaseOrderLineItemRequest.md +44 -0
- data/docs/PurchaseOrderRequest.md +44 -0
- data/docs/PurchaseOrderResponse.md +24 -0
- data/docs/PurchaseOrdersApi.md +167 -9
- data/docs/ReportItem.md +3 -1
- data/docs/SelectiveSyncApi.md +233 -0
- data/docs/SelectiveSyncConfigurationsUsageEnum.md +15 -0
- data/docs/SyncStatus.md +5 -3
- data/docs/TaxRate.md +11 -7
- data/docs/TaxRatesApi.md +2 -0
- data/docs/TrackingCategoriesApi.md +11 -5
- data/docs/TrackingCategory.md +13 -9
- data/docs/Transaction.md +20 -14
- data/docs/TransactionLineItem.md +9 -3
- data/docs/TransactionsApi.md +7 -5
- data/docs/VendorCredit.md +13 -7
- data/docs/VendorCreditLine.md +6 -2
- data/docs/VendorCreditsApi.md +7 -5
- data/lib/merge_accounting_client/api/accounts_api.rb +159 -4
- data/lib/merge_accounting_client/api/addresses_api.rb +9 -2
- data/lib/merge_accounting_client/api/attachments_api.rb +141 -0
- data/lib/merge_accounting_client/api/balance_sheets_api.rb +3 -0
- data/lib/merge_accounting_client/api/cash_flow_statements_api.rb +3 -0
- data/lib/merge_accounting_client/api/common_model_scopes_api.rb +146 -0
- data/lib/merge_accounting_client/api/company_info_api.rb +0 -14
- data/lib/merge_accounting_client/api/contacts_api.rb +159 -18
- data/lib/merge_accounting_client/api/credit_notes_api.rb +27 -18
- data/lib/merge_accounting_client/api/expenses_api.rb +147 -14
- data/lib/merge_accounting_client/api/income_statements_api.rb +3 -0
- data/lib/merge_accounting_client/api/invoices_api.rb +29 -20
- data/lib/merge_accounting_client/api/issues_api.rb +2 -2
- data/lib/merge_accounting_client/api/items_api.rb +21 -18
- data/lib/merge_accounting_client/api/journal_entries_api.rb +9 -14
- data/lib/merge_accounting_client/api/linked_accounts_api.rb +3 -3
- data/lib/merge_accounting_client/api/payments_api.rb +147 -14
- data/lib/merge_accounting_client/api/purchase_orders_api.rb +165 -18
- data/lib/merge_accounting_client/api/selective_sync_api.rb +225 -0
- data/lib/merge_accounting_client/api/tax_rates_api.rb +3 -0
- data/lib/merge_accounting_client/api/tracking_categories_api.rb +21 -4
- data/lib/merge_accounting_client/api/transactions_api.rb +9 -14
- data/lib/merge_accounting_client/api/vendor_credits_api.rb +9 -14
- data/lib/merge_accounting_client/models/account.rb +45 -21
- data/lib/merge_accounting_client/models/account_endpoint_request.rb +223 -0
- data/lib/merge_accounting_client/models/account_integration.rb +1 -1
- data/lib/merge_accounting_client/models/account_request.rb +344 -0
- data/lib/merge_accounting_client/models/account_response.rb +266 -0
- data/lib/merge_accounting_client/models/accounting_attachment.rb +39 -16
- data/lib/merge_accounting_client/models/accounting_attachment_endpoint_request.rb +223 -0
- data/lib/merge_accounting_client/models/accounting_attachment_request.rb +282 -0
- data/lib/merge_accounting_client/models/accounting_attachment_response.rb +266 -0
- data/lib/merge_accounting_client/models/accounting_phone_number_request.rb +256 -0
- data/lib/merge_accounting_client/models/address.rb +16 -5
- data/lib/merge_accounting_client/models/balance_sheet.rb +41 -18
- data/lib/merge_accounting_client/models/cash_flow_statement.rb +41 -18
- data/lib/merge_accounting_client/models/categories_enum.rb +3 -1
- data/lib/merge_accounting_client/models/category_enum.rb +3 -1
- data/lib/merge_accounting_client/models/common_model_scope_data.rb +234 -0
- data/lib/merge_accounting_client/models/common_model_scopes.rb +234 -0
- data/lib/merge_accounting_client/models/common_model_scopes_body_request.rb +274 -0
- data/lib/merge_accounting_client/models/common_model_scopes_disabled_models.rb +283 -0
- data/lib/merge_accounting_client/models/common_model_scopes_disabled_models_enabled_actions_enum.rb +45 -0
- data/lib/merge_accounting_client/models/common_model_scopes_post_inner_deserializer_request.rb +274 -0
- data/lib/merge_accounting_client/models/common_model_scopes_update_serializer.rb +226 -0
- data/lib/merge_accounting_client/models/company_info.rb +29 -17
- data/lib/merge_accounting_client/models/condition_schema.rb +298 -0
- data/lib/merge_accounting_client/models/condition_type_enum.rb +50 -0
- data/lib/merge_accounting_client/models/contact.rb +41 -18
- data/lib/merge_accounting_client/models/contact_endpoint_request.rb +223 -0
- data/lib/merge_accounting_client/models/contact_request.rb +346 -0
- data/lib/merge_accounting_client/models/contact_response.rb +266 -0
- data/lib/merge_accounting_client/models/credit_note.rb +43 -20
- data/lib/merge_accounting_client/models/credit_note_line_item.rb +40 -12
- data/lib/merge_accounting_client/models/data_passthrough_request.rb +1 -0
- data/lib/merge_accounting_client/models/enabled_actions_enum.rb +45 -0
- data/lib/merge_accounting_client/models/end_user_details_request.rb +18 -5
- data/lib/merge_accounting_client/models/expense.rb +91 -38
- data/lib/merge_accounting_client/models/expense_endpoint_request.rb +223 -0
- data/lib/merge_accounting_client/models/expense_line.rb +51 -17
- data/lib/merge_accounting_client/models/expense_line_request.rb +332 -0
- data/lib/merge_accounting_client/models/expense_request.rb +350 -0
- data/lib/merge_accounting_client/models/expense_response.rb +266 -0
- data/lib/merge_accounting_client/models/income_statement.rb +44 -21
- data/lib/merge_accounting_client/models/invoice.rb +94 -42
- data/lib/merge_accounting_client/models/invoice_line_item.rb +99 -26
- data/lib/merge_accounting_client/models/invoice_line_item_request.rb +102 -17
- data/lib/merge_accounting_client/models/invoice_request.rb +85 -32
- data/lib/merge_accounting_client/models/issue.rb +15 -4
- data/lib/merge_accounting_client/models/item.rb +44 -19
- data/lib/merge_accounting_client/models/journal_entry.rb +100 -38
- data/lib/merge_accounting_client/models/journal_entry_request.rb +92 -40
- data/lib/merge_accounting_client/models/journal_line.rb +28 -17
- data/lib/merge_accounting_client/models/journal_line_request.rb +52 -17
- data/lib/merge_accounting_client/models/link_token.rb +0 -5
- data/lib/merge_accounting_client/models/linked_account_condition.rb +282 -0
- data/lib/merge_accounting_client/models/linked_account_condition_request.rb +269 -0
- data/lib/merge_accounting_client/models/linked_account_selective_sync_configuration.rb +221 -0
- data/lib/merge_accounting_client/models/linked_account_selective_sync_configuration_list_request.rb +226 -0
- data/lib/merge_accounting_client/models/linked_account_selective_sync_configuration_request.rb +226 -0
- data/lib/merge_accounting_client/models/meta_response.rb +12 -1
- data/lib/merge_accounting_client/models/multipart_form_field_request.rb +1 -1
- data/lib/merge_accounting_client/models/operator_schema.rb +229 -0
- data/lib/merge_accounting_client/models/paginated_condition_schema_list.rb +240 -0
- data/lib/merge_accounting_client/models/payment.rb +82 -18
- data/lib/merge_accounting_client/models/payment_endpoint_request.rb +223 -0
- data/lib/merge_accounting_client/models/payment_request.rb +328 -0
- data/lib/merge_accounting_client/models/payment_response.rb +266 -0
- data/lib/merge_accounting_client/models/posting_status_enum.rb +45 -0
- data/lib/merge_accounting_client/models/purchase_order.rb +92 -41
- data/lib/merge_accounting_client/models/purchase_order_endpoint_request.rb +223 -0
- data/lib/merge_accounting_client/models/purchase_order_line_item.rb +79 -12
- data/lib/merge_accounting_client/models/purchase_order_line_item_request.rb +422 -0
- data/lib/merge_accounting_client/models/purchase_order_request.rb +383 -0
- data/lib/merge_accounting_client/models/purchase_order_response.rb +266 -0
- data/lib/merge_accounting_client/models/report_item.rb +15 -4
- data/lib/merge_accounting_client/models/selective_sync_configurations_usage_enum.rb +45 -0
- data/lib/merge_accounting_client/models/sync_status.rb +13 -4
- data/lib/merge_accounting_client/models/tax_rate.rb +59 -36
- data/lib/merge_accounting_client/models/tracking_category.rb +62 -38
- data/lib/merge_accounting_client/models/transaction.rb +97 -46
- data/lib/merge_accounting_client/models/transaction_line_item.rb +75 -19
- data/lib/merge_accounting_client/models/vendor_credit.rb +70 -18
- data/lib/merge_accounting_client/models/vendor_credit_line.rb +34 -6
- data/lib/merge_accounting_client/version.rb +1 -1
- data/lib/merge_accounting_client.rb +42 -1
- data/spec/api/accounts_api_spec.rb +30 -2
- data/spec/api/addresses_api_spec.rb +2 -1
- data/spec/api/attachments_api_spec.rb +26 -0
- data/spec/api/balance_sheets_api_spec.rb +1 -0
- data/spec/api/cash_flow_statements_api_spec.rb +1 -0
- data/spec/api/common_model_scopes_api_spec.rb +58 -0
- data/spec/api/company_info_api_spec.rb +0 -2
- data/spec/api/contacts_api_spec.rb +30 -4
- data/spec/api/credit_notes_api_spec.rb +7 -4
- data/spec/api/expenses_api_spec.rb +28 -2
- data/spec/api/income_statements_api_spec.rb +1 -0
- data/spec/api/invoices_api_spec.rb +8 -5
- data/spec/api/issues_api_spec.rb +1 -1
- data/spec/api/items_api_spec.rb +5 -4
- data/spec/api/journal_entries_api_spec.rb +3 -2
- data/spec/api/linked_accounts_api_spec.rb +1 -1
- data/spec/api/payments_api_spec.rb +28 -2
- data/spec/api/purchase_orders_api_spec.rb +32 -4
- data/spec/api/selective_sync_api_spec.rb +72 -0
- data/spec/api/tax_rates_api_spec.rb +1 -0
- data/spec/api/tracking_categories_api_spec.rb +5 -2
- data/spec/api/transactions_api_spec.rb +3 -2
- data/spec/api/vendor_credits_api_spec.rb +3 -2
- data/spec/models/account_endpoint_request_spec.rb +34 -0
- data/spec/models/account_request_spec.rb +100 -0
- data/spec/models/account_response_spec.rb +52 -0
- data/spec/models/account_spec.rb +18 -6
- data/spec/models/accounting_attachment_endpoint_request_spec.rb +34 -0
- data/spec/models/accounting_attachment_request_spec.rb +58 -0
- data/spec/models/accounting_attachment_response_spec.rb +52 -0
- data/spec/models/accounting_attachment_spec.rb +15 -3
- data/spec/models/accounting_phone_number_request_spec.rb +52 -0
- data/spec/models/address_spec.rb +6 -0
- data/spec/models/balance_sheet_spec.rb +15 -3
- data/spec/models/cash_flow_statement_spec.rb +15 -3
- data/spec/models/common_model_scope_data_spec.rb +40 -0
- data/spec/models/common_model_scopes_body_request_spec.rb +46 -0
- data/spec/models/common_model_scopes_disabled_models_enabled_actions_enum_spec.rb +28 -0
- data/spec/models/common_model_scopes_disabled_models_spec.rb +58 -0
- data/spec/models/common_model_scopes_post_inner_deserializer_request_spec.rb +46 -0
- data/spec/models/common_model_scopes_spec.rb +40 -0
- data/spec/models/common_model_scopes_update_serializer_spec.rb +34 -0
- data/spec/models/company_info_spec.rb +12 -6
- data/spec/models/condition_schema_spec.rb +70 -0
- data/spec/models/condition_type_enum_spec.rb +28 -0
- data/spec/models/contact_endpoint_request_spec.rb +34 -0
- data/spec/models/contact_request_spec.rb +100 -0
- data/spec/models/contact_response_spec.rb +52 -0
- data/spec/models/contact_spec.rb +18 -6
- data/spec/models/credit_note_line_item_spec.rb +12 -0
- data/spec/models/credit_note_spec.rb +17 -5
- data/spec/models/enabled_actions_enum_spec.rb +28 -0
- data/spec/models/end_user_details_request_spec.rb +6 -0
- data/spec/models/expense_endpoint_request_spec.rb +34 -0
- data/spec/models/expense_line_request_spec.rb +94 -0
- data/spec/models/expense_line_spec.rb +22 -4
- data/spec/models/expense_request_spec.rb +94 -0
- data/spec/models/expense_response_spec.rb +52 -0
- data/spec/models/expense_spec.rb +30 -12
- data/spec/models/income_statement_spec.rb +15 -3
- data/spec/models/invoice_line_item_request_spec.rb +41 -5
- data/spec/models/invoice_line_item_spec.rb +36 -6
- data/spec/models/invoice_request_spec.rb +26 -8
- data/spec/models/invoice_spec.rb +34 -16
- data/spec/models/issue_spec.rb +6 -0
- data/spec/models/item_spec.rb +18 -6
- data/spec/models/journal_entry_request_spec.rb +25 -7
- data/spec/models/journal_entry_spec.rb +35 -11
- data/spec/models/journal_line_request_spec.rb +22 -4
- data/spec/models/journal_line_spec.rb +10 -4
- data/spec/models/linked_account_condition_request_spec.rb +46 -0
- data/spec/models/linked_account_condition_spec.rb +64 -0
- data/spec/models/linked_account_selective_sync_configuration_list_request_spec.rb +34 -0
- data/spec/models/linked_account_selective_sync_configuration_request_spec.rb +34 -0
- data/spec/models/linked_account_selective_sync_configuration_spec.rb +34 -0
- data/spec/models/meta_response_spec.rb +6 -0
- data/spec/models/operator_schema_spec.rb +40 -0
- data/spec/models/paginated_condition_schema_list_spec.rb +46 -0
- data/spec/models/payment_endpoint_request_spec.rb +34 -0
- data/spec/models/payment_request_spec.rb +82 -0
- data/spec/models/payment_response_spec.rb +52 -0
- data/spec/models/payment_spec.rb +28 -4
- data/spec/models/posting_status_enum_spec.rb +28 -0
- data/spec/models/purchase_order_endpoint_request_spec.rb +34 -0
- data/spec/models/purchase_order_line_item_request_spec.rb +112 -0
- data/spec/models/purchase_order_line_item_spec.rb +24 -0
- data/spec/models/purchase_order_request_spec.rb +112 -0
- data/spec/models/purchase_order_response_spec.rb +52 -0
- data/spec/models/purchase_order_spec.rb +34 -16
- data/spec/models/report_item_spec.rb +6 -0
- data/spec/models/selective_sync_configurations_usage_enum_spec.rb +28 -0
- data/spec/models/sync_status_spec.rb +6 -0
- data/spec/models/tax_rate_spec.rb +19 -7
- data/spec/models/tracking_category_spec.rb +20 -8
- data/spec/models/transaction_line_item_spec.rb +19 -1
- data/spec/models/transaction_spec.rb +30 -12
- data/spec/models/vendor_credit_line_spec.rb +12 -0
- data/spec/models/vendor_credit_spec.rb +24 -6
- metadata +283 -115
@@ -0,0 +1,38 @@
|
|
1
|
+
# MergeAccountingClient::ExpenseLineRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **item** | **String** | The line's item. | [optional] |
|
8
|
+
| **net_amount** | **Float** | The line's net amount. | [optional] |
|
9
|
+
| **tracking_category** | **String** | | [optional] |
|
10
|
+
| **tracking_categories** | **Array<String>** | | [optional] |
|
11
|
+
| **company** | **String** | The company the line belongs to. | [optional] |
|
12
|
+
| **account** | **String** | The expense's payment account. | [optional] |
|
13
|
+
| **contact** | **String** | The expense's contact. | [optional] |
|
14
|
+
| **description** | **String** | The description of the item that was purchased by the company. | [optional] |
|
15
|
+
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
16
|
+
| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
17
|
+
| **linked_account_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
18
|
+
|
19
|
+
## Example
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'merge_accounting_client'
|
23
|
+
|
24
|
+
instance = MergeAccountingClient::ExpenseLineRequest.new(
|
25
|
+
item: b38c59b0-a9d7-4740-b1ee-5436c6751e3d,
|
26
|
+
net_amount: 25.54,
|
27
|
+
tracking_category: b38c59b0-a9d7-4740-b1ee-5436c6751e3d,
|
28
|
+
tracking_categories: ["b38c59b0-a9d7-4740-b1ee-5436c6751e3d","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],
|
29
|
+
company: 595c8f97-2ac4-45b7-b000-41bdf43240b5,
|
30
|
+
account: 2a56344a-a491-11ec-b909-0242ac120002,
|
31
|
+
contact: c640b80b-fac9-409f-aa19-1f9221aec445,
|
32
|
+
description: MacBook Pro,
|
33
|
+
remote_id: 121222,
|
34
|
+
integration_params: {"unique_integration_field":"unique_integration_field_value"},
|
35
|
+
linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"}
|
36
|
+
)
|
37
|
+
```
|
38
|
+
|
@@ -0,0 +1,38 @@
|
|
1
|
+
# MergeAccountingClient::ExpenseRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **transaction_date** | **Time** | When the transaction occurred. | [optional] |
|
8
|
+
| **account** | **String** | The expense's payment account. | [optional] |
|
9
|
+
| **contact** | **String** | The expense's contact. | [optional] |
|
10
|
+
| **total_amount** | **Float** | The expense's total amount. | [optional] |
|
11
|
+
| **currency** | [**CurrencyEnum**](CurrencyEnum.md) | The expense's currency. * `XUA` - ADB Unit of Account * `AFN` - Afghan Afghani * `AFA` - Afghan Afghani (1927–2002) * `ALL` - Albanian Lek * `ALK` - Albanian Lek (1946–1965) * `DZD` - Algerian Dinar * `ADP` - Andorran Peseta * `AOA` - Angolan Kwanza * `AOK` - Angolan Kwanza (1977–1991) * `AON` - Angolan New Kwanza (1990–2000) * `AOR` - Angolan Readjusted Kwanza (1995–1999) * `ARA` - Argentine Austral * `ARS` - Argentine Peso * `ARM` - Argentine Peso (1881–1970) * `ARP` - Argentine Peso (1983–1985) * `ARL` - Argentine Peso Ley (1970–1983) * `AMD` - Armenian Dram * `AWG` - Aruban Florin * `AUD` - Australian Dollar * `ATS` - Austrian Schilling * `AZN` - Azerbaijani Manat * `AZM` - Azerbaijani Manat (1993–2006) * `BSD` - Bahamian Dollar * `BHD` - Bahraini Dinar * `BDT` - Bangladeshi Taka * `BBD` - Barbadian Dollar * `BYN` - Belarusian Ruble * `BYB` - Belarusian Ruble (1994–1999) * `BYR` - Belarusian Ruble (2000–2016) * `BEF` - Belgian Franc * `BEC` - Belgian Franc (convertible) * `BEL` - Belgian Franc (financial) * `BZD` - Belize Dollar * `BMD` - Bermudan Dollar * `BTN` - Bhutanese Ngultrum * `BOB` - Bolivian Boliviano * `BOL` - Bolivian Boliviano (1863–1963) * `BOV` - Bolivian Mvdol * `BOP` - Bolivian Peso * `BAM` - Bosnia-Herzegovina Convertible Mark * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) * `BWP` - Botswanan Pula * `BRC` - Brazilian Cruzado (1986–1989) * `BRZ` - Brazilian Cruzeiro (1942–1967) * `BRE` - Brazilian Cruzeiro (1990–1993) * `BRR` - Brazilian Cruzeiro (1993–1994) * `BRN` - Brazilian New Cruzado (1989–1990) * `BRB` - Brazilian New Cruzeiro (1967–1986) * `BRL` - Brazilian Real * `GBP` - British Pound * `BND` - Brunei Dollar * `BGL` - Bulgarian Hard Lev * `BGN` - Bulgarian Lev * `BGO` - Bulgarian Lev (1879–1952) * `BGM` - Bulgarian Socialist Lev * `BUK` - Burmese Kyat * `BIF` - Burundian Franc * `XPF` - CFP Franc * `KHR` - Cambodian Riel * `CAD` - Canadian Dollar * `CVE` - Cape Verdean Escudo * `KYD` - Cayman Islands Dollar * `XAF` - Central African CFA Franc * `CLE` - Chilean Escudo * `CLP` - Chilean Peso * `CLF` - Chilean Unit of Account (UF) * `CNX` - Chinese People’s Bank Dollar * `CNY` - Chinese Yuan * `CNH` - Chinese Yuan (offshore) * `COP` - Colombian Peso * `COU` - Colombian Real Value Unit * `KMF` - Comorian Franc * `CDF` - Congolese Franc * `CRC` - Costa Rican Colón * `HRD` - Croatian Dinar * `HRK` - Croatian Kuna * `CUC` - Cuban Convertible Peso * `CUP` - Cuban Peso * `CYP` - Cypriot Pound * `CZK` - Czech Koruna * `CSK` - Czechoslovak Hard Koruna * `DKK` - Danish Krone * `DJF` - Djiboutian Franc * `DOP` - Dominican Peso * `NLG` - Dutch Guilder * `XCD` - East Caribbean Dollar * `DDM` - East German Mark * `ECS` - Ecuadorian Sucre * `ECV` - Ecuadorian Unit of Constant Value * `EGP` - Egyptian Pound * `GQE` - Equatorial Guinean Ekwele * `ERN` - Eritrean Nakfa * `EEK` - Estonian Kroon * `ETB` - Ethiopian Birr * `EUR` - Euro * `XBA` - European Composite Unit * `XEU` - European Currency Unit * `XBB` - European Monetary Unit * `XBC` - European Unit of Account (XBC) * `XBD` - European Unit of Account (XBD) * `FKP` - Falkland Islands Pound * `FJD` - Fijian Dollar * `FIM` - Finnish Markka * `FRF` - French Franc * `XFO` - French Gold Franc * `XFU` - French UIC-Franc * `GMD` - Gambian Dalasi * `GEK` - Georgian Kupon Larit * `GEL` - Georgian Lari * `DEM` - German Mark * `GHS` - Ghanaian Cedi * `GHC` - Ghanaian Cedi (1979–2007) * `GIP` - Gibraltar Pound * `XAU` - Gold * `GRD` - Greek Drachma * `GTQ` - Guatemalan Quetzal * `GWP` - Guinea-Bissau Peso * `GNF` - Guinean Franc * `GNS` - Guinean Syli * `GYD` - Guyanaese Dollar * `HTG` - Haitian Gourde * `HNL` - Honduran Lempira * `HKD` - Hong Kong Dollar * `HUF` - Hungarian Forint * `IMP` - IMP * `ISK` - Icelandic Króna * `ISJ` - Icelandic Króna (1918–1981) * `INR` - Indian Rupee * `IDR` - Indonesian Rupiah * `IRR` - Iranian Rial * `IQD` - Iraqi Dinar * `IEP` - Irish Pound * `ILS` - Israeli New Shekel * `ILP` - Israeli Pound * `ILR` - Israeli Shekel (1980–1985) * `ITL` - Italian Lira * `JMD` - Jamaican Dollar * `JPY` - Japanese Yen * `JOD` - Jordanian Dinar * `KZT` - Kazakhstani Tenge * `KES` - Kenyan Shilling * `KWD` - Kuwaiti Dinar * `KGS` - Kyrgystani Som * `LAK` - Laotian Kip * `LVL` - Latvian Lats * `LVR` - Latvian Ruble * `LBP` - Lebanese Pound * `LSL` - Lesotho Loti * `LRD` - Liberian Dollar * `LYD` - Libyan Dinar * `LTL` - Lithuanian Litas * `LTT` - Lithuanian Talonas * `LUL` - Luxembourg Financial Franc * `LUC` - Luxembourgian Convertible Franc * `LUF` - Luxembourgian Franc * `MOP` - Macanese Pataca * `MKD` - Macedonian Denar * `MKN` - Macedonian Denar (1992–1993) * `MGA` - Malagasy Ariary * `MGF` - Malagasy Franc * `MWK` - Malawian Kwacha * `MYR` - Malaysian Ringgit * `MVR` - Maldivian Rufiyaa * `MVP` - Maldivian Rupee (1947–1981) * `MLF` - Malian Franc * `MTL` - Maltese Lira * `MTP` - Maltese Pound * `MRU` - Mauritanian Ouguiya * `MRO` - Mauritanian Ouguiya (1973–2017) * `MUR` - Mauritian Rupee * `MXV` - Mexican Investment Unit * `MXN` - Mexican Peso * `MXP` - Mexican Silver Peso (1861–1992) * `MDC` - Moldovan Cupon * `MDL` - Moldovan Leu * `MCF` - Monegasque Franc * `MNT` - Mongolian Tugrik * `MAD` - Moroccan Dirham * `MAF` - Moroccan Franc * `MZE` - Mozambican Escudo * `MZN` - Mozambican Metical * `MZM` - Mozambican Metical (1980–2006) * `MMK` - Myanmar Kyat * `NAD` - Namibian Dollar * `NPR` - Nepalese Rupee * `ANG` - Netherlands Antillean Guilder * `TWD` - New Taiwan Dollar * `NZD` - New Zealand Dollar * `NIO` - Nicaraguan Córdoba * `NIC` - Nicaraguan Córdoba (1988–1991) * `NGN` - Nigerian Naira * `KPW` - North Korean Won * `NOK` - Norwegian Krone * `OMR` - Omani Rial * `PKR` - Pakistani Rupee * `XPD` - Palladium * `PAB` - Panamanian Balboa * `PGK` - Papua New Guinean Kina * `PYG` - Paraguayan Guarani * `PEI` - Peruvian Inti * `PEN` - Peruvian Sol * `PES` - Peruvian Sol (1863–1965) * `PHP` - Philippine Peso * `XPT` - Platinum * `PLN` - Polish Zloty * `PLZ` - Polish Zloty (1950–1995) * `PTE` - Portuguese Escudo * `GWE` - Portuguese Guinea Escudo * `QAR` - Qatari Rial * `XRE` - RINET Funds * `RHD` - Rhodesian Dollar * `RON` - Romanian Leu * `ROL` - Romanian Leu (1952–2006) * `RUB` - Russian Ruble * `RUR` - Russian Ruble (1991–1998) * `RWF` - Rwandan Franc * `SVC` - Salvadoran Colón * `WST` - Samoan Tala * `SAR` - Saudi Riyal * `RSD` - Serbian Dinar * `CSD` - Serbian Dinar (2002–2006) * `SCR` - Seychellois Rupee * `SLL` - Sierra Leonean Leone * `XAG` - Silver * `SGD` - Singapore Dollar * `SKK` - Slovak Koruna * `SIT` - Slovenian Tolar * `SBD` - Solomon Islands Dollar * `SOS` - Somali Shilling * `ZAR` - South African Rand * `ZAL` - South African Rand (financial) * `KRH` - South Korean Hwan (1953–1962) * `KRW` - South Korean Won * `KRO` - South Korean Won (1945–1953) * `SSP` - South Sudanese Pound * `SUR` - Soviet Rouble * `ESP` - Spanish Peseta * `ESA` - Spanish Peseta (A account) * `ESB` - Spanish Peseta (convertible account) * `XDR` - Special Drawing Rights * `LKR` - Sri Lankan Rupee * `SHP` - St. Helena Pound * `XSU` - Sucre * `SDD` - Sudanese Dinar (1992–2007) * `SDG` - Sudanese Pound * `SDP` - Sudanese Pound (1957–1998) * `SRD` - Surinamese Dollar * `SRG` - Surinamese Guilder * `SZL` - Swazi Lilangeni * `SEK` - Swedish Krona * `CHF` - Swiss Franc * `SYP` - Syrian Pound * `STN` - São Tomé & Príncipe Dobra * `STD` - São Tomé & Príncipe Dobra (1977–2017) * `TVD` - TVD * `TJR` - Tajikistani Ruble * `TJS` - Tajikistani Somoni * `TZS` - Tanzanian Shilling * `XTS` - Testing Currency Code * `THB` - Thai Baht * `XXX` - The codes assigned for transactions where no currency is involved * `TPE` - Timorese Escudo * `TOP` - Tongan Paʻanga * `TTD` - Trinidad & Tobago Dollar * `TND` - Tunisian Dinar * `TRY` - Turkish Lira * `TRL` - Turkish Lira (1922–2005) * `TMT` - Turkmenistani Manat * `TMM` - Turkmenistani Manat (1993–2009) * `USD` - US Dollar * `USN` - US Dollar (Next day) * `USS` - US Dollar (Same day) * `UGX` - Ugandan Shilling * `UGS` - Ugandan Shilling (1966–1987) * `UAH` - Ukrainian Hryvnia * `UAK` - Ukrainian Karbovanets * `AED` - United Arab Emirates Dirham * `UYW` - Uruguayan Nominal Wage Index Unit * `UYU` - Uruguayan Peso * `UYP` - Uruguayan Peso (1975–1993) * `UYI` - Uruguayan Peso (Indexed Units) * `UZS` - Uzbekistani Som * `VUV` - Vanuatu Vatu * `VES` - Venezuelan Bolívar * `VEB` - Venezuelan Bolívar (1871–2008) * `VEF` - Venezuelan Bolívar (2008–2018) * `VND` - Vietnamese Dong * `VNN` - Vietnamese Dong (1978–1985) * `CHE` - WIR Euro * `CHW` - WIR Franc * `XOF` - West African CFA Franc * `YDD` - Yemeni Dinar * `YER` - Yemeni Rial * `YUN` - Yugoslavian Convertible Dinar (1990–1992) * `YUD` - Yugoslavian Hard Dinar (1966–1990) * `YUM` - Yugoslavian New Dinar (1994–2002) * `YUR` - Yugoslavian Reformed Dinar (1992–1993) * `ZWN` - ZWN * `ZRN` - Zairean New Zaire (1993–1998) * `ZRZ` - Zairean Zaire (1971–1993) * `ZMW` - Zambian Kwacha * `ZMK` - Zambian Kwacha (1968–2012) * `ZWD` - Zimbabwean Dollar (1980–2008) * `ZWR` - Zimbabwean Dollar (2008) * `ZWL` - Zimbabwean Dollar (2009) | [optional] |
|
12
|
+
| **exchange_rate** | **String** | The expense's exchange rate. | [optional] |
|
13
|
+
| **company** | **String** | The company the expense belongs to. | [optional] |
|
14
|
+
| **memo** | **String** | The expense's private note. | [optional] |
|
15
|
+
| **lines** | [**Array<ExpenseLineRequest>**](ExpenseLineRequest.md) | | [optional] |
|
16
|
+
| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
17
|
+
| **linked_account_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
18
|
+
|
19
|
+
## Example
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'merge_accounting_client'
|
23
|
+
|
24
|
+
instance = MergeAccountingClient::ExpenseRequest.new(
|
25
|
+
transaction_date: null,
|
26
|
+
account: 9d892439-5fab-4dbb-8bd8-34f7f96c7912,
|
27
|
+
contact: 3d263469-51a1-4766-9205-f6c997826be1,
|
28
|
+
total_amount: 10000.0,
|
29
|
+
currency: USD,
|
30
|
+
exchange_rate: 2.9,
|
31
|
+
company: 595c8f97-2ac4-45b7-b000-41bdf43240b5,
|
32
|
+
memo: New employee supplies,
|
33
|
+
lines: [{"remote_id":"121222","net_amount":25.54,"tracking_category":"b38c59b0-a9d7-4740-b1ee-5436c6751e3d","tracking_categories":["b38c59b0-a9d7-4740-b1ee-5436c6751e3d","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"company":"595c8f97-2ac4-45b7-b000-41bdf43240b5","item":"b38c59b0-a9d7-4740-b1ee-5436c6751e3d","account":"2a56344a-a491-11ec-b909-0242ac120002","contact":"c640b80b-fac9-409f-aa19-1f9221aec445","description":"MacBook Pro"},{"remote_id":"121223","net_amount":10,"tracking_category":"b38c59b0-a9d7-4740-b1ee-5436c6751e3d","tracking_categories":["b38c59b0-a9d7-4740-b1ee-5436c6751e3d","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"item":"b38c59b0-a9d7-4740-b1ee-5436c6751e3d","account":"2a56344a-a491-11ec-b909-0242ac120002","description":"Desk Lamp"}],
|
34
|
+
integration_params: {"unique_integration_field":"unique_integration_field_value"},
|
35
|
+
linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"}
|
36
|
+
)
|
37
|
+
```
|
38
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# MergeAccountingClient::ExpenseResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **model** | [**Expense**](Expense.md) | | |
|
8
|
+
| **warnings** | [**Array<WarningValidationProblem>**](WarningValidationProblem.md) | | |
|
9
|
+
| **errors** | [**Array<ErrorValidationProblem>**](ErrorValidationProblem.md) | | |
|
10
|
+
| **logs** | [**Array<DebugModeLog>**](DebugModeLog.md) | | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'merge_accounting_client'
|
16
|
+
|
17
|
+
instance = MergeAccountingClient::ExpenseResponse.new(
|
18
|
+
model: null,
|
19
|
+
warnings: null,
|
20
|
+
errors: null,
|
21
|
+
logs: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/ExpensesApi.md
CHANGED
@@ -4,10 +4,91 @@ All URIs are relative to *https://api.merge.dev/api/accounting/v1*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
+
| [**expenses_create**](ExpensesApi.md#expenses_create) | **POST** /expenses | |
|
7
8
|
| [**expenses_list**](ExpensesApi.md#expenses_list) | **GET** /expenses | |
|
9
|
+
| [**expenses_meta_post_retrieve**](ExpensesApi.md#expenses_meta_post_retrieve) | **GET** /expenses/meta/post | |
|
8
10
|
| [**expenses_retrieve**](ExpensesApi.md#expenses_retrieve) | **GET** /expenses/{id} | |
|
9
11
|
|
10
12
|
|
13
|
+
## expenses_create
|
14
|
+
|
15
|
+
> <ExpenseResponse> expenses_create(x_account_token, expense_endpoint_request, opts)
|
16
|
+
|
17
|
+
|
18
|
+
|
19
|
+
Creates an `Expense` object with the given values.
|
20
|
+
|
21
|
+
### Examples
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
require 'time'
|
25
|
+
require 'merge_accounting_client'
|
26
|
+
# setup authorization
|
27
|
+
MergeAccountingClient.configure do |config|
|
28
|
+
# Configure API key authorization: tokenAuth
|
29
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
30
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
31
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
32
|
+
end
|
33
|
+
|
34
|
+
api_instance = MergeAccountingClient::ExpensesApi.new
|
35
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
36
|
+
expense_endpoint_request = MergeAccountingClient::ExpenseEndpointRequest.new({model: MergeAccountingClient::ExpenseRequest.new}) # ExpenseEndpointRequest |
|
37
|
+
opts = {
|
38
|
+
is_debug_mode: true, # Boolean | Whether to include debug fields (such as log file links) in the response.
|
39
|
+
run_async: true # Boolean | Whether or not third-party updates should be run asynchronously.
|
40
|
+
}
|
41
|
+
|
42
|
+
begin
|
43
|
+
|
44
|
+
result = api_instance.expenses_create(x_account_token, expense_endpoint_request, opts)
|
45
|
+
p result
|
46
|
+
rescue MergeAccountingClient::ApiError => e
|
47
|
+
puts "Error when calling ExpensesApi->expenses_create: #{e}"
|
48
|
+
end
|
49
|
+
```
|
50
|
+
|
51
|
+
#### Using the expenses_create_with_http_info variant
|
52
|
+
|
53
|
+
This returns an Array which contains the response data, status code and headers.
|
54
|
+
|
55
|
+
> <Array(<ExpenseResponse>, Integer, Hash)> expenses_create_with_http_info(x_account_token, expense_endpoint_request, opts)
|
56
|
+
|
57
|
+
```ruby
|
58
|
+
begin
|
59
|
+
|
60
|
+
data, status_code, headers = api_instance.expenses_create_with_http_info(x_account_token, expense_endpoint_request, opts)
|
61
|
+
p status_code # => 2xx
|
62
|
+
p headers # => { ... }
|
63
|
+
p data # => <ExpenseResponse>
|
64
|
+
rescue MergeAccountingClient::ApiError => e
|
65
|
+
puts "Error when calling ExpensesApi->expenses_create_with_http_info: #{e}"
|
66
|
+
end
|
67
|
+
```
|
68
|
+
|
69
|
+
### Parameters
|
70
|
+
|
71
|
+
| Name | Type | Description | Notes |
|
72
|
+
| ---- | ---- | ----------- | ----- |
|
73
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
74
|
+
| **expense_endpoint_request** | [**ExpenseEndpointRequest**](ExpenseEndpointRequest.md) | | |
|
75
|
+
| **is_debug_mode** | **Boolean** | Whether to include debug fields (such as log file links) in the response. | [optional] |
|
76
|
+
| **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
|
77
|
+
|
78
|
+
### Return type
|
79
|
+
|
80
|
+
[**ExpenseResponse**](ExpenseResponse.md)
|
81
|
+
|
82
|
+
### Authorization
|
83
|
+
|
84
|
+
[tokenAuth](../README.md#tokenAuth)
|
85
|
+
|
86
|
+
### HTTP request headers
|
87
|
+
|
88
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
89
|
+
- **Accept**: application/json
|
90
|
+
|
91
|
+
|
11
92
|
## expenses_list
|
12
93
|
|
13
94
|
> <PaginatedExpenseList> expenses_list(x_account_token, opts)
|
@@ -32,16 +113,18 @@ end
|
|
32
113
|
api_instance = MergeAccountingClient::ExpensesApi.new
|
33
114
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
34
115
|
opts = {
|
116
|
+
company_id: 'company_id_example', # String | If provided, will only return expenses for this company.
|
35
117
|
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
36
118
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
37
119
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
38
|
-
expand: 'account', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
39
120
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
40
121
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
41
122
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
42
123
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
43
124
|
page_size: 56, # Integer | Number of results to return per page.
|
44
|
-
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
125
|
+
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
126
|
+
transaction_date_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
127
|
+
transaction_date_before: Time.parse('2013-10-20T19:20:30+01:00') # Time | If provided, will only return objects created before this datetime.
|
45
128
|
}
|
46
129
|
|
47
130
|
begin
|
@@ -76,16 +159,18 @@ end
|
|
76
159
|
| Name | Type | Description | Notes |
|
77
160
|
| ---- | ---- | ----------- | ----- |
|
78
161
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
162
|
+
| **company_id** | **String** | If provided, will only return expenses for this company. | [optional] |
|
79
163
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
80
164
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
81
165
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
82
|
-
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
83
166
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
84
167
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
85
168
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
86
169
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
87
170
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
88
171
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
172
|
+
| **transaction_date_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
173
|
+
| **transaction_date_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
89
174
|
|
90
175
|
### Return type
|
91
176
|
|
@@ -101,6 +186,77 @@ end
|
|
101
186
|
- **Accept**: application/json
|
102
187
|
|
103
188
|
|
189
|
+
## expenses_meta_post_retrieve
|
190
|
+
|
191
|
+
> <MetaResponse> expenses_meta_post_retrieve(x_account_token)
|
192
|
+
|
193
|
+
|
194
|
+
|
195
|
+
Returns metadata for `Expense` POSTs.
|
196
|
+
|
197
|
+
### Examples
|
198
|
+
|
199
|
+
```ruby
|
200
|
+
require 'time'
|
201
|
+
require 'merge_accounting_client'
|
202
|
+
# setup authorization
|
203
|
+
MergeAccountingClient.configure do |config|
|
204
|
+
# Configure API key authorization: tokenAuth
|
205
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
206
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
207
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
208
|
+
end
|
209
|
+
|
210
|
+
api_instance = MergeAccountingClient::ExpensesApi.new
|
211
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
212
|
+
|
213
|
+
begin
|
214
|
+
|
215
|
+
result = api_instance.expenses_meta_post_retrieve(x_account_token)
|
216
|
+
p result
|
217
|
+
rescue MergeAccountingClient::ApiError => e
|
218
|
+
puts "Error when calling ExpensesApi->expenses_meta_post_retrieve: #{e}"
|
219
|
+
end
|
220
|
+
```
|
221
|
+
|
222
|
+
#### Using the expenses_meta_post_retrieve_with_http_info variant
|
223
|
+
|
224
|
+
This returns an Array which contains the response data, status code and headers.
|
225
|
+
|
226
|
+
> <Array(<MetaResponse>, Integer, Hash)> expenses_meta_post_retrieve_with_http_info(x_account_token)
|
227
|
+
|
228
|
+
```ruby
|
229
|
+
begin
|
230
|
+
|
231
|
+
data, status_code, headers = api_instance.expenses_meta_post_retrieve_with_http_info(x_account_token)
|
232
|
+
p status_code # => 2xx
|
233
|
+
p headers # => { ... }
|
234
|
+
p data # => <MetaResponse>
|
235
|
+
rescue MergeAccountingClient::ApiError => e
|
236
|
+
puts "Error when calling ExpensesApi->expenses_meta_post_retrieve_with_http_info: #{e}"
|
237
|
+
end
|
238
|
+
```
|
239
|
+
|
240
|
+
### Parameters
|
241
|
+
|
242
|
+
| Name | Type | Description | Notes |
|
243
|
+
| ---- | ---- | ----------- | ----- |
|
244
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
245
|
+
|
246
|
+
### Return type
|
247
|
+
|
248
|
+
[**MetaResponse**](MetaResponse.md)
|
249
|
+
|
250
|
+
### Authorization
|
251
|
+
|
252
|
+
[tokenAuth](../README.md#tokenAuth)
|
253
|
+
|
254
|
+
### HTTP request headers
|
255
|
+
|
256
|
+
- **Content-Type**: Not defined
|
257
|
+
- **Accept**: application/json
|
258
|
+
|
259
|
+
|
104
260
|
## expenses_retrieve
|
105
261
|
|
106
262
|
> <Expense> expenses_retrieve(x_account_token, id, opts)
|
@@ -126,7 +282,6 @@ api_instance = MergeAccountingClient::ExpensesApi.new
|
|
126
282
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
127
283
|
id = TODO # String |
|
128
284
|
opts = {
|
129
|
-
expand: 'account', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
130
285
|
include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
131
286
|
}
|
132
287
|
|
@@ -163,7 +318,6 @@ end
|
|
163
318
|
| ---- | ---- | ----------- | ----- |
|
164
319
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
165
320
|
| **id** | [**String**](.md) | | |
|
166
|
-
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
167
321
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
168
322
|
|
169
323
|
### Return type
|
data/docs/IncomeStatement.md
CHANGED
@@ -6,19 +6,21 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
8
8
|
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
|
-
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
10
9
|
| **name** | **String** | The income statement's name. | [optional] |
|
11
|
-
| **currency** | [**CurrencyEnum**](CurrencyEnum.md) | The income statement's currency. | [optional] |
|
10
|
+
| **currency** | [**CurrencyEnum**](CurrencyEnum.md) | The income statement's currency. * `XUA` - ADB Unit of Account * `AFN` - Afghan Afghani * `AFA` - Afghan Afghani (1927–2002) * `ALL` - Albanian Lek * `ALK` - Albanian Lek (1946–1965) * `DZD` - Algerian Dinar * `ADP` - Andorran Peseta * `AOA` - Angolan Kwanza * `AOK` - Angolan Kwanza (1977–1991) * `AON` - Angolan New Kwanza (1990–2000) * `AOR` - Angolan Readjusted Kwanza (1995–1999) * `ARA` - Argentine Austral * `ARS` - Argentine Peso * `ARM` - Argentine Peso (1881–1970) * `ARP` - Argentine Peso (1983–1985) * `ARL` - Argentine Peso Ley (1970–1983) * `AMD` - Armenian Dram * `AWG` - Aruban Florin * `AUD` - Australian Dollar * `ATS` - Austrian Schilling * `AZN` - Azerbaijani Manat * `AZM` - Azerbaijani Manat (1993–2006) * `BSD` - Bahamian Dollar * `BHD` - Bahraini Dinar * `BDT` - Bangladeshi Taka * `BBD` - Barbadian Dollar * `BYN` - Belarusian Ruble * `BYB` - Belarusian Ruble (1994–1999) * `BYR` - Belarusian Ruble (2000–2016) * `BEF` - Belgian Franc * `BEC` - Belgian Franc (convertible) * `BEL` - Belgian Franc (financial) * `BZD` - Belize Dollar * `BMD` - Bermudan Dollar * `BTN` - Bhutanese Ngultrum * `BOB` - Bolivian Boliviano * `BOL` - Bolivian Boliviano (1863–1963) * `BOV` - Bolivian Mvdol * `BOP` - Bolivian Peso * `BAM` - Bosnia-Herzegovina Convertible Mark * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) * `BWP` - Botswanan Pula * `BRC` - Brazilian Cruzado (1986–1989) * `BRZ` - Brazilian Cruzeiro (1942–1967) * `BRE` - Brazilian Cruzeiro (1990–1993) * `BRR` - Brazilian Cruzeiro (1993–1994) * `BRN` - Brazilian New Cruzado (1989–1990) * `BRB` - Brazilian New Cruzeiro (1967–1986) * `BRL` - Brazilian Real * `GBP` - British Pound * `BND` - Brunei Dollar * `BGL` - Bulgarian Hard Lev * `BGN` - Bulgarian Lev * `BGO` - Bulgarian Lev (1879–1952) * `BGM` - Bulgarian Socialist Lev * `BUK` - Burmese Kyat * `BIF` - Burundian Franc * `XPF` - CFP Franc * `KHR` - Cambodian Riel * `CAD` - Canadian Dollar * `CVE` - Cape Verdean Escudo * `KYD` - Cayman Islands Dollar * `XAF` - Central African CFA Franc * `CLE` - Chilean Escudo * `CLP` - Chilean Peso * `CLF` - Chilean Unit of Account (UF) * `CNX` - Chinese People’s Bank Dollar * `CNY` - Chinese Yuan * `CNH` - Chinese Yuan (offshore) * `COP` - Colombian Peso * `COU` - Colombian Real Value Unit * `KMF` - Comorian Franc * `CDF` - Congolese Franc * `CRC` - Costa Rican Colón * `HRD` - Croatian Dinar * `HRK` - Croatian Kuna * `CUC` - Cuban Convertible Peso * `CUP` - Cuban Peso * `CYP` - Cypriot Pound * `CZK` - Czech Koruna * `CSK` - Czechoslovak Hard Koruna * `DKK` - Danish Krone * `DJF` - Djiboutian Franc * `DOP` - Dominican Peso * `NLG` - Dutch Guilder * `XCD` - East Caribbean Dollar * `DDM` - East German Mark * `ECS` - Ecuadorian Sucre * `ECV` - Ecuadorian Unit of Constant Value * `EGP` - Egyptian Pound * `GQE` - Equatorial Guinean Ekwele * `ERN` - Eritrean Nakfa * `EEK` - Estonian Kroon * `ETB` - Ethiopian Birr * `EUR` - Euro * `XBA` - European Composite Unit * `XEU` - European Currency Unit * `XBB` - European Monetary Unit * `XBC` - European Unit of Account (XBC) * `XBD` - European Unit of Account (XBD) * `FKP` - Falkland Islands Pound * `FJD` - Fijian Dollar * `FIM` - Finnish Markka * `FRF` - French Franc * `XFO` - French Gold Franc * `XFU` - French UIC-Franc * `GMD` - Gambian Dalasi * `GEK` - Georgian Kupon Larit * `GEL` - Georgian Lari * `DEM` - German Mark * `GHS` - Ghanaian Cedi * `GHC` - Ghanaian Cedi (1979–2007) * `GIP` - Gibraltar Pound * `XAU` - Gold * `GRD` - Greek Drachma * `GTQ` - Guatemalan Quetzal * `GWP` - Guinea-Bissau Peso * `GNF` - Guinean Franc * `GNS` - Guinean Syli * `GYD` - Guyanaese Dollar * `HTG` - Haitian Gourde * `HNL` - Honduran Lempira * `HKD` - Hong Kong Dollar * `HUF` - Hungarian Forint * `IMP` - IMP * `ISK` - Icelandic Króna * `ISJ` - Icelandic Króna (1918–1981) * `INR` - Indian Rupee * `IDR` - Indonesian Rupiah * `IRR` - Iranian Rial * `IQD` - Iraqi Dinar * `IEP` - Irish Pound * `ILS` - Israeli New Shekel * `ILP` - Israeli Pound * `ILR` - Israeli Shekel (1980–1985) * `ITL` - Italian Lira * `JMD` - Jamaican Dollar * `JPY` - Japanese Yen * `JOD` - Jordanian Dinar * `KZT` - Kazakhstani Tenge * `KES` - Kenyan Shilling * `KWD` - Kuwaiti Dinar * `KGS` - Kyrgystani Som * `LAK` - Laotian Kip * `LVL` - Latvian Lats * `LVR` - Latvian Ruble * `LBP` - Lebanese Pound * `LSL` - Lesotho Loti * `LRD` - Liberian Dollar * `LYD` - Libyan Dinar * `LTL` - Lithuanian Litas * `LTT` - Lithuanian Talonas * `LUL` - Luxembourg Financial Franc * `LUC` - Luxembourgian Convertible Franc * `LUF` - Luxembourgian Franc * `MOP` - Macanese Pataca * `MKD` - Macedonian Denar * `MKN` - Macedonian Denar (1992–1993) * `MGA` - Malagasy Ariary * `MGF` - Malagasy Franc * `MWK` - Malawian Kwacha * `MYR` - Malaysian Ringgit * `MVR` - Maldivian Rufiyaa * `MVP` - Maldivian Rupee (1947–1981) * `MLF` - Malian Franc * `MTL` - Maltese Lira * `MTP` - Maltese Pound * `MRU` - Mauritanian Ouguiya * `MRO` - Mauritanian Ouguiya (1973–2017) * `MUR` - Mauritian Rupee * `MXV` - Mexican Investment Unit * `MXN` - Mexican Peso * `MXP` - Mexican Silver Peso (1861–1992) * `MDC` - Moldovan Cupon * `MDL` - Moldovan Leu * `MCF` - Monegasque Franc * `MNT` - Mongolian Tugrik * `MAD` - Moroccan Dirham * `MAF` - Moroccan Franc * `MZE` - Mozambican Escudo * `MZN` - Mozambican Metical * `MZM` - Mozambican Metical (1980–2006) * `MMK` - Myanmar Kyat * `NAD` - Namibian Dollar * `NPR` - Nepalese Rupee * `ANG` - Netherlands Antillean Guilder * `TWD` - New Taiwan Dollar * `NZD` - New Zealand Dollar * `NIO` - Nicaraguan Córdoba * `NIC` - Nicaraguan Córdoba (1988–1991) * `NGN` - Nigerian Naira * `KPW` - North Korean Won * `NOK` - Norwegian Krone * `OMR` - Omani Rial * `PKR` - Pakistani Rupee * `XPD` - Palladium * `PAB` - Panamanian Balboa * `PGK` - Papua New Guinean Kina * `PYG` - Paraguayan Guarani * `PEI` - Peruvian Inti * `PEN` - Peruvian Sol * `PES` - Peruvian Sol (1863–1965) * `PHP` - Philippine Peso * `XPT` - Platinum * `PLN` - Polish Zloty * `PLZ` - Polish Zloty (1950–1995) * `PTE` - Portuguese Escudo * `GWE` - Portuguese Guinea Escudo * `QAR` - Qatari Rial * `XRE` - RINET Funds * `RHD` - Rhodesian Dollar * `RON` - Romanian Leu * `ROL` - Romanian Leu (1952–2006) * `RUB` - Russian Ruble * `RUR` - Russian Ruble (1991–1998) * `RWF` - Rwandan Franc * `SVC` - Salvadoran Colón * `WST` - Samoan Tala * `SAR` - Saudi Riyal * `RSD` - Serbian Dinar * `CSD` - Serbian Dinar (2002–2006) * `SCR` - Seychellois Rupee * `SLL` - Sierra Leonean Leone * `XAG` - Silver * `SGD` - Singapore Dollar * `SKK` - Slovak Koruna * `SIT` - Slovenian Tolar * `SBD` - Solomon Islands Dollar * `SOS` - Somali Shilling * `ZAR` - South African Rand * `ZAL` - South African Rand (financial) * `KRH` - South Korean Hwan (1953–1962) * `KRW` - South Korean Won * `KRO` - South Korean Won (1945–1953) * `SSP` - South Sudanese Pound * `SUR` - Soviet Rouble * `ESP` - Spanish Peseta * `ESA` - Spanish Peseta (A account) * `ESB` - Spanish Peseta (convertible account) * `XDR` - Special Drawing Rights * `LKR` - Sri Lankan Rupee * `SHP` - St. Helena Pound * `XSU` - Sucre * `SDD` - Sudanese Dinar (1992–2007) * `SDG` - Sudanese Pound * `SDP` - Sudanese Pound (1957–1998) * `SRD` - Surinamese Dollar * `SRG` - Surinamese Guilder * `SZL` - Swazi Lilangeni * `SEK` - Swedish Krona * `CHF` - Swiss Franc * `SYP` - Syrian Pound * `STN` - São Tomé & Príncipe Dobra * `STD` - São Tomé & Príncipe Dobra (1977–2017) * `TVD` - TVD * `TJR` - Tajikistani Ruble * `TJS` - Tajikistani Somoni * `TZS` - Tanzanian Shilling * `XTS` - Testing Currency Code * `THB` - Thai Baht * `XXX` - The codes assigned for transactions where no currency is involved * `TPE` - Timorese Escudo * `TOP` - Tongan Paʻanga * `TTD` - Trinidad & Tobago Dollar * `TND` - Tunisian Dinar * `TRY` - Turkish Lira * `TRL` - Turkish Lira (1922–2005) * `TMT` - Turkmenistani Manat * `TMM` - Turkmenistani Manat (1993–2009) * `USD` - US Dollar * `USN` - US Dollar (Next day) * `USS` - US Dollar (Same day) * `UGX` - Ugandan Shilling * `UGS` - Ugandan Shilling (1966–1987) * `UAH` - Ukrainian Hryvnia * `UAK` - Ukrainian Karbovanets * `AED` - United Arab Emirates Dirham * `UYW` - Uruguayan Nominal Wage Index Unit * `UYU` - Uruguayan Peso * `UYP` - Uruguayan Peso (1975–1993) * `UYI` - Uruguayan Peso (Indexed Units) * `UZS` - Uzbekistani Som * `VUV` - Vanuatu Vatu * `VES` - Venezuelan Bolívar * `VEB` - Venezuelan Bolívar (1871–2008) * `VEF` - Venezuelan Bolívar (2008–2018) * `VND` - Vietnamese Dong * `VNN` - Vietnamese Dong (1978–1985) * `CHE` - WIR Euro * `CHW` - WIR Franc * `XOF` - West African CFA Franc * `YDD` - Yemeni Dinar * `YER` - Yemeni Rial * `YUN` - Yugoslavian Convertible Dinar (1990–1992) * `YUD` - Yugoslavian Hard Dinar (1966–1990) * `YUM` - Yugoslavian New Dinar (1994–2002) * `YUR` - Yugoslavian Reformed Dinar (1992–1993) * `ZWN` - ZWN * `ZRN` - Zairean New Zaire (1993–1998) * `ZRZ` - Zairean Zaire (1971–1993) * `ZMW` - Zambian Kwacha * `ZMK` - Zambian Kwacha (1968–2012) * `ZWD` - Zimbabwean Dollar (1980–2008) * `ZWR` - Zimbabwean Dollar (2008) * `ZWL` - Zimbabwean Dollar (2009) | [optional] |
|
11
|
+
| **company** | **String** | The company the income statement belongs to. | [optional] |
|
12
12
|
| **start_period** | **Time** | The income statement's start period. | [optional] |
|
13
13
|
| **end_period** | **Time** | The income statement's end period. | [optional] |
|
14
14
|
| **income** | [**Array<ReportItem>**](ReportItem.md) | | [optional][readonly] |
|
15
15
|
| **cost_of_sales** | [**Array<ReportItem>**](ReportItem.md) | | [optional][readonly] |
|
16
|
-
| **gross_profit** | **Float** | The
|
16
|
+
| **gross_profit** | **Float** | The revenue minus the cost of sale. | [optional] |
|
17
17
|
| **operating_expenses** | [**Array<ReportItem>**](ReportItem.md) | | [optional][readonly] |
|
18
|
-
| **net_operating_income** | **Float** | The
|
18
|
+
| **net_operating_income** | **Float** | The revenue minus the operating expenses. | [optional] |
|
19
19
|
| **non_operating_expenses** | [**Array<ReportItem>**](ReportItem.md) | | [optional][readonly] |
|
20
|
-
| **net_income** | **Float** | The
|
20
|
+
| **net_income** | **Float** | The gross profit minus the total expenses. | [optional] |
|
21
21
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
22
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
23
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
22
24
|
|
23
25
|
## Example
|
24
26
|
|
@@ -28,19 +30,21 @@ require 'merge_accounting_client'
|
|
28
30
|
instance = MergeAccountingClient::IncomeStatement.new(
|
29
31
|
id: 0958cbc6-6040-430a-848e-aafacbadf4ae,
|
30
32
|
remote_id: 1342348,
|
31
|
-
remote_data: [{"path":"/actions","data":["Varies by platform"]}],
|
32
33
|
name: IncomeStatement,
|
33
34
|
currency: USD,
|
35
|
+
company: 595c8f97-2ac4-45b7-b000-41bdf43240b5,
|
34
36
|
start_period: null,
|
35
37
|
end_period: null,
|
36
|
-
income: [{"remote_id":"10299","name":"Total Income","value":325.0,"sub_items":[{"remote_id":"10200","name":"Landscaping Services","value":425,"sub_items":
|
37
|
-
cost_of_sales: [{"remote_id":"10299","name":"Total COGS","value":25.0,"sub_items":[{"remote_id":"10200","name":"Supplies","value":10,"sub_items":
|
38
|
+
income: [{"remote_id":"10299","name":"Total Income","value":325.0,"sub_items":[{"remote_id":"10200","name":"Landscaping Services","value":425,"sub_items":[]},{"remote_id":"10201","name":"Pest Control Services","value":-100,"sub_items":[]}]}],
|
39
|
+
cost_of_sales: [{"remote_id":"10299","name":"Total COGS","value":25.0,"sub_items":[{"remote_id":"10200","name":"Supplies","value":10,"sub_items":[]}]}],
|
38
40
|
gross_profit: 300.0,
|
39
|
-
operating_expenses: [{"remote_id":"10299","name":"Total Operating Expenses","value":100.0,"sub_items":
|
41
|
+
operating_expenses: [{"remote_id":"10299","name":"Total Operating Expenses","value":100.0,"sub_items":[]}],
|
40
42
|
net_operating_income: 200.0,
|
41
|
-
non_operating_expenses: [{"remote_id":"10299","name":"Total Non-Operating Expenses","value":100.0,"sub_items":
|
43
|
+
non_operating_expenses: [{"remote_id":"10299","name":"Total Non-Operating Expenses","value":100.0,"sub_items":[]}],
|
42
44
|
net_income: 100.0,
|
43
|
-
remote_was_deleted: null
|
45
|
+
remote_was_deleted: null,
|
46
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
47
|
+
remote_data: [{"path":"/actions","data":["Varies by platform"]}]
|
44
48
|
)
|
45
49
|
```
|
46
50
|
|
data/docs/IncomeStatementsApi.md
CHANGED
@@ -32,6 +32,7 @@ end
|
|
32
32
|
api_instance = MergeAccountingClient::IncomeStatementsApi.new
|
33
33
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
34
34
|
opts = {
|
35
|
+
company_id: 'company_id_example', # String | If provided, will only return income statements for this company.
|
35
36
|
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
36
37
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
37
38
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
@@ -75,6 +76,7 @@ end
|
|
75
76
|
| Name | Type | Description | Notes |
|
76
77
|
| ---- | ---- | ----------- | ----- |
|
77
78
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
79
|
+
| **company_id** | **String** | If provided, will only return income statements for this company. | [optional] |
|
78
80
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
79
81
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
80
82
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
data/docs/Invoice.md
CHANGED
@@ -4,26 +4,29 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **
|
8
|
-
| **
|
9
|
-
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
10
|
-
| **type** | [**InvoiceTypeEnum**](InvoiceTypeEnum.md) | The invoice's type. | [optional] |
|
11
|
-
| **contact** | **String** | | [optional] |
|
7
|
+
| **type** | [**InvoiceTypeEnum**](InvoiceTypeEnum.md) | Whether the invoice is an accounts receivable or accounts payable. Accounts payable invoices are commonly referred to as Bills. * `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE * `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE | [optional] |
|
8
|
+
| **contact** | **String** | The invoice's contact. | [optional] |
|
12
9
|
| **number** | **String** | The invoice's number. | [optional] |
|
13
10
|
| **issue_date** | **Time** | The invoice's issue date. | [optional] |
|
14
11
|
| **due_date** | **Time** | The invoice's due date. | [optional] |
|
15
12
|
| **paid_on_date** | **Time** | The invoice's paid date. | [optional] |
|
16
13
|
| **memo** | **String** | The invoice's private note. | [optional] |
|
17
|
-
| **
|
18
|
-
| **total_discount** | **Float** | The invoice's total discount. | [optional] |
|
19
|
-
| **
|
20
|
-
| **
|
14
|
+
| **company** | **String** | The company the invoice belongs to. | [optional] |
|
15
|
+
| **currency** | [**CurrencyEnum**](CurrencyEnum.md) | The invoice's currency. * `XUA` - ADB Unit of Account * `AFN` - Afghan Afghani * `AFA` - Afghan Afghani (1927–2002) * `ALL` - Albanian Lek * `ALK` - Albanian Lek (1946–1965) * `DZD` - Algerian Dinar * `ADP` - Andorran Peseta * `AOA` - Angolan Kwanza * `AOK` - Angolan Kwanza (1977–1991) * `AON` - Angolan New Kwanza (1990–2000) * `AOR` - Angolan Readjusted Kwanza (1995–1999) * `ARA` - Argentine Austral * `ARS` - Argentine Peso * `ARM` - Argentine Peso (1881–1970) * `ARP` - Argentine Peso (1983–1985) * `ARL` - Argentine Peso Ley (1970–1983) * `AMD` - Armenian Dram * `AWG` - Aruban Florin * `AUD` - Australian Dollar * `ATS` - Austrian Schilling * `AZN` - Azerbaijani Manat * `AZM` - Azerbaijani Manat (1993–2006) * `BSD` - Bahamian Dollar * `BHD` - Bahraini Dinar * `BDT` - Bangladeshi Taka * `BBD` - Barbadian Dollar * `BYN` - Belarusian Ruble * `BYB` - Belarusian Ruble (1994–1999) * `BYR` - Belarusian Ruble (2000–2016) * `BEF` - Belgian Franc * `BEC` - Belgian Franc (convertible) * `BEL` - Belgian Franc (financial) * `BZD` - Belize Dollar * `BMD` - Bermudan Dollar * `BTN` - Bhutanese Ngultrum * `BOB` - Bolivian Boliviano * `BOL` - Bolivian Boliviano (1863–1963) * `BOV` - Bolivian Mvdol * `BOP` - Bolivian Peso * `BAM` - Bosnia-Herzegovina Convertible Mark * `BAD` - Bosnia-Herzegovina Dinar (1992–1994) * `BAN` - Bosnia-Herzegovina New Dinar (1994–1997) * `BWP` - Botswanan Pula * `BRC` - Brazilian Cruzado (1986–1989) * `BRZ` - Brazilian Cruzeiro (1942–1967) * `BRE` - Brazilian Cruzeiro (1990–1993) * `BRR` - Brazilian Cruzeiro (1993–1994) * `BRN` - Brazilian New Cruzado (1989–1990) * `BRB` - Brazilian New Cruzeiro (1967–1986) * `BRL` - Brazilian Real * `GBP` - British Pound * `BND` - Brunei Dollar * `BGL` - Bulgarian Hard Lev * `BGN` - Bulgarian Lev * `BGO` - Bulgarian Lev (1879–1952) * `BGM` - Bulgarian Socialist Lev * `BUK` - Burmese Kyat * `BIF` - Burundian Franc * `XPF` - CFP Franc * `KHR` - Cambodian Riel * `CAD` - Canadian Dollar * `CVE` - Cape Verdean Escudo * `KYD` - Cayman Islands Dollar * `XAF` - Central African CFA Franc * `CLE` - Chilean Escudo * `CLP` - Chilean Peso * `CLF` - Chilean Unit of Account (UF) * `CNX` - Chinese People’s Bank Dollar * `CNY` - Chinese Yuan * `CNH` - Chinese Yuan (offshore) * `COP` - Colombian Peso * `COU` - Colombian Real Value Unit * `KMF` - Comorian Franc * `CDF` - Congolese Franc * `CRC` - Costa Rican Colón * `HRD` - Croatian Dinar * `HRK` - Croatian Kuna * `CUC` - Cuban Convertible Peso * `CUP` - Cuban Peso * `CYP` - Cypriot Pound * `CZK` - Czech Koruna * `CSK` - Czechoslovak Hard Koruna * `DKK` - Danish Krone * `DJF` - Djiboutian Franc * `DOP` - Dominican Peso * `NLG` - Dutch Guilder * `XCD` - East Caribbean Dollar * `DDM` - East German Mark * `ECS` - Ecuadorian Sucre * `ECV` - Ecuadorian Unit of Constant Value * `EGP` - Egyptian Pound * `GQE` - Equatorial Guinean Ekwele * `ERN` - Eritrean Nakfa * `EEK` - Estonian Kroon * `ETB` - Ethiopian Birr * `EUR` - Euro * `XBA` - European Composite Unit * `XEU` - European Currency Unit * `XBB` - European Monetary Unit * `XBC` - European Unit of Account (XBC) * `XBD` - European Unit of Account (XBD) * `FKP` - Falkland Islands Pound * `FJD` - Fijian Dollar * `FIM` - Finnish Markka * `FRF` - French Franc * `XFO` - French Gold Franc * `XFU` - French UIC-Franc * `GMD` - Gambian Dalasi * `GEK` - Georgian Kupon Larit * `GEL` - Georgian Lari * `DEM` - German Mark * `GHS` - Ghanaian Cedi * `GHC` - Ghanaian Cedi (1979–2007) * `GIP` - Gibraltar Pound * `XAU` - Gold * `GRD` - Greek Drachma * `GTQ` - Guatemalan Quetzal * `GWP` - Guinea-Bissau Peso * `GNF` - Guinean Franc * `GNS` - Guinean Syli * `GYD` - Guyanaese Dollar * `HTG` - Haitian Gourde * `HNL` - Honduran Lempira * `HKD` - Hong Kong Dollar * `HUF` - Hungarian Forint * `IMP` - IMP * `ISK` - Icelandic Króna * `ISJ` - Icelandic Króna (1918–1981) * `INR` - Indian Rupee * `IDR` - Indonesian Rupiah * `IRR` - Iranian Rial * `IQD` - Iraqi Dinar * `IEP` - Irish Pound * `ILS` - Israeli New Shekel * `ILP` - Israeli Pound * `ILR` - Israeli Shekel (1980–1985) * `ITL` - Italian Lira * `JMD` - Jamaican Dollar * `JPY` - Japanese Yen * `JOD` - Jordanian Dinar * `KZT` - Kazakhstani Tenge * `KES` - Kenyan Shilling * `KWD` - Kuwaiti Dinar * `KGS` - Kyrgystani Som * `LAK` - Laotian Kip * `LVL` - Latvian Lats * `LVR` - Latvian Ruble * `LBP` - Lebanese Pound * `LSL` - Lesotho Loti * `LRD` - Liberian Dollar * `LYD` - Libyan Dinar * `LTL` - Lithuanian Litas * `LTT` - Lithuanian Talonas * `LUL` - Luxembourg Financial Franc * `LUC` - Luxembourgian Convertible Franc * `LUF` - Luxembourgian Franc * `MOP` - Macanese Pataca * `MKD` - Macedonian Denar * `MKN` - Macedonian Denar (1992–1993) * `MGA` - Malagasy Ariary * `MGF` - Malagasy Franc * `MWK` - Malawian Kwacha * `MYR` - Malaysian Ringgit * `MVR` - Maldivian Rufiyaa * `MVP` - Maldivian Rupee (1947–1981) * `MLF` - Malian Franc * `MTL` - Maltese Lira * `MTP` - Maltese Pound * `MRU` - Mauritanian Ouguiya * `MRO` - Mauritanian Ouguiya (1973–2017) * `MUR` - Mauritian Rupee * `MXV` - Mexican Investment Unit * `MXN` - Mexican Peso * `MXP` - Mexican Silver Peso (1861–1992) * `MDC` - Moldovan Cupon * `MDL` - Moldovan Leu * `MCF` - Monegasque Franc * `MNT` - Mongolian Tugrik * `MAD` - Moroccan Dirham * `MAF` - Moroccan Franc * `MZE` - Mozambican Escudo * `MZN` - Mozambican Metical * `MZM` - Mozambican Metical (1980–2006) * `MMK` - Myanmar Kyat * `NAD` - Namibian Dollar * `NPR` - Nepalese Rupee * `ANG` - Netherlands Antillean Guilder * `TWD` - New Taiwan Dollar * `NZD` - New Zealand Dollar * `NIO` - Nicaraguan Córdoba * `NIC` - Nicaraguan Córdoba (1988–1991) * `NGN` - Nigerian Naira * `KPW` - North Korean Won * `NOK` - Norwegian Krone * `OMR` - Omani Rial * `PKR` - Pakistani Rupee * `XPD` - Palladium * `PAB` - Panamanian Balboa * `PGK` - Papua New Guinean Kina * `PYG` - Paraguayan Guarani * `PEI` - Peruvian Inti * `PEN` - Peruvian Sol * `PES` - Peruvian Sol (1863–1965) * `PHP` - Philippine Peso * `XPT` - Platinum * `PLN` - Polish Zloty * `PLZ` - Polish Zloty (1950–1995) * `PTE` - Portuguese Escudo * `GWE` - Portuguese Guinea Escudo * `QAR` - Qatari Rial * `XRE` - RINET Funds * `RHD` - Rhodesian Dollar * `RON` - Romanian Leu * `ROL` - Romanian Leu (1952–2006) * `RUB` - Russian Ruble * `RUR` - Russian Ruble (1991–1998) * `RWF` - Rwandan Franc * `SVC` - Salvadoran Colón * `WST` - Samoan Tala * `SAR` - Saudi Riyal * `RSD` - Serbian Dinar * `CSD` - Serbian Dinar (2002–2006) * `SCR` - Seychellois Rupee * `SLL` - Sierra Leonean Leone * `XAG` - Silver * `SGD` - Singapore Dollar * `SKK` - Slovak Koruna * `SIT` - Slovenian Tolar * `SBD` - Solomon Islands Dollar * `SOS` - Somali Shilling * `ZAR` - South African Rand * `ZAL` - South African Rand (financial) * `KRH` - South Korean Hwan (1953–1962) * `KRW` - South Korean Won * `KRO` - South Korean Won (1945–1953) * `SSP` - South Sudanese Pound * `SUR` - Soviet Rouble * `ESP` - Spanish Peseta * `ESA` - Spanish Peseta (A account) * `ESB` - Spanish Peseta (convertible account) * `XDR` - Special Drawing Rights * `LKR` - Sri Lankan Rupee * `SHP` - St. Helena Pound * `XSU` - Sucre * `SDD` - Sudanese Dinar (1992–2007) * `SDG` - Sudanese Pound * `SDP` - Sudanese Pound (1957–1998) * `SRD` - Surinamese Dollar * `SRG` - Surinamese Guilder * `SZL` - Swazi Lilangeni * `SEK` - Swedish Krona * `CHF` - Swiss Franc * `SYP` - Syrian Pound * `STN` - São Tomé & Príncipe Dobra * `STD` - São Tomé & Príncipe Dobra (1977–2017) * `TVD` - TVD * `TJR` - Tajikistani Ruble * `TJS` - Tajikistani Somoni * `TZS` - Tanzanian Shilling * `XTS` - Testing Currency Code * `THB` - Thai Baht * `XXX` - The codes assigned for transactions where no currency is involved * `TPE` - Timorese Escudo * `TOP` - Tongan Paʻanga * `TTD` - Trinidad & Tobago Dollar * `TND` - Tunisian Dinar * `TRY` - Turkish Lira * `TRL` - Turkish Lira (1922–2005) * `TMT` - Turkmenistani Manat * `TMM` - Turkmenistani Manat (1993–2009) * `USD` - US Dollar * `USN` - US Dollar (Next day) * `USS` - US Dollar (Same day) * `UGX` - Ugandan Shilling * `UGS` - Ugandan Shilling (1966–1987) * `UAH` - Ukrainian Hryvnia * `UAK` - Ukrainian Karbovanets * `AED` - United Arab Emirates Dirham * `UYW` - Uruguayan Nominal Wage Index Unit * `UYU` - Uruguayan Peso * `UYP` - Uruguayan Peso (1975–1993) * `UYI` - Uruguayan Peso (Indexed Units) * `UZS` - Uzbekistani Som * `VUV` - Vanuatu Vatu * `VES` - Venezuelan Bolívar * `VEB` - Venezuelan Bolívar (1871–2008) * `VEF` - Venezuelan Bolívar (2008–2018) * `VND` - Vietnamese Dong * `VNN` - Vietnamese Dong (1978–1985) * `CHE` - WIR Euro * `CHW` - WIR Franc * `XOF` - West African CFA Franc * `YDD` - Yemeni Dinar * `YER` - Yemeni Rial * `YUN` - Yugoslavian Convertible Dinar (1990–1992) * `YUD` - Yugoslavian Hard Dinar (1966–1990) * `YUM` - Yugoslavian New Dinar (1994–2002) * `YUR` - Yugoslavian Reformed Dinar (1992–1993) * `ZWN` - ZWN * `ZRN` - Zairean New Zaire (1993–1998) * `ZRZ` - Zairean Zaire (1971–1993) * `ZMW` - Zambian Kwacha * `ZMK` - Zambian Kwacha (1968–2012) * `ZWD` - Zimbabwean Dollar (1980–2008) * `ZWR` - Zimbabwean Dollar (2008) * `ZWL` - Zimbabwean Dollar (2009) | [optional] |
|
16
|
+
| **exchange_rate** | **String** | The invoice's exchange rate. | [optional] |
|
17
|
+
| **total_discount** | **Float** | The total discounts applied to the total cost. | [optional] |
|
18
|
+
| **sub_total** | **Float** | The total amount being paid before taxes. | [optional] |
|
19
|
+
| **total_tax_amount** | **Float** | The total amount being paid in taxes. | [optional] |
|
21
20
|
| **total_amount** | **Float** | The invoice's total amount. | [optional] |
|
22
21
|
| **balance** | **Float** | The invoice's remaining balance. | [optional] |
|
23
22
|
| **remote_updated_at** | **Time** | When the third party's invoice entry was updated. | [optional] |
|
24
23
|
| **payments** | **Array<String>** | Array of `Payment` object IDs. | [optional] |
|
25
|
-
| **line_items** | [**Array<InvoiceLineItem>**](InvoiceLineItem.md) | | [optional]
|
24
|
+
| **line_items** | [**Array<InvoiceLineItem>**](InvoiceLineItem.md) | | [optional] |
|
26
25
|
| **remote_was_deleted** | **Boolean** | | [optional][readonly] |
|
26
|
+
| **id** | **String** | | [optional][readonly] |
|
27
|
+
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
28
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
29
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
27
30
|
|
28
31
|
## Example
|
29
32
|
|
@@ -31,9 +34,6 @@
|
|
31
34
|
require 'merge_accounting_client'
|
32
35
|
|
33
36
|
instance = MergeAccountingClient::Invoice.new(
|
34
|
-
id: 9871b4a9-f5d2-4f3b-a66b-dfedbed42c46,
|
35
|
-
remote_id: 990110,
|
36
|
-
remote_data: [{"path":"/actions","data":["Varies by platform"]}],
|
37
37
|
type: ACCOUNTS_RECEIVABLE,
|
38
38
|
contact: 022a2bef-57e5-4def-8ed2-7c41bd9a5ed8,
|
39
39
|
number: AIQ12546,
|
@@ -41,7 +41,9 @@ instance = MergeAccountingClient::Invoice.new(
|
|
41
41
|
due_date: 2020-04-15T00:00Z,
|
42
42
|
paid_on_date: 2020-04-01T00:00Z,
|
43
43
|
memo: Weekly Payment,
|
44
|
+
company: 595c8f97-2ac4-45b7-b000-41bdf43240b5,
|
44
45
|
currency: USD,
|
46
|
+
exchange_rate: 2.9,
|
45
47
|
total_discount: null,
|
46
48
|
sub_total: 100,
|
47
49
|
total_tax_amount: 5,
|
@@ -49,8 +51,12 @@ instance = MergeAccountingClient::Invoice.new(
|
|
49
51
|
balance: 105,
|
50
52
|
remote_updated_at: 2020-04-01T00:00Z,
|
51
53
|
payments: ["b26fd49a-cbae-470a-a8f8-bcbc119e0390"],
|
52
|
-
line_items: [{"id":"022a2bef-57e5-4def-8ed2-7c41bd9a5ed8","remote_id":"8765432","description":"Pickleball lessons","unit_price":50.0,"quantity":
|
53
|
-
remote_was_deleted: null
|
54
|
+
line_items: [{"id":"022a2bef-57e5-4def-8ed2-7c41bd9a5ed8","remote_id":"8765432","description":"Pickleball lessons","unit_price":50.0,"quantity":1.0,"total_amount":50.0,"currency":"USD","exchange_rate":"2.9","item":"5b3c1341-a20f-4e51-b72c-f3830a16c97b","account":"cd0f32d4-a493-11ec-b909-0242ac120002","tracking_category":"b38c59b0-a9d7-4740-b1ee-5436c6751e3d","tracking_categories":["b38c59b0-a9d7-4740-b1ee-5436c6751e3d","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],"company":"595c8f97-2ac4-45b7-b000-41bdf43240b5","remote_data":[{"path":"/actions","data":["Varies by platform"]}]}],
|
55
|
+
remote_was_deleted: null,
|
56
|
+
id: 9871b4a9-f5d2-4f3b-a66b-dfedbed42c46,
|
57
|
+
remote_id: 990110,
|
58
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
59
|
+
remote_data: [{"path":"/actions","data":["Varies by platform"]}]
|
54
60
|
)
|
55
61
|
```
|
56
62
|
|