factorial_api 3.0.1

data/lib/factorial_api/models/finance_financial_document.rb

@@ -0,0 +1,623 @@
+=begin
+#Factorial API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 2026-10-01
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module F::Api
+  class FinanceFinancialDocument < ApiModelBase
+    # Factorial unique identifier for the financial document.
+    attr_accessor :id
+
+    # Sum of the line items before taxes, in cents. Use `total_amount_cents` for what is actually payable.
+    attr_accessor :net_amount_cents
+
+    # Total payable on the document, taxes included, in cents.
+    attr_accessor :total_amount_cents
+
+    # Number the issuer printed on the document; for a purchase, the vendor's own invoice number. Not a Factorial identifier: on a purchase it is only unique per vendor, so the same number can legitimately appear on documents from two different vendors.
+    attr_accessor :document_number
+
+    # ISO 4217 code of the currency the document is issued in, such as EUR or USD. Every amount on the document is expressed in it, so comparing amounts across documents without checking this is unsafe.
+    attr_accessor :currency
+
+    # Where the document stands on its way to being paid: `processing` while it is still being prepared, `review` while it awaits review (the value is `review`, never `pending`), `sent_to_pay` once it has been sent for payment, and `paid`. This is not an approval state: a document generated from an employee expense is created already `paid`, because the money left before Factorial ever saw it.
+    attr_accessor :status
+
+    # Date the payment falls due, as stated on the document.
+    attr_accessor :due_date
+
+    # Date the issuer put on the document. Distinct from `created_at`, which is when it reached Factorial; a document can arrive weeks after it was issued.
+    attr_accessor :document_date
+
+    # Factorial unique identifier for the legal entity of the financial document.
+    attr_accessor :legal_entity_id
+
+    # Factorial unique identifier for the vendor of the financial document.
+    attr_accessor :vendor_id
+
+    attr_accessor :file
+
+    # Updation date.
+    attr_accessor :updated_at
+
+    # Taxes.
+    attr_accessor :taxes
+
+    # When the document was fully matched against bank transactions. Null while any part of it remains unreconciled.
+    attr_accessor :fully_reconciled_at
+
+    # When the document was posted to accounting. Only possible once `validated_at` is set.
+    attr_accessor :recorded_at
+
+    # Factorial unique identifier for the duplicate financial document.
+    attr_accessor :duplicate_financial_document_id
+
+    # When a person confirmed the document data is correct. Validation is what unlocks recording and payment; it is not an approval decision, and says nothing about whether the spend was authorised.
+    attr_accessor :validated_at
+
+    # Factorial unique identifier of the employee who validated the document.
+    attr_accessor :validated_by_id
+
+    # One of `invoice`, `receipt` or `credit_note`. A document generated from an expense is typed automatically and can flip between `receipt` and `invoice` when the employee edits the expense.
+    attr_accessor :document_type
+
+    # Factorial unique identifier for the parent financial document of the financial document.
+    attr_accessor :parent_financial_document_id
+
+    # Sum of every tax charged on the document, in cents.
+    attr_accessor :taxes_total_amount_cents
+
+    # Name of the entity issuing the financial document.
+    attr_accessor :issuer_name
+
+    # First line of the issuer's address.
+    attr_accessor :issuer_address_line_1
+
+    # Second line of the issuer's address.
+    attr_accessor :issuer_address_line_2
+
+    # City of the issuer's address.
+    attr_accessor :issuer_city
+
+    # Postal code of the issuer's address.
+    attr_accessor :issuer_postal_code
+
+    # State or province of the issuer's address.
+    attr_accessor :issuer_state
+
+    # Country code of the issuer's address.
+    attr_accessor :issuer_country_code
+
+    # Tax identification number of the issuer.
+    attr_accessor :issuer_tax_id
+
+    # Name of the entity receiving the financial document.
+    attr_accessor :recipient_name
+
+    # First line of the recipient's address.
+    attr_accessor :recipient_address_line_1
+
+    # Second line of the recipient's address.
+    attr_accessor :recipient_address_line_2
+
+    # City of the recipient's address.
+    attr_accessor :recipient_city
+
+    # Postal code of the recipient's address.
+    attr_accessor :recipient_postal_code
+
+    # State or province of the recipient's address.
+    attr_accessor :recipient_state
+
+    # Country code of the recipient's address.
+    attr_accessor :recipient_country_code
+
+    # Tax identification number of the recipient.
+    attr_accessor :recipient_tax_id
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'net_amount_cents' => :'net_amount_cents',
+        :'total_amount_cents' => :'total_amount_cents',
+        :'document_number' => :'document_number',
+        :'currency' => :'currency',
+        :'status' => :'status',
+        :'due_date' => :'due_date',
+        :'document_date' => :'document_date',
+        :'legal_entity_id' => :'legal_entity_id',
+        :'vendor_id' => :'vendor_id',
+        :'file' => :'file',
+        :'updated_at' => :'updated_at',
+        :'taxes' => :'taxes',
+        :'fully_reconciled_at' => :'fully_reconciled_at',
+        :'recorded_at' => :'recorded_at',
+        :'duplicate_financial_document_id' => :'duplicate_financial_document_id',
+        :'validated_at' => :'validated_at',
+        :'validated_by_id' => :'validated_by_id',
+        :'document_type' => :'document_type',
+        :'parent_financial_document_id' => :'parent_financial_document_id',
+        :'taxes_total_amount_cents' => :'taxes_total_amount_cents',
+        :'issuer_name' => :'issuer_name',
+        :'issuer_address_line_1' => :'issuer_address_line_1',
+        :'issuer_address_line_2' => :'issuer_address_line_2',
+        :'issuer_city' => :'issuer_city',
+        :'issuer_postal_code' => :'issuer_postal_code',
+        :'issuer_state' => :'issuer_state',
+        :'issuer_country_code' => :'issuer_country_code',
+        :'issuer_tax_id' => :'issuer_tax_id',
+        :'recipient_name' => :'recipient_name',
+        :'recipient_address_line_1' => :'recipient_address_line_1',
+        :'recipient_address_line_2' => :'recipient_address_line_2',
+        :'recipient_city' => :'recipient_city',
+        :'recipient_postal_code' => :'recipient_postal_code',
+        :'recipient_state' => :'recipient_state',
+        :'recipient_country_code' => :'recipient_country_code',
+        :'recipient_tax_id' => :'recipient_tax_id'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'net_amount_cents' => :'Integer',
+        :'total_amount_cents' => :'Integer',
+        :'document_number' => :'String',
+        :'currency' => :'String',
+        :'status' => :'String',
+        :'due_date' => :'String',
+        :'document_date' => :'String',
+        :'legal_entity_id' => :'String',
+        :'vendor_id' => :'String',
+        :'file' => :'FinanceFinancialDocumentFile',
+        :'updated_at' => :'String',
+        :'taxes' => :'Array<FinanceFinancialDocumentsIdPutRequestTaxesInner>',
+        :'fully_reconciled_at' => :'String',
+        :'recorded_at' => :'String',
+        :'duplicate_financial_document_id' => :'String',
+        :'validated_at' => :'String',
+        :'validated_by_id' => :'String',
+        :'document_type' => :'String',
+        :'parent_financial_document_id' => :'String',
+        :'taxes_total_amount_cents' => :'Integer',
+        :'issuer_name' => :'String',
+        :'issuer_address_line_1' => :'String',
+        :'issuer_address_line_2' => :'String',
+        :'issuer_city' => :'String',
+        :'issuer_postal_code' => :'String',
+        :'issuer_state' => :'String',
+        :'issuer_country_code' => :'String',
+        :'issuer_tax_id' => :'String',
+        :'recipient_name' => :'String',
+        :'recipient_address_line_1' => :'String',
+        :'recipient_address_line_2' => :'String',
+        :'recipient_city' => :'String',
+        :'recipient_postal_code' => :'String',
+        :'recipient_state' => :'String',
+        :'recipient_country_code' => :'String',
+        :'recipient_tax_id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `F::Api::FinanceFinancialDocument` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `F::Api::FinanceFinancialDocument`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'net_amount_cents')
+        self.net_amount_cents = attributes[:'net_amount_cents']
+      end
+
+      if attributes.key?(:'total_amount_cents')
+        self.total_amount_cents = attributes[:'total_amount_cents']
+      end
+
+      if attributes.key?(:'document_number')
+        self.document_number = attributes[:'document_number']
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'due_date')
+        self.due_date = attributes[:'due_date']
+      end
+
+      if attributes.key?(:'document_date')
+        self.document_date = attributes[:'document_date']
+      end
+
+      if attributes.key?(:'legal_entity_id')
+        self.legal_entity_id = attributes[:'legal_entity_id']
+      end
+
+      if attributes.key?(:'vendor_id')
+        self.vendor_id = attributes[:'vendor_id']
+      end
+
+      if attributes.key?(:'file')
+        self.file = attributes[:'file']
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      else
+        self.updated_at = nil
+      end
+
+      if attributes.key?(:'taxes')
+        if (value = attributes[:'taxes']).is_a?(Array)
+          self.taxes = value
+        end
+      else
+        self.taxes = nil
+      end
+
+      if attributes.key?(:'fully_reconciled_at')
+        self.fully_reconciled_at = attributes[:'fully_reconciled_at']
+      end
+
+      if attributes.key?(:'recorded_at')
+        self.recorded_at = attributes[:'recorded_at']
+      end
+
+      if attributes.key?(:'duplicate_financial_document_id')
+        self.duplicate_financial_document_id = attributes[:'duplicate_financial_document_id']
+      end
+
+      if attributes.key?(:'validated_at')
+        self.validated_at = attributes[:'validated_at']
+      end
+
+      if attributes.key?(:'validated_by_id')
+        self.validated_by_id = attributes[:'validated_by_id']
+      end
+
+      if attributes.key?(:'document_type')
+        self.document_type = attributes[:'document_type']
+      else
+        self.document_type = nil
+      end
+
+      if attributes.key?(:'parent_financial_document_id')
+        self.parent_financial_document_id = attributes[:'parent_financial_document_id']
+      end
+
+      if attributes.key?(:'taxes_total_amount_cents')
+        self.taxes_total_amount_cents = attributes[:'taxes_total_amount_cents']
+      end
+
+      if attributes.key?(:'issuer_name')
+        self.issuer_name = attributes[:'issuer_name']
+      end
+
+      if attributes.key?(:'issuer_address_line_1')
+        self.issuer_address_line_1 = attributes[:'issuer_address_line_1']
+      end
+
+      if attributes.key?(:'issuer_address_line_2')
+        self.issuer_address_line_2 = attributes[:'issuer_address_line_2']
+      end
+
+      if attributes.key?(:'issuer_city')
+        self.issuer_city = attributes[:'issuer_city']
+      end
+
+      if attributes.key?(:'issuer_postal_code')
+        self.issuer_postal_code = attributes[:'issuer_postal_code']
+      end
+
+      if attributes.key?(:'issuer_state')
+        self.issuer_state = attributes[:'issuer_state']
+      end
+
+      if attributes.key?(:'issuer_country_code')
+        self.issuer_country_code = attributes[:'issuer_country_code']
+      end
+
+      if attributes.key?(:'issuer_tax_id')
+        self.issuer_tax_id = attributes[:'issuer_tax_id']
+      end
+
+      if attributes.key?(:'recipient_name')
+        self.recipient_name = attributes[:'recipient_name']
+      end
+
+      if attributes.key?(:'recipient_address_line_1')
+        self.recipient_address_line_1 = attributes[:'recipient_address_line_1']
+      end
+
+      if attributes.key?(:'recipient_address_line_2')
+        self.recipient_address_line_2 = attributes[:'recipient_address_line_2']
+      end
+
+      if attributes.key?(:'recipient_city')
+        self.recipient_city = attributes[:'recipient_city']
+      end
+
+      if attributes.key?(:'recipient_postal_code')
+        self.recipient_postal_code = attributes[:'recipient_postal_code']
+      end
+
+      if attributes.key?(:'recipient_state')
+        self.recipient_state = attributes[:'recipient_state']
+      end
+
+      if attributes.key?(:'recipient_country_code')
+        self.recipient_country_code = attributes[:'recipient_country_code']
+      end
+
+      if attributes.key?(:'recipient_tax_id')
+        self.recipient_tax_id = attributes[:'recipient_tax_id']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @updated_at.nil?
+        invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
+      end
+
+      if @taxes.nil?
+        invalid_properties.push('invalid value for "taxes", taxes cannot be nil.')
+      end
+
+      if @document_type.nil?
+        invalid_properties.push('invalid value for "document_type", document_type cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @id.nil?
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["processing", "review", "sent_to_pay", "paid"])
+      return false unless status_validator.valid?(@status)
+      return false if @updated_at.nil?
+      return false if @taxes.nil?
+      return false if @document_type.nil?
+      document_type_validator = EnumAttributeValidator.new('String', ["invoice", "receipt", "credit_note"])
+      return false unless document_type_validator.valid?(@document_type)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        @id = nil
+        return
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["processing", "review", "sent_to_pay", "paid"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] updated_at Value to be assigned
+    def updated_at=(updated_at)
+      if updated_at.nil?
+        @updated_at = nil
+        return
+      end
+
+      @updated_at = updated_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] taxes Value to be assigned
+    def taxes=(taxes)
+      if taxes.nil?
+        @taxes = nil
+        return
+      end
+
+      @taxes = taxes
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] document_type Object to be assigned
+    def document_type=(document_type)
+      validator = EnumAttributeValidator.new('String', ["invoice", "receipt", "credit_note"])
+      unless validator.valid?(document_type)
+        fail ArgumentError, "invalid value for \"document_type\", must be one of #{validator.allowable_values}."
+      end
+      @document_type = document_type
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          net_amount_cents == o.net_amount_cents &&
+          total_amount_cents == o.total_amount_cents &&
+          document_number == o.document_number &&
+          currency == o.currency &&
+          status == o.status &&
+          due_date == o.due_date &&
+          document_date == o.document_date &&
+          legal_entity_id == o.legal_entity_id &&
+          vendor_id == o.vendor_id &&
+          file == o.file &&
+          updated_at == o.updated_at &&
+          taxes == o.taxes &&
+          fully_reconciled_at == o.fully_reconciled_at &&
+          recorded_at == o.recorded_at &&
+          duplicate_financial_document_id == o.duplicate_financial_document_id &&
+          validated_at == o.validated_at &&
+          validated_by_id == o.validated_by_id &&
+          document_type == o.document_type &&
+          parent_financial_document_id == o.parent_financial_document_id &&
+          taxes_total_amount_cents == o.taxes_total_amount_cents &&
+          issuer_name == o.issuer_name &&
+          issuer_address_line_1 == o.issuer_address_line_1 &&
+          issuer_address_line_2 == o.issuer_address_line_2 &&
+          issuer_city == o.issuer_city &&
+          issuer_postal_code == o.issuer_postal_code &&
+          issuer_state == o.issuer_state &&
+          issuer_country_code == o.issuer_country_code &&
+          issuer_tax_id == o.issuer_tax_id &&
+          recipient_name == o.recipient_name &&
+          recipient_address_line_1 == o.recipient_address_line_1 &&
+          recipient_address_line_2 == o.recipient_address_line_2 &&
+          recipient_city == o.recipient_city &&
+          recipient_postal_code == o.recipient_postal_code &&
+          recipient_state == o.recipient_state &&
+          recipient_country_code == o.recipient_country_code &&
+          recipient_tax_id == o.recipient_tax_id
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id, net_amount_cents, total_amount_cents, document_number, currency, status, due_date, document_date, legal_entity_id, vendor_id, file, updated_at, taxes, fully_reconciled_at, recorded_at, duplicate_financial_document_id, validated_at, validated_by_id, document_type, parent_financial_document_id, taxes_total_amount_cents, issuer_name, issuer_address_line_1, issuer_address_line_2, issuer_city, issuer_postal_code, issuer_state, issuer_country_code, issuer_tax_id, recipient_name, recipient_address_line_1, recipient_address_line_2, recipient_city, recipient_postal_code, recipient_state, recipient_country_code, recipient_tax_id].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end