apimatic-tql-sdk 0.0.1

data/lib/tql_otr_factoring_data_exchange/models/invoice_search_request.rb

@@ -0,0 +1,242 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module TqlOtrFactoringDataExchange
+  # Search filters and pagination for querying invoices. All filter fields are
+  # optional — omit a filter to match all values for that field. **AND across
+  # fields, OR within arrays.** When multiple fields are supplied, all must
+  # match (AND). When an array-valued field (like `status`) contains multiple
+  # values, a match on *any* value satisfies that field (OR).
+  class InvoiceSearchRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 1-based page number.
+    # @return [Integer]
+    attr_accessor :page
+
+    # Number of results per page (max 100).
+    # @return [Integer]
+    attr_accessor :page_size
+
+    # Filter by one or more TQL load numbers (exact match, OR within the array).
+    # @return [Array[String]]
+    attr_accessor :load_numbers
+
+    # Filter by one or more factoring company invoice numbers (exact match, OR
+    # within the array).
+    # @return [Array[String]]
+    attr_accessor :invoice_numbers
+
+    # Filter by one or more invoice statuses (OR within the array).
+    # @return [Array[InvoiceStatus]]
+    attr_accessor :statuses
+
+    # Filter by one or more carrier names (partial match, OR within the array).
+    # @return [Array[String]]
+    attr_accessor :carrier_names
+
+    # Filter by one or more USDOT numbers (exact match, OR within the array).
+    # @return [Array[String]]
+    attr_accessor :carrier_dot_numbers
+
+    # Filter by one or more Motor Carrier (MC) numbers (exact match, OR within
+    # the array).
+    # @return [Array[String]]
+    attr_accessor :carrier_mc_numbers
+
+    # Only return invoices whose `lastUpdatedAt` is on or after this UTC
+    # timestamp.
+    # @return [DateTime]
+    attr_accessor :last_updated_after
+
+    # Only return invoices whose `lastUpdatedAt` is before this UTC timestamp.
+    # @return [DateTime]
+    attr_accessor :last_updated_before
+
+    # Only return invoices received on or after this UTC timestamp.
+    # @return [DateTime]
+    attr_accessor :received_after
+
+    # Only return invoices received before this UTC timestamp.
+    # @return [DateTime]
+    attr_accessor :received_before
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['page'] = 'page'
+      @_hash['page_size'] = 'pageSize'
+      @_hash['load_numbers'] = 'loadNumbers'
+      @_hash['invoice_numbers'] = 'invoiceNumbers'
+      @_hash['statuses'] = 'statuses'
+      @_hash['carrier_names'] = 'carrierNames'
+      @_hash['carrier_dot_numbers'] = 'carrierDotNumbers'
+      @_hash['carrier_mc_numbers'] = 'carrierMcNumbers'
+      @_hash['last_updated_after'] = 'lastUpdatedAfter'
+      @_hash['last_updated_before'] = 'lastUpdatedBefore'
+      @_hash['received_after'] = 'receivedAfter'
+      @_hash['received_before'] = 'receivedBefore'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        load_numbers
+        invoice_numbers
+        statuses
+        carrier_names
+        carrier_dot_numbers
+        carrier_mc_numbers
+        last_updated_after
+        last_updated_before
+        received_after
+        received_before
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        load_numbers
+        invoice_numbers
+        statuses
+        carrier_names
+        carrier_dot_numbers
+        carrier_mc_numbers
+        last_updated_after
+        last_updated_before
+        received_after
+        received_before
+      ]
+    end
+
+    def initialize(page:, page_size:, load_numbers: SKIP, invoice_numbers: SKIP,
+                   statuses: SKIP, carrier_names: SKIP,
+                   carrier_dot_numbers: SKIP, carrier_mc_numbers: SKIP,
+                   last_updated_after: SKIP, last_updated_before: SKIP,
+                   received_after: SKIP, received_before: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @page = page
+      @page_size = page_size
+      @load_numbers = load_numbers unless load_numbers == SKIP
+      @invoice_numbers = invoice_numbers unless invoice_numbers == SKIP
+      @statuses = statuses unless statuses == SKIP
+      @carrier_names = carrier_names unless carrier_names == SKIP
+      @carrier_dot_numbers = carrier_dot_numbers unless carrier_dot_numbers == SKIP
+      @carrier_mc_numbers = carrier_mc_numbers unless carrier_mc_numbers == SKIP
+      @last_updated_after = last_updated_after unless last_updated_after == SKIP
+      @last_updated_before = last_updated_before unless last_updated_before == SKIP
+      @received_after = received_after unless received_after == SKIP
+      @received_before = received_before unless received_before == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      page = hash.key?('page') ? hash['page'] : nil
+      page_size = hash.key?('pageSize') ? hash['pageSize'] : nil
+      load_numbers = hash.key?('loadNumbers') ? hash['loadNumbers'] : SKIP
+      invoice_numbers =
+        hash.key?('invoiceNumbers') ? hash['invoiceNumbers'] : SKIP
+      statuses = hash.key?('statuses') ? hash['statuses'] : SKIP
+      carrier_names = hash.key?('carrierNames') ? hash['carrierNames'] : SKIP
+      carrier_dot_numbers =
+        hash.key?('carrierDotNumbers') ? hash['carrierDotNumbers'] : SKIP
+      carrier_mc_numbers =
+        hash.key?('carrierMcNumbers') ? hash['carrierMcNumbers'] : SKIP
+      last_updated_after = if hash.key?('lastUpdatedAfter')
+                             (DateTimeHelper.from_rfc3339(hash['lastUpdatedAfter']) if hash['lastUpdatedAfter'])
+                           else
+                             SKIP
+                           end
+      last_updated_before = if hash.key?('lastUpdatedBefore')
+                              (DateTimeHelper.from_rfc3339(hash['lastUpdatedBefore']) if hash['lastUpdatedBefore'])
+                            else
+                              SKIP
+                            end
+      received_after = if hash.key?('receivedAfter')
+                         (DateTimeHelper.from_rfc3339(hash['receivedAfter']) if hash['receivedAfter'])
+                       else
+                         SKIP
+                       end
+      received_before = if hash.key?('receivedBefore')
+                          (DateTimeHelper.from_rfc3339(hash['receivedBefore']) if hash['receivedBefore'])
+                        else
+                          SKIP
+                        end
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      InvoiceSearchRequest.new(page: page,
+                               page_size: page_size,
+                               load_numbers: load_numbers,
+                               invoice_numbers: invoice_numbers,
+                               statuses: statuses,
+                               carrier_names: carrier_names,
+                               carrier_dot_numbers: carrier_dot_numbers,
+                               carrier_mc_numbers: carrier_mc_numbers,
+                               last_updated_after: last_updated_after,
+                               last_updated_before: last_updated_before,
+                               received_after: received_after,
+                               received_before: received_before,
+                               additional_properties: additional_properties)
+    end
+
+    def to_custom_last_updated_after
+      DateTimeHelper.to_rfc3339(last_updated_after)
+    end
+
+    def to_custom_last_updated_before
+      DateTimeHelper.to_rfc3339(last_updated_before)
+    end
+
+    def to_custom_received_after
+      DateTimeHelper.to_rfc3339(received_after)
+    end
+
+    def to_custom_received_before
+      DateTimeHelper.to_rfc3339(received_before)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} page: #{@page}, page_size: #{@page_size}, load_numbers: #{@load_numbers},"\
+      " invoice_numbers: #{@invoice_numbers}, statuses: #{@statuses}, carrier_names:"\
+      " #{@carrier_names}, carrier_dot_numbers: #{@carrier_dot_numbers}, carrier_mc_numbers:"\
+      " #{@carrier_mc_numbers}, last_updated_after: #{@last_updated_after}, last_updated_before:"\
+      " #{@last_updated_before}, received_after: #{@received_after}, received_before:"\
+      " #{@received_before}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} page: #{@page.inspect}, page_size: #{@page_size.inspect}, load_numbers:"\
+      " #{@load_numbers.inspect}, invoice_numbers: #{@invoice_numbers.inspect}, statuses:"\
+      " #{@statuses.inspect}, carrier_names: #{@carrier_names.inspect}, carrier_dot_numbers:"\
+      " #{@carrier_dot_numbers.inspect}, carrier_mc_numbers: #{@carrier_mc_numbers.inspect},"\
+      " last_updated_after: #{@last_updated_after.inspect}, last_updated_before:"\
+      " #{@last_updated_before.inspect}, received_after: #{@received_after.inspect},"\
+      " received_before: #{@received_before.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/invoice_search_response.rb

@@ -0,0 +1,124 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # Paginated list of invoice search results.
+  class InvoiceSearchResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Current page number.
+    # @return [Integer]
+    attr_accessor :page
+
+    # Number of results per page.
+    # @return [Integer]
+    attr_accessor :page_size
+
+    # Total number of invoices matching the search criteria.
+    # @return [Integer]
+    attr_accessor :total_count
+
+    # Total number of pages.
+    # @return [Integer]
+    attr_accessor :total_pages
+
+    # Invoices matching the search criteria for this page.
+    # @return [Array[Invoice]]
+    attr_accessor :results
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['page'] = 'page'
+      @_hash['page_size'] = 'pageSize'
+      @_hash['total_count'] = 'totalCount'
+      @_hash['total_pages'] = 'totalPages'
+      @_hash['results'] = 'results'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        page
+        page_size
+        total_count
+        total_pages
+        results
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(page: SKIP, page_size: SKIP, total_count: SKIP,
+                   total_pages: SKIP, results: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @page = page unless page == SKIP
+      @page_size = page_size unless page_size == SKIP
+      @total_count = total_count unless total_count == SKIP
+      @total_pages = total_pages unless total_pages == SKIP
+      @results = results unless results == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      page = hash.key?('page') ? hash['page'] : SKIP
+      page_size = hash.key?('pageSize') ? hash['pageSize'] : SKIP
+      total_count = hash.key?('totalCount') ? hash['totalCount'] : SKIP
+      total_pages = hash.key?('totalPages') ? hash['totalPages'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      results = nil
+      unless hash['results'].nil?
+        results = []
+        hash['results'].each do |structure|
+          results << (Invoice.from_hash(structure) if structure)
+        end
+      end
+
+      results = SKIP unless hash.key?('results')
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      InvoiceSearchResponse.new(page: page,
+                                page_size: page_size,
+                                total_count: total_count,
+                                total_pages: total_pages,
+                                results: results,
+                                additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} page: #{@page}, page_size: #{@page_size}, total_count: #{@total_count},"\
+      " total_pages: #{@total_pages}, results: #{@results}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} page: #{@page.inspect}, page_size: #{@page_size.inspect}, total_count:"\
+      " #{@total_count.inspect}, total_pages: #{@total_pages.inspect}, results:"\
+      " #{@results.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/invoice_status.rb

@@ -0,0 +1,74 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # Processing and payment status of an invoice. The lifecycle typically flows:
+  # `Received` → `Validating` → `Processing` → `Approved` → `NotPaid` → `Paid`.
+  # Branches include `AwaitingDocuments`, `PendingExceptions`, and `Rejected`.
+  class InvoiceStatus
+    INVOICE_STATUS = [
+      # TODO: Write general description for RECEIVED
+      RECEIVED = 'Received'.freeze,
+
+      # TODO: Write general description for VALIDATING
+      VALIDATING = 'Validating'.freeze,
+
+      # TODO: Write general description for PROCESSING
+      PROCESSING = 'Processing'.freeze,
+
+      # TODO: Write general description for AWAITINGDOCUMENTS
+      AWAITINGDOCUMENTS = 'AwaitingDocuments'.freeze,
+
+      # TODO: Write general description for PENDINGEXCEPTIONS
+      PENDINGEXCEPTIONS = 'PendingExceptions'.freeze,
+
+      # TODO: Write general description for APPROVED
+      APPROVED = 'Approved'.freeze,
+
+      # TODO: Write general description for NOTPAID
+      NOTPAID = 'NotPaid'.freeze,
+
+      # TODO: Write general description for PAID
+      PAID = 'Paid'.freeze,
+
+      # TODO: Write general description for PARTIALLYPAID
+      PARTIALLYPAID = 'PartiallyPaid'.freeze,
+
+      # TODO: Write general description for COMPLETE
+      COMPLETE = 'Complete'.freeze,
+
+      # TODO: Write general description for REJECTED
+      REJECTED = 'Rejected'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INVOICE_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = RECEIVED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'received' then RECEIVED
+      when 'validating' then VALIDATING
+      when 'processing' then PROCESSING
+      when 'awaitingdocuments' then AWAITINGDOCUMENTS
+      when 'pendingexceptions' then PENDINGEXCEPTIONS
+      when 'approved' then APPROVED
+      when 'notpaid' then NOTPAID
+      when 'paid' then PAID
+      when 'partiallypaid' then PARTIALLYPAID
+      when 'complete' then COMPLETE
+      when 'rejected' then REJECTED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/invoice_status_response.rb

@@ -0,0 +1,193 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module TqlOtrFactoringDataExchange
+  # Current processing state of an invoice, including any outstanding exceptions
+  # that require resolution.
+  class InvoiceStatusResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The TQL load number this invoice was submitted against.
+    # @return [String]
+    attr_accessor :load_number
+
+    # The factoring company's invoice number.
+    # @return [String]
+    attr_accessor :invoice_number
+
+    # Processing and payment status of an invoice. The lifecycle typically
+    # flows: `Received` → `Validating` → `Processing` → `Approved` → `NotPaid` →
+    # `Paid`. Branches include `AwaitingDocuments`, `PendingExceptions`, and
+    # `Rejected`.
+    # @return [InvoiceStatus]
+    attr_accessor :status
+
+    # UTC timestamp when the invoice was received.
+    # @return [DateTime]
+    attr_accessor :received_at
+
+    # UTC timestamp when processing completed (null if still in progress).
+    # @return [DateTime]
+    attr_accessor :completed_at
+
+    # Sum of all charge amounts on the invoice.
+    # @return [Float]
+    attr_accessor :total_charge_amount
+
+    # [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency
+    # code.
+    # @return [String]
+    attr_accessor :currency
+
+    # Documents uploaded and linked to this invoice. Each entry indicates the
+    # document type. Empty array means no documents have been received yet.
+    # @return [Array[DocumentType]]
+    attr_accessor :documents
+
+    # Outstanding exceptions that need resolution. Empty array means no issues.
+    # @return [Array[InvoiceException]]
+    attr_accessor :exceptions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['load_number'] = 'loadNumber'
+      @_hash['invoice_number'] = 'invoiceNumber'
+      @_hash['status'] = 'status'
+      @_hash['received_at'] = 'receivedAt'
+      @_hash['completed_at'] = 'completedAt'
+      @_hash['total_charge_amount'] = 'totalChargeAmount'
+      @_hash['currency'] = 'currency'
+      @_hash['documents'] = 'documents'
+      @_hash['exceptions'] = 'exceptions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        load_number
+        invoice_number
+        status
+        received_at
+        completed_at
+        total_charge_amount
+        currency
+        documents
+        exceptions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        completed_at
+      ]
+    end
+
+    def initialize(load_number: SKIP, invoice_number: SKIP, status: SKIP,
+                   received_at: SKIP, completed_at: SKIP,
+                   total_charge_amount: SKIP, currency: SKIP, documents: SKIP,
+                   exceptions: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @load_number = load_number unless load_number == SKIP
+      @invoice_number = invoice_number unless invoice_number == SKIP
+      @status = status unless status == SKIP
+      @received_at = received_at unless received_at == SKIP
+      @completed_at = completed_at unless completed_at == SKIP
+      @total_charge_amount = total_charge_amount unless total_charge_amount == SKIP
+      @currency = currency unless currency == SKIP
+      @documents = documents unless documents == SKIP
+      @exceptions = exceptions unless exceptions == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      load_number = hash.key?('loadNumber') ? hash['loadNumber'] : SKIP
+      invoice_number = hash.key?('invoiceNumber') ? hash['invoiceNumber'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      received_at = if hash.key?('receivedAt')
+                      (DateTimeHelper.from_rfc3339(hash['receivedAt']) if hash['receivedAt'])
+                    else
+                      SKIP
+                    end
+      completed_at = if hash.key?('completedAt')
+                       (DateTimeHelper.from_rfc3339(hash['completedAt']) if hash['completedAt'])
+                     else
+                       SKIP
+                     end
+      total_charge_amount =
+        hash.key?('totalChargeAmount') ? hash['totalChargeAmount'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      documents = hash.key?('documents') ? hash['documents'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      exceptions = nil
+      unless hash['exceptions'].nil?
+        exceptions = []
+        hash['exceptions'].each do |structure|
+          exceptions << (InvoiceException.from_hash(structure) if structure)
+        end
+      end
+
+      exceptions = SKIP unless hash.key?('exceptions')
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      InvoiceStatusResponse.new(load_number: load_number,
+                                invoice_number: invoice_number,
+                                status: status,
+                                received_at: received_at,
+                                completed_at: completed_at,
+                                total_charge_amount: total_charge_amount,
+                                currency: currency,
+                                documents: documents,
+                                exceptions: exceptions,
+                                additional_properties: additional_properties)
+    end
+
+    def to_custom_received_at
+      DateTimeHelper.to_rfc3339(received_at)
+    end
+
+    def to_custom_completed_at
+      DateTimeHelper.to_rfc3339(completed_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} load_number: #{@load_number}, invoice_number: #{@invoice_number}, status:"\
+      " #{@status}, received_at: #{@received_at}, completed_at: #{@completed_at},"\
+      " total_charge_amount: #{@total_charge_amount}, currency: #{@currency}, documents:"\
+      " #{@documents}, exceptions: #{@exceptions}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} load_number: #{@load_number.inspect}, invoice_number:"\
+      " #{@invoice_number.inspect}, status: #{@status.inspect}, received_at:"\
+      " #{@received_at.inspect}, completed_at: #{@completed_at.inspect}, total_charge_amount:"\
+      " #{@total_charge_amount.inspect}, currency: #{@currency.inspect}, documents:"\
+      " #{@documents.inspect}, exceptions: #{@exceptions.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/invoice_type.rb

@@ -0,0 +1,50 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # Indicates the purpose of the invoice being submitted. - **Invoice** — A
+  # standard carrier invoice for freight services   rendered on a load. This is
+  # the initial, primary billing   submitted by the factoring company on behalf
+  # of the carrier. - **BalanceDue** — A follow-up invoice for the remaining
+  # balance   after a partial payment or short-pay on a previously submitted
+  # invoice. Use this type when the original invoice was paid at   less than the
+  # full amount and the carrier is billing for the   difference. -
+  # **Supplemental** — An additional invoice for charges that were   not
+  # included on the original invoice. Common examples include   detention
+  # charges, lumper fees, or other accessorials   discovered or finalized after
+  # the initial invoice was   submitted.
+  class InvoiceType
+    INVOICE_TYPE = [
+      # TODO: Write general description for INVOICE
+      INVOICE = 'Invoice'.freeze,
+
+      # TODO: Write general description for BALANCEDUE
+      BALANCEDUE = 'BalanceDue'.freeze,
+
+      # TODO: Write general description for SUPPLEMENTAL
+      SUPPLEMENTAL = 'Supplemental'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INVOICE_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = INVOICE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'invoice' then INVOICE
+      when 'balancedue' then BALANCEDUE
+      when 'supplemental' then SUPPLEMENTAL
+      else
+        default_value
+      end
+    end
+  end
+end