zatca 0.1.2 → 1.0.0

data/lib/zatca/ubl/common_aggregate_components/allowance_charge.rb

@@ -0,0 +1,64 @@
+class ZATCA::UBL::CommonAggregateComponents::AllowanceCharge < ZATCA::UBL::BaseComponent
+  attr_accessor :id, :charge_indicator, :allowance_charge_reason, :amount
+
+  #   <cac:AllowanceCharge>
+  #   <cbc:ID>1</cbc:ID>
+  #   <cbc:ChargeIndicator>false</cbc:ChargeIndicator>
+  #   <cbc:AllowanceChargeReason>discount</cbc:AllowanceChargeReason>
+  #   <cbc:Amount currencyID="SAR">2</cbc:Amount>
+  #   <cac:TaxCategory>
+  #       <cbc:ID schemeAgencyID="6" schemeID="UN/ECE 5305">S</cbc:ID>
+  #       <cbc:Percent>15</cbc:Percent>
+  #       <cac:TaxScheme>
+  #           <cbc:ID schemeAgencyID="6" schemeID="UN/ECE 5153">VAT</cbc:ID>
+  #       </cac:TaxScheme>
+  #   </cac:TaxCategory>
+  # </cac:AllowanceCharge>
+
+  def initialize(
+    charge_indicator:, allowance_charge_reason:, amount:, currency_id: "SAR",
+    tax_category: nil, add_tax_category: true, add_id: true, tax_categories: []
+  )
+    super()
+
+    @charge_indicator = charge_indicator.to_s
+
+    @allowance_charge_reason = allowance_charge_reason
+    @amount = amount
+    @currency_id = currency_id
+
+    @add_tax_category = add_tax_category
+    @tax_category = tax_category
+    @add_id = add_id
+
+    if add_tax_category && @tax_category.blank?
+      @tax_category = ZATCA::UBL::CommonAggregateComponents::TaxCategory.new
+    end
+
+    @tax_categories = if @tax_category.present? && tax_categories.blank?
+      [@tax_category]
+    else
+      tax_categories
+    end
+  end
+
+  def name
+    "cac:AllowanceCharge"
+  end
+
+  def id_element
+    if @add_id && index.present?
+      ZATCA::UBL::BaseComponent.new(name: "cbc:ID", value: index)
+    end
+  end
+
+  def elements
+    [
+      id_element,
+      ZATCA::UBL::BaseComponent.new(name: "cbc:ChargeIndicator", value: @charge_indicator),
+      ZATCA::UBL::BaseComponent.new(name: "cbc:AllowanceChargeReason", value: @allowance_charge_reason),
+      ZATCA::UBL::BaseComponent.new(name: "cbc:Amount", value: @amount, attributes: {"currencyID" => @currency_id}),
+      *@tax_categories
+    ]
+  end
+end

data/lib/zatca/ubl/common_aggregate_components/classified_tax_category.rb

@@ -0,0 +1,25 @@
+class ZATCA::UBL::CommonAggregateComponents::ClassifiedTaxCategory < ZATCA::UBL::BaseComponent
+  attr_reader :scheme_id, :id
+
+  def initialize(id: "S", percent: "15.00", tax_scheme_id: "VAT")
+    super()
+
+    @id = id
+    @percent = percent
+    @tax_scheme_id = tax_scheme_id
+  end
+
+  def name
+    "cac:ClassifiedTaxCategory"
+  end
+
+  def elements
+    [
+      ZATCA::UBL::BaseComponent.new(name: "cbc:ID", value: @id),
+      ZATCA::UBL::BaseComponent.new(name: "cbc:Percent", value: @percent),
+      ZATCA::UBL::BaseComponent.new(name: "cac:TaxScheme", elements: [
+        ZATCA::UBL::BaseComponent.new(name: "cbc:ID", value: @tax_scheme_id)
+      ])
+    ]
+  end
+end

data/lib/zatca/ubl/common_aggregate_components/delivery.rb

@@ -0,0 +1,27 @@
+class ZATCA::UBL::CommonAggregateComponents::Delivery < ZATCA::UBL::BaseComponent
+  attr_reader :scheme_id, :id
+
+  def initialize(actual_delivery_date:, latest_delivery_date: nil)
+    super()
+
+    @latest_delivery_date = latest_delivery_date
+    @actual_delivery_date = actual_delivery_date
+  end
+
+  def name
+    "cac:Delivery"
+  end
+
+  def latest_delivery_date_element
+    return nil if @latest_delivery_date.nil?
+
+    ZATCA::UBL::BaseComponent.new(name: "cbc:LatestDeliveryDate", value: @latest_delivery_date)
+  end
+
+  def elements
+    [
+      ZATCA::UBL::BaseComponent.new(name: "cbc:ActualDeliveryDate", value: @actual_delivery_date),
+      latest_delivery_date_element
+    ]
+  end
+end

data/lib/zatca/ubl/common_aggregate_components/invoice_line.rb

@@ -0,0 +1,63 @@
+class ZATCA::UBL::CommonAggregateComponents::InvoiceLine < ZATCA::UBL::BaseComponent
+  # <cac:InvoiceLine>
+  # <cbc:ID>1</cbc:ID>
+  # <cbc:InvoicedQuantity unitCode="PCE">44.000000</cbc:InvoicedQuantity>
+  # <cbc:LineExtensionAmount currencyID="SAR">966.00</cbc:LineExtensionAmount>
+  # <cac:TaxTotal>
+  #     <cbc:TaxAmount currencyID="SAR">144.90</cbc:TaxAmount>
+  #     <cbc:RoundingAmount currencyID="SAR">1110.90</cbc:RoundingAmount>
+
+  # </cac:TaxTotal>
+  # <cac:Item>
+  #     <cbc:Name>dsd</cbc:Name>
+  #     <cac:ClassifiedTaxCategory>
+  #         <cbc:ID>S</cbc:ID>
+  #         <cbc:Percent>15.00</cbc:Percent>
+  #         <cac:TaxScheme>
+  #             <cbc:ID>VAT</cbc:ID>
+  #         </cac:TaxScheme>
+  #     </cac:ClassifiedTaxCategory>
+  # </cac:Item>
+  # <cac:Price>
+  #     <cbc:PriceAmount currencyID="SAR">22.00</cbc:PriceAmount>
+  #     <cac:AllowanceCharge>
+  #         <cbc:ChargeIndicator>false</cbc:ChargeIndicator>
+  #         <cbc:AllowanceChargeReason>discount</cbc:AllowanceChargeReason>
+  #         <cbc:Amount currencyID="SAR">2.00</cbc:Amount>
+  #     </cac:AllowanceCharge>
+  # </cac:Price>
+  # </cac:InvoiceLine>
+
+  def initialize(
+    invoiced_quantity:, invoiced_quantity_unit_code:,
+    line_extension_amount:, tax_total:, item:,
+    price:, allowance_charge: nil, currency_id: "SAR"
+  )
+    super()
+
+    @invoiced_quantity = invoiced_quantity
+    @invoiced_quantity_unit_code = invoiced_quantity_unit_code
+    @line_extension_amount = line_extension_amount
+    @tax_total = tax_total
+    @item = item
+    @price = price
+    @allowance_charge = allowance_charge
+    @currency_id = currency_id
+  end
+
+  def name
+    "cac:InvoiceLine"
+  end
+
+  def elements
+    [
+      ZATCA::UBL::BaseComponent.new(name: "cbc:ID", value: index),
+      ZATCA::UBL::BaseComponent.new(name: "cbc:InvoicedQuantity", value: @invoiced_quantity, attributes: {unitCode: @invoiced_quantity_unit_code}),
+      ZATCA::UBL::BaseComponent.new(name: "cbc:LineExtensionAmount", value: @line_extension_amount, attributes: {currencyID: @currency_id}),
+      @tax_total,
+      @item,
+      @price,
+      @allowance_charge
+    ]
+  end
+end

data/lib/zatca/ubl/common_aggregate_components/item.rb

@@ -0,0 +1,21 @@
+class ZATCA::UBL::CommonAggregateComponents::Item < ZATCA::UBL::BaseComponent
+  attr_reader :scheme_id, :id
+
+  def initialize(name:, classified_tax_category: nil)
+    super()
+
+    @name = name
+    @classified_tax_category = classified_tax_category || ZATCA::UBL::CommonAggregateComponents::ClassifiedTaxCategory.new
+  end
+
+  def name
+    "cac:Item"
+  end
+
+  def elements
+    [
+      ZATCA::UBL::BaseComponent.new(name: "cbc:Name", value: @name),
+      @classified_tax_category
+    ]
+  end
+end

data/lib/zatca/ubl/common_aggregate_components/legal_monetary_total.rb

@@ -0,0 +1,59 @@
+class ZATCA::UBL::CommonAggregateComponents::LegalMonetaryTotal < ZATCA::UBL::BaseComponent
+  attr_reader :line_extension_amount, :tax_exclusive_amount,
+    :tax_inclusive_amount, :allowance_total_amount, :prepaid_amount,
+    :payable_amount, :currency_id
+
+  # <cac:LegalMonetaryTotal>
+  #   <cbc:LineExtensionAmount currencyID="SAR">966.00</cbc:LineExtensionAmount>
+  #   <cbc:TaxExclusiveAmount currencyID="SAR">964.00</cbc:TaxExclusiveAmount>
+  #   <cbc:TaxInclusiveAmount currencyID="SAR">1108.90</cbc:TaxInclusiveAmount>
+  #   <cbc:AllowanceTotalAmount currencyID="SAR">2.00</cbc:AllowanceTotalAmount>
+  #   <cbc:PrepaidAmount currencyID="SAR">0.00</cbc:PrepaidAmount>
+  #   <cbc:PayableAmount currencyID="SAR">1108.90</cbc:PayableAmount>
+  # </cac:LegalMonetaryTotal>
+
+  def initialize(
+    line_extension_amount:,
+    tax_exclusive_amount:,
+    tax_inclusive_amount:,
+    allowance_total_amount:,
+    prepaid_amount: nil,
+    payable_amount: nil,
+    currency_id: "SAR"
+  )
+    @line_extension_amount = line_extension_amount
+    @tax_exclusive_amount = tax_exclusive_amount
+    @tax_inclusive_amount = tax_inclusive_amount
+    @allowance_total_amount = allowance_total_amount
+    @prepaid_amount = prepaid_amount
+    @payable_amount = payable_amount
+    @currency_id = currency_id
+  end
+
+  def name
+    "cac:LegalMonetaryTotal"
+  end
+
+  def prepaid_amount_element
+    return nil if @prepaid_amount.blank?
+
+    ZATCA::UBL::BaseComponent.new(name: "cbc:PrepaidAmount", value: @prepaid_amount, attributes: {"currencyID" => @currency_id})
+  end
+
+  def payable_amount_element
+    return nil if @payable_amount.blank?
+
+    ZATCA::UBL::BaseComponent.new(name: "cbc:PayableAmount", value: @payable_amount, attributes: {"currencyID" => @currency_id})
+  end
+
+  def elements
+    [
+      ZATCA::UBL::BaseComponent.new(name: "cbc:LineExtensionAmount", value: @line_extension_amount, attributes: {"currencyID" => @currency_id}),
+      ZATCA::UBL::BaseComponent.new(name: "cbc:TaxExclusiveAmount", value: @tax_exclusive_amount, attributes: {"currencyID" => @currency_id}),
+      ZATCA::UBL::BaseComponent.new(name: "cbc:TaxInclusiveAmount", value: @tax_inclusive_amount, attributes: {"currencyID" => @currency_id}),
+      ZATCA::UBL::BaseComponent.new(name: "cbc:AllowanceTotalAmount", value: @allowance_total_amount, attributes: {"currencyID" => @currency_id}),
+      prepaid_amount_element,
+      payable_amount_element
+    ]
+  end
+end

data/lib/zatca/ubl/common_aggregate_components/party.rb

@@ -0,0 +1,28 @@
+class ZATCA::UBL::CommonAggregateComponents::Party < ZATCA::UBL::BaseComponent
+  # Has:
+  # PartyIdentification
+  # PostalAddress
+  # PartyTaxScheme
+  # PartyLegalEntity
+  def initialize(party_identification:, postal_address:, party_tax_scheme:, party_legal_entity:)
+    super()
+
+    @party_identification = party_identification
+    @postal_address = postal_address
+    @party_tax_scheme = party_tax_scheme
+    @party_legal_entity = party_legal_entity
+  end
+
+  def name
+    "cac:Party"
+  end
+
+  def elements
+    [
+      @party_identification,
+      @postal_address,
+      @party_tax_scheme,
+      @party_legal_entity
+    ]
+  end
+end

data/lib/zatca/ubl/common_aggregate_components/party_identification.rb

@@ -0,0 +1,25 @@
+class ZATCA::UBL::CommonAggregateComponents::PartyIdentification < ZATCA::UBL::BaseComponent
+  attr_reader :scheme_id, :id
+
+  SCHEMA = Dry::Schema.Params do
+    required(:id).filled(:string)
+    required(:scheme_id).filled(:string)
+  end
+
+  def initialize(id:, scheme_id: "CRN")
+    super()
+
+    @id = id
+    @scheme_id = scheme_id
+  end
+
+  def name
+    "cac:PartyIdentification"
+  end
+
+  def elements
+    [
+      ZATCA::UBL::BaseComponent.new(name: "cbc:ID", value: @id, attributes: {"schemeID" => @scheme_id})
+    ]
+  end
+end

data/lib/zatca/ubl/common_aggregate_components/party_legal_entity.rb

@@ -0,0 +1,19 @@
+class ZATCA::UBL::CommonAggregateComponents::PartyLegalEntity < ZATCA::UBL::BaseComponent
+  attr_reader :scheme_id, :id
+
+  def initialize(registration_name:)
+    super()
+
+    @registration_name = registration_name
+  end
+
+  def name
+    "cac:PartyLegalEntity"
+  end
+
+  def elements
+    [
+      ZATCA::UBL::BaseComponent.build(name: "cbc:RegistrationName", value: @registration_name)
+    ]
+  end
+end

data/lib/zatca/ubl/common_aggregate_components/party_tax_scheme.rb

@@ -0,0 +1,30 @@
+class ZATCA::UBL::CommonAggregateComponents::PartyTaxScheme < ZATCA::UBL::BaseComponent
+  def initialize(
+    company_id: nil,
+    tax_scheme_id: "VAT"
+  )
+    super()
+
+    @company_id = company_id
+    @tax_scheme_id = tax_scheme_id
+  end
+
+  def name
+    "cac:PartyTaxScheme"
+  end
+
+  def company_id_element
+    return nil if @company_id.blank?
+
+    ZATCA::UBL::BaseComponent.new(name: "cbc:CompanyID", value: @company_id)
+  end
+
+  def elements
+    [
+      company_id_element,
+      ZATCA::UBL::BaseComponent.new(name: "cac:TaxScheme", elements: [
+        ZATCA::UBL::BaseComponent.new(name: "cbc:ID", value: @tax_scheme_id)
+      ])
+    ]
+  end
+end

data/lib/zatca/ubl/common_aggregate_components/postal_address.rb

@@ -0,0 +1,59 @@
+class ZATCA::UBL::CommonAggregateComponents::PostalAddress < ZATCA::UBL::BaseComponent
+  attr_accessor :street_name,
+    :additional_street_name,
+    :building_number,
+    :plot_identification,
+    :city_subdivision_name,
+    :city_name,
+    :postal_zone,
+    :country_subentity,
+    :country
+
+  SCHEMA = Dry::Schema.Params do
+    required(:street_name).filled(:string)
+    required(:additional_street_name).filled(:string)
+    required(:building_number).filled(:string)
+    required(:plot_identification).filled(:string)
+    required(:city_subdivision_name).filled(:string)
+    required(:city_name).filled(:string)
+    required(:postal_zone).filled(:string)
+    required(:country_subentity).filled(:string)
+    required(:country_identification_code).filled(:string)
+  end
+
+  def initialize(
+    street_name:, building_number:, plot_identification:,
+    city_subdivision_name:, city_name:, postal_zone:, country_subentity:,
+    additional_street_name: nil, country_identification_code: "SA"
+  )
+    @street_name = street_name
+    @additional_street_name = additional_street_name
+    @building_number = building_number
+    @plot_identification = plot_identification
+    @city_subdivision_name = city_subdivision_name
+    @city_name = city_name
+    @postal_zone = postal_zone
+    @country_subentity = country_subentity
+    @country_identification_code = country_identification_code
+  end
+
+  def name
+    "cac:PostalAddress"
+  end
+
+  def elements
+    [
+      ZATCA::UBL::BaseComponent.build(name: "cbc:StreetName", value: @street_name),
+      ZATCA::UBL::BaseComponent.build(name: "cbc:AdditionalStreetName", value: @additional_street_name),
+      ZATCA::UBL::BaseComponent.build(name: "cbc:BuildingNumber", value: @building_number),
+      ZATCA::UBL::BaseComponent.build(name: "cbc:PlotIdentification", value: @plot_identification),
+      ZATCA::UBL::BaseComponent.build(name: "cbc:CitySubdivisionName", value: @city_subdivision_name),
+      ZATCA::UBL::BaseComponent.build(name: "cbc:CityName", value: @city_name),
+      ZATCA::UBL::BaseComponent.build(name: "cbc:PostalZone", value: @postal_zone),
+      ZATCA::UBL::BaseComponent.build(name: "cbc:CountrySubentity", value: @country_subentity),
+      ZATCA::UBL::BaseComponent.build(name: "cac:Country", elements: [
+        ZATCA::UBL::BaseComponent.build(name: "cbc:IdentificationCode", value: @country_identification_code)
+      ])
+    ]
+  end
+end

data/lib/zatca/ubl/common_aggregate_components/price.rb

@@ -0,0 +1,20 @@
+class ZATCA::UBL::CommonAggregateComponents::Price < ZATCA::UBL::BaseComponent
+  def initialize(price_amount:, allowance_charge: nil, currency_id: "SAR")
+    super()
+
+    @price_amount = price_amount
+    @allowance_charge = allowance_charge
+    @currency_id = currency_id
+  end
+
+  def name
+    "cac:Price"
+  end
+
+  def elements
+    [
+      ZATCA::UBL::BaseComponent.new(name: "cbc:PriceAmount", value: @price_amount, attributes: {currencyID: @currency_id}),
+      @allowance_charge
+    ]
+  end
+end

data/lib/zatca/ubl/common_aggregate_components/tax_category.rb

@@ -0,0 +1,56 @@
+class ZATCA::UBL::CommonAggregateComponents::TaxCategory < ZATCA::UBL::BaseComponent
+  attr_reader :id, :percent
+
+  #     <cac:TaxCategory>
+  #         <cbc:ID schemeAgencyID="6" schemeID="UN/ECE 5305">S</cbc:ID>
+  #         <cbc:Percent>15.00</cbc:Percent>
+  #         <cac:TaxScheme>
+  #             <cbc:ID schemeAgencyID="6" schemeID="UN/ECE 5153">VAT</cbc:ID>
+  #         </cac:TaxScheme>
+  #     </cac:TaxCategory>
+  # <cac:TaxCategory>
+  #   <cbc:ID>O</cbc:ID>
+  #   <cbc:TaxExemptionReasonCode>VATEX-EU-O</cbc:TaxExemptionReasonCode>
+  #   <cac:TaxScheme>
+  #     <cbc:ID>VAT</cbc:ID>
+  #     </cac:TaxScheme>
+  # </cac:TaxCategory>
+  def initialize(
+    tax_percent: "15.00", id: "S", scheme_agency_id: "6",
+    scheme_id: "UN/ECE 5305", tax_scheme_id: "VAT",
+    tax_scheme_scheme_id: "UN/ECE 5153", tax_exemption_reason_code: nil
+  )
+    super()
+
+    @tax_percent = tax_percent
+    @id = id
+    @scheme_agency_id = scheme_agency_id
+    @scheme_id = scheme_id
+    @tax_scheme_id = tax_scheme_id
+    @tax_scheme_scheme_id = tax_scheme_scheme_id
+    @tax_exemption_reason_code = tax_exemption_reason_code
+  end
+
+  def name
+    "cac:TaxCategory"
+  end
+
+  def elements
+    [
+      ZATCA::UBL::BaseComponent.new(name: "cbc:ID", value: @id, attributes: {"schemeAgencyID" => @scheme_agency_id, "schemeID" => @scheme_id}.compact),
+      tax_exemption_reason_code_element,
+      ZATCA::UBL::BaseComponent.new(name: "cbc:Percent", value: @tax_percent),
+      ZATCA::UBL::BaseComponent.new(name: "cac:TaxScheme", elements: [
+        ZATCA::UBL::BaseComponent.new(name: "cbc:ID", value: @tax_scheme_id, attributes: {"schemeAgencyID" => @scheme_agency_id, "schemeID" => @tax_scheme_scheme_id}.compact)
+      ])
+    ]
+  end
+
+  private
+
+  def tax_exemption_reason_code_element
+    if @tax_exemption_reason_code.present?
+      ZATCA::UBL::BaseComponent.new(name: "cbc:TaxExemptionReasonCode", value: @tax_exemption_reason_code)
+    end
+  end
+end

data/lib/zatca/ubl/common_aggregate_components/tax_total.rb

@@ -0,0 +1,58 @@
+class ZATCA::UBL::CommonAggregateComponents::TaxTotal < ZATCA::UBL::BaseComponent
+  # <cac:TaxTotal>
+  # <cbc:TaxAmount currencyID="SAR">144.9</cbc:TaxAmount>
+  # <cac:TaxSubtotal>
+  #     <cbc:TaxableAmount currencyID="SAR">966.00</cbc:TaxableAmount>
+  #     <cbc:TaxAmount currencyID="SAR">144.90</cbc:TaxAmount>
+  #     <cac:TaxCategory>
+  #         <cbc:ID schemeAgencyID="6" schemeID="UN/ECE 5305">S</cbc:ID>
+  #         <cbc:Percent>15.00</cbc:Percent>
+  #         <cac:TaxScheme>
+  #             <cbc:ID schemeAgencyID="6" schemeID="UN/ECE 5153">VAT</cbc:ID>
+  #         </cac:TaxScheme>
+  #     </cac:TaxCategory>
+  # </cac:TaxSubtotal>
+  # </cac:TaxTotal>
+
+  def initialize(
+    tax_amount:, tax_subtotal_amount: nil, taxable_amount: nil,
+    rounding_amount: nil, tax_category: nil, currency_id: "SAR"
+  )
+    super()
+
+    @tax_amount = tax_amount
+    @tax_subtotal_amount = tax_subtotal_amount
+    @taxable_amount = taxable_amount
+    @rounding_amount = rounding_amount
+    @tax_category = tax_category || ZATCA::UBL::CommonAggregateComponents::TaxCategory.new
+    @currency_id = currency_id
+  end
+
+  def name
+    "cac:TaxTotal"
+  end
+
+  def tax_subtotal_element
+    if @taxable_amount.present? && @tax_subtotal_amount.present? && @tax_category.present?
+      ZATCA::UBL::BaseComponent.new(name: "cac:TaxSubtotal", elements: [
+        ZATCA::UBL::BaseComponent.new(name: "cbc:TaxableAmount", value: @taxable_amount, attributes: {"currencyID" => @currency_id}),
+        ZATCA::UBL::BaseComponent.new(name: "cbc:TaxAmount", value: @tax_subtotal_amount, attributes: {"currencyID" => @currency_id}),
+        @tax_category
+      ])
+    end
+  end
+
+  def rounding_amount_element
+    if @rounding_amount.present?
+      ZATCA::UBL::BaseComponent.new(name: "cbc:RoundingAmount", value: @rounding_amount, attributes: {"currencyID" => @currency_id})
+    end
+  end
+
+  def elements
+    [
+      ZATCA::UBL::BaseComponent.new(name: "cbc:TaxAmount", value: @tax_amount, attributes: {"currencyID" => @currency_id}),
+      rounding_amount_element,
+      tax_subtotal_element
+    ]
+  end
+end

data/lib/zatca/ubl/common_aggregate_components.rb

@@ -0,0 +1,2 @@
+module ZATCA::UBL::CommonAggregateComponents
+end