Class: Merge::Accounting::Expense
- Inherits:
-
Object
- Object
- Merge::Accounting::Expense
- Defined in:
- lib/merge_ruby_client/accounting/types/expense.rb
Overview
# The Expense Object
### Description
The `Expense` object is used to represent a direct purchase by a business,
typically made with a check, credit card, or cash. Each `Expense` object is
dedicated to a grouping of expenses, with each expense recorded in the lines
object.
The `Expense` object is used also used to represent refunds to direct purchases.
Refunds can be distinguished from purchases by the amount sign of the records.
Expense objects with a negative amount are purchases and `Expense` objects with
a positive amount are refunds to those purchases.
### Usage Example
Fetch from the `GET Expense` endpoint and view a company's expense.
Constant Summary collapse
- OMIT =
Object.new
Instance Attribute Summary collapse
-
#account ⇒ Merge::Accounting::ExpenseAccount
readonly
The expense’s payment account.
-
#accounting_period ⇒ Merge::Accounting::ExpenseAccountingPeriod
readonly
The accounting period that the Expense was generated in.
-
#additional_properties ⇒ OpenStruct
readonly
Additional properties unmapped to the current class definition.
-
#company ⇒ Merge::Accounting::ExpenseCompany
readonly
The company the expense belongs to.
-
#contact ⇒ Merge::Accounting::ExpenseContact
readonly
The expense’s contact.
-
#created_at ⇒ DateTime
readonly
The datetime that this object was created by Merge.
-
#currency ⇒ Merge::Accounting::CurrencyEnum
readonly
The expense’s currency.
-
#exchange_rate ⇒ String
readonly
The expense’s exchange rate.
- #field_mappings ⇒ Hash{String => Object} readonly
- #id ⇒ String readonly
- #lines ⇒ Array<Merge::Accounting::ExpenseLine> readonly
-
#memo ⇒ String
readonly
The expense’s private note.
-
#modified_at ⇒ DateTime
readonly
The datetime that this object was modified by Merge.
-
#remote_created_at ⇒ DateTime
readonly
When the expense was created.
- #remote_data ⇒ Array<Merge::Accounting::RemoteData> readonly
-
#remote_id ⇒ String
readonly
The third-party API ID of the matching object.
-
#remote_was_deleted ⇒ Boolean
readonly
Indicates whether or not this object has been deleted in the third party platform.
-
#sub_total ⇒ Float
readonly
The expense’s total amount before tax.
-
#total_amount ⇒ Float
readonly
The expense’s total amount.
-
#total_tax_amount ⇒ Float
readonly
The expense’s total tax amount.
- #tracking_categories ⇒ Array<Merge::Accounting::ExpenseTrackingCategoriesItem> readonly
-
#transaction_date ⇒ DateTime
readonly
When the transaction occurred.
Class Method Summary collapse
-
.from_json(json_object:) ⇒ Merge::Accounting::Expense
Deserialize a JSON object to an instance of Expense.
-
.validate_raw(obj:) ⇒ Void
Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object’s property definitions.
Instance Method Summary collapse
- #initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, transaction_date: OMIT, remote_created_at: OMIT, account: OMIT, contact: OMIT, total_amount: OMIT, sub_total: OMIT, total_tax_amount: OMIT, currency: OMIT, exchange_rate: OMIT, company: OMIT, memo: OMIT, lines: OMIT, tracking_categories: OMIT, remote_was_deleted: OMIT, accounting_period: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Accounting::Expense constructor
-
#to_json(*_args) ⇒ String
Serialize an instance of Expense to a JSON object.
Constructor Details
#initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, transaction_date: OMIT, remote_created_at: OMIT, account: OMIT, contact: OMIT, total_amount: OMIT, sub_total: OMIT, total_tax_amount: OMIT, currency: OMIT, exchange_rate: OMIT, company: OMIT, memo: OMIT, lines: OMIT, tracking_categories: OMIT, remote_was_deleted: OMIT, accounting_period: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Accounting::Expense
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 |
# File 'lib/merge_ruby_client/accounting/types/expense.rb', line 717 def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, transaction_date: OMIT, remote_created_at: OMIT, account: OMIT, contact: OMIT, total_amount: OMIT, sub_total: OMIT, total_tax_amount: OMIT, currency: OMIT, exchange_rate: OMIT, company: OMIT, memo: OMIT, lines: OMIT, tracking_categories: OMIT, remote_was_deleted: OMIT, accounting_period: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) @id = id if id != OMIT @remote_id = remote_id if remote_id != OMIT @created_at = created_at if created_at != OMIT @modified_at = modified_at if modified_at != OMIT @transaction_date = transaction_date if transaction_date != OMIT @remote_created_at = remote_created_at if remote_created_at != OMIT @account = account if account != OMIT @contact = contact if contact != OMIT @total_amount = total_amount if total_amount != OMIT @sub_total = sub_total if sub_total != OMIT @total_tax_amount = total_tax_amount if total_tax_amount != OMIT @currency = currency if currency != OMIT @exchange_rate = exchange_rate if exchange_rate != OMIT @company = company if company != OMIT @memo = memo if memo != OMIT @lines = lines if lines != OMIT @tracking_categories = tracking_categories if tracking_categories != OMIT @remote_was_deleted = remote_was_deleted if remote_was_deleted != OMIT @accounting_period = accounting_period if accounting_period != OMIT @field_mappings = field_mappings if field_mappings != OMIT @remote_data = remote_data if remote_data != OMIT @additional_properties = additional_properties @_field_set = { "id": id, "remote_id": remote_id, "created_at": created_at, "modified_at": modified_at, "transaction_date": transaction_date, "remote_created_at": remote_created_at, "account": account, "contact": contact, "total_amount": total_amount, "sub_total": sub_total, "total_tax_amount": total_tax_amount, "currency": currency, "exchange_rate": exchange_rate, "company": company, "memo": memo, "lines": lines, "tracking_categories": tracking_categories, "remote_was_deleted": remote_was_deleted, "accounting_period": accounting_period, "field_mappings": field_mappings, "remote_data": remote_data }.reject do |_k, v| v == OMIT end end |
Instance Attribute Details
#account ⇒ Merge::Accounting::ExpenseAccount (readonly)
Returns The expense’s payment account.
43 44 45 |
# File 'lib/merge_ruby_client/accounting/types/expense.rb', line 43 def account @account end |
#accounting_period ⇒ Merge::Accounting::ExpenseAccountingPeriod (readonly)
Returns The accounting period that the Expense was generated in.
374 375 376 |
# File 'lib/merge_ruby_client/accounting/types/expense.rb', line 374 def accounting_period @accounting_period end |
#additional_properties ⇒ OpenStruct (readonly)
Returns Additional properties unmapped to the current class definition.
380 381 382 |
# File 'lib/merge_ruby_client/accounting/types/expense.rb', line 380 def additional_properties @additional_properties end |
#company ⇒ Merge::Accounting::ExpenseCompany (readonly)
Returns The company the expense belongs to.
363 364 365 |
# File 'lib/merge_ruby_client/accounting/types/expense.rb', line 363 def company @company end |
#contact ⇒ Merge::Accounting::ExpenseContact (readonly)
Returns The expense’s contact.
45 46 47 |
# File 'lib/merge_ruby_client/accounting/types/expense.rb', line 45 def contact @contact end |
#created_at ⇒ DateTime (readonly)
Returns The datetime that this object was created by Merge.
35 36 37 |
# File 'lib/merge_ruby_client/accounting/types/expense.rb', line 35 def created_at @created_at end |
#currency ⇒ Merge::Accounting::CurrencyEnum (readonly)
Returns 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).
359 360 361 |
# File 'lib/merge_ruby_client/accounting/types/expense.rb', line 359 def currency @currency end |
#exchange_rate ⇒ String (readonly)
Returns The expense’s exchange rate.
361 362 363 |
# File 'lib/merge_ruby_client/accounting/types/expense.rb', line 361 def exchange_rate @exchange_rate end |
#field_mappings ⇒ Hash{String => Object} (readonly)
376 377 378 |
# File 'lib/merge_ruby_client/accounting/types/expense.rb', line 376 def field_mappings @field_mappings end |
#id ⇒ String (readonly)
31 32 33 |
# File 'lib/merge_ruby_client/accounting/types/expense.rb', line 31 def id @id end |
#lines ⇒ Array<Merge::Accounting::ExpenseLine> (readonly)
367 368 369 |
# File 'lib/merge_ruby_client/accounting/types/expense.rb', line 367 def lines @lines end |
#memo ⇒ String (readonly)
Returns The expense’s private note.
365 366 367 |
# File 'lib/merge_ruby_client/accounting/types/expense.rb', line 365 def memo @memo end |
#modified_at ⇒ DateTime (readonly)
Returns The datetime that this object was modified by Merge.
37 38 39 |
# File 'lib/merge_ruby_client/accounting/types/expense.rb', line 37 def modified_at @modified_at end |
#remote_created_at ⇒ DateTime (readonly)
Returns When the expense was created.
41 42 43 |
# File 'lib/merge_ruby_client/accounting/types/expense.rb', line 41 def remote_created_at @remote_created_at end |
#remote_data ⇒ Array<Merge::Accounting::RemoteData> (readonly)
378 379 380 |
# File 'lib/merge_ruby_client/accounting/types/expense.rb', line 378 def remote_data @remote_data end |
#remote_id ⇒ String (readonly)
Returns The third-party API ID of the matching object.
33 34 35 |
# File 'lib/merge_ruby_client/accounting/types/expense.rb', line 33 def remote_id @remote_id end |
#remote_was_deleted ⇒ Boolean (readonly)
Returns Indicates whether or not this object has been deleted in the third party platform.
372 373 374 |
# File 'lib/merge_ruby_client/accounting/types/expense.rb', line 372 def remote_was_deleted @remote_was_deleted end |
#sub_total ⇒ Float (readonly)
Returns The expense’s total amount before tax.
49 50 51 |
# File 'lib/merge_ruby_client/accounting/types/expense.rb', line 49 def sub_total @sub_total end |
#total_amount ⇒ Float (readonly)
Returns The expense’s total amount.
47 48 49 |
# File 'lib/merge_ruby_client/accounting/types/expense.rb', line 47 def total_amount @total_amount end |
#total_tax_amount ⇒ Float (readonly)
Returns The expense’s total tax amount.
51 52 53 |
# File 'lib/merge_ruby_client/accounting/types/expense.rb', line 51 def total_tax_amount @total_tax_amount end |
#tracking_categories ⇒ Array<Merge::Accounting::ExpenseTrackingCategoriesItem> (readonly)
369 370 371 |
# File 'lib/merge_ruby_client/accounting/types/expense.rb', line 369 def tracking_categories @tracking_categories end |
#transaction_date ⇒ DateTime (readonly)
Returns When the transaction occurred.
39 40 41 |
# File 'lib/merge_ruby_client/accounting/types/expense.rb', line 39 def transaction_date @transaction_date end |
Class Method Details
.from_json(json_object:) ⇒ Merge::Accounting::Expense
Deserialize a JSON object to an instance of Expense
772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 |
# File 'lib/merge_ruby_client/accounting/types/expense.rb', line 772 def self.from_json(json_object:) struct = JSON.parse(json_object, object_class: OpenStruct) parsed_json = JSON.parse(json_object) id = parsed_json["id"] remote_id = parsed_json["remote_id"] created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?) modified_at = (DateTime.parse(parsed_json["modified_at"]) unless parsed_json["modified_at"].nil?) transaction_date = (DateTime.parse(parsed_json["transaction_date"]) unless parsed_json["transaction_date"].nil?) remote_created_at = unless parsed_json["remote_created_at"].nil? DateTime.parse(parsed_json["remote_created_at"]) end if parsed_json["account"].nil? account = nil else account = parsed_json["account"].to_json account = Merge::Accounting::ExpenseAccount.from_json(json_object: account) end if parsed_json["contact"].nil? contact = nil else contact = parsed_json["contact"].to_json contact = Merge::Accounting::ExpenseContact.from_json(json_object: contact) end total_amount = parsed_json["total_amount"] sub_total = parsed_json["sub_total"] total_tax_amount = parsed_json["total_tax_amount"] currency = parsed_json["currency"] exchange_rate = parsed_json["exchange_rate"] if parsed_json["company"].nil? company = nil else company = parsed_json["company"].to_json company = Merge::Accounting::ExpenseCompany.from_json(json_object: company) end memo = parsed_json["memo"] lines = parsed_json["lines"]&.map do |item| item = item.to_json Merge::Accounting::ExpenseLine.from_json(json_object: item) end tracking_categories = parsed_json["tracking_categories"]&.map do |item| item = item.to_json Merge::Accounting::ExpenseTrackingCategoriesItem.from_json(json_object: item) end remote_was_deleted = parsed_json["remote_was_deleted"] if parsed_json["accounting_period"].nil? accounting_period = nil else accounting_period = parsed_json["accounting_period"].to_json accounting_period = Merge::Accounting::ExpenseAccountingPeriod.from_json(json_object: accounting_period) end field_mappings = parsed_json["field_mappings"] remote_data = parsed_json["remote_data"]&.map do |item| item = item.to_json Merge::Accounting::RemoteData.from_json(json_object: item) end new( id: id, remote_id: remote_id, created_at: created_at, modified_at: modified_at, transaction_date: transaction_date, remote_created_at: remote_created_at, account: account, contact: contact, total_amount: total_amount, sub_total: sub_total, total_tax_amount: total_tax_amount, currency: currency, exchange_rate: exchange_rate, company: company, memo: memo, lines: lines, tracking_categories: tracking_categories, remote_was_deleted: remote_was_deleted, accounting_period: accounting_period, field_mappings: field_mappings, remote_data: remote_data, additional_properties: struct ) end |
.validate_raw(obj:) ⇒ Void
Leveraged for Union-type generation, validate_raw attempts to parse the given
hash and check each fields type against the current object's property
definitions.
866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 |
# File 'lib/merge_ruby_client/accounting/types/expense.rb', line 866 def self.validate_raw(obj:) obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.") obj.remote_id&.is_a?(String) != false || raise("Passed value for field obj.remote_id is not the expected type, validation failed.") obj.created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.") obj.modified_at&.is_a?(DateTime) != false || raise("Passed value for field obj.modified_at is not the expected type, validation failed.") obj.transaction_date&.is_a?(DateTime) != false || raise("Passed value for field obj.transaction_date is not the expected type, validation failed.") obj.remote_created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.remote_created_at is not the expected type, validation failed.") obj.account.nil? || Merge::Accounting::ExpenseAccount.validate_raw(obj: obj.account) obj.contact.nil? || Merge::Accounting::ExpenseContact.validate_raw(obj: obj.contact) obj.total_amount&.is_a?(Float) != false || raise("Passed value for field obj.total_amount is not the expected type, validation failed.") obj.sub_total&.is_a?(Float) != false || raise("Passed value for field obj.sub_total is not the expected type, validation failed.") obj.total_tax_amount&.is_a?(Float) != false || raise("Passed value for field obj.total_tax_amount is not the expected type, validation failed.") obj.currency&.is_a?(Merge::Accounting::CurrencyEnum) != false || raise("Passed value for field obj.currency is not the expected type, validation failed.") obj.exchange_rate&.is_a?(String) != false || raise("Passed value for field obj.exchange_rate is not the expected type, validation failed.") obj.company.nil? || Merge::Accounting::ExpenseCompany.validate_raw(obj: obj.company) obj.memo&.is_a?(String) != false || raise("Passed value for field obj.memo is not the expected type, validation failed.") obj.lines&.is_a?(Array) != false || raise("Passed value for field obj.lines is not the expected type, validation failed.") obj.tracking_categories&.is_a?(Array) != false || raise("Passed value for field obj.tracking_categories is not the expected type, validation failed.") obj.remote_was_deleted&.is_a?(Boolean) != false || raise("Passed value for field obj.remote_was_deleted is not the expected type, validation failed.") obj.accounting_period.nil? || Merge::Accounting::ExpenseAccountingPeriod.validate_raw(obj: obj.accounting_period) obj.field_mappings&.is_a?(Hash) != false || raise("Passed value for field obj.field_mappings is not the expected type, validation failed.") obj.remote_data&.is_a?(Array) != false || raise("Passed value for field obj.remote_data is not the expected type, validation failed.") end |
Instance Method Details
#to_json(*_args) ⇒ String
Serialize an instance of Expense to a JSON object
856 857 858 |
# File 'lib/merge_ruby_client/accounting/types/expense.rb', line 856 def to_json(*_args) @_field_set&.to_json end |