merge_accounting_client 1.0.4 → 1.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +61 -5
- data/docs/Account.md +12 -8
- data/docs/AccountEndpointRequest.md +18 -0
- data/docs/AccountIntegration.md +1 -1
- data/docs/AccountRequest.md +40 -0
- data/docs/AccountResponse.md +24 -0
- data/docs/AccountingAttachment.md +7 -3
- data/docs/AccountingAttachmentEndpointRequest.md +18 -0
- data/docs/AccountingAttachmentRequest.md +26 -0
- data/docs/AccountingAttachmentResponse.md +24 -0
- data/docs/AccountingPhoneNumberRequest.md +24 -0
- data/docs/AccountsApi.md +163 -5
- data/docs/Address.md +5 -3
- data/docs/AddressesApi.md +4 -2
- data/docs/AttachmentsApi.md +154 -0
- data/docs/BalanceSheet.md +11 -7
- data/docs/BalanceSheetsApi.md +2 -0
- data/docs/CashFlowStatement.md +11 -7
- data/docs/CashFlowStatementsApi.md +2 -0
- data/docs/CommonModelScopeData.md +20 -0
- data/docs/CommonModelScopes.md +20 -0
- data/docs/CommonModelScopesApi.md +157 -0
- data/docs/CommonModelScopesBodyRequest.md +22 -0
- data/docs/CommonModelScopesDisabledModels.md +26 -0
- data/docs/CommonModelScopesDisabledModelsEnabledActionsEnum.md +15 -0
- data/docs/CommonModelScopesPostInnerDeserializerRequest.md +22 -0
- data/docs/CommonModelScopesUpdateSerializer.md +18 -0
- data/docs/CompanyInfo.md +6 -4
- data/docs/CompanyInfoApi.md +0 -4
- data/docs/ConditionSchema.md +30 -0
- data/docs/ConditionTypeEnum.md +15 -0
- data/docs/Contact.md +8 -4
- data/docs/ContactEndpointRequest.md +18 -0
- data/docs/ContactRequest.md +40 -0
- data/docs/ContactResponse.md +24 -0
- data/docs/ContactsApi.md +163 -9
- data/docs/CreditNote.md +12 -8
- data/docs/CreditNoteLineItem.md +7 -3
- data/docs/CreditNotesApi.md +15 -9
- data/docs/DataPassthroughRequest.md +1 -1
- data/docs/EnabledActionsEnum.md +15 -0
- data/docs/EndUserDetailsRequest.md +3 -1
- data/docs/Expense.md +18 -12
- data/docs/ExpenseEndpointRequest.md +18 -0
- data/docs/ExpenseLine.md +11 -5
- data/docs/ExpenseLineRequest.md +38 -0
- data/docs/ExpenseRequest.md +38 -0
- data/docs/ExpenseResponse.md +24 -0
- data/docs/ExpensesApi.md +159 -5
- data/docs/IncomeStatement.md +15 -11
- data/docs/IncomeStatementsApi.md +2 -0
- data/docs/Invoice.md +21 -15
- data/docs/InvoiceLineItem.md +15 -5
- data/docs/InvoiceLineItemRequest.md +15 -3
- data/docs/InvoiceRequest.md +17 -11
- data/docs/InvoicesApi.md +16 -10
- data/docs/Issue.md +9 -7
- data/docs/IssuesApi.md +2 -2
- data/docs/Item.md +11 -7
- data/docs/ItemsApi.md +11 -9
- data/docs/JournalEntriesApi.md +7 -5
- data/docs/JournalEntry.md +18 -10
- data/docs/JournalEntryRequest.md +14 -8
- data/docs/JournalLine.md +6 -4
- data/docs/JournalLineRequest.md +10 -4
- data/docs/LinkToken.md +1 -1
- data/docs/LinkedAccountCondition.md +28 -0
- data/docs/LinkedAccountConditionRequest.md +22 -0
- data/docs/LinkedAccountSelectiveSyncConfiguration.md +18 -0
- data/docs/LinkedAccountSelectiveSyncConfigurationListRequest.md +18 -0
- data/docs/LinkedAccountSelectiveSyncConfigurationRequest.md +18 -0
- data/docs/LinkedAccountsApi.md +2 -2
- data/docs/MetaResponse.md +2 -0
- data/docs/MultipartFormFieldRequest.md +1 -1
- data/docs/OperatorSchema.md +20 -0
- data/docs/PaginatedConditionSchemaList.md +22 -0
- data/docs/Payment.md +14 -6
- data/docs/PaymentEndpointRequest.md +18 -0
- data/docs/PaymentRequest.md +34 -0
- data/docs/PaymentResponse.md +24 -0
- data/docs/PaymentsApi.md +159 -5
- data/docs/PostingStatusEnum.md +15 -0
- data/docs/PurchaseOrder.md +19 -13
- data/docs/PurchaseOrderEndpointRequest.md +18 -0
- data/docs/PurchaseOrderLineItem.md +10 -2
- data/docs/PurchaseOrderLineItemRequest.md +44 -0
- data/docs/PurchaseOrderRequest.md +44 -0
- data/docs/PurchaseOrderResponse.md +24 -0
- data/docs/PurchaseOrdersApi.md +167 -9
- data/docs/ReportItem.md +3 -1
- data/docs/SelectiveSyncApi.md +233 -0
- data/docs/SelectiveSyncConfigurationsUsageEnum.md +15 -0
- data/docs/SyncStatus.md +5 -3
- data/docs/TaxRate.md +11 -7
- data/docs/TaxRatesApi.md +2 -0
- data/docs/TrackingCategoriesApi.md +11 -5
- data/docs/TrackingCategory.md +13 -9
- data/docs/Transaction.md +20 -14
- data/docs/TransactionLineItem.md +9 -3
- data/docs/TransactionsApi.md +7 -5
- data/docs/VendorCredit.md +13 -7
- data/docs/VendorCreditLine.md +6 -2
- data/docs/VendorCreditsApi.md +7 -5
- data/lib/merge_accounting_client/api/accounts_api.rb +159 -4
- data/lib/merge_accounting_client/api/addresses_api.rb +9 -2
- data/lib/merge_accounting_client/api/attachments_api.rb +141 -0
- data/lib/merge_accounting_client/api/balance_sheets_api.rb +3 -0
- data/lib/merge_accounting_client/api/cash_flow_statements_api.rb +3 -0
- data/lib/merge_accounting_client/api/common_model_scopes_api.rb +146 -0
- data/lib/merge_accounting_client/api/company_info_api.rb +0 -14
- data/lib/merge_accounting_client/api/contacts_api.rb +159 -18
- data/lib/merge_accounting_client/api/credit_notes_api.rb +27 -18
- data/lib/merge_accounting_client/api/expenses_api.rb +147 -14
- data/lib/merge_accounting_client/api/income_statements_api.rb +3 -0
- data/lib/merge_accounting_client/api/invoices_api.rb +29 -20
- data/lib/merge_accounting_client/api/issues_api.rb +2 -2
- data/lib/merge_accounting_client/api/items_api.rb +21 -18
- data/lib/merge_accounting_client/api/journal_entries_api.rb +9 -14
- data/lib/merge_accounting_client/api/linked_accounts_api.rb +3 -3
- data/lib/merge_accounting_client/api/payments_api.rb +147 -14
- data/lib/merge_accounting_client/api/purchase_orders_api.rb +165 -18
- data/lib/merge_accounting_client/api/selective_sync_api.rb +225 -0
- data/lib/merge_accounting_client/api/tax_rates_api.rb +3 -0
- data/lib/merge_accounting_client/api/tracking_categories_api.rb +21 -4
- data/lib/merge_accounting_client/api/transactions_api.rb +9 -14
- data/lib/merge_accounting_client/api/vendor_credits_api.rb +9 -14
- data/lib/merge_accounting_client/models/account.rb +45 -21
- data/lib/merge_accounting_client/models/account_endpoint_request.rb +223 -0
- data/lib/merge_accounting_client/models/account_integration.rb +1 -1
- data/lib/merge_accounting_client/models/account_request.rb +344 -0
- data/lib/merge_accounting_client/models/account_response.rb +266 -0
- data/lib/merge_accounting_client/models/accounting_attachment.rb +39 -16
- data/lib/merge_accounting_client/models/accounting_attachment_endpoint_request.rb +223 -0
- data/lib/merge_accounting_client/models/accounting_attachment_request.rb +282 -0
- data/lib/merge_accounting_client/models/accounting_attachment_response.rb +266 -0
- data/lib/merge_accounting_client/models/accounting_phone_number_request.rb +256 -0
- data/lib/merge_accounting_client/models/address.rb +16 -5
- data/lib/merge_accounting_client/models/balance_sheet.rb +41 -18
- data/lib/merge_accounting_client/models/cash_flow_statement.rb +41 -18
- data/lib/merge_accounting_client/models/categories_enum.rb +3 -1
- data/lib/merge_accounting_client/models/category_enum.rb +3 -1
- data/lib/merge_accounting_client/models/common_model_scope_data.rb +234 -0
- data/lib/merge_accounting_client/models/common_model_scopes.rb +234 -0
- data/lib/merge_accounting_client/models/common_model_scopes_body_request.rb +274 -0
- data/lib/merge_accounting_client/models/common_model_scopes_disabled_models.rb +283 -0
- data/lib/merge_accounting_client/models/common_model_scopes_disabled_models_enabled_actions_enum.rb +45 -0
- data/lib/merge_accounting_client/models/common_model_scopes_post_inner_deserializer_request.rb +274 -0
- data/lib/merge_accounting_client/models/common_model_scopes_update_serializer.rb +226 -0
- data/lib/merge_accounting_client/models/company_info.rb +29 -17
- data/lib/merge_accounting_client/models/condition_schema.rb +298 -0
- data/lib/merge_accounting_client/models/condition_type_enum.rb +50 -0
- data/lib/merge_accounting_client/models/contact.rb +41 -18
- data/lib/merge_accounting_client/models/contact_endpoint_request.rb +223 -0
- data/lib/merge_accounting_client/models/contact_request.rb +346 -0
- data/lib/merge_accounting_client/models/contact_response.rb +266 -0
- data/lib/merge_accounting_client/models/credit_note.rb +43 -20
- data/lib/merge_accounting_client/models/credit_note_line_item.rb +40 -12
- data/lib/merge_accounting_client/models/data_passthrough_request.rb +1 -0
- data/lib/merge_accounting_client/models/enabled_actions_enum.rb +45 -0
- data/lib/merge_accounting_client/models/end_user_details_request.rb +18 -5
- data/lib/merge_accounting_client/models/expense.rb +91 -38
- data/lib/merge_accounting_client/models/expense_endpoint_request.rb +223 -0
- data/lib/merge_accounting_client/models/expense_line.rb +51 -17
- data/lib/merge_accounting_client/models/expense_line_request.rb +332 -0
- data/lib/merge_accounting_client/models/expense_request.rb +350 -0
- data/lib/merge_accounting_client/models/expense_response.rb +266 -0
- data/lib/merge_accounting_client/models/income_statement.rb +44 -21
- data/lib/merge_accounting_client/models/invoice.rb +94 -42
- data/lib/merge_accounting_client/models/invoice_line_item.rb +99 -26
- data/lib/merge_accounting_client/models/invoice_line_item_request.rb +102 -17
- data/lib/merge_accounting_client/models/invoice_request.rb +85 -32
- data/lib/merge_accounting_client/models/issue.rb +15 -4
- data/lib/merge_accounting_client/models/item.rb +44 -19
- data/lib/merge_accounting_client/models/journal_entry.rb +100 -38
- data/lib/merge_accounting_client/models/journal_entry_request.rb +92 -40
- data/lib/merge_accounting_client/models/journal_line.rb +28 -17
- data/lib/merge_accounting_client/models/journal_line_request.rb +52 -17
- data/lib/merge_accounting_client/models/link_token.rb +0 -5
- data/lib/merge_accounting_client/models/linked_account_condition.rb +282 -0
- data/lib/merge_accounting_client/models/linked_account_condition_request.rb +269 -0
- data/lib/merge_accounting_client/models/linked_account_selective_sync_configuration.rb +221 -0
- data/lib/merge_accounting_client/models/linked_account_selective_sync_configuration_list_request.rb +226 -0
- data/lib/merge_accounting_client/models/linked_account_selective_sync_configuration_request.rb +226 -0
- data/lib/merge_accounting_client/models/meta_response.rb +12 -1
- data/lib/merge_accounting_client/models/multipart_form_field_request.rb +1 -1
- data/lib/merge_accounting_client/models/operator_schema.rb +229 -0
- data/lib/merge_accounting_client/models/paginated_condition_schema_list.rb +240 -0
- data/lib/merge_accounting_client/models/payment.rb +82 -18
- data/lib/merge_accounting_client/models/payment_endpoint_request.rb +223 -0
- data/lib/merge_accounting_client/models/payment_request.rb +328 -0
- data/lib/merge_accounting_client/models/payment_response.rb +266 -0
- data/lib/merge_accounting_client/models/posting_status_enum.rb +45 -0
- data/lib/merge_accounting_client/models/purchase_order.rb +92 -41
- data/lib/merge_accounting_client/models/purchase_order_endpoint_request.rb +223 -0
- data/lib/merge_accounting_client/models/purchase_order_line_item.rb +79 -12
- data/lib/merge_accounting_client/models/purchase_order_line_item_request.rb +422 -0
- data/lib/merge_accounting_client/models/purchase_order_request.rb +383 -0
- data/lib/merge_accounting_client/models/purchase_order_response.rb +266 -0
- data/lib/merge_accounting_client/models/report_item.rb +15 -4
- data/lib/merge_accounting_client/models/selective_sync_configurations_usage_enum.rb +45 -0
- data/lib/merge_accounting_client/models/sync_status.rb +13 -4
- data/lib/merge_accounting_client/models/tax_rate.rb +59 -36
- data/lib/merge_accounting_client/models/tracking_category.rb +62 -38
- data/lib/merge_accounting_client/models/transaction.rb +97 -46
- data/lib/merge_accounting_client/models/transaction_line_item.rb +75 -19
- data/lib/merge_accounting_client/models/vendor_credit.rb +70 -18
- data/lib/merge_accounting_client/models/vendor_credit_line.rb +34 -6
- data/lib/merge_accounting_client/version.rb +1 -1
- data/lib/merge_accounting_client.rb +42 -1
- data/spec/api/accounts_api_spec.rb +30 -2
- data/spec/api/addresses_api_spec.rb +2 -1
- data/spec/api/attachments_api_spec.rb +26 -0
- data/spec/api/balance_sheets_api_spec.rb +1 -0
- data/spec/api/cash_flow_statements_api_spec.rb +1 -0
- data/spec/api/common_model_scopes_api_spec.rb +58 -0
- data/spec/api/company_info_api_spec.rb +0 -2
- data/spec/api/contacts_api_spec.rb +30 -4
- data/spec/api/credit_notes_api_spec.rb +7 -4
- data/spec/api/expenses_api_spec.rb +28 -2
- data/spec/api/income_statements_api_spec.rb +1 -0
- data/spec/api/invoices_api_spec.rb +8 -5
- data/spec/api/issues_api_spec.rb +1 -1
- data/spec/api/items_api_spec.rb +5 -4
- data/spec/api/journal_entries_api_spec.rb +3 -2
- data/spec/api/linked_accounts_api_spec.rb +1 -1
- data/spec/api/payments_api_spec.rb +28 -2
- data/spec/api/purchase_orders_api_spec.rb +32 -4
- data/spec/api/selective_sync_api_spec.rb +72 -0
- data/spec/api/tax_rates_api_spec.rb +1 -0
- data/spec/api/tracking_categories_api_spec.rb +5 -2
- data/spec/api/transactions_api_spec.rb +3 -2
- data/spec/api/vendor_credits_api_spec.rb +3 -2
- data/spec/models/account_endpoint_request_spec.rb +34 -0
- data/spec/models/account_request_spec.rb +100 -0
- data/spec/models/account_response_spec.rb +52 -0
- data/spec/models/account_spec.rb +18 -6
- data/spec/models/accounting_attachment_endpoint_request_spec.rb +34 -0
- data/spec/models/accounting_attachment_request_spec.rb +58 -0
- data/spec/models/accounting_attachment_response_spec.rb +52 -0
- data/spec/models/accounting_attachment_spec.rb +15 -3
- data/spec/models/accounting_phone_number_request_spec.rb +52 -0
- data/spec/models/address_spec.rb +6 -0
- data/spec/models/balance_sheet_spec.rb +15 -3
- data/spec/models/cash_flow_statement_spec.rb +15 -3
- data/spec/models/common_model_scope_data_spec.rb +40 -0
- data/spec/models/common_model_scopes_body_request_spec.rb +46 -0
- data/spec/models/common_model_scopes_disabled_models_enabled_actions_enum_spec.rb +28 -0
- data/spec/models/common_model_scopes_disabled_models_spec.rb +58 -0
- data/spec/models/common_model_scopes_post_inner_deserializer_request_spec.rb +46 -0
- data/spec/models/common_model_scopes_spec.rb +40 -0
- data/spec/models/common_model_scopes_update_serializer_spec.rb +34 -0
- data/spec/models/company_info_spec.rb +12 -6
- data/spec/models/condition_schema_spec.rb +70 -0
- data/spec/models/condition_type_enum_spec.rb +28 -0
- data/spec/models/contact_endpoint_request_spec.rb +34 -0
- data/spec/models/contact_request_spec.rb +100 -0
- data/spec/models/contact_response_spec.rb +52 -0
- data/spec/models/contact_spec.rb +18 -6
- data/spec/models/credit_note_line_item_spec.rb +12 -0
- data/spec/models/credit_note_spec.rb +17 -5
- data/spec/models/enabled_actions_enum_spec.rb +28 -0
- data/spec/models/end_user_details_request_spec.rb +6 -0
- data/spec/models/expense_endpoint_request_spec.rb +34 -0
- data/spec/models/expense_line_request_spec.rb +94 -0
- data/spec/models/expense_line_spec.rb +22 -4
- data/spec/models/expense_request_spec.rb +94 -0
- data/spec/models/expense_response_spec.rb +52 -0
- data/spec/models/expense_spec.rb +30 -12
- data/spec/models/income_statement_spec.rb +15 -3
- data/spec/models/invoice_line_item_request_spec.rb +41 -5
- data/spec/models/invoice_line_item_spec.rb +36 -6
- data/spec/models/invoice_request_spec.rb +26 -8
- data/spec/models/invoice_spec.rb +34 -16
- data/spec/models/issue_spec.rb +6 -0
- data/spec/models/item_spec.rb +18 -6
- data/spec/models/journal_entry_request_spec.rb +25 -7
- data/spec/models/journal_entry_spec.rb +35 -11
- data/spec/models/journal_line_request_spec.rb +22 -4
- data/spec/models/journal_line_spec.rb +10 -4
- data/spec/models/linked_account_condition_request_spec.rb +46 -0
- data/spec/models/linked_account_condition_spec.rb +64 -0
- data/spec/models/linked_account_selective_sync_configuration_list_request_spec.rb +34 -0
- data/spec/models/linked_account_selective_sync_configuration_request_spec.rb +34 -0
- data/spec/models/linked_account_selective_sync_configuration_spec.rb +34 -0
- data/spec/models/meta_response_spec.rb +6 -0
- data/spec/models/operator_schema_spec.rb +40 -0
- data/spec/models/paginated_condition_schema_list_spec.rb +46 -0
- data/spec/models/payment_endpoint_request_spec.rb +34 -0
- data/spec/models/payment_request_spec.rb +82 -0
- data/spec/models/payment_response_spec.rb +52 -0
- data/spec/models/payment_spec.rb +28 -4
- data/spec/models/posting_status_enum_spec.rb +28 -0
- data/spec/models/purchase_order_endpoint_request_spec.rb +34 -0
- data/spec/models/purchase_order_line_item_request_spec.rb +112 -0
- data/spec/models/purchase_order_line_item_spec.rb +24 -0
- data/spec/models/purchase_order_request_spec.rb +112 -0
- data/spec/models/purchase_order_response_spec.rb +52 -0
- data/spec/models/purchase_order_spec.rb +34 -16
- data/spec/models/report_item_spec.rb +6 -0
- data/spec/models/selective_sync_configurations_usage_enum_spec.rb +28 -0
- data/spec/models/sync_status_spec.rb +6 -0
- data/spec/models/tax_rate_spec.rb +19 -7
- data/spec/models/tracking_category_spec.rb +20 -8
- data/spec/models/transaction_line_item_spec.rb +19 -1
- data/spec/models/transaction_spec.rb +30 -12
- data/spec/models/vendor_credit_line_spec.rb +12 -0
- data/spec/models/vendor_credit_spec.rb +24 -6
- metadata +283 -115
data/docs/InvoiceLineItem.md
CHANGED
@@ -4,15 +4,20 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **id** | **String** | | [optional][readonly] |
|
8
|
-
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
9
7
|
| **description** | **String** | The line item's description. | [optional] |
|
10
8
|
| **unit_price** | **Float** | The line item's unit price. | [optional] |
|
11
9
|
| **quantity** | **Float** | The line item's quantity. | [optional] |
|
12
10
|
| **total_amount** | **Float** | The line item's total amount. | [optional] |
|
11
|
+
| **currency** | [**CurrencyEnum**](CurrencyEnum.md) | The line item'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 line item's exchange rate. | [optional] |
|
13
13
|
| **item** | **String** | | [optional] |
|
14
14
|
| **account** | **String** | | [optional] |
|
15
15
|
| **tracking_category** | **String** | | [optional] |
|
16
|
+
| **tracking_categories** | **Array<String>** | | [optional] |
|
17
|
+
| **company** | **String** | The company the line item belongs to. | [optional] |
|
18
|
+
| **id** | **String** | | [optional][readonly] |
|
19
|
+
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
20
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
16
21
|
|
17
22
|
## Example
|
18
23
|
|
@@ -20,15 +25,20 @@
|
|
20
25
|
require 'merge_accounting_client'
|
21
26
|
|
22
27
|
instance = MergeAccountingClient::InvoiceLineItem.new(
|
23
|
-
id: 022a2bef-57e5-4def-8ed2-7c41bd9a5ed8,
|
24
|
-
remote_id: 8765432,
|
25
28
|
description: Pickleball lessons,
|
26
29
|
unit_price: 50.0,
|
27
30
|
quantity: 1.0,
|
28
31
|
total_amount: 50.0,
|
32
|
+
currency: USD,
|
33
|
+
exchange_rate: 2.9,
|
29
34
|
item: 5b3c1341-a20f-4e51-b72c-f3830a16c97b,
|
30
35
|
account: cd0f32d4-a493-11ec-b909-0242ac120002,
|
31
|
-
tracking_category: b38c59b0-a9d7-4740-b1ee-5436c6751e3d
|
36
|
+
tracking_category: b38c59b0-a9d7-4740-b1ee-5436c6751e3d,
|
37
|
+
tracking_categories: ["b38c59b0-a9d7-4740-b1ee-5436c6751e3d","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],
|
38
|
+
company: 595c8f97-2ac4-45b7-b000-41bdf43240b5,
|
39
|
+
id: 022a2bef-57e5-4def-8ed2-7c41bd9a5ed8,
|
40
|
+
remote_id: 8765432,
|
41
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}}
|
32
42
|
)
|
33
43
|
```
|
34
44
|
|
@@ -4,14 +4,20 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
8
7
|
| **description** | **String** | The line item's description. | [optional] |
|
9
8
|
| **unit_price** | **Float** | The line item's unit price. | [optional] |
|
10
9
|
| **quantity** | **Float** | The line item's quantity. | [optional] |
|
11
10
|
| **total_amount** | **Float** | The line item's total amount. | [optional] |
|
11
|
+
| **currency** | [**CurrencyEnum**](CurrencyEnum.md) | The line item'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 line item's exchange rate. | [optional] |
|
12
13
|
| **item** | **String** | | [optional] |
|
13
14
|
| **account** | **String** | | [optional] |
|
14
15
|
| **tracking_category** | **String** | | [optional] |
|
16
|
+
| **tracking_categories** | **Array<String>** | | [optional] |
|
17
|
+
| **company** | **String** | The company the line item belongs to. | [optional] |
|
18
|
+
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
19
|
+
| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
20
|
+
| **linked_account_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
15
21
|
|
16
22
|
## Example
|
17
23
|
|
@@ -19,14 +25,20 @@
|
|
19
25
|
require 'merge_accounting_client'
|
20
26
|
|
21
27
|
instance = MergeAccountingClient::InvoiceLineItemRequest.new(
|
22
|
-
remote_id: 8765432,
|
23
28
|
description: Pickleball lessons,
|
24
29
|
unit_price: 50.0,
|
25
30
|
quantity: 1.0,
|
26
31
|
total_amount: 50.0,
|
32
|
+
currency: USD,
|
33
|
+
exchange_rate: 2.9,
|
27
34
|
item: 5b3c1341-a20f-4e51-b72c-f3830a16c97b,
|
28
35
|
account: cd0f32d4-a493-11ec-b909-0242ac120002,
|
29
|
-
tracking_category: b38c59b0-a9d7-4740-b1ee-5436c6751e3d
|
36
|
+
tracking_category: b38c59b0-a9d7-4740-b1ee-5436c6751e3d,
|
37
|
+
tracking_categories: ["b38c59b0-a9d7-4740-b1ee-5436c6751e3d","9b840d2-686a-465a-8a8e-7b028498f8e4","a47e11b6-c73b-4a0c-be31-130fc48177fa"],
|
38
|
+
company: 595c8f97-2ac4-45b7-b000-41bdf43240b5,
|
39
|
+
remote_id: 8765432,
|
40
|
+
integration_params: {"unique_integration_field":"unique_integration_field_value"},
|
41
|
+
linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"}
|
30
42
|
)
|
31
43
|
```
|
32
44
|
|
data/docs/InvoiceRequest.md
CHANGED
@@ -4,22 +4,25 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **
|
8
|
-
| **
|
9
|
-
| **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] |
|
10
9
|
| **number** | **String** | The invoice's number. | [optional] |
|
11
10
|
| **issue_date** | **Time** | The invoice's issue date. | [optional] |
|
12
11
|
| **due_date** | **Time** | The invoice's due date. | [optional] |
|
13
12
|
| **paid_on_date** | **Time** | The invoice's paid date. | [optional] |
|
14
13
|
| **memo** | **String** | The invoice's private note. | [optional] |
|
15
|
-
| **
|
16
|
-
| **total_discount** | **Float** | The invoice's total discount. | [optional] |
|
17
|
-
| **
|
18
|
-
| **
|
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] |
|
19
20
|
| **total_amount** | **Float** | The invoice's total amount. | [optional] |
|
20
21
|
| **balance** | **Float** | The invoice's remaining balance. | [optional] |
|
21
|
-
| **remote_updated_at** | **Time** | When the third party's invoice entry was updated. | [optional] |
|
22
22
|
| **payments** | **Array<String>** | Array of `Payment` object IDs. | [optional] |
|
23
|
+
| **line_items** | [**Array<InvoiceLineItemRequest>**](InvoiceLineItemRequest.md) | | [optional] |
|
24
|
+
| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
25
|
+
| **linked_account_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
23
26
|
|
24
27
|
## Example
|
25
28
|
|
@@ -27,7 +30,6 @@
|
|
27
30
|
require 'merge_accounting_client'
|
28
31
|
|
29
32
|
instance = MergeAccountingClient::InvoiceRequest.new(
|
30
|
-
remote_id: 990110,
|
31
33
|
type: ACCOUNTS_RECEIVABLE,
|
32
34
|
contact: 022a2bef-57e5-4def-8ed2-7c41bd9a5ed8,
|
33
35
|
number: AIQ12546,
|
@@ -35,14 +37,18 @@ instance = MergeAccountingClient::InvoiceRequest.new(
|
|
35
37
|
due_date: 2020-04-15T00:00Z,
|
36
38
|
paid_on_date: 2020-04-01T00:00Z,
|
37
39
|
memo: Weekly Payment,
|
40
|
+
company: 595c8f97-2ac4-45b7-b000-41bdf43240b5,
|
38
41
|
currency: USD,
|
42
|
+
exchange_rate: 2.9,
|
39
43
|
total_discount: null,
|
40
44
|
sub_total: 100,
|
41
45
|
total_tax_amount: 5,
|
42
46
|
total_amount: 105,
|
43
47
|
balance: 105,
|
44
|
-
|
45
|
-
|
48
|
+
payments: ["b26fd49a-cbae-470a-a8f8-bcbc119e0390"],
|
49
|
+
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"]}]}],
|
50
|
+
integration_params: {"unique_integration_field":"unique_integration_field_value"},
|
51
|
+
linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"}
|
46
52
|
)
|
47
53
|
```
|
48
54
|
|
data/docs/InvoicesApi.md
CHANGED
@@ -113,19 +113,22 @@ end
|
|
113
113
|
api_instance = MergeAccountingClient::InvoicesApi.new
|
114
114
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
115
115
|
opts = {
|
116
|
+
company_id: 'company_id_example', # String | If provided, will only return invoices for this company.
|
116
117
|
contact_id: 'contact_id_example', # String | If provided, will only return invoices for this contact.
|
117
118
|
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
118
119
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
119
120
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
120
|
-
expand: 'contact', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
121
121
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
122
122
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
123
|
+
issue_date_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
124
|
+
issue_date_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
123
125
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
124
126
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
125
127
|
page_size: 56, # Integer | Number of results to return per page.
|
126
|
-
remote_fields: 'type', # String |
|
128
|
+
remote_fields: 'type', # String | Deprecated. Use show_enum_origins.
|
127
129
|
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
128
|
-
|
130
|
+
show_enum_origins: 'type', # String | Which fields should be returned in non-normalized form.
|
131
|
+
type: 'ACCOUNTS_PAYABLE' # String | If provided, will only return Invoices with this type * `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE * `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE
|
129
132
|
}
|
130
133
|
|
131
134
|
begin
|
@@ -160,19 +163,22 @@ end
|
|
160
163
|
| Name | Type | Description | Notes |
|
161
164
|
| ---- | ---- | ----------- | ----- |
|
162
165
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
166
|
+
| **company_id** | **String** | If provided, will only return invoices for this company. | [optional] |
|
163
167
|
| **contact_id** | **String** | If provided, will only return invoices for this contact. | [optional] |
|
164
168
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
165
169
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
166
170
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
167
|
-
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
168
171
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
169
172
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
173
|
+
| **issue_date_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
174
|
+
| **issue_date_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
170
175
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
171
176
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
172
177
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
173
|
-
| **remote_fields** | **String** |
|
178
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
174
179
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
175
|
-
| **
|
180
|
+
| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
181
|
+
| **type** | **String** | If provided, will only return Invoices with this type * `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE * `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE | [optional] |
|
176
182
|
|
177
183
|
### Return type
|
178
184
|
|
@@ -284,9 +290,9 @@ api_instance = MergeAccountingClient::InvoicesApi.new
|
|
284
290
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
285
291
|
id = TODO # String |
|
286
292
|
opts = {
|
287
|
-
expand: 'contact', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
288
293
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
289
|
-
remote_fields: 'type' # String |
|
294
|
+
remote_fields: 'type', # String | Deprecated. Use show_enum_origins.
|
295
|
+
show_enum_origins: 'type' # String | Which fields should be returned in non-normalized form.
|
290
296
|
}
|
291
297
|
|
292
298
|
begin
|
@@ -322,9 +328,9 @@ end
|
|
322
328
|
| ---- | ---- | ----------- | ----- |
|
323
329
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
324
330
|
| **id** | [**String**](.md) | | |
|
325
|
-
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
326
331
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
327
|
-
| **remote_fields** | **String** |
|
332
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
333
|
+
| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
328
334
|
|
329
335
|
### Return type
|
330
336
|
|
data/docs/Issue.md
CHANGED
@@ -11,6 +11,7 @@
|
|
11
11
|
| **first_incident_time** | **Time** | | [optional] |
|
12
12
|
| **last_incident_time** | **Time** | | [optional] |
|
13
13
|
| **is_muted** | **Boolean** | | [optional][readonly] |
|
14
|
+
| **error_details** | **Array<String>** | | [optional][readonly] |
|
14
15
|
|
15
16
|
## Example
|
16
17
|
|
@@ -18,13 +19,14 @@
|
|
18
19
|
require 'merge_accounting_client'
|
19
20
|
|
20
21
|
instance = MergeAccountingClient::Issue.new(
|
21
|
-
id:
|
22
|
-
status:
|
23
|
-
error_description:
|
24
|
-
end_user:
|
25
|
-
first_incident_time:
|
26
|
-
last_incident_time:
|
27
|
-
is_muted:
|
22
|
+
id: 3fa85f64-5717-4562-b3fc-2c963f66afa6,
|
23
|
+
status: ONGOING,
|
24
|
+
error_description: string,
|
25
|
+
end_user: b82302de-852e-4e60-b050-edf9da3b7c02,
|
26
|
+
first_incident_time: 2022-12-05T16:19:15.161Z,
|
27
|
+
last_incident_time: 2022-12-05T16:19:15.161Z,
|
28
|
+
is_muted: true,
|
29
|
+
error_details: ["Missing employee permissions.","Missing time off permissions."]
|
28
30
|
)
|
29
31
|
```
|
30
32
|
|
data/docs/IssuesApi.md
CHANGED
@@ -43,7 +43,7 @@ opts = {
|
|
43
43
|
last_incident_time_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was before this datetime.
|
44
44
|
page_size: 56, # Integer | Number of results to return per page.
|
45
45
|
start_date: 'start_date_example', # String | If included, will only include issues whose most recent action occurred after this time
|
46
|
-
status: 'ONGOING' # String |
|
46
|
+
status: 'ONGOING' # String | * `ONGOING` - ONGOING * `RESOLVED` - RESOLVED * `ONGOING` - ONGOING * `RESOLVED` - RESOLVED
|
47
47
|
}
|
48
48
|
|
49
49
|
begin
|
@@ -89,7 +89,7 @@ end
|
|
89
89
|
| **last_incident_time_before** | **Time** | If provided, will only return issues whose first incident time was before this datetime. | [optional] |
|
90
90
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
91
91
|
| **start_date** | **String** | If included, will only include issues whose most recent action occurred after this time | [optional] |
|
92
|
-
| **status** | **String** | | [optional] |
|
92
|
+
| **status** | **String** | * `ONGOING` - ONGOING * `RESOLVED` - RESOLVED * `ONGOING` - ONGOING * `RESOLVED` - RESOLVED | [optional] |
|
93
93
|
|
94
94
|
### Return type
|
95
95
|
|
data/docs/Item.md
CHANGED
@@ -6,15 +6,17 @@
|
|
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 item's name. | [optional] |
|
11
|
-
| **status** | [**Status7d1Enum**](Status7d1Enum.md) | The item's status. | [optional] |
|
10
|
+
| **status** | [**Status7d1Enum**](Status7d1Enum.md) | The item's status. * `ACTIVE` - ACTIVE * `ARCHIVED` - ARCHIVED | [optional] |
|
12
11
|
| **unit_price** | **Float** | The item's unit price. | [optional] |
|
13
|
-
| **purchase_price** | **Float** | The item
|
14
|
-
| **purchase_account** | **String** |
|
15
|
-
| **sales_account** | **String** |
|
12
|
+
| **purchase_price** | **Float** | The price at which the item is purchased from a vendor. | [optional] |
|
13
|
+
| **purchase_account** | **String** | References the default account used to record a purchase of the item. | [optional] |
|
14
|
+
| **sales_account** | **String** | References the default account used to record a sale. | [optional] |
|
15
|
+
| **company** | **String** | The company the item belongs to. | [optional] |
|
16
16
|
| **remote_updated_at** | **Time** | When the third party's item note was updated. | [optional] |
|
17
17
|
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
18
|
+
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
19
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
18
20
|
|
19
21
|
## Example
|
20
22
|
|
@@ -24,15 +26,17 @@ require 'merge_accounting_client'
|
|
24
26
|
instance = MergeAccountingClient::Item.new(
|
25
27
|
id: d2f972d0-2526-434b-9409-4c3b468e08f0,
|
26
28
|
remote_id: 12374,
|
27
|
-
remote_data: [{"path":"/actions","data":["Varies by platform"]}],
|
28
29
|
name: Pickleball Paddle,
|
29
30
|
status: ACTIVE,
|
30
31
|
unit_price: 10.0,
|
31
32
|
purchase_price: 25.0,
|
32
33
|
purchase_account: 9871b4a9-f5d2-4f3b-a66b-dfedbed42c46,
|
33
34
|
sales_account: 3872b4c9-f5d2-4f3b-a66b-dfedbed42c49,
|
35
|
+
company: 595c8f97-2ac4-45b7-b000-41bdf43240b5,
|
34
36
|
remote_updated_at: 2020-03-31T00:00Z,
|
35
|
-
remote_was_deleted: null
|
37
|
+
remote_was_deleted: null,
|
38
|
+
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
39
|
+
remote_data: [{"path":"/actions","data":["Varies by platform"]}]
|
36
40
|
)
|
37
41
|
```
|
38
42
|
|
data/docs/ItemsApi.md
CHANGED
@@ -32,17 +32,18 @@ end
|
|
32
32
|
api_instance = MergeAccountingClient::ItemsApi.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 items 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.
|
38
|
-
expand: 'purchase_account', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
39
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 |
|
45
|
-
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
44
|
+
remote_fields: 'status', # String | Deprecated. Use show_enum_origins.
|
45
|
+
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
46
|
+
show_enum_origins: 'status' # String | Which fields should be returned in non-normalized form.
|
46
47
|
}
|
47
48
|
|
48
49
|
begin
|
@@ -77,17 +78,18 @@ end
|
|
77
78
|
| Name | Type | Description | Notes |
|
78
79
|
| ---- | ---- | ----------- | ----- |
|
79
80
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
81
|
+
| **company_id** | **String** | If provided, will only return items for this company. | [optional] |
|
80
82
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
81
83
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
82
84
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
83
|
-
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
84
85
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
85
86
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
86
87
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
87
88
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
88
89
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
89
|
-
| **remote_fields** | **String** |
|
90
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
90
91
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
92
|
+
| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
91
93
|
|
92
94
|
### Return type
|
93
95
|
|
@@ -128,9 +130,9 @@ api_instance = MergeAccountingClient::ItemsApi.new
|
|
128
130
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
129
131
|
id = TODO # String |
|
130
132
|
opts = {
|
131
|
-
expand: 'purchase_account', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
132
133
|
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 |
|
134
|
+
remote_fields: 'status', # String | Deprecated. Use show_enum_origins.
|
135
|
+
show_enum_origins: 'status' # String | Which fields should be returned in non-normalized form.
|
134
136
|
}
|
135
137
|
|
136
138
|
begin
|
@@ -166,9 +168,9 @@ end
|
|
166
168
|
| ---- | ---- | ----------- | ----- |
|
167
169
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
168
170
|
| **id** | [**String**](.md) | | |
|
169
|
-
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
170
171
|
| **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** |
|
172
|
+
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
173
|
+
| **show_enum_origins** | **String** | Which fields should be returned in non-normalized form. | [optional] |
|
172
174
|
|
173
175
|
### Return type
|
174
176
|
|
data/docs/JournalEntriesApi.md
CHANGED
@@ -113,16 +113,18 @@ end
|
|
113
113
|
api_instance = MergeAccountingClient::JournalEntriesApi.new
|
114
114
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
115
115
|
opts = {
|
116
|
+
company_id: 'company_id_example', # String | If provided, will only return journal entries for this company.
|
116
117
|
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
117
118
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
118
119
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
119
|
-
expand: 'lines', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
120
120
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
121
121
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
122
122
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
123
123
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
124
124
|
page_size: 56, # Integer | Number of results to return per page.
|
125
|
-
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.
|
126
128
|
}
|
127
129
|
|
128
130
|
begin
|
@@ -157,16 +159,18 @@ end
|
|
157
159
|
| Name | Type | Description | Notes |
|
158
160
|
| ---- | ---- | ----------- | ----- |
|
159
161
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
162
|
+
| **company_id** | **String** | If provided, will only return journal entries for this company. | [optional] |
|
160
163
|
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
161
164
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
162
165
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
163
|
-
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
164
166
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
165
167
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
166
168
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
167
169
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
168
170
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
169
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] |
|
170
174
|
|
171
175
|
### Return type
|
172
176
|
|
@@ -278,7 +282,6 @@ api_instance = MergeAccountingClient::JournalEntriesApi.new
|
|
278
282
|
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
279
283
|
id = TODO # String |
|
280
284
|
opts = {
|
281
|
-
expand: 'lines', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
282
285
|
include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
283
286
|
}
|
284
287
|
|
@@ -315,7 +318,6 @@ end
|
|
315
318
|
| ---- | ---- | ----------- | ----- |
|
316
319
|
| **x_account_token** | **String** | Token identifying the end user. | |
|
317
320
|
| **id** | [**String**](.md) | | |
|
318
|
-
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
319
321
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
320
322
|
|
321
323
|
### Return type
|