fortnox-api 0.9.2 → 1.0.0.rc2

data/lib/fortnox/resources/invoice.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Fortnox
+  class Invoice < Document
+    using RestEasy::Refinements
+
+    configure do
+      path 'invoices'
+      instance_wrapper 'Invoice'
+      collection_wrapper 'Invoices'
+      scope 'invoice'
+    end
+
+    # AccountingMethod Accounting Method.
+    attr :accounting_method, AccountingMethods
+
+    # Balance Balance of the invoice.
+    attr :balance, Coercible::Float.optional, :read_only
+
+    # Booked If the invoice is bookkept.
+    attr :booked, Bool.optional, :read_only, Boolean
+
+    # Credit If the invoice is a credit invoice.
+    attr :credit, Bool.optional, :read_only, Boolean
+
+    # CreditInvoiceReference Reference to the credit invoice, if one exists.
+    attr :credit_invoice_reference, Coercible::Integer.optional
+
+    # ContractReference Reference to the contract, if one exists.
+    attr :contract_reference, Coercible::Integer.optional, :read_only
+
+    # DueDate Due date of the invoice.
+    attr :due_date, Date.optional, Mappers::Date
+
+    # EDIInformation Separate EDIInformation object
+    attr :edi_information <=> 'EDIInformation', Structs::EDIInformation, Mappers::EDIInformation
+
+    # EUQuarterlyReport EU Quarterly Report On / Off
+    attr :eu_quarterly_report <=> 'EUQuarterlyReport', Bool.optional, Boolean
+
+    # FinalPayDate Final pay date of the invoice.
+    attr :final_pay_date, Date.optional, Mappers::Date
+
+    # InvoiceDate Invoice date.
+    attr :invoice_date, Date.optional, Mappers::Date
+
+    # InvoicePeriodStart Start date of the invoice period.
+    attr :invoice_period_start, Date.optional, :read_only, Mappers::Date
+
+    # InvoicePeriodEnd End date of the invoice period.
+    attr :invoice_period_end, Date.optional, :read_only, Mappers::Date
+
+    # InvoicePeriodReference Reference to the invoice period.
+    attr :invoice_period_reference, Coercible::String.optional
+
+    # InvoiceReference Reference to another invoice.
+    attr :invoice_reference, Coercible::String.optional
+
+    # InvoiceRows Separate object
+    attr :invoice_rows, Strict::Array.of(Structs::InvoiceRow), Mappers::StructArray.for(Mappers::InvoiceRow)
+
+    # InvoiceType The type of invoice.
+    attr :invoice_type, InvoiceTypes
+
+    # LastRemindDate Date of last reminder.
+    attr :last_remind_date, Date.optional, :read_only, Mappers::Date
+
+    # NoxFinans If the invoice is managed by NoxFinans
+    attr :nox_finans, Bool.optional, :read_only, Boolean
+
+    # OCR OCR number of the invoice.
+    attr :ocr <=> 'OCR', Coercible::String.optional
+
+    # OrderReference Reference to the order, if one exists.
+    attr :order_reference, Coercible::Integer.optional, :read_only
+
+    # PaymentWay Payment way of the invoice.
+    attr :payment_way, PaymentWays
+
+    # Reminders Number of reminders sent to the customer.
+    attr :reminders, Coercible::Integer.optional, :read_only
+
+    # VoucherNumber Voucher number for the invoice.
+    attr :voucher_number, Coercible::Integer.optional, :read_only
+
+    # VoucherSeries Voucher series for the invoice.
+    attr :voucher_series, Coercible::String.optional, :read_only
+
+    # VoucherYear Voucher year for the invoice.
+    attr :voucher_year, Coercible::Integer.optional, :read_only
+  end
+end

data/lib/fortnox/resources/label.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Fortnox
+  class Label < Fortnox::Resource
+    configure do
+      path 'labels'
+      instance_wrapper 'Label'
+      collection_wrapper 'Labels'
+      scope 'settings'
+    end
+
+    attr :id, Coercible::Integer.optional, :read_only, :key
+    attr :description, Sized::String[25]
+  end
+end

data/lib/fortnox/resources/order.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Fortnox
+  class Order < Document
+    using RestEasy::Refinements
+
+    configure do
+      path 'orders'
+      instance_wrapper 'Order'
+      collection_wrapper 'Orders'
+      scope 'order'
+    end
+
+    # CopyRemarks If remarks shall be copied from order to invoice
+    attr :copy_remarks, Bool.optional, Boolean
+
+    # InvoiceReference Reference if an invoice is created from order
+    attr :invoice_reference, Coercible::Integer.optional, :read_only
+
+    # OrderDate Date of order
+    attr :order_date, Date.optional, Mappers::Date
+
+    # OrderRows Separate object
+    attr :order_rows, Strict::Array.of(Structs::OrderRow), Mappers::StructArray.for(Mappers::OrderRow)
+
+    # DeliveryState Delivery state of the order.
+    attr :delivery_state, DeliveryStates
+
+    # OrderType Type of order.
+    attr :order_type, Coercible::String.optional
+
+    # StockPointCode Code of the stock point.
+    attr :stock_point_code, Coercible::String.optional
+
+    # StockPointId ID of the stock point.
+    attr :stock_point_id, Coercible::String.optional
+  end
+end

data/lib/fortnox/resources/project.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Fortnox
+  class Project < Fortnox::Resource
+    using RestEasy::Refinements
+
+    configure do
+      path 'projects'
+      instance_wrapper 'Project'
+      collection_wrapper 'Projects'
+      scope 'project'
+    end
+
+    # @url Direct URL to the record.
+    attr :url <=> '@url', Coercible::String.optional, :read_only
+
+    # Comments Comments on project
+    attr :comments, Sized::String[512]
+
+    # ContactPerson ContactPerson for project
+    attr :contact_person, Sized::String[50]
+
+    # Description Description of the project
+    attr :description, Sized::String[50]
+
+    # EndDate End date of the project.
+    attr :end_date, Date.optional, Mappers::Date
+
+    # ProjectLeader Projectleader
+    attr :project_leader, Sized::String[50]
+
+    # ProjectNumber Projectnumber
+    key :project_number, Sized::String[20]
+
+    # Status Status of the project
+    attr :status, ProjectStatusTypes
+
+    # StartDate Start date of the project
+    attr :start_date, Date.optional, Mappers::Date
+  end
+end

data/lib/fortnox/resources/terms_of_payment.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Fortnox
+  class TermsOfPayment < Fortnox::Resource
+    using RestEasy::Refinements
+
+    configure do
+      path 'termsofpayments'
+      instance_wrapper 'TermsOfPayment'
+      collection_wrapper 'TermsOfPayments'
+      scope 'settings'
+    end
+
+    # @url Direct URL to the record.
+    attr :url <=> '@url', Coercible::String.optional, :read_only
+
+    # Code The code of the term of payment.
+    key :code, Sized::String[25], :required
+
+    # Description The description of the term of payment.
+    attr :description, Strict::String, :required
+  end
+end

data/lib/fortnox/resources/unit.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Fortnox
+  class Unit < Fortnox::Resource
+    using RestEasy::Refinements
+
+    configure do
+      path 'units'
+      instance_wrapper 'Unit'
+      collection_wrapper 'Units'
+      scope 'settings'
+    end
+
+    # @url Direct URL to the record.
+    attr :url <=> '@url', Coercible::String.optional, :read_only
+
+    # Code The code of the unit.
+    key :code, Sized::String[20], :required
+
+    # Description The description of the unit.
+    attr :description, Sized::String[100], :required
+
+    # CodeEnglish English code of the unit
+    attr :code_english, Sized::String[100]
+  end
+end

data/lib/fortnox/struct.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'dry-struct'
+
+module Fortnox
+  class Struct < Dry::Struct
+    class << self
+      def read_only_attributes
+        @read_only_attributes ||=
+          (superclass.respond_to?(:read_only_attributes) ? superclass.read_only_attributes.dup : [])
+      end
+
+      def attribute(name, type, *flags)
+        read_only_attributes << name if flags.include?(:read_only)
+        super(name, type)
+      end
+
+      def attribute?(name, type, *flags)
+        read_only_attributes << name if flags.include?(:read_only)
+        super(name, type)
+      end
+    end
+  end
+end

data/lib/fortnox/structs/default_delivery_types.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Fortnox
+  module Structs
+    class DefaultDeliveryTypes < Fortnox::Struct
+      # Default delivery type for invoices. Can be PRINT EMAIL or PRINTSERVICE.
+      attribute? :invoice, Types::DefaultDeliveryTypeValues
+
+      # Default delivery type for orders. Can be PRINT EMAIL or PRINTSERVICE.
+      attribute? :order, Types::DefaultDeliveryTypeValues
+
+      # Default delivery type for offers. Can be PRINT EMAIL or PRINTSERVICE.
+      attribute? :offer, Types::DefaultDeliveryTypeValues
+    end
+  end
+end

data/lib/fortnox/structs/default_templates.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Fortnox
+  module Structs
+    class DefaultTemplates < Fortnox::Struct
+      # Default template for orders. Must be a name of an existing print template.
+      attribute? :order, Types::Strict::String
+
+      # Default template for offers. Must be a name of an existing print template.
+      attribute? :offer, Types::Strict::String
+
+      # Default template for invoices. Must be a name of an existing print template.
+      attribute? :invoice, Types::Strict::String
+
+      # Default template for cash invoices. Must be a name of an existing print template.
+      attribute? :cash_invoice, Types::Strict::String
+    end
+  end
+end

data/lib/fortnox/structs/document_row.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Fortnox
+  module Structs
+    class DocumentRow < Fortnox::Struct
+      # AccountNumber Account number.
+      attribute? :account_number, Types::AccountNumber
+
+      # ArticleNumber Article number.
+      attribute? :article_number, Types::Sized::String[50]
+
+      # ContributionPercent Contribution Percent.
+      attribute? :contribution_percent, Types::Coercible::Float.optional, :read_only
+
+      # ContributionValue Contribution Value.
+      attribute? :contribution_value, Types::Coercible::Float.optional, :read_only
+
+      # CostCenter Code of the cost center for the row.
+      attribute? :cost_center, Types::Coercible::String.optional
+
+      # DeliveredQuantity Delivered quantity. 14 digits
+      attribute? :delivered_quantity, Types::Sized::Float[-9_999_999_999_999.9, 9_999_999_999_999.9]
+
+      # Description Row description.
+      attribute? :description, Types::Sized::String[255]
+
+      # Discount amount. 12 digits (for amount) / 5 digits (for percent)
+      # TODO: Verify that we can send in more than 5 digits through
+      # the actual API for DiscountType PERCENT. This cannot be done until
+      # we fix issue #62...
+      attribute? :discount, Types::Sized::Float[0.0, 99_999_999_999.9]
+
+      # DiscountType The type of discount used for the row.
+      attribute? :discount_type, Types::DiscountTypes
+
+      # HouseWork If the row is housework
+      attribute? :housework, Types::Bool.optional
+
+      # HouseWorkHoursToReport Hours to be reported if the quantity of the row
+      # should not be used as hours. 5 digits
+      attribute? :housework_hours_to_report, Types::Sized::Integer[0, 99_999].optional
+
+      # HouseWorkType The type of housework.
+      attribute? :housework_type, Types::HouseworkTypes.optional
+
+      # Price Price per unit. 12 digits
+      attribute? :price, Types::Sized::Float[-99_999_999_999.9, 99_999_999_999.9]
+
+      # Project Code of the project for the row.
+      attribute? :project, Types::Coercible::String.optional
+
+      # Total Total amount for the row.
+      attribute? :total, Types::Coercible::Float.optional, :read_only
+
+      # Unit Code of the unit for the row.
+      attribute? :unit, Types::Coercible::String.optional
+
+      # VAT VAT percentage of the row.
+      attribute? :vat, Types::Coercible::Integer.optional
+    end
+  end
+end

data/lib/fortnox/structs/edi_information.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Fortnox
+  module Structs
+    class EDIInformation < Fortnox::Struct
+      # EDIGlobalLocationNumber Invoice address GLN for EDI
+      attribute? :edi_global_location_number, Types::Coercible::String.optional
+
+      # EDIGlobalLocationNumberDelivery Delivery address GLN for EDI
+      attribute? :edi_global_location_number_delivery, Types::Coercible::String.optional
+
+      # EDIInvoiceExtra1 Extra EDI Information
+      attribute? :edi_invoice_extra1, Types::Coercible::String.optional
+
+      # EDIInvoiceExtra2 Extra EDI Information
+      attribute? :edi_invoice_extra2, Types::Coercible::String.optional
+
+      # EDIOurElectronicReference Our electronic reference for EDI
+      attribute? :edi_our_electronic_reference, Types::Coercible::String.optional
+
+      # EDIYourElectronicReference Your electronic reference for EDI
+      attribute? :edi_your_electronic_reference, Types::Coercible::String.optional
+    end
+  end
+end

data/lib/fortnox/structs/email_information.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Fortnox
+  module Structs
+    class EmailInformation < Fortnox::Struct
+      # EmailAddressTo Customer e-mail address. Must be a valid e-mail address.
+      attribute? :email_address_to, Types::Email
+
+      # EmailAddressCC Customer e-mail address, Carbon copy. Must be a valid e-mail address.
+      attribute? :email_address_cc, Types::Email
+
+      # EmailAddressBCC Customer e-mail address, Blind carbon copy. Must be a valid e-mail address.
+      attribute? :email_address_bcc, Types::Email
+
+      # EmailSubject Subject of the e-mail
+      attribute? :email_subject, Types::Sized::String[100]
+
+      # EmailBody Body of the e-mail
+      attribute? :email_body, Types::Sized::String[20_000]
+    end
+  end
+end

data/lib/fortnox/structs/invoice_row.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Fortnox
+  module Structs
+    class InvoiceRow < DocumentRow
+      # PriceExcludingVAT Price per unit excluding VAT.
+      attribute? :price_excluding_vat, Types::Coercible::Float.optional, :read_only
+
+      # TotalExcludingVAT Total amount for the row excluding VAT.
+      attribute? :total_excluding_vat, Types::Coercible::Float.optional, :read_only
+    end
+  end
+end

data/lib/fortnox/structs/order_row.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Fortnox
+  module Structs
+    class OrderRow < DocumentRow
+      # OrderedQuantity Ordered quantity
+      attribute? :ordered_quantity, Types::Coercible::Float
+    end
+  end
+end

data/lib/fortnox/types.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require 'dry-struct'
+require 'dry-types'
+
+module Fortnox
+  module Types
+    include Dry.Types()
+
+    THE_TRUTH = { true => true, 'true' => true, false => false, 'false' => false }.freeze
+
+    ArticleTypes = Types::Strict::String.enum(
+      'SERVICE', 'STOCK'
+    )
+
+    DiscountTypes = Types::Strict::String.enum(
+      'AMOUNT', 'PERCENT'
+    )
+
+    CURRENT_HOUSEWORK_TYPES = [
+      'CONSTRUCTION', 'ELECTRICITY', 'GLASSMETALWORK', 'GROUNDDRAINAGEWORK',
+      'MASONRY', 'PAINTINGWALLPAPERING', 'HVAC', 'MAJORAPPLIANCEREPAIR',
+      'MOVINGSERVICES', 'ITSERVICES', 'CLEANING', 'TEXTILECLOTHING',
+      'SNOWPLOWING', 'GARDENING', 'BABYSITTING', 'OTHERCARE', 'OTHERCOSTS',
+      'FURNISHING', 'HOMEMAINTENANCE', 'TRANSPORTATIONSERVICES',
+      'WASHINGANDCAREOFCLOTHING', 'SOLARCELLS', 'STORAGESELFPRODUCEDELECTRICITY',
+      'CHARGINGSTATIONELECTRICVEHICLE', 'EMPTYHOUSEWORK'
+    ].freeze
+
+    LEGACY_HOUSEWORK_TYPES = ['COOKING', 'TUTORING'].freeze
+
+    HouseworkTypes = Types::Strict::String.enum(
+      *(CURRENT_HOUSEWORK_TYPES + LEGACY_HOUSEWORK_TYPES)
+    )
+
+    Currencies = Types::Strict::String.enum(
+      'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN',
+      'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BOV',
+      'BRL', 'BSD', 'BTN', 'BWP', 'BYR', 'BZD', 'CAD', 'CDF', 'CHE', 'CHF',
+      'CHW', 'CLF', 'CLP', 'CNY', 'COP', 'COU', 'CRC', 'CUP', 'CVE', 'CZK',
+      'DJF', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP',
+      'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL',
+      'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR', 'ISK', 'JMD',
+      'JOD', 'JPY', 'KES', 'KGS', 'KHR', 'KMF', 'KPW', 'KRW', 'KWD',
+      'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LYD', 'MAD', 'MDL',
+      'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRO', 'MUR', 'MVR', 'MWK', 'MXN',
+      'MXV', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR',
+      'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD',
+      'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLL',
+      'SOS', 'SRD', 'SSP', 'STD', 'SYP', 'SZL', 'THB', 'TJS', 'TMM', 'TND',
+      'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USD', 'USN', 'USS',
+      'UYU', 'UZS', 'VEF', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XBA',
+      'XBB', 'XBC', 'XBD', 'XCD', 'XDR', 'XFU', 'XOF', 'XPD', 'XPF', 'XPT',
+      'XTS', 'XXX', 'YER', 'ZAR', 'ZMK', 'ZWD'
+    )
+
+    CustomerTypes = Types::Strict::String.enum(
+      'PRIVATE', 'COMPANY'
+    )
+
+    VATTypes = Types::Strict::String.enum(
+      'SEVAT', 'SEREVERSEDVAT', 'EUREVERSEDVAT', 'EUVAT', 'EXPORT'
+    )
+
+    DefaultDeliveryTypeValues = Types::Strict::String.enum(
+      'PRINT', 'EMAIL', 'PRINTSERVICE'
+    )
+
+    AccountingMethods = Types::Strict::String.enum(
+      '', 'ACCRUAL', 'CASH'
+    )
+
+    DeliveryStates = Types::Strict::String.enum(
+      '', 'registration', 'reservation', 'delivery'
+    )
+
+    PaymentWays = Types::Strict::String.enum(
+      '', 'CASH', 'CARD', 'AG'
+    )
+
+    ProjectStatusTypes = Types::Strict::String.enum(
+      'NOTSTARTED', 'ONGOING', 'COMPLETED'
+    )
+
+    InvoiceTypes = Types::Strict::String.enum(
+      '', 'INVOICE', 'AGREEMENTINVOICE', 'INTRESTINVOICE', 'SUMMARYINVOICE', 'CASHINVOICE'
+    )
+
+    TaxReductionTypes = Types::Strict::String.enum(
+      '', 'none', 'rot', 'rut', 'green'
+    )
+
+    AccountNumber = Coercible::Integer
+                    .constrained(gteq: 0, lteq: 9999)
+                    .optional
+
+    Email = Strict::String
+            .constrained(max_size: 1024, format: /\A\z|\A[[[:alnum:]]+-_.]+@[[[:alnum:]]+-_.]+\.[a-z]+\z/i)
+            .optional
+            .constructor { |v| v&.to_s&.downcase }
+
+    module Sized
+      module String
+        def self.[](size)
+          Types::Coercible::String.constrained(max_size: size).optional
+        end
+      end
+
+      module Integer
+        def self.[](low, high)
+          Types::Coercible::Integer.constrained(gteq: low, lteq: high).optional
+        end
+      end
+
+      module Float
+        def self.[](low, high)
+          Types::Coercible::Float.constrained(gteq: low, lteq: high).optional
+        end
+      end
+    end
+
+    require 'fortnox/structs/default_delivery_types'
+    require 'fortnox/structs/default_templates'
+    require 'fortnox/structs/email_information'
+    require 'fortnox/structs/edi_information'
+    require 'fortnox/structs/invoice_row'
+    require 'fortnox/structs/order_row'
+  end
+end

data/lib/fortnox/{api/version.rb → version.rb}

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
 module Fortnox
-  module API
-    VERSION = '0.9.2'
-  end
+  VERSION = '1.0.0.rc2'
 end