netsuite-soap 2025.2.3

data/lib/netsuite/records/promotion_code.rb

@@ -0,0 +1,38 @@
+# https://system.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2014_1/schema/record/promotioncode.html
+
+module NetSuite
+  module Records
+    class PromotionCode
+      include Support::Fields
+      include Support::RecordRefs
+      include Support::Records
+      include Support::Actions
+      include Namespaces::ListMkt
+
+      actions :get, :get_list, :add, :search, :delete, :update, :upsert
+
+      fields :code, :code_pattern, :description, :discount_type, :display_line_discounts, :end_date,
+             :exclude_items, :is_inactive, :is_public, :minimum_order_amount, :name, :number_to_generate,
+             :rate, :start_date
+
+      record_refs :free_ship_method, :implementation, :custom_form
+
+      # TODO custom records need to be implemented
+      # field :currency_list, PromotionCodeCurrencyList
+      # field :apply_discount_to, PromotionCodeApplyDiscountTo
+      # field :items_list, PromotionCodeItemsList
+      # field :partners_list, PromotionCodePartnersList
+      # field :use_type, PromotionCodeUseType
+
+      attr_reader   :internal_id
+      attr_accessor :external_id
+
+      def initialize(attributes = {})
+        @internal_id = attributes.delete(:internal_id) || attributes.delete(:@internal_id)
+        @external_id = attributes.delete(:external_id) || attributes.delete(:@external_id)
+        initialize_from_attributes_hash(attributes)
+      end
+
+    end
+  end
+end

data/lib/netsuite/records/promotions.rb

@@ -0,0 +1,26 @@
+module NetSuite
+  module Records
+    class Promotions
+      include Support::Fields
+      include Support::RecordRefs
+      include Support::Records
+      include Namespaces::TranSales
+
+      record_refs :coupon_code, :promo_code
+
+      def initialize(attributes_or_record = {})
+        case attributes_or_record
+        when Hash
+          initialize_from_attributes_hash(attributes_or_record)
+        when self.class
+          initialize_from_record(attributes_or_record)
+        end
+      end
+
+      def initialize_from_record(record)
+        self.attributes = record.send(:attributes)
+      end
+
+    end
+  end
+end

data/lib/netsuite/records/promotions_list.rb

@@ -0,0 +1,9 @@
+module NetSuite
+  module Records
+    class PromotionsList < Support::Sublist
+      include Namespaces::TranSales
+
+      sublist :promotions, Promotions
+    end
+  end
+end

data/lib/netsuite/records/purchase_order.rb

@@ -0,0 +1,52 @@
+module NetSuite
+  module Records
+    class PurchaseOrder
+      include Support::Fields
+      include Support::RecordRefs
+      include Support::Records
+      include Support::Actions
+      include Namespaces::TranPurch
+
+      actions :get, :get_list, :add, :initialize, :delete, :update, :upsert, :search
+
+      fields :created_date, :currency_name, :due_date, :email, :exchange_rate,
+             :fax, :fob, :interco_status, :interco_transaction, :last_modified_date,
+             :linked_tracking_numbers, :memo, :message, :other_ref_num, :ship_date,
+             :ship_is_residential, :source, :status, :sub_total, :supervisor_approval,
+             :tax2_total, :tax_total, :to_be_emailed, :to_be_faxed, :to_be_printed,
+             :total, :tracking_numbers, :tran_date, :tran_id, :vat_reg_num
+
+      field :billing_address,   Address
+      field :shipping_address,  Address
+      field :custom_field_list, CustomFieldList
+      field :item_list,         PurchaseOrderItemList
+
+      # TODO custom lists
+      # :ship_address_list
+      # :expense_list
+
+      record_refs :approval_status, :bill_address_list, :klass, :created_from, :currency,
+                  :custom_form, :department, :employee, :entity, :location, :next_approver,
+                  :order_status, :purchase_contract, :ship_method, :ship_to, :subsidiary,
+                  :terms
+
+      attr_reader :internal_id
+      attr_accessor :external_id
+
+      def initialize(attributes = {})
+        @internal_id = attributes.delete(:internal_id) || attributes.delete(:@internal_id)
+        @external_id = attributes.delete(:external_id) || attributes.delete(:@external_id)
+        initialize_from_attributes_hash(attributes)
+      end
+
+      def self.search_class_name
+        "Transaction"
+      end
+
+      def self.search_class_namespace
+        'tranSales'
+      end
+
+    end
+  end
+end

data/lib/netsuite/records/purchase_order_item.rb

@@ -0,0 +1,42 @@
+module NetSuite
+  module Records
+    class PurchaseOrderItem
+      include Support::Fields
+      include Support::RecordRefs
+      include Support::Records
+      include Namespaces::TranPurch
+
+      fields :amount, :description, :expected_receipt_date, :gross_amt, :is_billable,
+             :is_closed, :line, :match_bill_to_receipt, :quantity, :quantity_available,
+             :quantity_billed, :quantity_on_hand, :quantity_received, :rate, :serial_numbers,
+             :tax1_amt, :tax_rate1, :tax_rate2, :vendor_name
+
+      field :custom_field_list, CustomFieldList
+
+      record_refs :bill_variance_status, :klass, :created_from, :customer, :department,
+                  :inventory_detail, :item, :landed_cost_category, :linked_order_list,
+                  :location, :options, :purchase_contract, :tax_code, :units
+
+      def initialize(attributes_or_record = {})
+        case attributes_or_record
+        when Hash
+          initialize_from_attributes_hash(attributes_or_record)
+        when self.class
+          initialize_from_record(attributes_or_record)
+        end
+      end
+
+      def initialize_from_record(record)
+        self.attributes = record.send(:attributes)
+      end
+
+      def to_record
+        rec = super
+        if rec["#{record_namespace}:customFieldList"]
+          rec["#{record_namespace}:customFieldList!"] = rec.delete("#{record_namespace}:customFieldList")
+        end
+        rec
+      end
+    end
+  end
+end

data/lib/netsuite/records/purchase_order_item_list.rb

@@ -0,0 +1,11 @@
+module NetSuite
+  module Records
+    class PurchaseOrderItemList < Support::Sublist
+      include Namespaces::TranPurch
+
+      sublist :item, PurchaseOrderItem
+
+      alias :items :item
+    end
+  end
+end

data/lib/netsuite/records/record_ref.rb

@@ -0,0 +1,38 @@
+module NetSuite
+  module Records
+    class RecordRef
+      include Support::Fields
+      include Support::Records
+      include Namespaces::PlatformCore
+
+      attr_reader   :internal_id, :type
+      attr_accessor :external_id
+
+      def initialize(attributes_or_record = {})
+        case attributes_or_record
+        when Hash
+          attributes = attributes_or_record
+          attributes.delete(:"@xmlns:platform_core")
+          @internal_id = attributes.delete(:internal_id) || attributes.delete(:@internal_id)
+          @external_id = attributes.delete(:external_id) || attributes.delete(:@external_id)
+          @type        = attributes.delete(:type) || attributes.delete(:@type) || attributes.delete(:"@xsi:type")
+          @attributes  = attributes
+        else
+          record = attributes_or_record
+          @internal_id = record.internal_id if record.respond_to?(:internal_id)
+          @external_id = record.external_id if record.respond_to?(:external_id)
+          @type        = NetSuite::Support::Records.netsuite_type(record)
+        end
+      end
+
+      def method_missing(m, *args, &block)
+        if attributes.keys.map(&:to_sym).include?(m.to_sym)
+          attributes[m.to_sym]
+        else
+          super
+        end
+      end
+
+    end
+  end
+end

data/lib/netsuite/records/record_ref_list.rb

@@ -0,0 +1,22 @@
+module NetSuite
+  module Records
+    class RecordRefList < Support::Sublist
+      include Support::Records
+      include Namespaces::PlatformCore
+
+      sublist :record_ref, RecordRef
+
+      def to_record
+        {
+          "#{record_namespace}:recordRef" => record_ref.map do |rr|
+            rec = rr.to_record
+            rec[:@internalId] = rr.internal_id if rr.internal_id
+            rec[:@externalId] = rr.external_id if rr.external_id
+            rec[:@type] = rr.type if rr.type
+            rec
+          end
+        }
+      end
+    end
+  end
+end

data/lib/netsuite/records/return_authorization.rb

@@ -0,0 +1,135 @@
+module NetSuite
+  module Records
+    class ReturnAuthorization
+      include Support::Fields
+      include Support::RecordRefs
+      include Support::Records
+      include Support::Actions
+      include Namespaces::TranCust
+
+      # https://system.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2015_2/schema/record/returnauthorization.html
+
+      actions :get, :get_list, :initialize, :add, :update, :delete, :upsert, :search
+
+      fields :alt_sales_total,
+        :cc_approved,
+        :cc_expire_date,
+        :cc_name,
+        :cc_number,
+        :cc_street,
+        :cc_zip_code,
+        :contrib_pct,
+        :created_date,
+        :currency_name,
+        :debit_card_issue_no,
+        :deferred_revenue,
+        :discount_rate,
+        :discount_total,
+        :email,
+        :est_gross_profit,
+        :est_gross_profit_percent,
+        :exchange_rate,
+        :exclude_commission,
+        :fax,
+        :gift_cert_applied,
+        :gift_cert_available,
+        :gift_cert_total,
+        :is_taxable,
+        :job,
+        :last_modified_date,
+        :memo,
+        :message,
+        :other_ref_num,
+        :pay_pal_auth_id,
+        :pay_pal_process,
+        :pn_ref_num,
+        :recognized_revenue,
+        :rev_rec_end_date,
+        :rev_rec_on_rev_commitment,
+        :rev_rec_start_date,
+        :sales_effective_date,
+        :ship_address,
+        :source,
+        :status,
+        :sub_total,
+        :sync_partner_teams,
+        :sync_sales_teams,
+        :tax2_total,
+        :tax_rate,
+        :tax_total,
+        :to_be_emailed,
+        :to_be_faxed,
+        :to_be_printed,
+        :total,
+        :total_cost_estimate,
+        :tran_date,
+        :tran_id,
+        :tran_is_vsoe_bundle,
+        :valid_from,
+        :vat_reg_num,
+        :vsoe_auto_calc
+
+      record_refs :klass,
+        :created_from,
+        :credit_card,
+        :credit_card_processor,
+        :currency,
+        :custom_form,
+        :department,
+        :discount_item,
+        :dr_account,
+        :entity,
+        :fx_account,
+        :gift_cert,
+        :interco_status,
+        :interco_transaction,
+        :lead_source,
+        :location,
+        :message_sel,
+        :order_status,
+        :partner,
+        :payment_method,
+        :promo_code,
+        :rev_commit_status,
+        :revenue_status,
+        :rev_rec_schedule,
+        :sales_group,
+        :sales_rep,
+        :subsidiary,
+        :tax_item
+
+      # :bill_address_list
+      # :item_list,
+      # :partners_list,
+      # :sales_team_list,
+      # :ship_address_list,
+
+      field :billing_address,          Address
+      field :shipping_address,         Address
+      field :custom_field_list,        CustomFieldList
+      field :item_list,                ReturnAuthorizationItemList
+
+      attr_reader   :internal_id
+      attr_accessor :external_id
+
+      def initialize(attributes = {})
+        @internal_id = attributes.delete(:internal_id) || attributes.delete(:@internal_id)
+        @external_id = attributes.delete(:external_id) || attributes.delete(:@external_id)
+        initialize_from_attributes_hash(attributes)
+      end
+
+      def to_record
+        rec = super
+        if rec["#{record_namespace}:customFieldList"]
+          rec["#{record_namespace}:customFieldList!"] = rec.delete("#{record_namespace}:customFieldList")
+        end
+        rec
+      end
+
+      def self.search_class_name
+        "Transaction"
+      end
+
+    end
+  end
+end

data/lib/netsuite/records/return_authorization_item.rb

@@ -0,0 +1,43 @@
+module NetSuite
+  module Records
+    class ReturnAuthorizationItem
+      include Support::Fields
+      include Support::RecordRefs
+      include Support::Records
+      include Namespaces::TranCust
+
+      fields :alt_sales_amt, :amortization_period, :amortization_type, :amount, :bill_variance_status, :catch_up_period,
+        :cost_estimate, :cost_estimate_rate, :cost_estimate_type, :days_before_expiration, :defer_rev_rec, :description,
+        :gift_cert_from, :gift_cert_message, :gift_cert_recipient_email, :gift_cert_recipient_name, :id, :inventory_detail,
+        :is_closed, :is_drop_shipment, :is_taxable, :is_vsoe_bundle, :item_subtype, :item_type, :line, :line_number,
+        :matrix_type, :options, :order_line, :print_items, :quantity, :quantity_billed, :quantity_received, :quantity_rev_committed,
+        :rate, :rate_schedule, :rev_rec_end_date, :rev_rec_start_date, :tax_rate1, :vsoe_allocation, :vsoe_amount,
+        :vsoe_deferral, :vsoe_delivered, :vsoe_is_estimate, :vsoe_permit_discount, :vsoe_price, :vsoe_sop_group
+
+      field :custom_field_list, CustomFieldList
+
+      record_refs :department, :item, :job, :klass, :location, :price, :rev_rec_schedule, :tax_code, :units
+
+      def initialize(attributes_or_record = {})
+        case attributes_or_record
+        when Hash
+          initialize_from_attributes_hash(attributes_or_record)
+        when self.class
+          initialize_from_record(attributes_or_record)
+        end
+      end
+
+      def initialize_from_record(record)
+        self.attributes = record.send(:attributes)
+      end
+
+      def to_record
+        rec = super
+        if rec["#{record_namespace}:customFieldList"]
+          rec["#{record_namespace}:customFieldList!"] = rec.delete("#{record_namespace}:customFieldList")
+        end
+        rec
+      end
+    end
+  end
+end

data/lib/netsuite/records/return_authorization_item_list.rb

@@ -0,0 +1,11 @@
+module NetSuite
+  module Records
+    class ReturnAuthorizationItemList < Support::Sublist
+      include Namespaces::TranCust
+
+      sublist :item, ReturnAuthorizationItem
+
+      alias :items :item
+    end
+  end
+end

data/lib/netsuite/records/rev_rec_schedule.rb

@@ -0,0 +1,32 @@
+# https://system.netsuite.com/help/helpcenter/en_US/srbrowser/Browser2015_1/schema/record/revrecschedule.html
+
+module NetSuite
+  module Records
+    class RevRecSchedule
+      include Support::Fields
+      include Support::RecordRefs
+      include Support::Records
+      include Support::Actions
+      include Namespaces::ListAcct
+
+      actions :get, :get_list, :add, :update, :upsert, :delete, :search
+
+      fields :initial_amount, :is_inactive, :name, :period_offset, :rev_rec_offset,
+             :amortization_period
+
+      record_refs :amortization_type, :recog_interval_src, :recurrence_type
+
+      # recurrenceList	RevRecScheduleRecurrenceList	0..1
+
+      attr_reader :internal_id
+      attr_accessor :external_id
+
+      def initialize(attributes = {})
+        @internal_id = attributes.delete(:internal_id) || attributes.delete(:@internal_id)
+        @external_id = attributes.delete(:external_id) || attributes.delete(:@external_id)
+        initialize_from_attributes_hash(attributes)
+      end
+
+    end
+  end
+end

data/lib/netsuite/records/rev_rec_template.rb

@@ -0,0 +1,25 @@
+module NetSuite
+  module Records
+    class RevRecTemplate
+      include Support::Fields
+      include Support::RecordRefs
+      include Support::Records
+      include Support::Actions
+      include Namespaces::ListAcct
+
+      actions :get, :get_list, :add, :update, :upsert, :delete, :search
+      
+      fields :name, :is_inactive
+      
+      attr_reader :internal_id
+      attr_accessor :external_id
+
+      def initialize(attributes = {})
+        @internal_id = attributes.delete(:internal_id) || attributes.delete(:@internal_id)
+        @external_id = attributes.delete(:external_id) || attributes.delete(:@external_id)
+        initialize_from_attributes_hash(attributes)
+      end
+      
+    end
+  end
+end

data/lib/netsuite/records/role_list.rb

@@ -0,0 +1,24 @@
+module NetSuite
+  module Records
+    class RoleList < Support::Sublist
+      include Namespaces::ListEmp
+
+      sublist :roles, Roles
+
+      # role list is undocumented and has pretty funky XML:
+
+      # <listEmp:rolesList>
+      #   <listEmp:roles>
+      #     <listEmp:selectedRole xmlns:platformCore="urn:core_2013_1.platform.webservices.netsuite.com" internalId="1001">
+      #       <platformCore:name>Customer Service Rep</platformCore:name>
+      #     </listEmp:selectedRole>
+      #   </listEmp:roles>
+      #   <listEmp:roles>
+      #     <listEmp:selectedRole xmlns:platformCore="urn:core_2013_1.platform.webservices.netsuite.com" internalId="1002">
+      #       <platformCore:name>Customer Service Rep Mgr</platformCore:name>
+      #     </listEmp:selectedRole>
+      #   </listEmp:roles>
+      # </listEmp:rolesList>
+    end
+  end
+end

data/lib/netsuite/records/roles.rb

@@ -0,0 +1,17 @@
+module NetSuite
+  module Records
+    class Roles
+      include Support::Records
+      include Support::Fields
+      include Support::RecordRefs
+      include Namespaces::ListEmp
+
+      record_refs :selected_role
+
+      def initialize(attributes = {})
+        initialize_from_attributes_hash(attributes)
+      end
+
+    end
+  end
+end

data/lib/netsuite/records/sales_order.rb

@@ -0,0 +1,61 @@
+module NetSuite
+  module Records
+    class SalesOrder
+      include Support::Fields
+      include Support::RecordRefs
+      include Support::Records
+      include Support::Actions
+      include Namespaces::TranSales
+
+      actions :attach_file, :get, :get_list, :add, :initialize, :delete, :update, :upsert, :upsert_list, :search
+
+      fields :alt_handling_cost, :alt_shipping_cost, :amount_paid, :amount_remaining, :auto_apply, :balance,
+        :bill_address, :cc_approved, :contrib_pct, :created_date, :currency_name, :deferred_revenue, :discount_rate, :email, :end_date,
+        :est_gross_profit, :exchange_rate, :exclude_commission, :fax, :gift_cert_applied,
+        :gift_cert_available, :gift_cert_total, :handling_cost, :handling_tax1_rate, :handling_tax2_rate, :is_taxable,
+        :last_modified_date, :memo, :message, :on_credit_hold, :order_status, :other_ref_num, :recognized_revenue,
+        :rev_rec_on_rev_commitment, :sales_effective_date, :ship_complete, :ship_date, :shipping_cost, :shipping_tax1_rate, :shipping_tax2_rate, :source,
+        :start_date, :status, :sync_partner_teams, :sync_sales_teams, :tax2_total, :tax_rate, :to_be_emailed, :to_be_faxed,
+        :to_be_printed, :total_cost_estimate, :tran_date, :tran_id, :tran_is_vsoe_bundle, :vat_reg_num,
+        :linked_tracking_numbers, :vsoe_auto_calc, :quantity, :bill_city, :bill_state, :ship_city, :ship_state, :cost_estimate,
+        :amount, :is_ship_address, :auth_code, :pn_ref_num, :is_multi_ship_to, :cc_number, :cc_name, :cc_expire_date, :cc_avs_street_match,
+        :cc_avs_zip_match, :cc_security_code_match
+
+      # NOTE API >= 2014_2 only
+      field :shipping_address, Address
+      field :billing_address, Address
+
+      # NOTE transaction address fields only applicable for API < 2014_2
+      field :transaction_ship_address, ShipAddress
+      field :transaction_bill_address, BillAddress
+
+      field :item_list,                   SalesOrderItemList
+      field :custom_field_list,           CustomFieldList
+      field :gift_cert_redemption_list,   GiftCertRedemptionList
+      field :ship_group_list,             SalesOrderShipGroupList
+      field :promotions_list,             PromotionsList
+      field :null_field_list,             NullFieldList
+
+      read_only_fields :applied, :discount_total, :sub_total, :tax_total, :total, :unapplied,
+                       :est_gross_profit_percent
+
+      record_refs :account, :bill_address_list, :created_from, :currency, :custom_form, :department, :discount_item, :entity, :gift_cert,
+        :handling_tax_code, :job, :klass, :lead_source, :location, :message_sel, :opportunity, :partner, :posting_period, :promo_code,
+        :sales_group, :sales_rep, :ship_method, :shipping_tax_code, :subsidiary, :terms, :tax_item, :payment_method, :ship_address_list
+
+      attr_reader :internal_id
+      attr_accessor :external_id
+
+      def initialize(attributes = {})
+        @internal_id = attributes.delete(:internal_id) || attributes.delete(:@internal_id)
+        @external_id = attributes.delete(:external_id) || attributes.delete(:@external_id)
+        initialize_from_attributes_hash(attributes)
+      end
+
+      def self.search_class_name
+        "Transaction"
+      end
+
+    end
+  end
+end

data/lib/netsuite/records/sales_order_item.rb

@@ -0,0 +1,49 @@
+module NetSuite
+  module Records
+    class SalesOrderItem
+      include Support::Fields
+      include Support::RecordRefs
+      include Support::Records
+      include Namespaces::TranSales
+
+      fields :amount, :bin_numbers, :cost_estimate,
+        :cost_estimate_type, :defer_rev_rec, :description,
+        :expand_item_group, :gift_cert_from, :gift_cert_message,
+        :gift_cert_number, :gift_cert_recipient_email,
+        :gift_cert_recipient_name, :gross_amt, :is_closed,
+        :is_taxable, :line, :order_line, :po_currency, :quantity,
+        :quantity_back_ordered, :quantity_billed, :quantity_committed,
+        :quantity_fulfilled, :rate, :rev_rec_end_date,
+        :rev_rec_start_date, :rev_rec_term_in_months, :serial_numbers,
+        :shipping_cost, :tax1_amt, :tax_rate1, :tax_rate2,
+        :vsoe_allocation, :vsoe_amount, :vsoe_deferral,
+        :vsoe_delivered, :vsoe_permit_discount, :vsoe_price,
+        :ship_group
+
+      field :custom_field_list, CustomFieldList
+
+      record_refs :department, :item, :job, :klass, :location, :price, :rev_rec_schedule, :tax_code, :units
+
+      def initialize(attributes_or_record = {})
+        case attributes_or_record
+        when Hash
+          initialize_from_attributes_hash(attributes_or_record)
+        when self.class
+          initialize_from_record(attributes_or_record)
+        end
+      end
+
+      def initialize_from_record(record)
+        self.attributes = record.send(:attributes)
+      end
+
+      def to_record
+        rec = super
+        if rec["#{record_namespace}:customFieldList"]
+          rec["#{record_namespace}:customFieldList!"] = rec.delete("#{record_namespace}:customFieldList")
+        end
+        rec
+      end
+    end
+  end
+end

data/lib/netsuite/records/sales_order_item_list.rb

@@ -0,0 +1,11 @@
+module NetSuite
+  module Records
+    class SalesOrderItemList < Support::Sublist
+      include Namespaces::TranSales
+
+      sublist :item, SalesOrderItem
+
+      alias :items :item
+    end
+  end
+end

data/lib/netsuite/records/sales_order_ship_group_list.rb

@@ -0,0 +1,11 @@
+module NetSuite
+  module Records
+    class SalesOrderShipGroupList < Support::Sublist
+      include Namespaces::TranSales
+
+      sublist :ship_group, TransactionShipGroup
+
+      alias :ship_groups :ship_group
+    end
+  end
+end