fortnox-api 0.5.2 → 0.6.0

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

@@ -1,11 +1,12 @@
-require "fortnox/api/types"
-require "fortnox/api/models/base"
+# frozen_string_literal: true
+
+require 'fortnox/api/types'
+require 'fortnox/api/models/base'
 
 module Fortnox
   module API
     module Model
       class Customer < Fortnox::API::Model::Base
-
         UNIQUE_ID = :customer_number
         STUB = { name: '' }.freeze
 
@@ -26,183 +27,183 @@ module Fortnox
         #   :hire
         # )
 
-        #Url	Direct URL to the record
-        attribute :url, Types::Nullable::String.with( read_only: true )
+        # Url Direct URL to the record
+        attribute :url, Types::Nullable::String.is(:read_only)
 
-        #Address1	First address of the customer. 1024 characters
-        attribute :address1, Types::Sized::String[ 1024 ]
+        # Address1	First address of the customer. 1024 characters
+        attribute :address1, Types::Sized::String[1024]
 
-        #Address2	Second address of the customer. 1024 characters
-        attribute :address2, Types::Sized::String[ 1024 ]
+        # Address2	Second address of the customer. 1024 characters
+        attribute :address2, Types::Sized::String[1024]
 
-        #City	City of the customer. 1024 characters
-        attribute :city, Types::Sized::String[ 1024 ]
+        # City	City of the customer. 1024 characters
+        attribute :city, Types::Sized::String[1024]
 
-        #Country	Country of the customer. Read-only.
-        attribute :country, Types::Nullable::String.with( read_only: true )
+        # Country	Country of the customer. Read-only.
+        attribute :country, Types::Nullable::String.is(:read_only)
 
-        #Comments	Comments. 1024 characters.
-        attribute :comments, Types::Sized::String[ 1024 ]
+        # Comments	Comments. 1024 characters.
+        attribute :comments, Types::Sized::String[1024]
 
-        #Currency	Currency of the customer, 3 letters
+        # Currency	Currency of the customer, 3 letters
         attribute :currency, Types::Currency
 
-        #CostCenter	Cost center of the customer, Cost center in Fortnox
+        # CostCenter	Cost center of the customer, Cost center in Fortnox
         attribute :cost_center, Types::Nullable::String
 
-        #CountryCode	Country code of the customer, 2 letters
+        # CountryCode	Country code of the customer, 2 letters
         attribute :country_code, Types::CountryCode
 
-        #CustomerNumber	Customer number. 1024 characters
-        attribute :customer_number, Types::Sized::String[ 1024 ]
+        # CustomerNumber	Customer number. 1024 characters
+        attribute :customer_number, Types::Sized::String[1024]
 
-        #DefaultDeliveryTypes The properties for this object is listed in the table for “Default Delivery Types”.
+        # DefaultDeliveryTypes The properties for this object is listed in the table for "Default Delivery Types".
         attribute :default_delivery_types, Types::DefaultDeliveryTypes
 
-        #The properties for this object is listed in the table for “Default Templates”.
+        # The properties for this object is listed in the table for "Default Templates".
         attribute :default_templates, Types::DefaultTemplates
 
-        #DeliveryAddress1	First delivery address of the customer. 1024 characters
-        attribute :delivery_address1, Types::Sized::String[ 1024 ]
+        # DeliveryAddress1	First delivery address of the customer. 1024 characters
+        attribute :delivery_address1, Types::Sized::String[1024]
 
-        #DeliveryAddress2	Second delivery address of the customer. 1024 characters
-        attribute :delivery_address2, Types::Sized::String[ 1024 ]
+        # DeliveryAddress2	Second delivery address of the customer. 1024 characters
+        attribute :delivery_address2, Types::Sized::String[1024]
 
-        #DeliveryCity	Delivery city of the customer. 1024 characters
-        attribute :delivery_city, Types::Sized::String[ 1024 ]
+        # DeliveryCity	Delivery city of the customer. 1024 characters
+        attribute :delivery_city, Types::Sized::String[1024]
 
-        #DeliveryCountry	Delivery country of the customer. Read-only.
-        attribute :delivery_country, Types::Nullable::String.with( read_only: true )
+        # DeliveryCountry	Delivery country of the customer. Read-only.
+        attribute :delivery_country, Types::Nullable::String.is(:read_only)
 
-        #DeliveryCountryCode	Delivery country code of the customer, 2 letters
+        # DeliveryCountryCode	Delivery country code of the customer, 2 letters
         attribute :delivery_country_code, Types::CountryCode
 
-        #DeliveryFax	Delivery fax number of the customer. 1024 characters
-        attribute :delivery_fax, Types::Sized::String[ 1024 ]
+        # DeliveryFax	Delivery fax number of the customer. 1024 characters
+        attribute :delivery_fax, Types::Sized::String[1024]
 
-        #DeliveryName	Delivery name of the customer. 1024 characters
-        attribute :delivery_name, Types::Sized::String[ 1024 ]
+        # DeliveryName	Delivery name of the customer. 1024 characters
+        attribute :delivery_name, Types::Sized::String[1024]
 
-        #DeliveryPhone1	First delivery phone number of the customer. 1024 characters
-        attribute :delivery_phone1, Types::Sized::String[ 1024 ]
+        # DeliveryPhone1	First delivery phone number of the customer. 1024 characters
+        attribute :delivery_phone1, Types::Sized::String[1024]
 
-        #DeliveryPhone2	Second delivery phone number of the customer. 1024 characters
-        attribute :delivery_phone2, Types::Sized::String[ 1024 ]
+        # DeliveryPhone2	Second delivery phone number of the customer. 1024 characters
+        attribute :delivery_phone2, Types::Sized::String[1024]
 
-        #DeliveryZipCode	Delivery zip code of the customer. 1024 characters.
-        attribute :delivery_zip_code, Types::Sized::String[ 1024 ]
+        # DeliveryZipCode	Delivery zip code of the customer. 1024 characters.
+        attribute :delivery_zip_code, Types::Sized::String[1024]
 
-        #Email	Email address of the customer. 1024 characters
+        # Email	Email address of the customer. 1024 characters
         attribute :email, Types::Email
 
-        #EmailInvoice	Invoice email address of the customer. 1024 characters
+        # EmailInvoice	Invoice email address of the customer. 1024 characters
         attribute :email_invoice, Types::Email
 
-        #EmailInvoiceBCC	Invoice BCC email address of the customer. 1024 characters
+        # EmailInvoiceBCC	Invoice BCC email address of the customer. 1024 characters
         attribute :email_invoice_bcc, Types::Email
 
-        #EmailInvoiceCC	Invoice CC email address of the customer. 1024 characters
+        # EmailInvoiceCC	Invoice CC email address of the customer. 1024 characters
         attribute :email_invoice_cc, Types::Email
 
-        #EmailOffer	Offer email address of the customer. 1024 characters
+        # EmailOffer	Offer email address of the customer. 1024 characters
         attribute :email_offer, Types::Email
 
-        #EmailOfferBCC	Offer BCC email address of the customer. 1024 characters
+        # EmailOfferBCC	Offer BCC email address of the customer. 1024 characters
         attribute :email_offer_bcc, Types::Email
 
-        #EmailOfferCC	Offer CC email address of the customer. 1024 characters
+        # EmailOfferCC	Offer CC email address of the customer. 1024 characters
         attribute :email_offer_cc, Types::Email
 
-        #EmailOrder	Order email address of the customer. 1024 characters
+        # EmailOrder	Order email address of the customer. 1024 characters
         attribute :email_order, Types::Email
 
-        #EmailOrderBCC	Order BCC email address of the customer. 1024 characters
+        # EmailOrderBCC	Order BCC email address of the customer. 1024 characters
         attribute :email_order_bcc, Types::Email
 
-        #EmailOrderCC	Order CC email address of the customer. 1024 characters
+        # EmailOrderCC	Order CC email address of the customer. 1024 characters
         attribute :email_order_cc, Types::Email
 
-        #Fax	Fax number of the customer. 1024 characters
-        attribute :fax, Types::Sized::String[ 1024 ]
+        # Fax	Fax number of the customer. 1024 characters
+        attribute :fax, Types::Sized::String[1024]
 
-        #InvoiceAdministrationFee  Invoice administration fee of the customer, 12 digits (incl. decimals).
+        # InvoiceAdministrationFee  Invoice administration fee of the customer, 12 digits (incl. decimals).
         attribute :invoice_administration_fee,
-                  Types::Sized::Float[ 0.0, 99_999_999_999.9 ]
+                  Types::Sized::Float[0.0, 99_999_999_999.9]
 
-        #InvoiceDiscount	Invoice discount of the customer, 12 digits (incl. decimals)
-        attribute :invoice_discount, Types::Sized::Float[ 0.0, 99_999_999_999.9 ]
+        # InvoiceDiscount	Invoice discount of the customer, 12 digits (incl. decimals)
+        attribute :invoice_discount, Types::Sized::Float[0.0, 99_999_999_999.9]
 
-        #InvoiceFreight	Invoice freight fee of the customer, 12 digits (incl. decimals)
-        attribute :invoice_freight, Types::Sized::Float[ 0.0, 99_999_999_999.9 ]
+        # InvoiceFreight	Invoice freight fee of the customer, 12 digits (incl. decimals)
+        attribute :invoice_freight, Types::Sized::Float[0.0, 99_999_999_999.9]
 
-        #InvoiceRemark	Invoice remark of the customer. 1024 characters
-        attribute :invoice_remark, Types::Sized::String[ 1024 ]
+        # InvoiceRemark	Invoice remark of the customer. 1024 characters
+        attribute :invoice_remark, Types::Sized::String[1024]
 
-        #Name	Name of the customer, 1024 characters
-        attribute :name, Types::Sized::String[ 1024 ].with( required: true )
+        # Name	Name of the customer, 1024 characters
+        attribute :name, Types::Sized::String[1024].is(:required)
 
-        #OrganisationNumber	Organisation number of the customer. 30 characters
-        attribute :organisation_number, Types::Sized::String[ 30 ]
+        # OrganisationNumber	Organisation number of the customer. 30 characters
+        attribute :organisation_number, Types::Sized::String[30]
 
-        #OurReference	Our reference of the customer. 50 characters
-        attribute :our_reference, Types::Sized::String[ 50 ]
+        # OurReference	Our reference of the customer. 50 characters
+        attribute :our_reference, Types::Sized::String[50]
 
-        #Phone1	First phone number of the customer. 1024 characters
-        attribute :phone1, Types::Sized::String[ 1024 ]
+        # Phone1	First phone number of the customer. 1024 characters
+        attribute :phone1, Types::Sized::String[1024]
 
-        #Phone2	Second phone number of the customer. 1024 characters
-        attribute :phone2, Types::Sized::String[ 1024 ]
+        # Phone2	Second phone number of the customer. 1024 characters
+        attribute :phone2, Types::Sized::String[1024]
 
-        #PriceList	Price list of the customer, Price list in Fortnox
+        # PriceList	Price list of the customer, Price list in Fortnox
         attribute :price_list, Types::Nullable::String
 
-        #Project	Project of the customer, Project in Fortnox
+        # Project	Project of the customer, Project in Fortnox
         attribute :project, Types::Nullable::String
 
-        #SalesAccount	Sales account of the customer, 4 digits
+        # SalesAccount	Sales account of the customer, 4 digits
         attribute :sales_account, Types::AccountNumber
 
-        #ShowPriceVATIncluded	Show prices with VAT included or not
+        # ShowPriceVATIncluded	Show prices with VAT included or not
         attribute :show_price_vat_included, Types::Nullable::Boolean
 
-        #TermsOfDeliveryCode	Terms of delivery code of the customer
+        # TermsOfDeliveryCode	Terms of delivery code of the customer
         attribute :terms_of_delivery, Types::Nullable::String
 
-        #TermsOfPaymentCode	Terms of payment code of the customer
+        # TermsOfPaymentCode	Terms of payment code of the customer
         attribute :terms_of_payment, Types::Nullable::String
 
-        #Type	Customer type, PRIVATE / COMPANY
+        # Type	Customer type, PRIVATE / COMPANY
         attribute :type, Types::CustomerType
 
-        #VATNumber	VAT number of the customer
+        # VATNumber	VAT number of the customer
         attribute :vat_number, Types::Nullable::String
 
-        #VATType	VAT type of the customer, SEVAT / SEREVERSEDVAT / EUREVERSEDVAT / EUVAT / EXPORT
+        # VATType	VAT type of the customer, SEVAT / SEREVERSEDVAT / EUREVERSEDVAT / EUVAT / EXPORT
         attribute :vat_type, Types::VATType
 
-        #VisitAddress	Visit address of the customer. 128 characters
-        attribute :visiting_address, Types::Sized::String[ 128 ]
+        # VisitAddress	Visit address of the customer. 128 characters
+        attribute :visiting_address, Types::Sized::String[128]
 
-        #VisitCity	Visit city of the customer. 128 characters
-        attribute :visiting_city, Types::Sized::String[ 128 ]
+        # VisitCity	Visit city of the customer. 128 characters
+        attribute :visiting_city, Types::Sized::String[128]
 
-        #VisitCountry	Visit country of the customer, read-only
-        attribute :visiting_country, Types::Nullable::String.with( read_only: true )
+        # VisitCountry	Visit country of the customer, read-only
+        attribute :visiting_country, Types::Nullable::String.is(:read_only)
 
-        #VisitingCountryCode Code of the visiting country for the customer, 2 letters
+        # VisitingCountryCode Code of the visiting country for the customer, 2 letters
         attribute :visiting_country_code, Types::CountryCode
 
-        #VisitZipCode	Visit zip code of the customer. 10 characters
-        attribute :visiting_zip_code, Types::Sized::String[ 10 ]
+        # VisitZipCode	Visit zip code of the customer. 10 characters
+        attribute :visiting_zip_code, Types::Sized::String[10]
 
-        #WayOfDeliveryCode	Way of delivery code of the customer
+        # WayOfDeliveryCode	Way of delivery code of the customer
         attribute :way_of_delivery, Types::Nullable::String
 
-        #YourReference	Your reference of the customer. 50 characters
-        attribute :your_reference, Types::Sized::String[ 50 ]
+        # YourReference	Your reference of the customer. 50 characters
+        attribute :your_reference, Types::Sized::String[50]
 
-        #ZipCode	Zip code of the customer. 10 characters
-        attribute :zip_code, Types::Sized::String[ 10 ]
+        # ZipCode	Zip code of the customer. 10 characters
+        attribute :zip_code, Types::Sized::String[10]
       end
     end
   end

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

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