sunat_invoice 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b49429704d8a0fd453f1210ee274c0b111dbb96e
+  data.tar.gz: ecae8df2666c3e508abea79a594c375b12b03153
+SHA512:
+  metadata.gz: 83d17d8b14f0bfb1bcbdea6e449346d7ac0b819859d434695f93ba306e8f979f0885683454fd655d1bfb54f4ee9f60cbe16e0266e429b1507df75d6745365d82
+  data.tar.gz: c1992a23ae4817da9539e980bc3ee745335d70b802d1a18a32793eee7c6918140af4915ae84cd72c6e30a7b8edb2077808f656f596c0e8b4446cdf3eba362865

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+*.swp
+*.gem
+test/certs

data/.rubocop.yml

@@ -0,0 +1,11 @@
+AllCops:
+  TargetRubyVersion: 2.3
+Style/Documentation:
+  Enabled: false
+Style/AsciiComments :
+  Enabled: false
+Metrics/BlockLength:
+  Exclude:
+    - 'test/*.rb'
+Metrics/MethodLength:
+  Max: 20

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create use 2.4.1@sunat_invoice

data/Gemfile

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

data/Makefile

@@ -0,0 +1,8 @@
+.PHONY: test
+
+console:
+	irb -Ilib -rsunat_invoice
+
+test:
+	cutest test/**/*_test.rb
+	rubocop

data/README.mkd

@@ -0,0 +1,26 @@
+# 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

data/lib/sunat_invoice/catalogs.rb

@@ -0,0 +1,177 @@
+# frozen_string_literal: false
+
+module SunatInvoice
+  module Catalogs
+    # SUNAT codes
+
+    # Tipo de documento
+    CATALOG_01 = [
+      '01', # FACTURA
+      '03', # BOLETA DE VENTA
+      '07', # NOTA DE CREDITO
+      '08', # NOTA DE DEBITO 383
+      '09', # GUIA DE REMISIÓN REMITENTE
+      '12', # TICKET DE MAQUINA REGISTRADORA
+      '13', # DOCUMENTO EMITIDO POR BANCOS, INSTITUCIONES FINANCIERAS
+      '18', # DOCUMENTOS EMITIDOS POR LAS AFP
+      '31', # GUIA DE REMISIÓN TRANSPORTISTA
+    ].freeze
+
+    # Tipo de Tributo
+    CATALOG_05 = [
+      '1000', # IGV
+      '2000', # ISC
+      '9999'  # Otros
+    ].freeze
+
+    # Tipo de Documentos de Identidad
+    CATALOG_06 = [
+      '0', # DOC.TRIB.NO.DOM.SIN.RUC
+      '1', # DOC. NACIONAL DE IDENTIDAD
+      '4', # CARNET DE EXTRANJERIA
+      '6', # REG. UNICO DE CONTRIBUYENTES
+      '7', # PASAPORTE
+      'A'  # CED. DIPLOMATICA DE IDENTIDAD
+    ].freeze
+
+    # Tipo de Afectación del IGV
+    CATALOG_07 = [
+      '10', # Gravado - Operación Onerosa
+      '11', # Gravado – Retiro por premio
+      '12', # Gravado – Retiro por donación
+      '13', # Gravado – Retiro
+      '14', # Gravado – Retiro por publicidad
+      '15', # Gravado – Bonificaciones
+      '16', # Gravado – Retiro por entrega a trabajadores
+      '20', # Exonerado - Operación Onerosa
+      '30', # Inafecto - Operación Onerosa
+      '31', # Inafecto – Retiro por Bonificación
+      '32', # Inafecto – Retiro
+      '33', # Inafecto – Retiro por Muestras Médicas
+      '34', # Inafecto - Retiro por Convenio Colectivo
+      '35', # Inafecto – Retiro por premio
+      '36', # Inafecto - Retiro por publicidad
+      '40'  # Exportación
+    ].freeze
+
+    # Tipo de Sistema de Cáclulo del ISC
+    CATALOG_08 = [
+      '01', # Sistema al valor
+      '02', # Aplicación del Monto Fijo
+      '03', # Sistema de Precios de Venta al Público
+    ].freeze
+
+    # Tipo de Nota de Crédito Electrónica
+    CATALOG_09 = [
+      '01', # Anulación de la operación
+      '02', # Anulación por error en el RUC
+      '03', # Corrección por error en la descripción
+      '04', # Descuento global
+      '05', # Descuento por ítem
+      '06', # Devolución total
+      '07', # Devolución por ítem
+      '08', # Bonificación
+      '09'  # Disminución en el valor
+    ].freeze
+
+    # Tipo de Nota de Débito Electrónica
+    CATALOG_10 = [
+      '01', # Intereses por mora
+      '02'  # Aumento en el valor
+    ].freeze
+
+    # Resumen Diario de Boletas de Ventas Electrónicas y Notas Electrónicas
+    # Tipo de Valor de Venta
+    CATALOG_11 = [
+      '01', # Gravado
+      '02', # Exonerado
+      '03', # Inafecto
+      '04', # Exportación
+      '05'  # Gratuitas
+    ].freeze
+
+    # Documentos Relacionados Tributarios
+    CATALOG_12 = [
+      '01', # Factura – emitida para corregir error en el RUC
+      '04', # Ticket de Salida - ENAPU
+      '05', # Código SCOP
+      '99'  # Otros
+    ].freeze
+
+    # Otros conceptos tributarios
+    CATALOG_14 = [
+      '1001', # Total valor de venta - operaciones gravadas
+      '1002', # Total valor de venta - operaciones inafectas
+      '1003', # Total valor de venta - operaciones exoneradas
+      '1004', # Total valor de venta - Operaciones gratuitas
+      '1005', # Sub total de venta
+      '2001', # Percepciones
+      '2002', # Retenciones
+      '2003', # Detracciones
+      '2004', # Bonificaciones
+      '2005'  # Total descuentos
+    ].freeze
+
+    # Elementos adicionales en la Factura y/o Boleta de Venta Electrónica
+    CATALOG_15 = [
+      '1000', # Monto en Letras
+      '1002',
+      # Leyenda “TRANSFERENCIA GRATUITA DE UN BIEN Y/O SERVICIO PRESTADO
+      # GRATUITAMENTE”
+      '2000', # Leyenda “COMPROBANTE DE PERCEPCIÓN”
+      '2001',
+      # Leyenda “BIENES TRANSFERIDOS EN LA AMAZONÍA REGIÓN SELVAPARA SER
+      # CONSUMIDOS EN LA MISMA”
+      '2002',
+      # Leyenda “SERVICIOS PRESTADOS EN LA AMAZONÍA REGIÓN SELVA PARA SER
+      # CONSUMIDOS EN LA MISMA”
+      '2003',
+      # Leyenda “CONTRATOS DE CONSTRUCCIÓN EJECUTADOS EN LA AMAZONÍA REGIÓN
+      # SELVA”
+      '2004', # Leyenda “Agencia de Viaje - Paquete turístico”
+      '3000', # Detracciones: CODIGO DE BB Y SS SUJETOS A DETRACCION
+      '3001', # Detracciones: NUMERO DE CTA EN EL BN
+      '3002',
+      # Detracciones: Recursos Hidrobiológicos-Nombre y matrícula de la
+      # embarcación
+      '3003',
+      # Detracciones: Recursos Hidrobiológicos-Tipo y cantidad de especie
+      # vendida
+      '3004', # Detracciones: Recursos Hidrobiológicos -Lugar de descarga
+      '3005', # Detracciones: Recursos Hidrobiológicos -Fecha de descarga
+      '3006',
+      # Detracciones: Transporte Bienes vía terrestre – Numero Registro MTC
+      '3007',
+      # Detracciones: Transporte Bienes vía terrestre -configuración vehicular
+      '3008', # Detracciones: Transporte Bienes vía terrestre – punto de origen
+      '3009', # Detracciones: Transporte Bienes vía terrestre – punto destino
+      '3010',
+      # Detracciones: Transporte Bienes vía terrestre – valor referencial
+      # preliminar
+      '4000', # Beneficio hospedajes: Código País de emisión del pasaporte
+      '4001',
+      # Beneficio hospedajes: Código País de residencia del sujeto no
+      # domiciliado
+      '4002', # Beneficio Hospedajes: Fecha de ingreso al país
+      '4003', # Beneficio Hospedajes: Fecha de ingreso al establecimiento
+      '4004', # Beneficio Hospedajes: Fecha de salida del establecimiento
+      '4005', # Beneficio Hospedajes: Número de días de permanencia
+      '4006', # Beneficio Hospedajes: Fecha de consumo
+      '4007',
+      # Beneficio Hospedajes: Paquete turístico - Nombres y Apellidos del
+      # Huésped
+      '4008',
+      # Beneficio Hospedajes: Paquete turístico – Tipo documento identidad del
+      # huésped
+      '4009'
+      # Beneficio Hospedajes: Paquete turístico – Numero de documento identidad
+      # de huésped
+    ].freeze
+
+    # Tipo de Precio de Venta Unitario
+    CATALOG_16 = [
+      '01', # Precio unitario (incluye el IGV)
+      '02'  # Valor referencial unitario en operaciones no onerosas
+    ].freeze
+  end
+end

data/lib/sunat_invoice/client.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'zip'
+require 'savon'
+
+module SunatInvoice
+  class Client
+    def initialize(env = 'dev')
+      @env = env
+      @soap_client = savon_client
+    end
+
+    def log
+      (@env != 'prod')
+    end
+
+    private
+
+    def config
+      SunatInvoice.configuration
+    end
+
+    def authentication
+      login = config.account_ruc + config.account_user
+      password = config.account_password
+      [login, password]
+    end
+
+    def savon_client
+      Savon.client(wsdl: wsdl,
+                   wsse_auth: authentication,
+                   namespace: 'http://service.sunat.gob.pe',
+                   log: log)
+    end
+  end
+end

data/lib/sunat_invoice/clients/consult_client.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SunatInvoice
+  class ConsultClient < Client
+    # consult CDR and ticket state
+
+    def wsdl
+      'https://www.sunat.gob.pe/ol-it-wsconscpegem/billConsultService?wsdl'
+    end
+  end
+end

data/lib/sunat_invoice/clients/invoice_client.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module SunatInvoice
+  class InvoiceClient < Client
+    def wsdl
+      send("#{@env}_server")
+    end
+
+    def prod_server
+      'https://e-factura.sunat.gob.pe/ol-ti-itcpfegem/billService?wsdl'
+    end
+
+    def dev_server
+      'https://e-beta.sunat.gob.pe/ol-ti-itcpfegem-beta/billService?wsdl'
+    end
+
+    def prepare_zip(invoice, name)
+      # * invoice - xml document to zip
+      # * name - xml document name
+      zip_file = Zip::OutputStream.write_buffer do |zip|
+        zip.put_next_entry name
+        zip.write invoice
+      end
+      zip_file.rewind
+      encode(zip_file.sysread)
+    end
+
+    def send_invoice(invoice, name)
+      zip = prepare_zip(invoice, "#{name}.xml")
+      @soap_client.call(:send_bill,
+                        message: { fileName: "#{name}.zip", contentFile: zip })
+    end
+
+    private
+
+    def encode(zip_str)
+      Base64.encode64(zip_str)
+    end
+  end
+end

data/lib/sunat_invoice/clients/validate_client.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SunatInvoice
+  class ValidateClient < Client
+    # verify invoice generated
+
+    def wsdl
+      'https://www.sunat.gob.pe/ol-it-wsconsvalidcpe/billValidService?wsdl'
+    end
+
+    def verify_file(invoice, name)
+      cli = savon_client(valid_server)
+      cli.call(:verifica_cp_earchivo, message: {
+                 nombre: name, archivo: invoice
+               })
+    end
+  end
+end

data/lib/sunat_invoice/configuration.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module SunatInvoice
+  class Configuration
+    attr_accessor :account_ruc, :account_user, :account_password, :provider
+  end
+end

data/lib/sunat_invoice/customer.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require_relative 'tributer'
+
+module SunatInvoice
+  class Customer < Tributer
+    def info(xml)
+      xml['cac'].AccountingCustomerParty do
+        xml['cbc'].CustomerAssignedAccountID @ruc
+        xml['cbc'].AdditionalAccountID @document_type
+        xml['cac'].Party do
+          xml['cac'].PartyLegalEntity do
+            xml['cbc'].RegistrationName @name
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sunat_invoice/invoice.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: false
+require_relative 'utils'
+require_relative 'provider'
+require_relative 'customer'
+require_relative 'signature'
+require_relative 'tax'
+require_relative 'catalogs'
+
+module SunatInvoice
+  class Invoice < Model
+    include Utils
+
+    attr_accessor :document_type, :document_number, :items
+
+    UBL_VERSION = '2.0'
+    CUSTOMIZATION = '1.0'
+
+    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')
+      @document_type = opts[:document_type] || '01'
+      @document_number = opts[:document_number] || 'F001-1'
+      @currency = opts[:currency] || 'PEN'
+      @items ||= []
+      @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
+    end
+
+    def build_total(xml)
+      xml['cac'].LegalMonetaryTotal do
+        amount_xml(xml['cbc'], 'PayableAmount', @total, @currency)
+      end
+    end
+
+    def add_item(item)
+      items << item if item.is_a?(SunatInvoice::Item)
+    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
+
+    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
+    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
+        }
+      }
+    end
+  end
+end

data/lib/sunat_invoice/item.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+require_relative 'utils'
+
+module SunatInvoice
+  class Item < Model
+    include Utils
+
+    attr_accessor :quantity, :description, :price, :price_code, :unit_code,
+                  :taxes
+
+    def initialize(*args)
+      # * quantity - quantity of item
+      # * description - name or description of product or service
+      # * price - unit price without taxes
+      # * price_code - type unit price (Catalogs::CATALOG_16)
+      # * unit_code - unit of measure
+      #   UN/ECE rec 20- Unit Of Measure
+      #   http://www.unece.org/fileadmin/DAM/cefact/recommendations/rec20/rec20_rev3_Annex2e.pdf
+      # * taxes - An array of SunatInvoice::Tax
+      super(*args)
+      @taxes ||= []
+    end
+
+    def bi_value
+      # bi of sale = price without taxes * quantity
+      (@price.to_f * @quantity.to_f).round(2)
+    end
+
+    def sale_taxes
+      # generate and object with taxes sum by type
+      sums = {}
+      taxes.each do |tax|
+        sums[tax.tax_type] ||= 0
+        sums[tax.tax_type] = (tax.amount.to_f * quantity.to_f).round(2)
+      end
+      sums
+    end
+
+    def sale_price
+      # unit price with tax
+      (@price.to_f + sum_taxes).round(2)
+    end
+
+    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
+    end
+
+    def build_item(xml)
+      xml['cac'].Item do
+        xml['cbc'].Description description
+      end
+    end
+
+    def taxes_xml(xml, currency)
+      taxes&.each do |tax|
+        tax.xml(xml, currency)
+      end
+    end
+  end
+end

data/lib/sunat_invoice/model.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SunatInvoice
+  class Model
+    def initialize(options = {})
+      options.each do |key, value|
+        send("#{key}=", value) if respond_to?("#{key}=")
+      end
+    end
+  end
+end