Class: Secretariat::LineItem

Inherits:
Struct
  • Object
show all
Includes:
Versioner
Defined in:
lib/secretariat/line_item.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Versioner

#by_version

Instance Attribute Details

#charge_amount ⇒ Object

Returns the value of attribute charge_amount

Returns:

  • (Object) —

    the current value of charge_amount



21
22
23
 
# File 'lib/secretariat/line_item.rb', line 21

def charge_amount
  @charge_amount
end

#currency_code ⇒ Object

Returns the value of attribute currency_code

Returns:

  • (Object) —

    the current value of currency_code



21
22
23
 
# File 'lib/secretariat/line_item.rb', line 21

def currency_code
  @currency_code
end

#discount_amount ⇒ Object

Returns the value of attribute discount_amount

Returns:

  • (Object) —

    the current value of discount_amount



21
22
23
 
# File 'lib/secretariat/line_item.rb', line 21

def discount_amount
  @discount_amount
end

#discount_reason ⇒ Object

Returns the value of attribute discount_reason

Returns:

  • (Object) —

    the current value of discount_reason



21
22
23
 
# File 'lib/secretariat/line_item.rb', line 21

def discount_reason
  @discount_reason
end

#gross_amount ⇒ Object

Returns the value of attribute gross_amount

Returns:

  • (Object) —

    the current value of gross_amount



21
22
23
 
# File 'lib/secretariat/line_item.rb', line 21

def gross_amount
  @gross_amount
end

#name ⇒ Object

Returns the value of attribute name

Returns:

  • (Object) —

    the current value of name



21
22
23
 
# File 'lib/secretariat/line_item.rb', line 21

def name
  @name
end

#net_amount ⇒ Object

Returns the value of attribute net_amount

Returns:

  • (Object) —

    the current value of net_amount



21
22
23
 
# File 'lib/secretariat/line_item.rb', line 21

def net_amount
  @net_amount
end

#origin_country_code ⇒ Object

Returns the value of attribute origin_country_code

Returns:

  • (Object) —

    the current value of origin_country_code



21
22
23
 
# File 'lib/secretariat/line_item.rb', line 21

def origin_country_code
  @origin_country_code
end

#quantity ⇒ Object

Returns the value of attribute quantity

Returns:

  • (Object) —

    the current value of quantity



21
22
23
 
# File 'lib/secretariat/line_item.rb', line 21

def quantity
  @quantity
end

#tax_amount ⇒ Object

Returns the value of attribute tax_amount

Returns:

  • (Object) —

    the current value of tax_amount



21
22
23
 
# File 'lib/secretariat/line_item.rb', line 21

def tax_amount
  @tax_amount
end

#tax_category ⇒ Object

Returns the value of attribute tax_category

Returns:

  • (Object) —

    the current value of tax_category



21
22
23
 
# File 'lib/secretariat/line_item.rb', line 21

def tax_category
  @tax_category
end

#tax_percent ⇒ Object

Returns the value of attribute tax_percent

Returns:

  • (Object) —

    the current value of tax_percent



21
22
23
 
# File 'lib/secretariat/line_item.rb', line 21

def tax_percent
  @tax_percent
end

#unit ⇒ Object

Returns the value of attribute unit

Returns:

  • (Object) —

    the current value of unit



21
22
23
 
# File 'lib/secretariat/line_item.rb', line 21

def unit
  @unit
end

Instance Method Details

#errors ⇒ Object 



40
41
42
 
# File 'lib/secretariat/line_item.rb', line 40

def errors
  @errors
end

#tax_category_code(version: 2) ⇒ Object 



81
82
83
84
85
86
 
# File 'lib/secretariat/line_item.rb', line 81

def tax_category_code(version: 2)
  if version == 1
    return TAX_CATEGORY_CODES_1[tax_category] || 'S'
  end
  TAX_CATEGORY_CODES[tax_category] || 'S'
end

#to_xml(xml, line_item_index, version: 2, validate: true) ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/secretariat/line_item.rb', line 92

def to_xml(xml, line_item_index, version: 2, validate: true)
  net_price = net_amount && BigDecimal(net_amount)
  gross_price = gross_amount && BigDecimal(gross_amount)
  charge_price = charge_amount && BigDecimal(charge_amount)

  self.tax_percent ||= BigDecimal(0)

  if net_price&.zero?
    self.tax_percent = 0
  end
  
  if net_price&.negative?
    # Zugferd doesn't allow negative amounts at the item level.
    # Instead, a negative quantity is used.
    self.quantity = -quantity
    self.gross_amount = gross_price&.abs
    self.net_amount = net_price&.abs
    self.charge_amount = charge_price&.abs
  end

  if validate && !valid?
    raise ValidationError.new("LineItem #{line_item_index} is invalid", errors)
  end

  xml['ram'].IncludedSupplyChainTradeLineItem do
    xml['ram'].AssociatedDocumentLineDocument do
      xml['ram'].LineID line_item_index
    end
    if (version == 2)
      xml['ram'].SpecifiedTradeProduct do
        xml['ram'].Name name
        xml['ram'].OriginTradeCountry do
          xml['ram'].ID origin_country_code
        end
      end
    end
    agreement = by_version(version, 'SpecifiedSupplyChainTradeAgreement', 'SpecifiedLineTradeAgreement')

    xml['ram'].send(agreement) do
      xml['ram'].GrossPriceProductTradePrice do
        Helpers.currency_element(xml, 'ram', 'ChargeAmount', gross_amount, currency_code, add_currency: version == 1, digits: 4)
        if version == 2 && discount_amount
          xml['ram'].BasisQuantity(unitCode: unit_code) do
            xml.text(Helpers.format(quantity, digits: 4))
          end
          xml['ram'].AppliedTradeAllowanceCharge do
            xml['ram'].ChargeIndicator do
              xml['udt'].Indicator 'false'
            end
            Helpers.currency_element(xml, 'ram', 'ActualAmount', discount_amount, currency_code, add_currency: version == 1)
            xml['ram'].Reason discount_reason
          end
        end
        if version == 1 && discount_amount
          xml['ram'].AppliedTradeAllowanceCharge do
            xml['ram'].ChargeIndicator do
              xml['udt'].Indicator 'false'
            end
            Helpers.currency_element(xml, 'ram', 'ActualAmount', discount_amount, currency_code, add_currency: version == 1)
            xml['ram'].Reason discount_reason
          end
        end
      end
      xml['ram'].NetPriceProductTradePrice do
        Helpers.currency_element(xml, 'ram', 'ChargeAmount', net_amount, currency_code, add_currency: version == 1, digits: 4)
        if version == 2
          xml['ram'].BasisQuantity(unitCode: unit_code) do
            xml.text(Helpers.format(quantity, digits: 4))
          end
        end
      end
    end

    delivery = by_version(version, 'SpecifiedSupplyChainTradeDelivery', 'SpecifiedLineTradeDelivery')

    xml['ram'].send(delivery) do
      xml['ram'].BilledQuantity(unitCode: unit_code) do
        xml.text(Helpers.format(quantity, digits: 4))
      end
    end

    settlement = by_version(version, 'SpecifiedSupplyChainTradeSettlement', 'SpecifiedLineTradeSettlement')

    xml['ram'].send(settlement) do
      xml['ram'].ApplicableTradeTax do
        xml['ram'].TypeCode 'VAT'
        xml['ram'].CategoryCode tax_category_code(version: version)
        unless untaxable?
          percent = by_version(version, 'ApplicablePercent', 'RateApplicablePercent')
          xml['ram'].send(percent,Helpers.format(tax_percent))            
        end
      end
      monetary_summation = by_version(version, 'SpecifiedTradeSettlementMonetarySummation', 'SpecifiedTradeSettlementLineMonetarySummation')
      xml['ram'].send(monetary_summation) do
        Helpers.currency_element(xml, 'ram', 'LineTotalAmount', (quantity.negative? ? -charge_amount  : charge_amount), currency_code, add_currency: version == 1)
      end
    end

    if version == 1
      xml['ram'].SpecifiedTradeProduct do
        xml['ram'].Name name
      end
    end
  end
end

#unit_code ⇒ Object 



77
78
79
 
# File 'lib/secretariat/line_item.rb', line 77

def unit_code
  UNIT_CODES[unit] || 'C62'
end

#untaxable? ⇒ Boolean

Returns:

  • (Boolean) 


88
89
90
 
# File 'lib/secretariat/line_item.rb', line 88

def untaxable?
  tax_category == :UNTAXEDSERVICE
end

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/secretariat/line_item.rb', line 44

def valid?
  @errors = []
  net_price = BigDecimal(net_amount)
  gross_price = BigDecimal(gross_amount)
  charge_price = BigDecimal(charge_amount)
  tax = BigDecimal(tax_amount)
  unit_price = net_price * BigDecimal(quantity.abs)

  if charge_price != unit_price
    @errors << "charge price and gross price times quantity deviate: #{charge_price} / #{unit_price}"
    return false
  end
  if discount_amount
    discount = BigDecimal(discount_amount)
    calculated_net_price = (gross_price - discount).round(2, :down)
    if calculated_net_price != net_price
      @errors = "Calculated net price and net price deviate: #{calculated_net_price} / #{net_price}"
      return false
    end
  end
  if tax_category != :UNTAXEDSERVICE
    self.tax_percent ||= BigDecimal(0)
    calculated_tax = charge_price * BigDecimal(tax_percent) / BigDecimal(100)
    calculated_tax = calculated_tax.round(2)
    calculated_tax = -calculated_tax if quantity.negative?
    if calculated_tax != tax
      @errors << "Tax and calculated tax deviate: #{tax} / #{calculated_tax}"
      return false
    end
  end
  return true
end