sunat_invoice 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b49429704d8a0fd453f1210ee274c0b111dbb96e
-  data.tar.gz: ecae8df2666c3e508abea79a594c375b12b03153
+  metadata.gz: c15a897331d06af16937c9bf1020984592bcd0f3
+  data.tar.gz: 51cc6c5c299e0d2209a32ccc51be2158b7a4e780
 SHA512:
-  metadata.gz: 83d17d8b14f0bfb1bcbdea6e449346d7ac0b819859d434695f93ba306e8f979f0885683454fd655d1bfb54f4ee9f60cbe16e0266e429b1507df75d6745365d82
-  data.tar.gz: c1992a23ae4817da9539e980bc3ee745335d70b802d1a18a32793eee7c6918140af4915ae84cd72c6e30a7b8edb2077808f656f596c0e8b4446cdf3eba362865
+  metadata.gz: a5866087a7d0c40c4c88ad32ee94812d7e3dbd75892968ca39df00aa501fcdb9167a0ba06b60c3c38d0095b51c631d6de51055e01dfee4f4db029c473bac4b91
+  data.tar.gz: 20781a7b8110190a887a7c9740fbfebb4a8fd55893953a07fc12c8da05f549d1fae2630b301bc98329db94dc39c2ca23f2ce017541409774013d034c4626062e

data/Gemfile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/README.mkd

@@ -1,26 +1,2 @@
 # Sunat Invoice
-Ruby wrapper to use SUNAT Electronic Invoice API
-
-homologacion
-https://www.sunat.gob.pe/ol-ti-itcpgem-sqa/billService?wsdl
-
-valid_service
-
-http://www.sunat.gob.pe/ol-ti-itconsvalicpe/ConsValiCpe.htm
-
-{:validaCDPcriterios=>{:rucEmisor=>"string", :tipoCDP=>"string", :serieCDP=>"string", :numeroCDP=>"string", :tipoDocIdReceptor=>"string", :numeroDocIdReceptor=>"string", :fechaEmision=>"string", :importeTotal=>"double", :nroAutorizacion=>"string"}}
-
-http://www.sunat.gob.pe/ol-ti-itconsverixml/ConsVeriXml.htm
-
-{:verificaCPEarchivo=>{:nombre=>"string", :archivo=>"string"}}
-
-errors
-https://www.facturacionperu.ws/?p=138
-
-
-To write:
-https://www.xml.com/pub/a/2001/08/08/xmldsig.html
-https://www.di-mgt.com.au/xmldsig.html
-
-https://github.com/ebeigarts/signer
-https://github.com/benoist/xmldsig
+Ruby gem to use [SUNAT Electronic Billing](http://cpe.sunat.gob.pe/factura-desde-los-sistemas-del-contribuyente) from your app

data/lib/sunat_invoice/client.rb

@@ -5,15 +5,12 @@ require 'savon'
 
 module SunatInvoice
   class Client
-    def initialize(env = 'dev')
+    def initialize(env = 'dev', log = false)
       @env = env
+      @log = log
       @soap_client = savon_client
     end
 
-    def log
-      (@env != 'prod')
-    end
-
     private
 
     def config
@@ -30,7 +27,7 @@ module SunatInvoice
       Savon.client(wsdl: wsdl,
                    wsse_auth: authentication,
                    namespace: 'http://service.sunat.gob.pe',
-                   log: log)
+                   log: @log)
     end
   end
 end

data/lib/sunat_invoice/clients/consult_client.rb

@@ -7,5 +7,22 @@ module SunatInvoice
     def wsdl
       'https://www.sunat.gob.pe/ol-it-wsconscpegem/billConsultService?wsdl'
     end
+
+    def get_status(ticket)
+      @soap_client.call(:get_status, message: { ticket: ticket })
+    end
+
+    def get_status_cdr(options = {})
+      # Available document_type to use:
+      #   01: Factura.
+      #   07: Nota de crédito.
+      #   08: Nota de débito
+      @soap_client.call(:get_status, message: {
+                          rucComprobante: options[:ruc],
+                          tipoComprobante: options[:document_type],
+                          serieComprobante: options[:document_serial],
+                          numeroComprobante: options[:document_number]
+                        })
+    end
   end
 end

data/lib/sunat_invoice/clients/invoice_client.rb

@@ -25,12 +25,20 @@ module SunatInvoice
       encode(zip_file.sysread)
     end
 
-    def send_invoice(invoice, name)
-      zip = prepare_zip(invoice, "#{name}.xml")
-      @soap_client.call(:send_bill,
+    def dispatch(document)
+      # * document - Invoice or DailySummary instance
+      xml_build = document.xml
+      name = document.document_name
+      operation = document.operation
+      zip = prepare_zip(xml_build, "#{name}.xml")
+      @soap_client.call(operation,
                         message: { fileName: "#{name}.zip", contentFile: zip })
     end
 
+    def get_status(ticket)
+      @soap_client.call(:get_status, message: { ticket: ticket })
+    end
+
     private
 
     def encode(zip_str)

data/lib/sunat_invoice/configuration.rb

@@ -2,6 +2,6 @@
 
 module SunatInvoice
   class Configuration
-    attr_accessor :account_ruc, :account_user, :account_password, :provider
+    attr_accessor :account_ruc, :account_user, :account_password
   end
 end

data/lib/sunat_invoice/credit_note.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: false
+
+require_relative 'trade_document'
+
+module SunatInvoice
+  class CreditNote < TradeDocument
+    # * date - issued date
+    # * ref_document_number - serial and number of document affected
+    # * ref_document_type - type of document affected
+    # * response_code - reason for which credit note is issued (CATALOG_09)
+    # * description - description of reason
+    # * document_type - should be '07' according CATALOG_01
+    # * document_number - serial and correlative number of document
+    # * provider - a SunatInvoice::Provider instance
+    # * customer - a SunatInvoice::Customer instance
+    # * signature - a SunatInvoice::Signature instance
+    # * lines - array of SunatInvoice::CreditNoteLine instances
+
+    attr_accessor :ref_document_number, :ref_document_type, :response_code,
+                  :description
+
+    def xml
+      build = build_xml do |xml|
+        build_document_data(xml)
+        build_discrepancy_response(xml)
+        build_billing_reference(xml)
+        build_common_content(xml)
+      end
+      @signature.sign(build.to_xml)
+    end
+
+    private
+
+    def root_name
+      'CreditNote'
+    end
+
+    def namespaces
+      CREDIT_NOTE_NAMESPACES.merge(TRADE_NAMESPACES)
+    end
+
+    def build_discrepancy_response(xml)
+      xml['cac'].DiscrepancyResponse do
+        xml['cbc'].ReferenceID ref_document_number
+        xml['cbc'].ResponseCode response_code # CATALOG_09
+        xml['cbc'].Description description
+      end
+    end
+
+    def build_billing_reference(xml)
+      xml['cac'].BillingReference do
+        xml['cac'].InvoiceDocumentReference do
+          xml['cbc'].ID ref_document_number
+          xml['cbc'].DocumentTypeCode ref_document_type
+        end
+      end
+    end
+  end
+end

data/lib/sunat_invoice/credit_note_line.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: false
+
+require_relative 'item'
+
+module SunatInvoice
+  class CreditNoteLine < Item
+    def line_tag_name
+      'CreditNoteLine'
+    end
+
+    def quantity_tag_name
+      'CreditedQuantity'
+    end
+  end
+end

data/lib/sunat_invoice/customer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'tributer'
 
 module SunatInvoice

data/lib/sunat_invoice/daily_summary.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module SunatInvoice
+  class DailySummary < XmlDocument
+    attr_accessor :reference_date
+
+    def namespaces
+      DAILY_SUMMARY_NAMESPACES.merge(SUMMARY_NAMESPACES)
+    end
+
+    def xml
+      build = build_xml do |xml|
+        build_number(xml)
+        build_summary_info(xml)
+        @signature.signer_data(xml)
+        @provider.info(xml, false)
+        build_lines_xml(xml)
+      end
+      @signature.sign(build.to_xml)
+    end
+
+    def operation
+      :send_summary
+    end
+
+    def document_name
+      "#{@provider.ruc}-#{document_number}"
+    end
+
+    private
+
+    def root_name
+      'SummaryDocuments'
+    end
+
+    def document_number
+      formatted = date.strftime('%Y%m%d') #  YYYYMMDD
+      "RC-#{formatted}-1"
+    end
+
+    def build_summary_info(xml)
+      xml['cbc'].ReferenceDate formatted_date(reference_date)
+      xml['cbc'].IssueDate formatted_date(date)
+    end
+  end
+end

data/lib/sunat_invoice/debit_note.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: false
+
+require_relative 'credit_note'
+
+module SunatInvoice
+  class DebitNote < CreditNote
+    # * date - issued date
+    # * ref_document_number - serial and number of document affected
+    # * ref_document_type - type of document affected
+    # * response_code - reason for which debit note is issued (CATALOG_10)
+    # * description - description of reason
+    # * document_type - should be '08' according CATALOG_01
+    # * document_number - serial and correlative number of document
+    # * provider - a SunatInvoice::Provider instance
+    # * customer - a SunatInvoice::Customer instance
+    # * signature - a SunatInvoice::Signature instance
+    # * lines - array of SunatInvoice::DebitNoteLine instances
+
+    private
+
+    def root_name
+      'DebitNote'
+    end
+
+    def namespaces
+      DEBIT_NOTE_NAMESPACES.merge(TRADE_NAMESPACES)
+    end
+
+    def total_tag
+      'RequestedMonetaryTotal'
+    end
+  end
+end

data/lib/sunat_invoice/debit_note_line.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: false
+
+require_relative 'item'
+
+module SunatInvoice
+  class DebitNoteLine < Item
+    def line_tag_name
+      'DebitNoteLine'
+    end
+
+    def quantity_tag_name
+      'DebitedQuantity'
+    end
+  end
+end

data/lib/sunat_invoice/invoice.rb

@@ -1,171 +1,50 @@
 # frozen_string_literal: false
-require_relative 'utils'
+
 require_relative 'provider'
 require_relative 'customer'
 require_relative 'signature'
-require_relative 'tax'
-require_relative 'catalogs'
+require_relative 'trade_document'
 
 module SunatInvoice
-  class Invoice < Model
-    include Utils
-
-    attr_accessor :document_type, :document_number, :items
-
-    UBL_VERSION = '2.0'
-    CUSTOMIZATION = '1.0'
-
+  class Invoice < TradeDocument
     def initialize(*args)
       super(*args)
       opts = args[0] || {}
-      @provider = opts[:provider] || SunatInvoice::Provider.new
-      @customer = opts[:customer] || SunatInvoice::Customer.new
-      @date = opts[:date] || DateTime.now.strftime('%Y-%m-%d')
+      init_defaults(opts)
+    end
+
+    def init_defaults(opts)
+      parties_default(opts)
       @document_type = opts[:document_type] || '01'
       @document_number = opts[:document_number] || 'F001-1'
       @currency = opts[:currency] || 'PEN'
-      @items ||= []
+      @lines ||= []
       @signature = SunatInvoice::Signature.new(provider: @provider)
     end
 
-    def xml
-      prepare_totals
-
-      build = Nokogiri::XML::Builder.new do |xml|
-        xml.Invoice(UBL_NAMESPACES) do
-          xml['ext'].UBLExtensions do
-            build_sale_totals(xml)
-            @signature.signature_ext(xml)
-          end
-
-          xml['cbc'].UBLVersionID UBL_VERSION
-          xml['cbc'].CustomizationID CUSTOMIZATION
-          xml['cbc'].ID @document_number
-          xml['cbc'].IssueDate @date
-          xml['cbc'].InvoiceTypeCode @document_type
-          xml['cbc'].DocumentCurrencyCode @currency
-
-          @signature.signer_data(xml)
-          @provider.info(xml)
-          @customer.info(xml)
-          build_tax_totals(xml)
-          build_total(xml)
-          build_items(xml)
-        end
-      end
-      invoice_xml = build.to_xml
-      @signature.sign(invoice_xml)
-    end
-
-    def prepare_totals
-      calculate_tax_totals
-      calculate_sale_totals
-      calculate_total
-    end
-
-    def calculate_total
-      # calculate invoice total
-      @total = 0
-      @total += @tax_totals.values.sum
-      @total += @sale_totals.values.sum
-    end
-
-    def calculate_sale_totals
-      @sale_totals = {}
-      # get bi totals according kind of sale (gravado, inafecto, exonerado ..)
-      items.each do |item|
-        # TODO: I think in most cases only be one tax for item, but should
-        #       handle more cases
-        total_code = get_total_code(item.taxes.first)
-        if total_code
-          @sale_totals[total_code] = 0 unless @sale_totals[total_code]
-          @sale_totals[total_code] += item.bi_value
-        end
-      end
-    end
-
-    def calculate_tax_totals
-      # concat item's sale_taxes
-      @tax_totals = {}
-      taxes = items.map(&:sale_taxes).flatten
-      taxes.each do |tax|
-        @tax_totals[tax.keys.first] ||= 0
-        @tax_totals[tax.keys.first] += tax.values.sum
-      end
-    end
-
-    def build_items(xml)
-      items.each_with_index do |item, index|
-        item.xml(xml, index, @currency)
-      end
-    end
-
-    def document_name
-      "#{@provider.ruc}-#{document_type}-#{document_number}"
-    end
-
-    def build_tax_totals(xml)
-      @tax_totals.each do |key, value|
-        SunatInvoice::Tax.new(tax_type: key, amount: value).xml(xml, @currency)
-      end
-    end
-
-    def build_sale_totals(xml)
-      ubl_ext(xml) do
-        xml['sac'].AdditionalInformation do
-          @sale_totals.each do |code, amount|
-            xml['sac'].AdditionalMonetaryTotal do
-              xml['cbc'].ID code
-              amount_xml(xml['cbc'], 'PayableAmount', amount, @currency)
-            end
-          end
-        end
-      end
+    def parties_default(opts)
+      @provider = opts[:provider] || SunatInvoice::Provider.new
+      @customer = opts[:customer] || SunatInvoice::Customer.new
     end
 
-    def build_total(xml)
-      xml['cac'].LegalMonetaryTotal do
-        amount_xml(xml['cbc'], 'PayableAmount', @total, @currency)
+    def xml
+      build = build_xml do |xml|
+        build_document_data(xml)
+        build_common_content(xml)
       end
-    end
 
-    def add_item(item)
-      items << item if item.is_a?(SunatInvoice::Item)
+      invoice_xml = build.to_xml
+      @signature.sign(invoice_xml)
     end
 
-    def get_total_code(tax)
-      return unless tax
-      case tax.tax_type
-      when :igv
-        get_total_igv_code(tax.tax_exemption_reason)
-      # when :isc
-      #   tax.tier_range
-      end
-    end
+    private
 
-    def get_total_igv_code(exemption_reason)
-      if Catalogs::CATALOG_07.first == exemption_reason
-        Catalogs::CATALOG_14.first
-      elsif Catalogs::CATALOG_07[1..6].include?(exemption_reason)
-        Catalogs::CATALOG_14[3]
-      elsif Catalogs::CATALOG_07[7] == exemption_reason
-        Catalogs::CATALOG_14[2]
-      elsif Catalogs::CATALOG_07[8..14].include?(exemption_reason)
-        Catalogs::CATALOG_14[1]
-      end
+    def root_name
+      'Invoice'
     end
 
-    def attributes
-      {
-        attributes!: {
-          'cbc:InvoicedQuantity' => { '@unitCode' => :unit },
-          'cbc:PriceAmount' => { '@currencyID' => :currency }, # PEN
-          'cbc:TaxAmount' => { '@currencyID' => :currency }, # PEN
-          'cbc:PayableAmount' => { '@currencyID' => :currency }, # PEN
-          'cbc:LineExtensionAmount' => { '@currencyID' => :currency }, # PEN
-          'cbc:ChargeTotalAmount' => { '@currencyID' => :currency }, # PEN
-        }
-      }
+    def namespaces
+      INVOICE_NAMESPACES.merge(TRADE_NAMESPACES)
     end
   end
 end

data/lib/sunat_invoice/item.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
-require_relative 'utils'
 
-module SunatInvoice
-  class Item < Model
-    include Utils
+require_relative 'line'
 
-    attr_accessor :quantity, :description, :price, :price_code, :unit_code,
-                  :taxes
+module SunatInvoice
+  class Item < Line
+    attr_accessor :quantity, :description, :price, :price_code, :unit_code
 
     def initialize(*args)
       # * quantity - quantity of item
@@ -21,6 +19,25 @@ module SunatInvoice
       @taxes ||= []
     end
 
+    def line_tag_name
+      'InvoiceLine'
+    end
+
+    def quantity_tag_name
+      'InvoicedQuantity'
+    end
+
+    def xml(xml, index, currency)
+      xml['cac'].send(line_tag_name) do
+        build_basic_line_xml(xml, index)
+        amount_xml(xml['cbc'], 'LineExtensionAmount', bi_value, currency)
+        build_pricing_reference(xml, currency)
+        build_taxes_xml(xml, currency)
+        build_item(xml)
+        build_price(xml, currency)
+      end
+    end
+
     def bi_value
       # bi of sale = price without taxes * quantity
       (@price.to_f * @quantity.to_f).round(2)
@@ -41,27 +58,15 @@ module SunatInvoice
       (@price.to_f + sum_taxes).round(2)
     end
 
+    private
+
     def sum_taxes
       taxes.map(&:amount).sum
     end
 
-    def xml(xml, index, currency)
-      xml['cac'].InvoiceLine do
-        xml['cbc'].ID(index + 1)
-        xml['cbc'].InvoicedQuantity(@quantity, unitCode: unit_code)
-        amount_xml(xml['cbc'], 'LineExtensionAmount', bi_value, currency)
-        xml['cac'].PricingReference do
-          xml['cac'].AlternativeConditionPrice do
-            amount_xml(xml['cbc'], 'PriceAmount', sale_price, currency)
-            xml['cbc'].PriceTypeCode price_code
-          end
-        end
-        taxes_xml(xml, currency)
-        build_item(xml)
-        xml['cac'].Price do
-          amount_xml(xml['cbc'], 'PriceAmount', price, currency)
-        end
-      end
+    def build_basic_line_xml(xml, index)
+      xml['cbc'].ID(index + 1)
+      xml['cbc'].send(quantity_tag_name, quantity, unitCode: unit_code)
     end
 
     def build_item(xml)
@@ -70,9 +75,18 @@ module SunatInvoice
       end
     end
 
-    def taxes_xml(xml, currency)
-      taxes&.each do |tax|
-        tax.xml(xml, currency)
+    def build_pricing_reference(xml, currency)
+      xml['cac'].PricingReference do
+        xml['cac'].AlternativeConditionPrice do
+          amount_xml(xml['cbc'], 'PriceAmount', sale_price, currency)
+          xml['cbc'].PriceTypeCode price_code
+        end
+      end
+    end
+
+    def build_price(xml, currency)
+      xml['cac'].Price do
+        amount_xml(xml['cbc'], 'PriceAmount', price, currency)
       end
     end
   end

data/lib/sunat_invoice/line.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative 'model'
+require_relative 'utils'
+
+module SunatInvoice
+  class Line < Model
+    include Utils
+
+    attr_accessor :taxes
+
+    def build_taxes_xml(xml, currency)
+      taxes&.each do |tax|
+        tax.xml(xml, currency)
+      end
+    end
+  end
+end

data/lib/sunat_invoice/provider.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'tributer'
 require_relative 'utils'
 
@@ -6,8 +7,25 @@ module SunatInvoice
   class Provider < Tributer
     include Utils
 
-    attr_accessor :signature_id, :signature_location_id, :uri, :pk_file,
-                  :cert_file
+    attr_accessor :signature_id, :signature_location_id, :pk_file, :cert_file
+
+    def info(xml, with_address = true)
+      xml['cac'].AccountingSupplierParty do
+        xml['cbc'].CustomerAssignedAccountID ruc
+        xml['cbc'].AdditionalAccountID document_type
+        build_party_xml(xml, with_address)
+      end
+    end
+
+    private
+
+    def build_party_xml(xml, with_address)
+      xml['cac'].Party do
+        build_name(xml)
+        xml['cac'].PostalAddress { address(xml) } if with_address
+        build_registration_name(xml)
+      end
+    end
 
     def address(xml)
       xml['cbc'].ID @ubigeo
@@ -36,17 +54,5 @@ module SunatInvoice
         xml['cbc'].RegistrationName name
       end
     end
-
-    def info(xml)
-      xml['cac'].AccountingSupplierParty do
-        xml['cbc'].CustomerAssignedAccountID ruc
-        xml['cbc'].AdditionalAccountID document_type
-        xml['cac'].Party do
-          build_name(xml)
-          xml['cac'].PostalAddress { address(xml) }
-          build_registration_name(xml)
-        end
-      end
-    end
   end
 end