fortnox-api 0.9.2 → 1.0.0.rc2

data/lib/fortnox/resource.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Fortnox
+  class Resource < RestEasy::Resource
+    include Fortnox::Types
+
+    settings do
+      setting :instance_wrapper, reader: true
+      setting :collection_wrapper, reader: true
+      setting :scope, reader: true
+    end
+
+    @registered_resources = []
+
+    before_parse do |data, meta|
+      if data.key?(config.instance_wrapper)
+        meta.partial = false
+        next data[config.instance_wrapper]
+      elsif data.key?(config.collection_wrapper)
+        meta.partial = true
+        next data[config.collection_wrapper]
+      else
+        raise Fortnox::RequestError, "Unknown response format: #{data}"
+      end
+    end
+
+    after_serialise do |data|
+      if meta.new?
+        # Strip nils for new records — rely on Fortnox defaults
+        data = data.compact
+      elsif __changes__.any?
+        # Only send changed attributes on update, preserving explicit nils
+        changed_api_names = __changes__.keys.filter_map do |model_name|
+          self.class.all_attribute_definitions[model_name]&.api_name
+        end
+        data = data.slice(*changed_api_names)
+      end
+
+      # TODO: rest-easy should do this wrapping for us.
+      { config.instance_wrapper => data }
+    end
+
+    class << self
+      attr_reader :registered_resources
+
+      def inherited(subclass)
+        super
+        Fortnox::Resource.registered_resources << subclass
+      end
+
+      def parse(response)
+        with_translated_errors do
+          pagination = extract_pagination(response)
+          result = super
+          result.is_a?(Array) ? Collection.new(result, **pagination) : result
+        end
+      end
+
+      def stub(**model_data)
+        with_translated_errors { super }
+      end
+
+      def save(instance)
+        with_translated_errors { super }
+      end
+
+      def only(filter)
+        response = get(path: config.path, params: { filter: })
+        parse(response)
+      end
+
+      def search(hash)
+        attribute, value = hash.first
+        response = get(path: config.path, params: { attribute => value })
+        parse(response)
+      end
+
+      def find(id_or_hash)
+        return find_all_by(id_or_hash) if id_or_hash.is_a? Hash
+
+        find_one_by(id_or_hash)
+      end
+
+      def find_one_by(id)
+        response = get(path: "#{config.path}/#{id}")
+        parse(response)
+      end
+
+      def find_all_by(hash)
+        response = get(path: config.path.to_s, params: hash)
+        parse(response)
+      end
+
+      [:get, :post, :put, :delete].each do |method|
+        define_method(method) do |**options|
+          options[:headers] ||= {}
+          options[:headers]['Content-Type'] = 'application/json'
+          options[:headers]['Accept'] = 'application/json'
+          with_translated_errors { super(**options) }
+        end
+      end
+
+      private
+
+      # Translate rest-easy errors at the gem boundary so callers only see
+      # Fortnox-namespaced exceptions.
+      def with_translated_errors
+        yield
+      rescue RestEasy::ConstraintError => e
+        raise Fortnox::ConstraintError.new(e.attribute_name, e.value, e.message)
+      rescue RestEasy::MissingAttributeError => e
+        raise Fortnox::MissingAttributeError, e.attribute_name
+      rescue RestEasy::AttributeError => e
+        raise Fortnox::AttributeError, e.message
+      rescue RestEasy::RequestError => e
+        raise Fortnox::RequestError, e.response || e.message
+      end
+
+      def extract_pagination(data)
+        return {} unless data.is_a?(Hash) && data.key?('MetaInformation')
+
+        meta = data['MetaInformation']
+        {
+          total: meta['@TotalResources']&.to_i,
+          pages: meta['@TotalPages']&.to_i,
+          current_page: meta['@CurrentPage']&.to_i
+        }
+      end
+    end
+  end
+end

data/lib/fortnox/resources/article.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+module Fortnox
+  class Article < Fortnox::Resource
+    using RestEasy::Refinements
+
+    configure do
+      path 'articles'
+      instance_wrapper 'Article'
+      collection_wrapper 'Articles'
+      scope 'article'
+    end
+
+    # @url Direct URL to the record.
+    attr :url <=> '@url', Coercible::String.optional, :read_only
+
+    # True If the article is active
+    attr :active, Bool.optional, Boolean
+
+    # ArticleNumber Article number
+    key :article_number, Sized::String[50]
+
+    # Bulky If the article is bulky.
+    attr :bulky, Bool.optional, Boolean
+
+    # ConstructionAccount Account number for construction work (special VAT rules in Sweden).
+    # The number must be of an existing account.
+    attr :construction_account, Types::AccountNumber
+
+    # Depth The depth of the article in millimeters
+    attr :depth, Sized::Integer[0, 999_999_999]
+
+    # Description The description of the article
+    attr :description, Sized::String[200], :required
+
+    # DisposableQuantity Disposable quantity of the article.
+    attr :disposable_quantity, Coercible::Float.optional, :read_only
+
+    # EAN EAN bar code
+    attr :ean <=> 'EAN', Sized::String[30]
+
+    # EUAccount Account number for the sales account to EU.
+    # The number must be of an existing account.
+    attr :eu_account <=> 'EUAccount', Types::AccountNumber
+
+    # EUVATAccount Account number for the sales account to EU with VAT.
+    # The number must be of an existing account.
+    attr :eu_vat_account <=> 'EUVATAccount', Types::AccountNumber
+
+    # ExportAccount Account number for the sales account outside EU.
+    # The number must be of an existing account.
+    attr :export_account, Types::AccountNumber
+
+    # Height The height of the article in millimeters
+    attr :height, Sized::Integer[0, 999_999_999]
+
+    # Housework If the article is housework
+    attr :housework, Bool.optional, Boolean
+
+    # HouseworkType The type of housework.
+    attr :housework_type, HouseworkTypes
+
+    # Manufacturer The manufacturer of the article
+    attr :manufacturer, Sized::String[50]
+
+    # ManufacturerArticleNumber The manufacturer's article number
+    attr :manufacturer_article_number, Sized::String[50]
+
+    # Note Text note
+    attr :note, Sized::String[10_000]
+
+    # PurchaseAccount Account number for purchase.
+    # The number must be of an existing account.
+    attr :purchase_account, Types::AccountNumber
+
+    # PurchasePrice Purchase price of the article
+    attr :purchase_price, Sized::Float[0.0, 99_999_999_999_999.9]
+
+    # QuantityInStock Quantity in stock of the article
+    attr :quantity_in_stock, Sized::Float[-100_000_000_000_000.0, 99_999_999_999_999.9]
+
+    # ReservedQuantity Reserved quantity of the article
+    attr :reserved_quantity, Coercible::Float.optional, :read_only
+
+    # SalesAccount Account number for the sales account in Sweden.
+    # The number must be of an existing account.
+    attr :sales_account, Types::AccountNumber
+
+    # SalesPrice Price of article for its default price list
+    attr :sales_price, Coercible::Float.optional, :read_only
+
+    # StockGoods If the article is stock goods
+    attr :stock_goods, Bool.optional, Boolean
+
+    # StockPlace Storage place for the article
+    attr :stock_place, Sized::String[100]
+
+    # StockValue Value in stock of the article
+    attr :stock_value, Coercible::Float.optional, :read_only
+
+    # StockWarning When to start warning for low quantity in stock
+    attr :stock_warning, Sized::Float[0.0, 99_999_999_999_999.9]
+
+    # SupplierName Name of the supplier
+    attr :supplier_name, Coercible::String.optional, :read_only
+
+    # SupplierNumber Supplier number for the article.
+    # The number must be of an existing supplier.
+    attr :supplier_number, Coercible::String.optional
+
+    # Type The type of the article
+    attr :type, ArticleTypes
+
+    # Unit Unit code for the article.
+    # The code must be of an existing unit.
+    attr :unit, Coercible::String.optional
+
+    # VAT VAT percent, this is predefined by the VAT for the sales account
+    attr :vat <=> 'VAT', Coercible::Float.optional
+
+    # WebshopArticle If the article is a webshop article
+    attr :webshop_article, Bool.optional, Boolean
+
+    # Weight Weight of the article in grams
+    attr :weight, Sized::Integer[0, 999_999_999]
+
+    # Width Width of the article in millimeters.
+    attr :width, Sized::Integer[0, 999_999_999]
+
+    # True If the article has expired
+    attr :expired, Bool.optional, Boolean
+
+    # CostCalculationMethod Cost calculation method used for the article.
+    attr :cost_calculation_method, Coercible::String.optional
+
+    # StockAccount Account number for stock.
+    attr :stock_account, Types::AccountNumber
+
+    # StockChangeAccount Account number for stock changes.
+    attr :stock_change_account, Types::AccountNumber
+
+    # DirectCost Direct cost of the article.
+    attr :direct_cost, Coercible::Float.optional
+
+    # FreightCost Freight cost of the article.
+    attr :freight_cost, Coercible::Float.optional
+
+    # OtherCost Other cost of the article.
+    attr :other_cost, Coercible::Float.optional
+
+    # DefaultStockPoint Default stock point for the article.
+    attr :default_stock_point, Coercible::String.optional
+
+    # DefaultStockLocation Default stock location for the article.
+    attr :default_stock_location, Coercible::String.optional
+
+    # CommodityCode Commodity code of the article.
+    attr :commodity_code, Coercible::String.optional
+  end
+end

data/lib/fortnox/resources/customer.rb

@@ -0,0 +1,209 @@
+# frozen_string_literal: true
+
+module Fortnox
+  class Customer < Fortnox::Resource
+    using RestEasy::Refinements
+
+    configure do
+      path 'customers'
+      instance_wrapper 'Customer'
+      collection_wrapper 'Customers'
+      scope 'customer'
+    end
+
+    # Direct URL to the record.
+    attr :url <=> '@url', Coercible::String.optional, :read_only
+
+    # First address of the customer
+    attr :address1, Sized::String[1024]
+
+    # Second address of the customer
+    attr :address2, Sized::String[1024]
+
+    # City of the customer
+    attr :city, Sized::String[1024]
+
+    # Country of the customer
+    attr :country, Coercible::String.optional, :read_only
+
+    # Comments
+    attr :comments, Sized::String[1024]
+
+    # Currency of the customer
+    attr :currency, Currencies
+
+    # Cost center of the customer
+    attr :cost_center, Coercible::String.optional
+
+    # Country code of the customer
+    attr :country_code, Sized::String[2]
+
+    # Customer number
+    key :customer_number, Sized::String[1024]
+
+    # Default delivery types
+    attr :default_delivery_types, Structs::DefaultDeliveryTypes, Mappers::Struct.for(Structs::DefaultDeliveryTypes)
+
+    # Default templates
+    attr :default_templates, Structs::DefaultTemplates, Mappers::Struct.for(Structs::DefaultTemplates)
+
+    # First delivery address of the customer
+    attr :delivery_address1, Sized::String[1024]
+
+    # Second delivery address of the customer
+    attr :delivery_address2, Sized::String[1024]
+
+    # Delivery city of the customer
+    attr :delivery_city, Sized::String[1024]
+
+    # Delivery country of the customer
+    attr :delivery_country, Coercible::String.optional, :read_only
+
+    # Delivery country code of the customer
+    attr :delivery_country_code, Sized::String[2]
+
+    # Delivery fax number of the customer
+    attr :delivery_fax, Sized::String[1024]
+
+    # Delivery name of the customer
+    attr :delivery_name, Sized::String[1024]
+
+    # First delivery phone number of the customer
+    attr :delivery_phone1, Sized::String[1024]
+
+    # Second delivery phone number of the customer
+    attr :delivery_phone2, Sized::String[1024]
+
+    # Delivery zip code of the customer
+    attr :delivery_zip_code, Sized::String[1024]
+
+    # Email address of the customer
+    attr :email, Email
+
+    # Invoice email address of the customer
+    attr :email_invoice, Email
+
+    # Invoice BCC email address of the customer
+    attr :email_invoice_bcc <=> 'EmailInvoiceBCC', Email
+
+    # Invoice CC email address of the customer
+    attr :email_invoice_cc <=> 'EmailInvoiceCC', Email
+
+    # Offer email address of the customer
+    attr :email_offer, Email
+
+    # Offer BCC email address of the customer
+    attr :email_offer_bcc <=> 'EmailOfferBCC', Email
+
+    # Offer CC email address of the customer
+    attr :email_offer_cc <=> 'EmailOfferCC', Email
+
+    # Order email address of the customer
+    attr :email_order, Email
+
+    # Order BCC email address of the customer
+    attr :email_order_bcc <=> 'EmailOrderBCC', Email
+
+    # Order CC email address of the customer
+    attr :email_order_cc <=> 'EmailOrderCC', Email
+
+    # Fax number of the customer
+    attr :fax, Sized::String[1024]
+
+    # Invoice administration fee, 12 digits (incl. decimals)
+    attr :invoice_administration_fee, Sized::Float[0.0, 99_999_999_999.9]
+
+    # Invoice discount, 12 digits (incl. decimals)
+    attr :invoice_discount, Sized::Float[0.0, 99_999_999_999.9]
+
+    # Invoice freight fee, 12 digits (incl. decimals)
+    attr :invoice_freight, Sized::Float[0.0, 99_999_999_999.9]
+
+    # Invoice remark
+    attr :invoice_remark, Sized::String[1024]
+
+    # Name of the customer
+    attr :name, Sized::String[1024], :required
+
+    # Organisation number of the customer
+    attr :organisation_number, Sized::String[30]
+
+    # Our reference
+    attr :our_reference, Sized::String[50]
+
+    # First phone number of the customer
+    attr :phone1, Sized::String[1024]
+
+    # Second phone number of the customer
+    attr :phone2, Sized::String[1024]
+
+    # Price list of the customer
+    attr :price_list, Coercible::String.optional
+
+    # Project of the customer
+    attr :project, Coercible::String.optional
+
+    # Sales account of the customer
+    attr :sales_account, Types::AccountNumber
+
+    # Show prices with VAT included or not
+    attr :show_price_vat_included <=> 'ShowPriceVATIncluded', Bool.optional, Boolean
+
+    # Terms of delivery code
+    attr :terms_of_delivery, Coercible::String.optional
+
+    # Terms of payment code
+    attr :terms_of_payment, Coercible::String.optional
+
+    # Customer type
+    attr :type, CustomerTypes
+
+    # VAT number of the customer
+    attr :vat_number <=> 'VATNumber', Coercible::String.optional
+
+    # VAT type of the customer
+    attr :vat_type <=> 'VATType', VATTypes
+
+    # Visit address of the customer
+    attr :visiting_address, Sized::String[128]
+
+    # Visit city of the customer
+    attr :visiting_city, Sized::String[128]
+
+    # Visit country of the customer
+    attr :visiting_country, Coercible::String.optional, :read_only
+
+    # Visiting country code
+    attr :visiting_country_code, Sized::String[2]
+
+    # Visit zip code of the customer
+    attr :visiting_zip_code, Sized::String[10]
+
+    # Way of delivery code
+    attr :way_of_delivery, Coercible::String.optional
+
+    # Your reference
+    attr :your_reference, Sized::String[50]
+
+    # Zip code of the customer
+    attr :zip_code, Sized::String[10]
+
+    # Active If the customer is active.
+    attr :active, Bool.optional, Boolean
+
+    # Phone number of the customer. Only present in collection responses.
+    attr :phone, Coercible::String.optional
+
+    # External reference
+    attr :external_reference, Sized::String[1024]
+
+    # GLN Global Location Number
+    attr :gln <=> 'GLN', Sized::String[13]
+
+    # GLNDelivery Global Location Number for delivery
+    attr :gln_delivery <=> 'GLNDelivery', Sized::String[13]
+
+    # WWW Website URL
+    attr :www <=> 'WWW', Sized::String[128]
+  end
+end

data/lib/fortnox/resources/document.rb

@@ -0,0 +1,202 @@
+# frozen_string_literal: true
+
+module Fortnox
+  # Shared attributes for Offer, Order and Invoice — the three "document" resources in Fortnox.
+  # In the Fortnox implementation these are so close together that they are saved in the same database table.
+  # This is never used standalone, only inherited by the respective resources.
+  class Document < Fortnox::Resource
+    using RestEasy::Refinements
+
+    # Url Direct url to the record.
+    attr :url <=> '@url', Coercible::String.optional, :read_only
+
+    # @urlTaxReductionList Direct URL to the tax reduction list.
+    attr :tax_reduction_list_url <=> '@urlTaxReductionList', Coercible::String.optional, :read_only
+
+    # AdministrationFee The document administration fee.
+    attr :administration_fee, Coercible::Float.optional
+
+    # AdministrationFeeVAT VAT of the document administration fee.
+    attr :administration_fee_vat <=> 'AdministrationFeeVAT', Coercible::Float.optional, :read_only
+
+    # Address1 Document address 1.
+    attr :address1, Sized::String[1024]
+
+    # Address2 Document address 2
+    attr :address2, Sized::String[1024]
+
+    # BasisTaxReduction Basis of tax reduction.
+    attr :basis_tax_reduction, Coercible::Float.optional, :read_only
+
+    # Cancelled If the document is cancelled.
+    attr :cancelled, Bool.optional, :read_only, Boolean
+
+    # City City for the document address.
+    attr :city, Sized::String[1024]
+
+    # Comments Comments of the document
+    attr :comments, Sized::String[1024]
+
+    # ContributionPercent Document contribution in percent.
+    attr :contribution_percent, Coercible::Float.optional, :read_only
+
+    # ContributionValue Document contribution in amount.
+    attr :contribution_value, Coercible::Float.optional, :read_only
+
+    # Country Country for the document address.
+    attr :country_code <=> 'Country', Sized::String[2], Mappers::CountryCode
+
+    # CostCenter Code of the cost center.
+    attr :cost_center, Coercible::String.optional
+
+    # Currency Code of the currency.
+    attr :currency, Currencies
+
+    # CurrencyRate Currency rate used for the document
+    attr :currency_rate, Coercible::Float.optional
+
+    # CurrencyUnit Currency unit used for the document
+    attr :currency_unit, Coercible::Float.optional
+
+    # CustomerName Name of the customer
+    attr :customer_name, Sized::String[1024]
+
+    # CustomerNumber Customer number of the customer.
+    attr :customer_number, Strict::String, :required
+
+    # DeliveryAddress1 Document delivery address 1.
+    attr :delivery_address1, Sized::String[1024]
+
+    # DeliveryAddress2 Document delivery address 2.
+    attr :delivery_address2, Sized::String[1024]
+
+    # DeliveryCity City for the document delivery address.
+    attr :delivery_city, Sized::String[1024]
+
+    # DeliveryCountry Country for the document delivery address.
+    attr :delivery_country, Sized::String[2], Mappers::CountryCode
+
+    # DeliveryDate Date of delivery.
+    attr :delivery_date, Date.optional, Mappers::Date
+
+    # DeliveryName Name of the recipient of the delivery
+    attr :delivery_name, Sized::String[1024]
+
+    # DeliveryZipCode ZipCode for the document delivery address.
+    attr :delivery_zip_code, Sized::String[1024]
+
+    # DocumentNumber The document number.
+    key :document_number, Coercible::Integer.optional
+
+    # EmailInformation Separate EmailInformation object
+    attr :email_information, Structs::EmailInformation, Mappers::EmailInformation
+
+    # ExternalInvoiceReference1 External document reference 1
+    attr :external_invoice_reference1, Sized::String[80]
+
+    # ExternalInvoiceReference2 External document reference 2
+    attr :external_invoice_reference2, Sized::String[80]
+
+    # Freight Freight cost of the document. 12 digits (incl. decimals)
+    attr :freight, Sized::Float[0.0, 99_999_999_999.9]
+
+    # FreightVAT VAT of the freight cost.
+    attr :freight_vat <=> 'FreightVAT', Coercible::Float.optional, :read_only
+
+    # Gross Gross value of the document
+    attr :gross, Coercible::Float.optional, :read_only
+
+    # HouseWork If there is any row of the document marked "housework".
+    attr :housework <=> 'HouseWork', Bool.optional, :read_only, Boolean
+
+    # Labels attached to the document.
+    attr :labels, Strict::Array.of(Types.Instance(Label)), Mappers::LabelReferences
+
+    # Net Net amount
+    attr :net, Coercible::Float.optional, :read_only
+
+    # NotCompleted If the document is set as not completed.
+    attr :not_completed, Bool.optional, Boolean
+
+    # OfferReference Reference to the offer, if one exists.
+    attr :offer_reference, Coercible::Integer.optional, :read_only
+
+    # OrganisationNumber Organisation number of the customer for the document.
+    attr :organisation_number, Coercible::String.optional, :read_only
+
+    # OurReference Our reference
+    attr :our_reference, Sized::String[50]
+
+    # Phone1 Phone number 1 of the customer for the document
+    attr :phone1, Sized::String[1024]
+
+    # Phone2 Phone number 2 of the customer for the document
+    attr :phone2, Sized::String[1024]
+
+    # PriceList Code of the price list.
+    attr :price_list, Coercible::String.optional
+
+    # PrintTemplate Print template of the document.
+    attr :print_template, Coercible::String.optional
+
+    # Project Code of the project.
+    attr :project, Coercible::String.optional
+
+    # Remarks Remarks of the document
+    attr :remarks, Sized::String[1024]
+
+    # RoundOff Round off amount for the document.
+    attr :round_off, Coercible::Float.optional, :read_only
+
+    # Sent If the document is printed or sent in any way.
+    attr :sent, Bool.optional, :read_only, Boolean
+
+    # TaxReduction The amount of tax reduction.
+    attr :tax_reduction, Coercible::Integer.optional, :read_only
+
+    # TaxReductionType Type of tax reduction.
+    attr :tax_reduction_type, TaxReductionTypes
+
+    # TermsOfDelivery Code of the terms of delivery.
+    attr :terms_of_delivery, Coercible::String.optional
+
+    # TermsOfPayment Code of the terms of payment.
+    attr :terms_of_payment, Coercible::String.optional
+
+    # Total The total amount of the document.
+    attr :total, Coercible::Float.optional, :read_only
+
+    # TotalVAT The total VAT amount of the document.
+    attr :total_vat <=> 'TotalVAT', Coercible::Float.optional, :read_only
+
+    # VATIncluded If the price of the document is including VAT.
+    attr :vat_included <=> 'VATIncluded', Bool.optional, Boolean
+
+    # WayOfDelivery Code of the way of delivery.
+    attr :way_of_delivery, Coercible::String.optional
+
+    # YourOrderNumber Your order number
+    attr :your_order_number, Sized::String[75]
+
+    # YourReference Your reference
+    attr :your_reference, Sized::String[50]
+
+    # ZipCode Zip code of the document
+    attr :zip_code, Sized::String[1024]
+
+    # Language Language code.
+    attr :language, Coercible::String.optional
+
+    # OutboundDate Date of outbound delivery.
+    attr :outbound_date, Date.optional, Mappers::Date
+
+    # TimeBasisReference Reference to time basis.
+    attr :time_basis_reference, Coercible::Integer.optional
+
+    # TotalToPay Total amount to pay.
+    attr :total_to_pay, Coercible::Float.optional
+
+    # WarehouseReady If the document is warehouse ready.
+    attr :warehouse_ready, Bool.optional, Boolean
+  end
+end