fortnox-api 0.1.0 → 0.2.0

data/lib/fortnox/api/models/document_base.rb

@@ -0,0 +1,189 @@
+require "fortnox/api/types"
+require "fortnox/api/models/label"
+
+module Fortnox
+  module API
+    module Model
+      module DocumentBase
+        # Method length is ignored due to readability.
+        # rubocop:disable Metrics/MethodLength
+        def self.ify( base )
+          base.class_eval do
+
+            # Url Direct url to the record.
+            base.attribute :url, Types::Nullable::String.with( read_only: true )
+
+            # AdministrationFee The document administration fee.
+            base.attribute :administration_fee, Types::Nullable::Float
+
+            # AdministrationFeeVAT VAT of the document administration fee.
+            base.attribute :administration_fee_vat, Types::Nullable::Float.with( read_only: true )
+
+            # Address1 Document address 1. 1024 characters
+            base.attribute :address1, Types::Sized::String[ 1024 ]
+
+            # Address2 Document address 2. 1024 characters
+            base.attribute :address2, Types::Sized::String[ 1024 ]
+
+            # BasisTaxReduction Basis of tax reduction.
+            base.attribute :basis_tax_reduction, Types::Nullable::Float.with( read_only: true )
+
+            # Cancelled If the document is cancelled.
+            base.attribute :cancelled, Types::Nullable::Boolean.with( read_only: true )
+
+            # City City for the document address.
+            base.attribute :city, Types::Sized::String[ 1024 ]
+
+            # Comments Comments of the document
+            base.attribute :comments, Types::Sized::String[ 1024 ]
+
+            # ContributionPercent Document contribution in percent.
+            base.attribute :contribution_percent, Types::Nullable::Float.with( read_only: true )
+
+            # ContributionValue Document contribution in amount.
+            base.attribute :contribution_value, Types::Nullable::Float.with( read_only: true )
+
+            # Country Country for the document address.
+            base.attribute :country, Fortnox::API::Types::CountryCode
+
+            # CostCenter Code of the cost center.
+            base.attribute :cost_center, Types::Nullable::String
+
+            # Currency Code of the currency.
+            base.attribute :currency, Fortnox::API::Types::Currency
+
+            # CurrencyRate Currency rate used for the document
+            base.attribute :currency_rate, Types::Nullable::Float
+
+            # CurrencyUnit Currency unit used for the document
+            base.attribute :currency_unit, Types::Nullable::Float
+
+            # CustomerName Name of the customer. 1024 characters
+            base.attribute :customer_name, Types::Sized::String[ 1024 ]
+
+            # CustomerNumber Customer number of the customer. Required
+            base.attribute :customer_number, Types::Required::String
+
+            # DeliveryAddress1 Document delivery address 1.
+            base.attribute :delivery_address1, Types::Sized::String[ 1024 ]
+
+            # DeliveryAddress2 Document delivery address 2.
+            base.attribute :delivery_address2, Types::Sized::String[ 1024 ]
+
+            # DeliveryCity City for the document delivery address.
+            base.attribute :delivery_city, Types::Sized::String[ 1024 ]
+
+            # DeliveryCountry Country for the document delivery address.
+            base.attribute :delivery_country, Fortnox::API::Types::CountryCode
+
+            # DeliveryDate Date of delivery.
+            base.attribute :delivery_date, Types::Nullable::Date
+
+            # DeliveryName  Name of the recipient of the delivery
+            base.attribute :delivery_name, Types::Sized::String[ 1024 ]
+
+            # DeliveryZipCode ZipCode for the document delivery address.
+            base.attribute :delivery_zip_code, Types::Sized::String[ 1024 ]
+
+            # DocumentNumber The document number.
+            base.attribute :document_number, Types::Nullable::Integer
+
+            # EmailInformation Separete EmailInformation object
+            base.attribute :email_information, Types::EmailInformation
+
+            # ExternalInvoiceReference1 External document reference 1. 80 characters
+            base.attribute :external_invoice_reference1, Types::Sized::String[ 80 ]
+
+            # ExternalInvoiceReference2 External document reference 2. 80 characters
+            base.attribute :external_invoice_reference2, Types::Sized::String[ 80 ]
+
+            # Freight Freight cost of the document. 12 digits (incl. decimals)
+            base.attribute :freight, Types::Sized::Float[ 0.0, 99_999_999_999.0 ]
+
+            # FreightVAT VAT of the freight cost.
+            base.attribute :freight_vat, Types::Nullable::Float.with( read_only: true )
+
+            # Gross Gross value of the document
+            base.attribute :gross, Types::Nullable::Float.with( read_only: true )
+
+            # HouseWork If there is any row of the document marked “house work”.
+            base.attribute :house_work, Types::Nullable::Boolean.with( read_only: true )
+
+            base.attribute :labels, Types::Strict::Array.member( Label )
+
+            # Net Net amount
+            base.attribute :net, Types::Nullable::Float.with( read_only: true )
+
+            # NotCompleted If the document is set as not completed.
+            base.attribute :not_completed, Types::Nullable::Boolean
+
+            # OfferReference Reference to the offer, if one exists.
+            base.attribute :offer_reference, Types::Nullable::Integer.with( read_only: true )
+
+            # OrganisationNumber Organisation number of the customer for the
+            # document.
+            base.attribute :organisation_number, Types::Nullable::String.with( read_only: true )
+
+            # OurReference Our reference. 50 characters
+            base.attribute :our_reference, Types::Sized::String[ 50 ]
+
+            # Phone1 Phone number 1 of the customer for the document. 1024 characters
+            base.attribute :phone1, Types::Sized::String[ 1024 ]
+
+            # Phone2 Phone number 2 of the customer for the document. 1024 characters
+            base.attribute :phone2, Types::Sized::String[ 1024 ]
+
+            # PriceList Code of the price list.
+            base.attribute :price_list, Types::Nullable::String
+
+            # PrintTemplate Print template of the document.
+            base.attribute :print_template, Types::Nullable::String
+
+            # Project Code of the project.
+            base.attribute :project, Types::Nullable::String
+
+            # Remarks Remarks of the document. 1024 characters
+            base.attribute :remarks, Types::Sized::String[ 1024 ]
+
+            # RoundOff Round off amount for the document.
+            base.attribute :round_off, Types::Nullable::Float.with( read_only: true )
+
+            # Sent If the document is printed or sent in any way.
+            base.attribute :sent, Types::Nullable::Boolean.with( read_only: true )
+
+            # TaxReduction The amount of tax reduction.
+            base.attribute :tax_reduction, Types::Nullable::Integer.with( read_only: true )
+
+            # TermsOfDelivery Code of the terms of delivery.
+            base.attribute :terms_of_delivery, Types::Nullable::String
+
+            # TermsOfPayment Code of the terms of payment.
+            base.attribute :terms_of_payment, Types::Nullable::String
+
+            # Total The total amount of the document.
+            base.attribute :total, Types::Nullable::Float.with( read_only: true )
+
+            # TotalVAT The total VAT amount of the document.
+            base.attribute :total_vat, Types::Nullable::Float.with( read_only: true )
+
+            # VATIncluded If the price of the document is including VAT.
+            base.attribute :vat_included, Types::Nullable::Boolean
+
+            # WayOfDelivery Code of the way of delivery.
+            base.attribute :way_of_delivery, Types::Nullable::String
+
+            # YourOrderNumber Your order number. 30 characters
+            base.attribute :your_order_number, Types::Sized::String[ 30 ]
+
+            # YourReference Your reference. 50 characters
+            base.attribute :your_reference, Types::Sized::String[ 50 ]
+
+            # ZipCode Zip code of the document. 1024 characters
+            base.attribute :zip_code, Types::Sized::String[ 1024 ]
+          end
+        end
+        # rubocop:enable Metrics/MethodLength
+      end
+    end
+  end
+end

data/lib/fortnox/api/models/invoice.rb

@@ -1,252 +1,86 @@
 require "fortnox/api/models/base"
-require "fortnox/api/models/edi_information"
-require "fortnox/api/models/email_information"
-require "fortnox/api/models/row"
+require "fortnox/api/models/document_base"
 
 module Fortnox
   module API
     module Model
       class Invoice < Fortnox::API::Model::Base
+        UNIQUE_ID = :document_number
+        STUB = { customer_number: '' }.freeze
 
-        #Url Direct url to the record.
-        attribute :url, String, writer: :private
+        DocumentBase.ify( self )
 
         #UrlTaxReductionList Direct url to the tax reduction for the invoice.
-        attribute :url_tax_reduction_list, String, writer: :private
+        attribute :url_tax_reduction_list, Types::Nullable::String.with( read_only: true )
 
         #AccountingMethod Accounting Method.
-        attribute :accounting_method, String
-
-        #AdministrationFee The invoice administration fee. 12 digits (incl. decimals)
-        attribute :administration_fee, Float
-
-        #AdministrationFeeVAT VAT of the invoice administration fee.
-        attribute :administration_fee_vat, Float, writer: :private
-
-        #Address1 Invoice address 1. 1024 characters
-        attribute :address1, String
-
-        #Address2 Invoice address 2. 1024 characters
-        attribute :address2, String
+        attribute :accounting_method, Types::Nullable::String
 
         #Balance Balance of the invoice.
-        attribute :balance, Float, writer: :private
-
-        #BasisTaxReduction Basis of tax reduction.
-        attribute :basis_tax_reduction, Float, writer: :private
+        attribute :balance, Types::Nullable::Float.with( read_only: true )
 
         #Booked If the invoice is bookkept.
-        attribute :booked, Boolean, writer: :private
-
-        #Cancelled If the invoice is cancelled.
-        attribute :cancelled, Boolean, writer: :private
+        attribute :booked, Types::Nullable::Boolean.with( read_only: true )
 
         #Credit If the invoice is a credit invoice.
-        attribute :credit, Boolean, writer: :private
+        attribute :credit, Types::Nullable::Boolean.with( read_only: true )
 
         #CreditInvoiceReference Reference to the credit invoice, if one exits.
-        attribute :credit_invoice_reference, Integer
-
-        #City City for the invoice address.
-        attribute :city, String
-
-        #Comments Comments of the invoice
-        attribute :comments, String
+        attribute :credit_invoice_reference, Types::Nullable::Integer
 
         #ContractReference Reference to the contract, if one exists.
-        attribute :contract_reference, Integer, writer: :private
-
-        #ContributionPercent Invoice contribution in percent.
-        attribute :contribution_percent, Float, writer: :private
-
-        #ContributionValue Invoice contribution in amount.
-        attribute :contribution_value, Float, writer: :private
-
-        #Country Country for the invoice address.
-        attribute :country, String
-
-        # CostCenter Code of the cost center.
-        attribute :cost_center, String
-
-        #Currency Code of the currency.
-        attribute :currency, String
-
-        #CurrencyRate Currency rate used for the invoice. 16 digits
-        attribute :currency_rate, Float
-
-        #CurrencyUnit Currency unit used for the invoice. 16 digits
-        attribute :currency_unit, Float
-
-        #CustomerName Name of the customer. 1024 characters
-        attribute :customer_name, String
-
-        #CustomerNumber Customer number of the customer. Required
-        attribute :customer_number, String
-
-        #DeliveryAddress1 Invoice delivery address 1.
-        attribute :delivery_address1, String
-
-        #DeliveryAddress2 Invoice delivery address 2.
-        attribute :delivery_address2, String
-
-        #DeliveryCity City for the invoice delivery address.
-        attribute :delivery_city, String
-
-        #DeliveryCountry Country for the invoice delivery address.
-        attribute :delivery_country, String
-
-        #DeliveryDate Date of delivery.
-        attribute :delivery_date, Date
-
-        #DeliveryName  Name of the recipient of the delivery
-        attribute :delivery_name, String
-
-        #DeliveryZipCode ZipCode for the invoice delivery address.
-        attribute :delivery_zip_code, String
-
-        #DocumentNumber The invoice number.
-        attribute :document_number, Integer
+        attribute :contract_reference, Types::Nullable::Integer.with( read_only: true )
 
         #DueDate Due date of the invoice.
-        attribute :due_date, Date
+        attribute :due_date, Types::Nullable::Date
 
         #EDIInformation Separate EDIInformation object
-        attribute :edi_information, EDIInformation
-
-        #EmailInformation Separete EmailInformation object
-        attribute :email_information, EmailInformation
+        attribute :edi_information, Types::EDIInformation
 
         #EUQuarterlyReport EU Quarterly Report On / Off
-        attribute :eu_quarterly_report, Boolean
-
-        #ExternalInvoiceReference1 External invoice reference 1. 80 characters
-        attribute :external_invoice_reference1, String
-
-        #ExternalInvoiceReference2 External invoice reference 2. 80 characters
-        attribute :external_invoice_reference2, String
-
-        #Freight Freight cost of the invoice. 12 digits (incl. decimals)
-        attribute :freight, Float
-
-        #FreightVAT VAT of the freight cost.
-        attribute :freight_vat, Float, writer: :private
-
-        #Gross Gross value of the invoice
-        attribute :gross, Float, writer: :private
-
-        #HouseWork If there is any row of the invoice marked “house work”.
-        attribute :house_work, Boolean, writer: :private
+        attribute :eu_quarterly_report, Types::Nullable::Boolean
 
         #InvoiceDate Invoice date.
-        attribute :invoice_date, Date
+        attribute :invoice_date, Types::Nullable::Date
 
         #InvoicePeriodStart Start date of the invoice period.
-        attribute :invoice_period_start, Date, writer: :private
+        attribute :invoice_period_start, Types::Nullable::Date.with( read_only: true )
 
         #InvoicePeriodEnd End date of the invoice period.
-        attribute :invoice_period_end, Date, writer: :private
+        attribute :invoice_period_end, Types::Nullable::Date.with( read_only: true )
 
-        #InvoiceRows Separate Row object
-        attribute :invoice_rows, Array[Row]
+        #InvoiceRows Separate object
+        attribute :invoice_rows, Types::Strict::Array.member( Types::InvoiceRow )
 
         #InvoiceType The type of invoice.
-        attribute :invoice_type, String
+        attribute :invoice_type, Types::Nullable::String
 
         #Language Language code.
-        attribute :language, String
+        attribute :language, Types::Nullable::String
 
         #LastRemindDate Date of last reminder.
-        attribute :last_remind_date, Date, writer: :private
-
-        #Net Net amount
-        attribute :net, Float, writer: :private
-
-        #NotCompleted If the invoice is set as not completed.
-        attribute :not_completed, Boolean
+        attribute :last_remind_date, Types::Nullable::Date.with( read_only: true )
 
         #NoxFinans If the invoice is managed by NoxFinans
-        attribute :nox_finans, Boolean, writer: :private
+        attribute :nox_finans, Types::Nullable::Boolean.with( read_only: true )
 
         #OCR OCR number of the invoice.
-        attribute :ocr, String
-
-        #OfferReference Reference to the offer, if one exists.
-        attribute :offer_reference, Integer, writer: :private
+        attribute :ocr, Types::Nullable::String
 
         #OrderReference Reference to the order, if one exists.
-        attribute :order_reference, Integer, writer: :private
-
-        #OrganisationNumber Organisation number of the customer for the invoice.
-        attribute :organisation_number, String, writer: :private
-
-        #OurReference Our reference. 50 characters
-        attribute :our_reference, String
-
-        #Phone1 Phone number 1 of the customer for the invoice. 1024 characters
-        attribute :phone1, String
-
-        #Phone2 Phone number 2 of the customer for the invoice. 1024 characters
-        attribute :phone2, String
-
-        #PriceList Code of the price list.
-        attribute :price_list, String
-
-        #PrintTemplate Print template of the invoice.
-        attribute :print_template, String
-
-        #Project Code of the project.
-        attribute :project, String
-
-        #Remarks Remarks of the invoice. 1024 characters
-        attribute :remarks, String
+        attribute :order_reference, Types::Nullable::Integer.with( read_only: true )
 
         #Reminders Number of reminders sent to the customer.
-        attribute :reminders, Integer, writer: :private
-
-        #RoundOff Round off amount for the invoice.
-        attribute :round_off, Float, writer: :private
-
-        #Sent If the document is printed or sent in any way.
-        attribute :sent, Boolean, writer: :private
-
-        #TaxReduction The amount of tax reduction.
-        attribute :tax_reduction, Integer, writer: :private
-
-        #TermsOfDelivery Code of the terms of delivery.
-        attribute :terms_of_delivery, String
-
-        #TermsOfPayment Code of the terms of payment.
-        attribute :terms_of_payment, String
-
-        #Total The total amount of the invoice.
-        attribute :total, Float, writer: :private
-
-        #TotalVAT The total VAT amount of the invoice.
-        attribute :total_vat, Float, writer: :private
-
-        #VATIncluded If the price of the invoice is including VAT.
-        attribute :vat_included, Boolean
+        attribute :reminders, Types::Nullable::Integer.with( read_only: true )
 
         #VoucherNumber Voucher number for the invoice.
-        attribute :voucher_number, Integer, writer: :private
+        attribute :voucher_number, Types::Nullable::Integer.with( read_only: true )
 
         #VoucherSeries Voucher series for the invoice.
-        attribute :voucher_series, String, writer: :private
+        attribute :voucher_series, Types::Nullable::String.with( read_only: true )
 
         #VoucherYear Voucher year for the invoice.
-        attribute :voucher_year, Integer, writer: :private
-
-        #WayOfDelivery Code of the way of delivery.
-        attribute :way_of_delivery, String
-
-        #YourOrderNumber Your order number. 30 characters
-        attribute :your_order_number, String
-
-        #YourReference Your reference. 50 characters
-        attribute :your_reference, String
-
-        #ZipCode Zip code of the invoice. 1024 characters
-        attribute :zip_code, String
+        attribute :voucher_year, Types::Nullable::Integer.with( read_only: true )
       end
     end
   end