lockstep_sdk 2022.15.31.1 → 2022.26.12.0

data/lib/lockstep_sdk/models/contact_sync_model.rb

@@ -55,7 +55,7 @@ module LockstepSdk
         end
 
         ##
-        # @return [String] This is the primary key of the Contact record. For this field, you should use whatever the contact's unique identifying number is in the originating system. Search for a unique, non-changing number within the originating financial system for this record. Example: If you store your contact records in a database, whatever the primary key for the contact table is in the database should be the "ErpKey". As some ERP systems don't maintain a unique key for Contacts, we also support syncing Contacts with ERP keys of the form {CompanyErpKey}|{index}, for example CompanyErpKey|1, CompanyErpKey|2 and so on. For this reason, please ensure that your Company/Contact ERP keys don't contain the '|' symbol or that it is replaced by an alternate symbol if they do. For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
+        # @return [String] This is the primary key of the Contact record. For this field, you should use whatever the contact's unique identifying number is in the originating system. Search for a unique, non-changing number within the originating financial system for this record. Example: If you store your contact records in a database, whatever the primary key for the contact table is in the database should be the "ErpKey". As some ERP systems don't maintain a unique key for Contacts, we also support syncing Contacts with ERP keys of the form {prefix}|{index}, for example ContactPrefix|1, ContactPrefix|2 and so on. For this reason, please ensure that your Contact ERP keys don't otherwise contain the '|' symbol or that it is replaced by an alternate symbol if they do. For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
         attr_accessor :erp_key
 
         ##
@@ -115,7 +115,7 @@ module LockstepSdk
         attr_accessor :postal_code
 
         ##
-        # @return [String] The mailing address information for this contact. This will be validated by the /api/v1/definitions/countries data set
+        # @return [String] The mailing address information for this contact.
         attr_accessor :country_code
 
         ##

data/lib/lockstep_sdk/models/customer_summary_model.rb

@@ -31,10 +31,16 @@ module LockstepSdk
             @total_invoices_open = params.dig(:total_invoices_open)
             @total_invoices_past_due = params.dig(:total_invoices_past_due)
             @closed_invoices = params.dig(:closed_invoices)
+            @closed_invoices_past_thirty_days = params.dig(:closed_invoices_past_thirty_days)
             @amount_collected = params.dig(:amount_collected)
+            @amount_collected_past_thirty_days = params.dig(:amount_collected_past_thirty_days)
             @outstanding_amount = params.dig(:outstanding_amount)
+            @invoiced_amount_past_thirty_days = params.dig(:invoiced_amount_past_thirty_days)
+            @outstanding_amount_past_thirty_days = params.dig(:outstanding_amount_past_thirty_days)
+            @invoices_past_thirty_days = params.dig(:invoices_past_thirty_days)
             @amount_past_due = params.dig(:amount_past_due)
             @unapplied_payments = params.dig(:unapplied_payments)
+            @unapplied_amount_past_thirty_days = params.dig(:unapplied_amount_past_thirty_days)
             @percent_of_total_ar = params.dig(:percent_of_total_ar)
             @dso = params.dig(:dso)
             @newest_activity = params.dig(:newest_activity)
@@ -72,14 +78,34 @@ module LockstepSdk
         # @return [Int32] The number of closed invoices for this customer.
         attr_accessor :closed_invoices
 
+        ##
+        # @return [Int32] The number of closed invoices for this customer in the past thirty days.
+        attr_accessor :closed_invoices_past_thirty_days
+
         ##
         # @return [Double] The total from collected payments.
         attr_accessor :amount_collected
 
+        ##
+        # @return [Double] The total from collected payments in the past thirty days.
+        attr_accessor :amount_collected_past_thirty_days
+
         ##
         # @return [Double] The total balance of outstanding invoices.
         attr_accessor :outstanding_amount
 
+        ##
+        # @return [Double] The total amount invoiced in the past thirty days.
+        attr_accessor :invoiced_amount_past_thirty_days
+
+        ##
+        # @return [Double] The total amount outstanding from the invoices invoiced in the past thirty days.
+        attr_accessor :outstanding_amount_past_thirty_days
+
+        ##
+        # @return [Int32] The number of invoices invoiced in the past thirty days.
+        attr_accessor :invoices_past_thirty_days
+
         ##
         # @return [Double] The total amount past due for this customer.
         attr_accessor :amount_past_due
@@ -88,6 +114,10 @@ module LockstepSdk
         # @return [Double] The total value of unapplied Payments for this Customer.
         attr_accessor :unapplied_payments
 
+        ##
+        # @return [Double] The total value of unapplied Payments for this Customer in the past thirty days.
+        attr_accessor :unapplied_amount_past_thirty_days
+
         ##
         # @return [Double] Portion of Total AR for this Customer that is Past due. (TotalPastDue / Total AR).
         attr_accessor :percent_of_total_ar
@@ -112,10 +142,16 @@ module LockstepSdk
                 'totalInvoicesOpen' => @total_invoices_open,
                 'totalInvoicesPastDue' => @total_invoices_past_due,
                 'closedInvoices' => @closed_invoices,
+                'closedInvoicesPastThirtyDays' => @closed_invoices_past_thirty_days,
                 'amountCollected' => @amount_collected,
+                'amountCollectedPastThirtyDays' => @amount_collected_past_thirty_days,
                 'outstandingAmount' => @outstanding_amount,
+                'invoicedAmountPastThirtyDays' => @invoiced_amount_past_thirty_days,
+                'outstandingAmountPastThirtyDays' => @outstanding_amount_past_thirty_days,
+                'invoicesPastThirtyDays' => @invoices_past_thirty_days,
                 'amountPastDue' => @amount_past_due,
                 'unappliedPayments' => @unapplied_payments,
+                'unappliedAmountPastThirtyDays' => @unapplied_amount_past_thirty_days,
                 'percentOfTotalAr' => @percent_of_total_ar,
                 'dso' => @dso,
                 'newestActivity' => @newest_activity,

data/lib/lockstep_sdk/models/daily_payable_outstanding_report_model.rb

@@ -0,0 +1,59 @@
+#
+# Lockstep Platform SDK for Ruby
+#
+# (c) 2021-2022 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Lockstep Network <support@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # Represents the daily payable outstanding report
+    class DailyPayableOutstandingReportModel
+
+        ##
+        # Initialize the DailyPayableOutstandingReportModel using the provided prototype
+        def initialize(params = {})
+            @timeframe = params.dig(:timeframe)
+            @invoice_count = params.dig(:invoice_count)
+            @daily_payable_outstanding = params.dig(:daily_payable_outstanding)
+        end
+
+        ##
+        # @return [Date-time] Timeframe (quarter) the daily payable outstanding values are associated with
+        attr_accessor :timeframe
+
+        ##
+        # @return [Int32] Number of invoices the average daily payable outstanding is calculated on
+        attr_accessor :invoice_count
+
+        ##
+        # @return [Double] Time (in days) between an invoice was completed paid off and when the invoice was issued
+        attr_accessor :daily_payable_outstanding
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'timeframe' => @timeframe,
+                'invoiceCount' => @invoice_count,
+                'dailyPayableOutstanding' => @daily_payable_outstanding,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end

data/lib/lockstep_sdk/models/daily_sales_outstanding_report_model.rb

@@ -24,7 +24,6 @@ module LockstepSdk
         # Initialize the DailySalesOutstandingReportModel using the provided prototype
         def initialize(params = {})
             @timeframe = params.dig(:timeframe)
-            @invoice_count = params.dig(:invoice_count)
             @daily_sales_outstanding = params.dig(:daily_sales_outstanding)
         end
 
@@ -32,10 +31,6 @@ module LockstepSdk
         # @return [Date-time] Timeframe (month) the daily sales outstanding values are associated with
         attr_accessor :timeframe
 
-        ##
-        # @return [Int32] Number of invoices the average daily sales outstanding is calculated on
-        attr_accessor :invoice_count
-
         ##
         # @return [Double] Time (in days) between an invoice was completed paid off and when the invoice was issued
         attr_accessor :daily_sales_outstanding
@@ -45,7 +40,6 @@ module LockstepSdk
         def as_json(options={})
             {
                 'timeframe' => @timeframe,
-                'invoiceCount' => @invoice_count,
                 'dailySalesOutstanding' => @daily_sales_outstanding,
             }
         end

data/lib/lockstep_sdk/models/dpo_summary_group_total_model.rb

@@ -0,0 +1,71 @@
+#
+# Lockstep Platform SDK for Ruby
+#
+# (c) 2021-2022 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Lockstep Network <support@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # Represents the group totals for the values found in the daily payable outstanding summary
+    class DpoSummaryGroupTotalModel
+
+        ##
+        # Initialize the DpoSummaryGroupTotalModel using the provided prototype
+        def initialize(params = {})
+            @group_key = params.dig(:group_key)
+            @vendors = params.dig(:vendors)
+            @bills = params.dig(:bills)
+            @amount_outstanding = params.dig(:amount_outstanding)
+            @dpo = params.dig(:dpo)
+        end
+
+        ##
+        # @return [Uuid] The GroupKey uniquely identifies a single Lockstep Platform account. All records for this account will share the same GroupKey value. GroupKey values cannot be changed once created. For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
+        attr_accessor :group_key
+
+        ##
+        # @return [Int32] The total number of vendors with outstanding bills
+        attr_accessor :vendors
+
+        ##
+        # @return [Int32] The total number of bills outstanding
+        attr_accessor :bills
+
+        ##
+        # @return [Double] The total amount outstanding
+        attr_accessor :amount_outstanding
+
+        ##
+        # @return [Double] The total dpo for the group key
+        attr_accessor :dpo
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'groupKey' => @group_key,
+                'vendors' => @vendors,
+                'bills' => @bills,
+                'amountOutstanding' => @amount_outstanding,
+                'dpo' => @dpo,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end

data/lib/lockstep_sdk/models/dpo_summary_model.rb

@@ -0,0 +1,83 @@
+#
+# Lockstep Platform SDK for Ruby
+#
+# (c) 2021-2022 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Lockstep Network <support@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # Represents a summary of outstanding amounts for bills to vendors and their associated daily payable outstanding value.
+    class DpoSummaryModel
+
+        ##
+        # Initialize the DpoSummaryModel using the provided prototype
+        def initialize(params = {})
+            @group_key = params.dig(:group_key)
+            @vendor_id = params.dig(:vendor_id)
+            @vendor_name = params.dig(:vendor_name)
+            @primary_contact = params.dig(:primary_contact)
+            @bills = params.dig(:bills)
+            @amount_outstanding = params.dig(:amount_outstanding)
+            @dpo = params.dig(:dpo)
+        end
+
+        ##
+        # @return [Uuid] The GroupKey uniquely identifies a single Lockstep Platform account. All records for this account will share the same GroupKey value. GroupKey values cannot be changed once created. For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
+        attr_accessor :group_key
+
+        ##
+        # @return [Uuid] The unique ID of the vendor.
+        attr_accessor :vendor_id
+
+        ##
+        # @return [String] The name of the vendor.
+        attr_accessor :vendor_name
+
+        ##
+        # @return [String] The name of the primary contact.
+        attr_accessor :primary_contact
+
+        ##
+        # @return [Int32] The total number of outstanding bills.
+        attr_accessor :bills
+
+        ##
+        # @return [Double] The total amount outstanding.
+        attr_accessor :amount_outstanding
+
+        ##
+        # @return [Double] The days payable outstanding value.
+        attr_accessor :dpo
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'groupKey' => @group_key,
+                'vendorId' => @vendor_id,
+                'vendorName' => @vendor_name,
+                'primaryContact' => @primary_contact,
+                'bills' => @bills,
+                'amountOutstanding' => @amount_outstanding,
+                'dpo' => @dpo,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end

data/lib/lockstep_sdk/models/error_result.rb

@@ -0,0 +1,77 @@
+#
+# Lockstep Platform SDK for Ruby
+#
+# (c) 2021-2022 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Lockstep Network <support@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # Represents a failed API request.
+    class ErrorResult
+
+        ##
+        # Initialize the ErrorResult using the provided prototype
+        def initialize(params = {})
+            @type = params.dig(:type)
+            @title = params.dig(:title)
+            @status = params.dig(:status)
+            @detail = params.dig(:detail)
+            @instance = params.dig(:instance)
+            @content = params.dig(:content)
+        end
+
+        ##
+        # @return [String] A description of the type of error that occurred.
+        attr_accessor :type
+
+        ##
+        # @return [String] A short title describing the error.
+        attr_accessor :title
+
+        ##
+        # @return [Int32] If an error code is applicable, this contains an error number.
+        attr_accessor :status
+
+        ##
+        # @return [String] If detailed information about this error is available, this value contains more information.
+        attr_accessor :detail
+
+        ##
+        # @return [String] If this error corresponds to a specific instance or object, this field indicates which one.
+        attr_accessor :instance
+
+        ##
+        # @return [String] The full content of the HTTP response.
+        attr_accessor :content
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'type' => @type,
+                'title' => @title,
+                'status' => @status,
+                'detail' => @detail,
+                'instance' => @instance,
+                'content' => @content,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end

data/lib/lockstep_sdk/models/group_account_model.rb

@@ -0,0 +1,101 @@
+#
+# Lockstep Platform SDK for Ruby
+#
+# (c) 2021-2022 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Lockstep Network <support@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # Represents an account for an entire group
+    class GroupAccountModel
+
+        ##
+        # Initialize the GroupAccountModel using the provided prototype
+        def initialize(params = {})
+            @group_key = params.dig(:group_key)
+            @group_name = params.dig(:group_name)
+            @primary_user_id = params.dig(:primary_user_id)
+            @group_company_id = params.dig(:group_company_id)
+            @is_active = params.dig(:is_active)
+            @onboarding_scheduled = params.dig(:onboarding_scheduled)
+            @created = params.dig(:created)
+            @created_user_id = params.dig(:created_user_id)
+            @modified = params.dig(:modified)
+            @modified_user_id = params.dig(:modified_user_id)
+        end
+
+        ##
+        # @return [Uuid] The GroupKey uniquely identifies a single Lockstep Platform account. All records for this account will share the same GroupKey value. GroupKey values cannot be changed once created. For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
+        attr_accessor :group_key
+
+        ##
+        # @return [String] The name of the group
+        attr_accessor :group_name
+
+        ##
+        # @return [Uuid] The primary user for the group
+        attr_accessor :primary_user_id
+
+        ##
+        # @return [Uuid] The CompanyId of the Company the group is associated with
+        attr_accessor :group_company_id
+
+        ##
+        # @return [Boolean] The active status of the group
+        attr_accessor :is_active
+
+        ##
+        # @return [Boolean] The onboarding session status of the group
+        attr_accessor :onboarding_scheduled
+
+        ##
+        # @return [Date-time] The date this group account was created
+        attr_accessor :created
+
+        ##
+        # @return [Uuid] The ID of the user who created this group account
+        attr_accessor :created_user_id
+
+        ##
+        # @return [Date-time] The date this group account was last modified
+        attr_accessor :modified
+
+        ##
+        # @return [Uuid] The ID of the user who last modified this group account
+        attr_accessor :modified_user_id
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'groupKey' => @group_key,
+                'groupName' => @group_name,
+                'primaryUserId' => @primary_user_id,
+                'groupCompanyId' => @group_company_id,
+                'isActive' => @is_active,
+                'onboardingScheduled' => @onboarding_scheduled,
+                'created' => @created,
+                'createdUserId' => @created_user_id,
+                'modified' => @modified,
+                'modifiedUserId' => @modified_user_id,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end

data/lib/lockstep_sdk/models/invoice_line_sync_model.rb

@@ -152,7 +152,7 @@ module LockstepSdk
         attr_accessor :origin_address_postal_code
 
         ##
-        # @return [String] Origination address for this invoice line, if this line item was originated from a different address This will be validated by the /api/v1/definitions/countries data set
+        # @return [String] Origination address for this invoice line, if this line item was originated from a different address
         attr_accessor :origin_address_country
 
         ##
@@ -188,7 +188,7 @@ module LockstepSdk
         attr_accessor :bill_to_address_postal_code
 
         ##
-        # @return [String] Billing address for this invoice line, if this line item is to be billed to a different address This will be validated by the /api/v1/definitions/countries data set
+        # @return [String] Billing address for this invoice line, if this line item is to be billed to a different address
         attr_accessor :bill_to_address_country
 
         ##
@@ -224,7 +224,7 @@ module LockstepSdk
         attr_accessor :ship_to_address_postal_code
 
         ##
-        # @return [String] Shipping address for this invoice line, if this line item is to be shipped to a different address This will be validated by the /api/v1/definitions/countries data set
+        # @return [String] Shipping address for this invoice line, if this line item is to be shipped to a different address
         attr_accessor :ship_to_address_country
 
         ##

data/lib/lockstep_sdk/models/invoice_model.rb

@@ -63,6 +63,7 @@ module LockstepSdk
             @is_voided = params.dig(:is_voided)
             @in_dispute = params.dig(:in_dispute)
             @exclude_from_aging = params.dig(:exclude_from_aging)
+            @preferred_delivery_method = params.dig(:preferred_delivery_method)
             @addresses = params.dig(:addresses)
             @lines = params.dig(:lines)
             @payments = params.dig(:payments)
@@ -113,7 +114,7 @@ module LockstepSdk
         attr_accessor :salesperson_name
 
         ##
-        # @return [String] A code identifying the type of this invoice. Recognized Invoice types are: * `Invoice` - Represents an invoice sent by Company to the Customer * `AP Invoice` - Represents an invoice sent by Customer to the Company * `Credit Memo` - Represents a credit memo generated by Customer given to Company
+        # @return [String] A code identifying the type of this invoice. Recognized Invoice types are: * `AR Invoice` - Represents an invoice sent by Company to the Customer * `AP Invoice` - Represents an invoice sent by Vendor to the Company * `AR Credit Memo` - Represents a credit memo generated by Company given to Customer * `AP Credit Memo` - Represents a credit memo generated by Vendor given to Company
         attr_accessor :invoice_type_code
 
         ##
@@ -216,6 +217,10 @@ module LockstepSdk
         # @return [Boolean] Should the invoice be excluded from aging calculations?
         attr_accessor :exclude_from_aging
 
+        ##
+        # @return [String] Indicates the preferred delivery method for this invoice. Examples include Print, Email, Fax
+        attr_accessor :preferred_delivery_method
+
         ##
         # @return [InvoiceAddressModel] All addresses connected to this invoice. To retrieve this collection, specify `Addresses` in the "Include" parameter for your query.
         attr_accessor :addresses
@@ -299,6 +304,7 @@ module LockstepSdk
                 'isVoided' => @is_voided,
                 'inDispute' => @in_dispute,
                 'excludeFromAging' => @exclude_from_aging,
+                'preferredDeliveryMethod' => @preferred_delivery_method,
                 'addresses' => @addresses,
                 'lines' => @lines,
                 'payments' => @payments,

data/lib/lockstep_sdk/models/invoice_summary_model.rb

@@ -28,6 +28,7 @@ module LockstepSdk
             @invoice_id = params.dig(:invoice_id)
             @invoice_number = params.dig(:invoice_number)
             @invoice_date = params.dig(:invoice_date)
+            @invoice_closed_date = params.dig(:invoice_closed_date)
             @customer_name = params.dig(:customer_name)
             @status = params.dig(:status)
             @payment_due_date = params.dig(:payment_due_date)
@@ -60,6 +61,10 @@ module LockstepSdk
         # @return [Date] The reporting date for this invoice.
         attr_accessor :invoice_date
 
+        ##
+        # @return [Date] The date when the invoice was closed and finalized after completion of all payments and delivery of all products and services.
+        attr_accessor :invoice_closed_date
+
         ##
         # @return [String] The name of the counterparty for the invoice, for example, a customer or vendor.
         attr_accessor :customer_name
@@ -109,6 +114,7 @@ module LockstepSdk
                 'invoiceId' => @invoice_id,
                 'invoiceNumber' => @invoice_number,
                 'invoiceDate' => @invoice_date,
+                'invoiceClosedDate' => @invoice_closed_date,
                 'customerName' => @customer_name,
                 'status' => @status,
                 'paymentDueDate' => @payment_due_date,

data/lib/lockstep_sdk/models/invoice_sync_model.rb

@@ -84,6 +84,7 @@ module LockstepSdk
             @modified = params.dig(:modified)
             @is_voided = params.dig(:is_voided)
             @in_dispute = params.dig(:in_dispute)
+            @preferred_delivery_method = params.dig(:preferred_delivery_method)
         end
 
         ##
@@ -115,7 +116,7 @@ module LockstepSdk
         attr_accessor :salesperson_code
 
         ##
-        # @return [String] A code identifying the type of this invoice. Recognized Invoice types are: * `Invoice` - Represents an invoice sent by Company to the Customer * `AP Invoice` - Represents an invoice sent by Vendor to the Company * `Credit Memo` - Represents a credit memo generated by Company given to Customer * `AP Credit Memo` - Represents a credit memo generated by Vendor given to Company
+        # @return [String] A code identifying the type of this invoice. Recognized Invoice types are: * `AR Invoice` - Represents an invoice sent by Company to the Customer * `AP Invoice` - Represents an invoice sent by Vendor to the Company * `AR Credit Memo` - Represents a credit memo generated by Company given to Customer * `AP Credit Memo` - Represents a credit memo generated by Vendor given to Company
         attr_accessor :invoice_type_code
 
         ##
@@ -199,7 +200,7 @@ module LockstepSdk
         attr_accessor :origin_address_postal_code
 
         ##
-        # @return [String] The origination address for this invoice This will be validated by the /api/v1/definitions/countries data set
+        # @return [String] The origination address for this invoice
         attr_accessor :origin_address_country
 
         ##
@@ -235,7 +236,7 @@ module LockstepSdk
         attr_accessor :bill_to_address_postal_code
 
         ##
-        # @return [String] The billing address for this invoice This will be validated by the /api/v1/definitions/countries data set
+        # @return [String] The billing address for this invoice
         attr_accessor :bill_to_address_country
 
         ##
@@ -271,7 +272,7 @@ module LockstepSdk
         attr_accessor :ship_to_address_postal_code
 
         ##
-        # @return [String] The shipping address for this invoice This will be validated by the /api/v1/definitions/countries data set
+        # @return [String] The shipping address for this invoice
         attr_accessor :ship_to_address_country
 
         ##
@@ -298,6 +299,10 @@ module LockstepSdk
         # @return [Boolean] Is the invoice in dispute? If not specified, we assume the invoice is not in dispute.
         attr_accessor :in_dispute
 
+        ##
+        # @return [String] Indicates the preferred delivery method for this invoice. Examples include Print, Email, Fax
+        attr_accessor :preferred_delivery_method
+
         ##
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
@@ -355,6 +360,7 @@ module LockstepSdk
                 'modified' => @modified,
                 'isVoided' => @is_voided,
                 'inDispute' => @in_dispute,
+                'preferredDeliveryMethod' => @preferred_delivery_method,
             }
         end