lockstep_sdk 2022.6.49.0 → 2022.9.6.0

data/lib/lockstep_sdk/models/custom_field_value_model.rb

@@ -40,6 +40,7 @@ module LockstepSdk
             @modified = params.dig(:modified)
             @modified_user_id = params.dig(:modified_user_id)
             @app_enrollment_id = params.dig(:app_enrollment_id)
+            @value = params.dig(:value)
             @custom_field_definition = params.dig(:custom_field_definition)
         end
 
@@ -80,9 +81,13 @@ module LockstepSdk
         attr_accessor :modified_user_id
 
         ##
-        # @return [Uuid] AppEnrollmentId for this record; used for mapping purposes.
+        # @return [Uuid] The AppEnrollmentId of the application that imported this attachment record. For accounts with more than one financial system connected, this field identifies the originating financial system that produced this record. This value is null if this record was not loaded from an external ERP or financial system.
         attr_accessor :app_enrollment_id
 
+        ##
+        # @return [String] The value of this custom field.
+        attr_accessor :value
+
         ##
         # @return [CustomFieldDefinitionModel] Definition of the value
         attr_accessor :custom_field_definition
@@ -101,6 +106,7 @@ module LockstepSdk
                 'modified' => @modified,
                 'modifiedUserId' => @modified_user_id,
                 'appEnrollmentId' => @app_enrollment_id,
+                'value' => @value,
                 'customFieldDefinition' => @custom_field_definition,
             }
         end

data/lib/lockstep_sdk/models/email_model.rb

@@ -144,7 +144,7 @@ module LockstepSdk
         attr_accessor :view_count
 
         ##
-        # @return [Uuid] AppEnrollmentId for this record; used for mapping purposes.
+        # @return [Uuid] The AppEnrollmentId of the application that imported this record. For accounts with more than one financial system connected, this field identifies the originating financial system that produced this record. This value is null if this record was not loaded from an external ERP or financial system.
         attr_accessor :app_enrollment_id
 
         ##
@@ -180,19 +180,19 @@ module LockstepSdk
         attr_accessor :response_origin
 
         ##
-        # @return [NoteModel] All notes attached to this email. To retrieve this collection, specify `Notes` in the "Include" parameter for your query.
+        # @return [NoteModel] A collection of notes linked to this record. To retrieve this collection, specify `Notes` in the `include` parameter when retrieving data. To create a note, use the [Create Note](https://developer.lockstep.io/reference/post_api-v1-notes) endpoint with the `TableKey` to `Email` and the `ObjectKey` set to the `EmailId` for this record. For more information on extensibility, see [linking extensible metadata to objects](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
         attr_accessor :notes
 
         ##
-        # @return [AttachmentModel] All attachments attached to this email. To retrieve this collection, specify `Attachments` in the "Include" parameter for your query.
+        # @return [AttachmentModel] A collection of attachments linked to this record. To retrieve this collection, specify `Attachments` in the `include` parameter when retrieving data. To create an attachment, use the [Upload Attachment](https://developer.lockstep.io/reference/post_api-v1-attachments) endpoint with the `TableKey` to `Email` and the `ObjectKey` set to the `EmailId` for this record. For more information on extensibility, see [linking extensible metadata to objects](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
         attr_accessor :attachments
 
         ##
-        # @return [CustomFieldDefinitionModel] All definitions attached to this email. To retrieve this collection, specify `CustomFieldValues` in the "Include" parameter for your query.
+        # @return [CustomFieldDefinitionModel] A collection of custom fields linked to this record. To retrieve this collection, specify `CustomFieldDefinitions` in the `include` parameter when retrieving data. To create a custom field, use the [Create Custom Field](https://developer.lockstep.io/reference/post_api-v1-customfieldvalues) endpoint with the `TableKey` to `Email` and the `ObjectKey` set to the `EmailId` for this record. For more information on extensibility, see [linking extensible metadata to objects](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
         attr_accessor :custom_field_definitions
 
         ##
-        # @return [CustomFieldValueModel] All values attached to this email. To retrieve this collection, specify `Attachments` in the "Include" parameter for your query.
+        # @return [CustomFieldValueModel] A collection of custom fields linked to this record. To retrieve this collection, specify `CustomFieldValues` in the `include` parameter when retrieving data. To create a custom field, use the [Create Custom Field](https://developer.lockstep.io/reference/post_api-v1-customfieldvalues) endpoint with the `TableKey` to `Email` and the `ObjectKey` set to the `EmailId` for this record. For more information on extensibility, see [linking extensible metadata to objects](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
         attr_accessor :custom_field_values
 
         ##

data/lib/lockstep_sdk/models/financial_account_balance_history_model.rb

@@ -0,0 +1,127 @@
+#
+# Lockstep Software Development Kit 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     Ted Spence <tspence@lockstep.io>
+# @author     Manish Narayan B S <manish.n@lockstep.io>
+# @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # Represents a balance for a financial account for a given period of time.
+    class FinancialAccountBalanceHistoryModel
+
+        ##
+        # Initialize the FinancialAccountBalanceHistoryModel using the provided prototype
+        def initialize(params = {})
+            @financial_account_balance_history_id = params.dig(:financial_account_balance_history_id)
+            @group_key = params.dig(:group_key)
+            @financial_account_id = params.dig(:financial_account_id)
+            @app_enrollment_id = params.dig(:app_enrollment_id)
+            @financial_year = params.dig(:financial_year)
+            @period_number = params.dig(:period_number)
+            @period_start_date = params.dig(:period_start_date)
+            @period_end_date = params.dig(:period_end_date)
+            @status = params.dig(:status)
+            @balance = params.dig(:balance)
+            @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 unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.
+        attr_accessor :financial_account_balance_history_id
+
+        ##
+        # @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 id of the Financial Account that this balance history is for.
+        attr_accessor :financial_account_id
+
+        ##
+        # @return [Uuid] The AppEnrollmentId of the application that imported this record. For accounts with more than one financial system connected, this field identifies the originating financial system that produced this record. This value is null if this record was not loaded from an external ERP or financial system.
+        attr_accessor :app_enrollment_id
+
+        ##
+        # @return [Int32] The financial year that this period falls under
+        attr_accessor :financial_year
+
+        ##
+        # @return [Int32] The period number (1-12 or 1-13) that this balance history is for
+        attr_accessor :period_number
+
+        ##
+        # @return [Date-time] The start date of this period.
+        attr_accessor :period_start_date
+
+        ##
+        # @return [Date-time] The end date of this period.
+        attr_accessor :period_end_date
+
+        ##
+        # @return [String] The status of this period. The status should be Closed if the books for this period have been closed, if not the status should be Open. The status can also be Deleted if there was a recalculation that needed to occur, for example due to a change in financial year settings.
+        attr_accessor :status
+
+        ##
+        # @return [Double] The current or end balance of this period.
+        attr_accessor :balance
+
+        ##
+        # @return [Date-time] The date on which this financial account balance history record was created.
+        attr_accessor :created
+
+        ##
+        # @return [Uuid] The ID number of the user who created this financial account balance history.
+        attr_accessor :created_user_id
+
+        ##
+        # @return [Date-time] The date on which this financial account balance history record was modified.
+        attr_accessor :modified
+
+        ##
+        # @return [Uuid] The ID number of the user who most recently modified this financial account balance history.
+        attr_accessor :modified_user_id
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'financialAccountBalanceHistoryId' => @financial_account_balance_history_id,
+                'groupKey' => @group_key,
+                'financialAccountId' => @financial_account_id,
+                'appEnrollmentId' => @app_enrollment_id,
+                'financialYear' => @financial_year,
+                'periodNumber' => @period_number,
+                'periodStartDate' => @period_start_date,
+                'periodEndDate' => @period_end_date,
+                'status' => @status,
+                'balance' => @balance,
+                '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/financial_account_model.rb

@@ -0,0 +1,139 @@
+#
+# Lockstep Software Development Kit 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     Ted Spence <tspence@lockstep.io>
+# @author     Manish Narayan B S <manish.n@lockstep.io>
+# @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # An Financial account refers to records of assets, liabilities, income, expenses, and equity.
+    class FinancialAccountModel
+
+        ##
+        # Initialize the FinancialAccountModel using the provided prototype
+        def initialize(params = {})
+            @financial_account_id = params.dig(:financial_account_id)
+            @group_key = params.dig(:group_key)
+            @code = params.dig(:code)
+            @erp_key = params.dig(:erp_key)
+            @app_enrollment_id = params.dig(:app_enrollment_id)
+            @name = params.dig(:name)
+            @status = params.dig(:status)
+            @cashflow_type = params.dig(:cashflow_type)
+            @description = params.dig(:description)
+            @classification = params.dig(:classification)
+            @category = params.dig(:category)
+            @subcategory = params.dig(:subcategory)
+            @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 unique identifier for the Financial Account.
+        attr_accessor :financial_account_id
+
+        ##
+        # @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 code for the Financial Account. Can either be a general ledger or an account code.
+        attr_accessor :code
+
+        ##
+        # @return [String] The External Id for the Financial Account.
+        attr_accessor :erp_key
+
+        ##
+        # @return [Uuid] The App Enrollment Id for the Financial Account.
+        attr_accessor :app_enrollment_id
+
+        ##
+        # @return [String] The name of the Financial Account.
+        attr_accessor :name
+
+        ##
+        # @return [String] The status of the Financial Account. Possible values are active, inactive, deleted or archived.
+        attr_accessor :status
+
+        ##
+        # @return [String] The cashflow type for the Financial Account. Examples include cash, financing, investment or operation.
+        attr_accessor :cashflow_type
+
+        ##
+        # @return [String] The description for the Financial Account.
+        attr_accessor :description
+
+        ##
+        # @return [String] The classification for the Financial Account. Possible values are Asset, Equity, Expense, Liability or Revenue.
+        attr_accessor :classification
+
+        ##
+        # @return [String] The category for the Financial Account. Examples include Current Asset, Current Liability, Common Stock
+        attr_accessor :category
+
+        ##
+        # @return [String] The subcategory for the Financial Account. Examples include Cash, Property, Bank Loan, etc.
+        attr_accessor :subcategory
+
+        ##
+        # @return [Date-time] The date the FinancialAccount was created.
+        attr_accessor :created
+
+        ##
+        # @return [Uuid] The user that has created the Financial Account.
+        attr_accessor :created_user_id
+
+        ##
+        # @return [Date-time] The date the Financial Account was modified.
+        attr_accessor :modified
+
+        ##
+        # @return [Uuid] The user that has modified the Financial Account.
+        attr_accessor :modified_user_id
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'financialAccountId' => @financial_account_id,
+                'groupKey' => @group_key,
+                'code' => @code,
+                'erpKey' => @erp_key,
+                'appEnrollmentId' => @app_enrollment_id,
+                'name' => @name,
+                'status' => @status,
+                'cashflowType' => @cashflow_type,
+                'description' => @description,
+                'classification' => @classification,
+                'category' => @category,
+                'subcategory' => @subcategory,
+                '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/financial_year_setting_model.rb

@@ -0,0 +1,111 @@
+#
+# Lockstep Software Development Kit 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     Ted Spence <tspence@lockstep.io>
+# @author     Manish Narayan B S <manish.n@lockstep.io>
+# @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # A Financial Year Setting is used to to set the type, beginning, end, and number of periods of a year used to
+    # calculate accounting reports. The financial setting can either be for a specific app enrollment id via a sync
+    # or, when the financial year setting is manually created, will cover all account data without an app enrollment id.
+    class FinancialYearSettingModel
+
+        ##
+        # Initialize the FinancialYearSettingModel using the provided prototype
+        def initialize(params = {})
+            @financial_year_setting_id = params.dig(:financial_year_setting_id)
+            @group_key = params.dig(:group_key)
+            @app_enrollment_id = params.dig(:app_enrollment_id)
+            @year_type = params.dig(:year_type)
+            @total_periods = params.dig(:total_periods)
+            @start_date = params.dig(:start_date)
+            @end_date = params.dig(:end_date)
+            @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 unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.
+        attr_accessor :financial_year_setting_id
+
+        ##
+        # @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 AppEnrollmentId of the application that imported this record. For accounts with more than one financial system connected, this field identifies the originating financial system that produced this record. This value is null if this record was not loaded from an external ERP or financial system.
+        attr_accessor :app_enrollment_id
+
+        ##
+        # @return [String] The type of financial year, either Calendar or Fiscal.
+        attr_accessor :year_type
+
+        ##
+        # @return [Int32] Total number of periods in the year. For Calendar year types this should always be 12. For Fiscal year types this can either be 12 or 13 for a 4 week 13 period year.
+        attr_accessor :total_periods
+
+        ##
+        # @return [Date] The start date of the financial year. Should be entered in MM-DD format.
+        attr_accessor :start_date
+
+        ##
+        # @return [Date] The end date of the financial year. Should be entered in MM-DD format.
+        attr_accessor :end_date
+
+        ##
+        # @return [Date-time] The date on which this financial year setting record was created.
+        attr_accessor :created
+
+        ##
+        # @return [Uuid] The ID number of the user who created this financial year setting.
+        attr_accessor :created_user_id
+
+        ##
+        # @return [Date-time] The date on which this financial year setting record was last modified.
+        attr_accessor :modified
+
+        ##
+        # @return [Uuid] The ID number of the user who most recently modified this financial year setting.
+        attr_accessor :modified_user_id
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'financialYearSettingId' => @financial_year_setting_id,
+                'groupKey' => @group_key,
+                'appEnrollmentId' => @app_enrollment_id,
+                'yearType' => @year_type,
+                'totalPeriods' => @total_periods,
+                'startDate' => @start_date,
+                'endDate' => @end_date,
+                '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_address_model.rb

@@ -41,6 +41,7 @@ module LockstepSdk
             @created_user_id = params.dig(:created_user_id)
             @modified = params.dig(:modified)
             @modified_user_id = params.dig(:modified_user_id)
+            @app_enrollment_id = params.dig(:app_enrollment_id)
         end
 
         ##
@@ -107,6 +108,10 @@ module LockstepSdk
         # @return [Uuid] The ID number of the user who most recently modified this address.
         attr_accessor :modified_user_id
 
+        ##
+        # @return [Uuid] The AppEnrollmentId of the application that imported this record. For accounts with more than one financial system connected, this field identifies the originating financial system that produced this record. This value is null if this record was not loaded from an external ERP or financial system.
+        attr_accessor :app_enrollment_id
+
         ##
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
@@ -127,6 +132,7 @@ module LockstepSdk
                 'createdUserId' => @created_user_id,
                 'modified' => @modified,
                 'modifiedUserId' => @modified_user_id,
+                'appEnrollmentId' => @app_enrollment_id,
             }
         end
 

data/lib/lockstep_sdk/models/invoice_history_model.rb

@@ -59,6 +59,7 @@ module LockstepSdk
             @created_user_id = params.dig(:created_user_id)
             @modified = params.dig(:modified)
             @modified_user_id = params.dig(:modified_user_id)
+            @app_enrollment_id = params.dig(:app_enrollment_id)
         end
 
         ##
@@ -189,6 +190,10 @@ module LockstepSdk
         # @return [Uuid] The ID number of the user who most recently modified this invoice.
         attr_accessor :modified_user_id
 
+        ##
+        # @return [Uuid] The AppEnrollmentId of the application that imported this record. For accounts with more than one financial system connected, this field identifies the originating financial system that produced this record. This value is null if this record was not loaded from an external ERP or financial system.
+        attr_accessor :app_enrollment_id
+
         ##
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
@@ -225,6 +230,7 @@ module LockstepSdk
                 'createdUserId' => @created_user_id,
                 'modified' => @modified,
                 'modifiedUserId' => @modified_user_id,
+                'appEnrollmentId' => @app_enrollment_id,
             }
         end
 

data/lib/lockstep_sdk/models/invoice_line_model.rb

@@ -141,15 +141,15 @@ module LockstepSdk
         attr_accessor :modified_user_id
 
         ##
-        # @return [Uuid] AppEnrollmentId for this record; used for mapping purposes.
+        # @return [Uuid] The AppEnrollmentId of the application that imported this record. For accounts with more than one financial system connected, this field identifies the originating financial system that produced this record. This value is null if this record was not loaded from an external ERP or financial system.
         attr_accessor :app_enrollment_id
 
         ##
-        # @return [NoteModel] All notes attached to this company. To retrieve this collection, specify `Notes` in the "Include" parameter for your query.
+        # @return [NoteModel] A collection of notes linked to this record. To retrieve this collection, specify `Notes` in the `include` parameter when retrieving data. To create a note, use the [Create Note](https://developer.lockstep.io/reference/post_api-v1-notes) endpoint with the `TableKey` to `InvoiceLine` and the `ObjectKey` set to the `InvoiceLineId` for this record. For more information on extensibility, see [linking extensible metadata to objects](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
         attr_accessor :notes
 
         ##
-        # @return [AttachmentModel] All attachments attached to this company. To retrieve this collection, specify `Attachments` in the "Include" parameter for your query.
+        # @return [AttachmentModel] A collection of attachments linked to this record. To retrieve this collection, specify `Attachments` in the `include` parameter when retrieving data. To create an attachment, use the [Upload Attachment](https://developer.lockstep.io/reference/post_api-v1-attachments) endpoint with the `TableKey` to `InvoiceLine` and the `ObjectKey` set to the `InvoiceLineId` for this record. For more information on extensibility, see [linking extensible metadata to objects](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
         attr_accessor :attachments
 
         ##

data/lib/lockstep_sdk/models/invoice_model.rb

@@ -187,23 +187,23 @@ module LockstepSdk
         attr_accessor :primary_ship_to_address_id
 
         ##
-        # @return [Date-time] The date on which this address record was created.
+        # @return [Date-time] The date on which this invoice record was created.
         attr_accessor :created
 
         ##
-        # @return [Uuid] The ID number of the user who created this address.
+        # @return [Uuid] The ID number of the user who created this invoice.
         attr_accessor :created_user_id
 
         ##
-        # @return [Date-time] The date on which this address record was last modified.
+        # @return [Date-time] The date on which this invoice record was last modified.
         attr_accessor :modified
 
         ##
-        # @return [Uuid] The ID number of the user who most recently modified this address.
+        # @return [Uuid] The ID number of the user who most recently modified this invoice.
         attr_accessor :modified_user_id
 
         ##
-        # @return [Uuid] AppEnrollmentId for this record; used for mapping purposes.
+        # @return [Uuid] The AppEnrollmentId of the application that imported this record. For accounts with more than one financial system connected, this field identifies the originating financial system that produced this record. This value is null if this record was not loaded from an external ERP or financial system.
         attr_accessor :app_enrollment_id
 
         ##
@@ -231,11 +231,11 @@ module LockstepSdk
         attr_accessor :payments
 
         ##
-        # @return [NoteModel] All notes attached to this invoice. To retrieve this collection, specify `Notes` in the "Include" parameter for your query.
+        # @return [NoteModel] A collection of notes linked to this record. To retrieve this collection, specify `Notes` in the `include` parameter when retrieving data. To create a note, use the [Create Note](https://developer.lockstep.io/reference/post_api-v1-notes) endpoint with the `TableKey` to `Invoice` and the `ObjectKey` set to the `InvoiceId` for this record. For more information on extensibility, see [linking extensible metadata to objects](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
         attr_accessor :notes
 
         ##
-        # @return [AttachmentModel] All attachments attached to this invoice. To retrieve this collection, specify `Attachments` in the "Include" parameter for your query.
+        # @return [AttachmentModel] A collection of attachments linked to this record. To retrieve this collection, specify `Attachments` in the `include` parameter when retrieving data. To create an attachment, use the [Upload Attachment](https://developer.lockstep.io/reference/post_api-v1-attachments) endpoint with the `TableKey` to `Invoice` and the `ObjectKey` set to the `InvoiceId` for this record. For more information on extensibility, see [linking extensible metadata to objects](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
         attr_accessor :attachments
 
         ##
@@ -255,11 +255,11 @@ module LockstepSdk
         attr_accessor :credit_memos
 
         ##
-        # @return [CustomFieldValueModel] All custom field values associated with this invoice To retrieve this item, specify `CustomFieldValues` in the "Include" parameter for your query.
+        # @return [CustomFieldValueModel] A collection of custom fields linked to this record. To retrieve this collection, specify `CustomFieldValues` in the `include` parameter when retrieving data. To create a custom field, use the [Create Custom Field](https://developer.lockstep.io/reference/post_api-v1-customfieldvalues) endpoint with the `TableKey` to `Invoice` and the `ObjectKey` set to the `InvoiceId` for this record. For more information on extensibility, see [linking extensible metadata to objects](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
         attr_accessor :custom_field_values
 
         ##
-        # @return [CustomFieldDefinitionModel] All custom field definitions
+        # @return [CustomFieldDefinitionModel] A collection of custom fields linked to this record. To retrieve this collection, specify `CustomFieldDefinitions` in the `include` parameter when retrieving data. To create a custom field, use the [Create Custom Field](https://developer.lockstep.io/reference/post_api-v1-customfieldvalues) endpoint with the `TableKey` to `Invoice` and the `ObjectKey` set to the `InvoiceId` for this record. For more information on extensibility, see [linking extensible metadata to objects](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
         attr_accessor :custom_field_definitions
 
         ##

data/lib/lockstep_sdk/models/invoice_sync_model.rb

@@ -293,11 +293,11 @@ module LockstepSdk
         attr_accessor :modified
 
         ##
-        # @return [Boolean] Is the invoice voided?
+        # @return [Boolean] Is the invoice voided? If not specified, we assume the invoice is not voided.
         attr_accessor :is_voided
 
         ##
-        # @return [Boolean] Is the invoice in dispute?
+        # @return [Boolean] Is the invoice in dispute? If not specified, we assume the invoice is not in dispute.
         attr_accessor :in_dispute
 
         ##

data/lib/lockstep_sdk/models/note_model.rb

@@ -85,7 +85,7 @@ module LockstepSdk
         attr_accessor :created_user_name
 
         ##
-        # @return [Uuid] AppEnrollmentId for this record; used for mapping purposes.
+        # @return [Uuid] The AppEnrollmentId of the application that imported this record. For accounts with more than one financial system connected, this field identifies the originating financial system that produced this record. This value is null if this record was not loaded from an external ERP or financial system.
         attr_accessor :app_enrollment_id
 
         ##

data/lib/lockstep_sdk/models/payment_applied_model.rb

@@ -93,7 +93,7 @@ module LockstepSdk
         attr_accessor :modified_user_id
 
         ##
-        # @return [Uuid] AppEnrollmentId for this record; used for mapping purposes.
+        # @return [Uuid] The AppEnrollmentId of the application that imported this record. For accounts with more than one financial system connected, this field identifies the originating financial system that produced this record. This value is null if this record was not loaded from an external ERP or financial system.
         attr_accessor :app_enrollment_id
 
         ##

data/lib/lockstep_sdk/models/payment_model.rb

@@ -132,7 +132,7 @@ module LockstepSdk
         attr_accessor :modified_user_id
 
         ##
-        # @return [Uuid] AppEnrollmentId for this record; used for mapping purposes.
+        # @return [Uuid] The AppEnrollmentId of the application that imported this record. For accounts with more than one financial system connected, this field identifies the originating financial system that produced this record. This value is null if this record was not loaded from an external ERP or financial system.
         attr_accessor :app_enrollment_id
 
         ##
@@ -148,19 +148,19 @@ module LockstepSdk
         attr_accessor :applications
 
         ##
-        # @return [NoteModel] All notes attached to this payment. To retrieve this collection, specify `Notes` in the "Include" parameter for your query.
+        # @return [NoteModel] A collection of notes linked to this record. To retrieve this collection, specify `Notes` in the `include` parameter when retrieving data. To create a note, use the [Create Note](https://developer.lockstep.io/reference/post_api-v1-notes) endpoint with the `TableKey` to `Payment` and the `ObjectKey` set to the `PaymentId` for this record. For more information on extensibility, see [linking extensible metadata to objects](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
         attr_accessor :notes
 
         ##
-        # @return [AttachmentModel] All attachments attached to this payment. To retrieve this collection, specify `Attachments` in the "Include" parameter for your query.
+        # @return [AttachmentModel] A collection of attachments linked to this record. To retrieve this collection, specify `Attachments` in the `include` parameter when retrieving data. To create an attachment, use the [Upload Attachment](https://developer.lockstep.io/reference/post_api-v1-attachments) endpoint with the `TableKey` to `Payment` and the `ObjectKey` set to the `PaymentId` for this record. For more information on extensibility, see [linking extensible metadata to objects](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
         attr_accessor :attachments
 
         ##
-        # @return [CustomFieldDefinitionModel] All definitions attached to this payment. To retrieve this collection, specify `CustomFieldValues` in the "Include" parameter for your query.
+        # @return [CustomFieldDefinitionModel] A collection of custom fields linked to this record. To retrieve this collection, specify `CustomFieldDefinitions` in the `include` parameter when retrieving data. To create a custom field, use the [Create Custom Field](https://developer.lockstep.io/reference/post_api-v1-customfieldvalues) endpoint with the `TableKey` to `Payment` and the `ObjectKey` set to the `PaymentId` for this record. For more information on extensibility, see [linking extensible metadata to objects](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
         attr_accessor :custom_field_definitions
 
         ##
-        # @return [CustomFieldValueModel] All values attached to this payment. To retrieve this collection, specify `CustomFieldValues` in the "Include" parameter for your query.
+        # @return [CustomFieldValueModel] A collection of custom fields linked to this record. To retrieve this collection, specify `CustomFieldValues` in the `include` parameter when retrieving data. To create a custom field, use the [Create Custom Field](https://developer.lockstep.io/reference/post_api-v1-customfieldvalues) endpoint with the `TableKey` to `Payment` and the `ObjectKey` set to the `PaymentId` for this record. For more information on extensibility, see [linking extensible metadata to objects](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
         attr_accessor :custom_field_values
 
         ##