lockstep_rails 0.3.65 → 0.3.67

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffc2c21371e280e4b0d300d21a889b1e9604ea20868527c470cdd21858fe8c05
-  data.tar.gz: 2d3f226fe569acb51bf9b9ceddd2eb22c7f7ebaa3ba7e5f8d15ef78043d6c28f
+  metadata.gz: b9caa7796257df2cf09f394b6ab631e4922b2a8f0c0419e5d5213b5ffc4ad878
+  data.tar.gz: cbb88f32896582f39526be39488360a836202ee7fce260a990a983a1d067c219
 SHA512:
-  metadata.gz: '018b416e5c30156f70cc03d864ff72d112439d4aa552e174e59f8e414b3fc36a6a0809c2ff4c447c2b7b382361d3d3bcb0cfc763c2080f3dec1e2ae28d5829ee'
-  data.tar.gz: 6b3cb5bf9430de1269912ebbac07387f25e46806b9cc62ab6a539783a305049f8dfd9ee2513dc0d71a4edf5d55a406fd4c811579c47173fb6d88eed65e3b3894
+  metadata.gz: 4ee749d754595dfaa1bea76fd3c1f477d572f13193596952a905c1fefb70d12f822f7d2f843678d4736125b2cf500339481865f6120ba3b85347ae36f91e038e
+  data.tar.gz: e5eae79797f82b4f0cee3878c2bff602456e5362ad023f1c6f08f68aefe3a62797f5d7acc3fbe0e3d5fee0dd2237f2154a276d7a9fb0e605fd6612971c30c1f4

data/app/models/lockstep/financial_institution_account.rb

@@ -0,0 +1,6 @@
+class Lockstep::FinancialInstitutionAccount < Lockstep::ApiRecord
+  self.model_name_uri = "v1/financial-institution-accounts"
+  self.id_ref = "financial_institution_account_id"
+  self.query_path = ""
+  load_schema(Schema::FinancialInstitutionAccount)
+end

data/app/platform_api/schema/financial_account_sync.rb

@@ -36,7 +36,7 @@ end
   field :description
 
   # The classification for the Financial Account. Possible values are Asset, Equity,
-  # Expense, Liability or Income.
+  # Expense, Liability, Income, CreditCard, Checking, or Savings.
   # @type: string
   field :classification
 

data/app/platform_api/schema/financial_institution_account.rb

@@ -0,0 +1,76 @@
+class Schema::FinancialInstitutionAccount < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The unique identifier for the Financial Institution Account.
+  # @type: string
+  # @format: uuid
+  field :financial_institution_account_id
+
+  # 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).
+  # @type: string
+  # @format: uuid
+  field :group_key
+
+  # An alternate account id for the Financial Institution Account.
+  # @type: string
+  field :bank_account_id
+
+  # The External Id for the Financial Institution Account.
+  # @type: string
+  field :erp_key
+
+  # The App Enrollment Id this Financial Institution is associated with.
+  # @type: string
+  # @format: uuid
+  field :app_enrollment_id
+
+  # The name of the Financial Institution Account.
+  # @type: string
+  field :name
+
+  # The status of the Financial Institution Account. Possible values are active,
+  # inactive, deleted or archived.
+  # @type: string
+  field :status
+
+  # The description for the Financial Institution Account.
+  # @type: string
+  field :description
+
+  # The classification for the Financial Institution Account. Possible values are Asset, Equity,
+  # Expense, Liability or Income.
+  # @type: string
+  field :account_type
+
+  # The date the Financial Institution Account was created.
+  # @type: string
+  # @format: date-time
+  field :created, Types::Params::DateTime
+
+  # The user that has created the Financial Institution Account.
+  # @type: string
+  # @format: uuid
+  field :created_user_id
+
+  # The date the Financial Institution Account was modified.
+  # @type: string
+  # @format: date-time
+  field :modified, Types::Params::DateTime
+
+  # The user that has modified the Financial Institution Account.
+  # @type: string
+  # @format: uuid
+  field :modified_user_id
+
+  belongs_to :created_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"created_user_id"}
+  belongs_to :modified_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"modified_user_id"}
+
+
+end

data/app/platform_api/schema/financial_institution_account_fetch_result.rb

@@ -0,0 +1,26 @@
+class Schema::FinancialInstitutionAccountFetchResult < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  
+  # @type: integer
+  # @format: int32
+  field :total_count
+
+  
+  # @type: integer
+  # @format: int32
+  field :page_size
+
+  
+  # @type: integer
+  # @format: int32
+  field :page_number
+
+
+  has_many :records, {:class_name=>"Schema::FinancialInstitutionAccount", :included=>true}
+
+end

data/app/platform_api/schema/insert_payment_applied_request.rb

@@ -0,0 +1,52 @@
+class Schema::InsertPaymentAppliedRequest < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The unique ID of this record, automatically assigned by Lockstep when this record is
+  # added to the Lockstep platform.
+  #             
+  # For the ID of this record in its originating financial system, see `ErpKey`.
+  # @type: string
+  # @format: uuid
+  field :payment_applied_id
+
+  # The Invoice this payment is applied to.
+  # @type: string
+  # @format: uuid
+  field :invoice_id
+
+  # The Payment this application applies from.
+  # @type: string
+  # @format: uuid
+  field :payment_id
+
+  # The unique ID of this record as it was known in its originating financial system.
+  #             
+  # If this company record was imported from a financial system, it will have the value `ErpKey`
+  # set to the original primary key number of the record as it was known in the originating financial
+  # system.  If this record was not imported, this value will be `null`.
+  #             
+  # For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
+  # @type: string
+  field :erp_key
+
+  # The ERP key of the Invoice this payment is applied to.
+  # @type: string
+  field :invoice_erp_key
+
+  # The date this payment was applied to this invoice.
+  # @type: string
+  # @format: date-time
+  field :apply_to_invoice_date, Types::Params::DateTime
+
+  # The total amount that was applied to this Invoice from the Payment.
+  # @type: number
+  # @format: double
+  field :payment_applied_amount
+
+
+
+end

data/app/platform_api/schema/insert_payment_request.rb

@@ -0,0 +1,134 @@
+class Schema::InsertPaymentRequest < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The AppEnrollmentId of the application to write this record to.
+  # @type: string
+  # @format: uuid
+  field :app_enrollment_id
+
+  # The unique ID of this record, automatically assigned by Lockstep when this record is
+  # added to the Lockstep platform.
+  #             
+  # For the ID of this record in its originating financial system, see `ErpKey`.
+  # @type: string
+  # @format: uuid
+  field :payment_id
+
+  # The ID of the company to which this payment belongs.
+  # @type: string
+  # @format: uuid
+  field :company_id
+
+  # The ERP key for the company to which this payment belongs.
+  # @type: string
+  field :company_erp_key
+
+  # A additional reference that may be used in the ERP
+  # @type: string
+  field :company_external_reference
+
+  # The unique ID of this record as it was known in its originating financial system.
+  #             
+  # If this company record was imported from a financial system, it will have the value `ErpKey`
+  # set to the original primary key number of the record as it was known in the originating financial
+  # system.  If this record was not imported, this value will be `null`.
+  #             
+  # For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
+  # @type: string
+  field :erp_key
+
+  # The type of payment, AR Payment or AP Payment.
+  #             
+  # Recognized PaymentType values are:
+  # * `AR Payment` - A payment made by a Customer to the Company
+  # * `AP Payment` - A payment made by the Company to a Vendor
+  # @type: string
+  field :payment_type
+
+  # Cash, check, credit card, wire transfer.
+  #             
+  # Recognized TenderType values are:
+  # * `Cash` - A cash payment or other direct transfer.
+  # * `Check` - A check payment.
+  # * `Credit Card` - A payment made via a credit card.
+  # * `Wire Transfer` - A payment made via wire transfer from another financial institution.
+  # * `Other` - A payment made via another method not listed above.
+  # @type: string
+  field :tender_type
+
+  # Memo or reference text (ex. memo field on a check).
+  # @type: string
+  field :memo_text
+
+  # The date when this payment was received.
+  # @type: string
+  # @format: date-time
+  field :payment_date, Types::Params::DateTime
+
+  # The date when a payment was posted to a ledger.
+  # @type: string
+  # @format: date-time
+  field :post_date, Types::Params::DateTime
+
+  # Total amount of this payment in it's received currency.
+  # @type: number
+  # @format: double
+  field :payment_amount
+
+  # Unapplied balance of this payment in it's received currency.  If this amount is nonzero, the field `IsOpen` will be true.
+  # @type: number
+  # @format: double
+  field :unapplied_amount
+
+  # The ISO 4217 currency code for this payment.
+  #             
+  # For a list of ISO 4217 currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies).
+  # @type: string
+  field :currency_code
+
+  # Reference code for the payment for the given Erp system.
+  # @type: string
+  field :reference_code
+
+  # Is the payment voided?
+  # @type: boolean
+  field :is_voided
+
+  # Is the payment in dispute?
+  # @type: boolean
+  field :in_dispute
+
+  # The Currency Rate used to get from the account's base currency to the payment amount.
+  # @type: number
+  # @format: double
+  field :currency_rate
+
+  # Total amount of this payment in the group's base currency.
+  # @type: number
+  # @format: double
+  field :base_currency_payment_amount
+
+  # Unapplied balance of this payment in the group's base currency.  If this amount is nonzero, the field `IsOpen` will be true.
+  # @type: number
+  # @format: double
+  field :base_currency_unapplied_amount
+
+  # The Bank account id for the company to which this payment belongs.
+  # @type: string
+  field :bank_account_id
+
+  # The GroupKey this request belongs to.
+  # @type: string
+  # @format: uuid
+  field :group_key
+
+  belongs_to :company, {:class_name=>"Lockstep::Account", :primary_key=>:company_id, :foreign_key=>"company_id"}
+  belongs_to :account, {:class_name=>"Lockstep::Account", :primary_key=>:company_id, :foreign_key=>"company_id"}
+
+  has_many :applications, {:class_name=>"Schema::InsertPaymentAppliedRequest", :included=>true}
+
+end

data/app/platform_api/schema/insert_payment_request_erp_write_sync_submit.rb

@@ -0,0 +1,16 @@
+class Schema::InsertPaymentRequestErpWriteSyncSubmit < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The connected App Enrollment id.
+  # @type: string
+  # @format: uuid
+  field :app_enrollment_id
+
+
+  has_many :requests, {:class_name=>"Schema::InsertPaymentRequest", :included=>true}
+
+end

data/app/platform_api/schema/payment_erp_write_result.rb

@@ -0,0 +1,37 @@
+class Schema::PaymentErpWriteResult < Lockstep::ApiRecord
+
+# ApiRecord will crash unless `id_ref` is defined
+def self.id_ref
+  nil
+end
+
+  # The id of the connected AppEnrollmentModel
+  # @type: string
+  # @format: uuid
+  field :app_enrollment_id
+
+  # The ErpKey for the object written to the Erp if created
+  # @type: string
+  field :erp_key
+
+  # 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).
+  # @type: string
+  # @format: uuid
+  field :group_key
+
+  # An optional message to return with the result
+  # @type: string
+  field :message
+
+  # The id of the SyncRequestModel the requests were added to
+  # @type: string
+  # @format: uuid
+  field :sync_request_id
+
+
+  has_many :results, {:class_name=>"Schema::Payment", :included=>true}
+
+end

data/app/platform_api/schema/user_account.rb

@@ -142,6 +142,10 @@ end
   # @type: string
   field :default_currency_code
 
+  # The IETF language tag for the user's preferred locale.
+  # @type: string
+  field :locale
+
   # Accounting role definition for this User.
   # To retrieve this collection, specify `AccountingRole` in the "Include" parameter for your query.
   field :accounting_role_code_definition

data/app/platform_api/swagger.json

@@ -7485,6 +7485,165 @@
         ]
       }
     },
+    "/api/v1/financial-institution-accounts/{id}": {
+      "get": {
+        "tags": [
+          "FinancialInstitutionAccounts"
+        ],
+        "summary": "Retrieve Financial Institution Accounts",
+        "description": "Retrieves the financial institution account specified by this unique identifier.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n* Member\n* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
+        "operationId": "v1_FinancialInstitutionAccounts_RetrieveInstitution",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "description": "The unique Lockstep Platform ID number of this institution account; NOT the customer's ERP key",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "format": "uuid"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/FinancialInstitutionAccountModel"
+                }
+              },
+              "text/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/FinancialInstitutionAccountModel"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Not Found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ProblemDetails"
+                }
+              },
+              "text/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ProblemDetails"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized"
+          },
+          "403": {
+            "description": "Forbidden"
+          }
+        },
+        "security": [
+          {
+            "oauth2": [ ]
+          },
+          {
+            "bearer_token": [ ]
+          },
+          {
+            "api_key": [ ]
+          }
+        ]
+      }
+    },
+    "/api/v1/financial-institution-accounts/query": {
+      "get": {
+        "tags": [
+          "FinancialInstitutionAccounts"
+        ],
+        "summary": "Query Financial Institution Accounts",
+        "description": "\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n* Member\n* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
+        "operationId": "v1_FinancialInstitutionAccounts_QueryInstitutions",
+        "parameters": [
+          {
+            "name": "filter",
+            "in": "query",
+            "description": "The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "include",
+            "in": "query",
+            "description": "To fetch additional data on this object, specify the list of elements to retrieve.\r\n            \r\nNo collections are currently available but may be offered in the future.",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "order",
+            "in": "query",
+            "description": "The sort order for this query.  See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "pageSize",
+            "in": "query",
+            "description": "The page size for results (default 250, maximum of 500).  See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)",
+            "schema": {
+              "type": "integer",
+              "format": "int32"
+            }
+          },
+          {
+            "name": "pageNumber",
+            "in": "query",
+            "description": "The page number for results (default 0).  See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)",
+            "schema": {
+              "type": "integer",
+              "format": "int32"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/FinancialInstitutionAccountModelFetchResult"
+                }
+              },
+              "text/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/FinancialInstitutionAccountModelFetchResult"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized"
+          },
+          "403": {
+            "description": "Forbidden"
+          }
+        },
+        "security": [
+          {
+            "oauth2": [ ]
+          },
+          {
+            "bearer_token": [ ]
+          },
+          {
+            "api_key": [ ]
+          }
+        ]
+      }
+    },
     "/api/v1/FinancialYearSettings/{id}": {
       "get": {
         "tags": [
@@ -9911,7 +10070,7 @@
           "MagicLinks"
         ],
         "summary": "Retrieve Magic Link",
-        "description": "Retrieves the Magic Link specified by this unique identifier, optionally including nested data sets.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n* Member\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
+        "description": "Retrieves the Magic Link specified by this unique identifier, optionally including nested data sets.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n* Member\n* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
         "operationId": "v1_MagicLinks_RetrieveMagicLink",
         "parameters": [
           {
@@ -10059,7 +10218,7 @@
           "MagicLinks"
         ],
         "summary": "Query Magic Links",
-        "description": "Queries Magic Links for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n* Member\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
+        "description": "Queries Magic Links for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n* Member\n* Read-Only\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
         "operationId": "v1_MagicLinks_QueryMagicLinks",
         "parameters": [
           {
@@ -11665,6 +11824,100 @@
         ]
       }
     },
+    "/api/v1/Payments/erp-write": {
+      "post": {
+        "tags": [
+          "Payments"
+        ],
+        "summary": "Write payments to connected ERP",
+        "description": "Schedule an ERP post request for payments.\r\n\r\nThe payments must be associated with an active app enrollment and have a valid `AppEnrollmentId`.\n\n### Roles\n\nTo call this endpoint, you must have one of these roles:\n\n* Group Owner\n* Group Admin\n\n\nYou can view your roles with the [Status](https://developer.lockstep.io/reference/get_api-v1-status) API.",
+        "operationId": "v1_Payments_ErpWritePayments",
+        "requestBody": {
+          "description": "The payments to submit to the connected ERP",
+          "content": {
+            "application/json": {
+              "schema": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/InsertPaymentRequestModelErpWriteSyncSubmitModel"
+                  }
+                ],
+                "description": "Lockstep.Shared.Models.Sync.ErpWriteSyncSubmitModel`1 represents a request to write back a collection\r\n            of requests to the connected AppEnrollment."
+              }
+            },
+            "text/json": {
+              "schema": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/InsertPaymentRequestModelErpWriteSyncSubmitModel"
+                  }
+                ],
+                "description": "Lockstep.Shared.Models.Sync.ErpWriteSyncSubmitModel`1 represents a request to write back a collection\r\n            of requests to the connected AppEnrollment."
+              }
+            },
+            "application/*+json": {
+              "schema": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/InsertPaymentRequestModelErpWriteSyncSubmitModel"
+                  }
+                ],
+                "description": "Lockstep.Shared.Models.Sync.ErpWriteSyncSubmitModel`1 represents a request to write back a collection\r\n            of requests to the connected AppEnrollment."
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PaymentModelErpWriteResult"
+                }
+              },
+              "text/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PaymentModelErpWriteResult"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad Request",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ProblemDetails"
+                }
+              },
+              "text/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ProblemDetails"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized"
+          },
+          "403": {
+            "description": "Forbidden"
+          }
+        },
+        "security": [
+          {
+            "oauth2": [ ]
+          },
+          {
+            "bearer_token": [ ]
+          },
+          {
+            "api_key": [ ]
+          }
+        ]
+      }
+    },
     "/api/v1/payments-acceptance/customers/{companyId}/{customerId}": {
       "get": {
         "tags": [
@@ -22527,6 +22780,13 @@
       "AttachmentLinkModelFetchResult": {
         "type": "object",
         "properties": {
+          "records": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/AttachmentLinkModel"
+            },
+            "nullable": true
+          },
           "totalCount": {
             "type": "integer",
             "format": "int32",
@@ -22541,13 +22801,6 @@
             "type": "integer",
             "format": "int32",
             "nullable": true
-          },
-          "records": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/AttachmentLinkModel"
-            },
-            "nullable": true
           }
         },
         "additionalProperties": false
@@ -23225,21 +23478,21 @@
             "nullable": true
           },
           "address1": {
-            "maxLength": 80,
+            "maxLength": 170,
             "minLength": 0,
             "type": "string",
             "description": "Address info",
             "nullable": true
           },
           "address2": {
-            "maxLength": 80,
+            "maxLength": 170,
             "minLength": 0,
             "type": "string",
             "description": "Address info",
             "nullable": true
           },
           "address3": {
-            "maxLength": 80,
+            "maxLength": 170,
             "minLength": 0,
             "type": "string",
             "description": "Address info",
@@ -24857,13 +25110,6 @@
       "CustomFieldDefinitionModelFetchResult": {
         "type": "object",
         "properties": {
-          "records": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/CustomFieldDefinitionModel"
-            },
-            "nullable": true
-          },
           "totalCount": {
             "type": "integer",
             "format": "int32",
@@ -24878,12 +25124,19 @@
             "type": "integer",
             "format": "int32",
             "nullable": true
-          }
-        },
-        "additionalProperties": false
-      },
-      "CustomFieldSyncModel": {
-        "required": [
+          },
+          "records": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/CustomFieldDefinitionModel"
+            },
+            "nullable": true
+          }
+        },
+        "additionalProperties": false
+      },
+      "CustomFieldSyncModel": {
+        "required": [
           "customFieldLabel",
           "erpKey",
           "tableKey"
@@ -25057,13 +25310,6 @@
       "CustomFieldValueModelFetchResult": {
         "type": "object",
         "properties": {
-          "records": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/CustomFieldValueModel"
-            },
-            "nullable": true
-          },
           "totalCount": {
             "type": "integer",
             "format": "int32",
@@ -25078,6 +25324,13 @@
             "type": "integer",
             "format": "int32",
             "nullable": true
+          },
+          "records": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/CustomFieldValueModel"
+            },
+            "nullable": true
           }
         },
         "additionalProperties": false
@@ -26068,7 +26321,7 @@
           },
           "classification": {
             "type": "string",
-            "description": "The classification for the Financial Account. Possible values are Asset, Equity,\r\nExpense, Liability or Income."
+            "description": "The classification for the Financial Account. Possible values are Asset, Equity,\r\nExpense, Liability, Income, CreditCard, Checking, or Savings."
           },
           "category": {
             "type": "string",
@@ -26084,6 +26337,126 @@
         "additionalProperties": false,
         "description": "The FinancialAccountSyncModel represents information coming into Lockstep from an external financial system or other\r\nenterprise resource planning system.  To import data from an external system, convert your original data into\r\nthe FinancialAccountSyncModel format and call the [Upload Sync File API](https://developer.lockstep.io/reference/post_api-v1-sync-zip).\r\nThis API retrieves all of the data you uploaded in a compressed ZIP file and imports it into the Lockstep\r\nplatform.\r\n            \r\nOnce imported, this record will be available in the Lockstep API as a [FinancialAccountModel](https://developer.lockstep.io/docs/financialaccountmodel).\r\n            \r\nFor more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data)."
       },
+      "FinancialInstitutionAccountModel": {
+        "type": "object",
+        "properties": {
+          "financialInstitutionAccountId": {
+            "type": "string",
+            "description": "The unique identifier for the Financial Institution Account.",
+            "format": "uuid",
+            "readOnly": true
+          },
+          "groupKey": {
+            "type": "string",
+            "description": "The GroupKey uniquely identifies a single Lockstep Platform account.  All records for this\r\naccount will share the same GroupKey value.  GroupKey values cannot be changed once created.\r\n            \r\nFor more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).",
+            "format": "uuid",
+            "readOnly": true
+          },
+          "bankAccountId": {
+            "maxLength": 255,
+            "minLength": 0,
+            "type": "string",
+            "description": "An alternate account id for the Financial Institution Account.",
+            "nullable": true
+          },
+          "erpKey": {
+            "maxLength": 255,
+            "minLength": 0,
+            "type": "string",
+            "description": "The External Id for the Financial Institution Account.",
+            "nullable": true
+          },
+          "appEnrollmentId": {
+            "type": "string",
+            "description": "The App Enrollment Id this Financial Institution is associated with.",
+            "format": "uuid",
+            "nullable": true,
+            "readOnly": true
+          },
+          "name": {
+            "maxLength": 100,
+            "minLength": 0,
+            "type": "string",
+            "description": "The name of the Financial Institution Account.",
+            "nullable": true
+          },
+          "status": {
+            "maxLength": 8,
+            "minLength": 0,
+            "type": "string",
+            "description": "The status of the Financial Institution Account. Possible values are active,\r\ninactive, deleted or archived.",
+            "nullable": true
+          },
+          "description": {
+            "maxLength": 500,
+            "minLength": 0,
+            "type": "string",
+            "description": "The description for the Financial Institution Account.",
+            "nullable": true
+          },
+          "accountType": {
+            "maxLength": 10,
+            "minLength": 0,
+            "type": "string",
+            "description": "The classification for the Financial Institution Account. Possible values are Asset, Equity,\r\nExpense, Liability or Income.",
+            "nullable": true
+          },
+          "created": {
+            "type": "string",
+            "description": "The date the Financial Institution Account was created.",
+            "format": "date-time",
+            "readOnly": true
+          },
+          "createdUserId": {
+            "type": "string",
+            "description": "The user that has created the Financial Institution Account.",
+            "format": "uuid",
+            "readOnly": true
+          },
+          "modified": {
+            "type": "string",
+            "description": "The date the Financial Institution Account was modified.",
+            "format": "date-time",
+            "readOnly": true
+          },
+          "modifiedUserId": {
+            "type": "string",
+            "description": "The user that has modified the Financial Institution Account.",
+            "format": "uuid",
+            "readOnly": true
+          }
+        },
+        "additionalProperties": false,
+        "description": "An Financial Institution Account represents an account used for monetary transactions. E.g. - checking, savings,  or credit card accounts."
+      },
+      "FinancialInstitutionAccountModelFetchResult": {
+        "type": "object",
+        "properties": {
+          "totalCount": {
+            "type": "integer",
+            "format": "int32",
+            "nullable": true
+          },
+          "pageSize": {
+            "type": "integer",
+            "format": "int32",
+            "nullable": true
+          },
+          "pageNumber": {
+            "type": "integer",
+            "format": "int32",
+            "nullable": true
+          },
+          "records": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/FinancialInstitutionAccountModel"
+            },
+            "nullable": true
+          }
+        },
+        "additionalProperties": false
+      },
       "FinancialReportCellModel": {
         "type": "object",
         "properties": {
@@ -26389,6 +26762,205 @@
         "additionalProperties": false,
         "description": "Represents an account for an entire group"
       },
+      "InsertPaymentAppliedRequestModel": {
+        "type": "object",
+        "properties": {
+          "paymentAppliedId": {
+            "type": "string",
+            "description": "The unique ID of this record, automatically assigned by Lockstep when this record is\r\nadded to the Lockstep platform.\r\n            \r\nFor the ID of this record in its originating financial system, see `ErpKey`.",
+            "format": "uuid",
+            "nullable": true
+          },
+          "invoiceId": {
+            "type": "string",
+            "description": "The Invoice this payment is applied to.",
+            "format": "uuid",
+            "nullable": true
+          },
+          "paymentId": {
+            "type": "string",
+            "description": "The Payment this application applies from.",
+            "format": "uuid",
+            "nullable": true
+          },
+          "erpKey": {
+            "type": "string",
+            "description": "The unique ID of this record as it was known in its originating financial system.\r\n            \r\nIf this company record was imported from a financial system, it will have the value `ErpKey`\r\nset to the original primary key number of the record as it was known in the originating financial\r\nsystem.  If this record was not imported, this value will be `null`.\r\n            \r\nFor more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).",
+            "nullable": true
+          },
+          "invoiceErpKey": {
+            "type": "string",
+            "description": "The ERP key of the Invoice this payment is applied to.",
+            "nullable": true
+          },
+          "applyToInvoiceDate": {
+            "type": "string",
+            "description": "The date this payment was applied to this invoice.",
+            "format": "date-time"
+          },
+          "paymentAppliedAmount": {
+            "type": "number",
+            "description": "The total amount that was applied to this Invoice from the Payment.",
+            "format": "double"
+          }
+        },
+        "additionalProperties": false,
+        "description": "A request to insert a payment application"
+      },
+      "InsertPaymentRequestModel": {
+        "type": "object",
+        "properties": {
+          "appEnrollmentId": {
+            "type": "string",
+            "description": "The AppEnrollmentId of the application to write this record to.",
+            "format": "uuid",
+            "nullable": true
+          },
+          "paymentId": {
+            "type": "string",
+            "description": "The unique ID of this record, automatically assigned by Lockstep when this record is\r\nadded to the Lockstep platform.\r\n            \r\nFor the ID of this record in its originating financial system, see `ErpKey`.",
+            "format": "uuid",
+            "nullable": true
+          },
+          "companyId": {
+            "type": "string",
+            "description": "The ID of the company to which this payment belongs.",
+            "format": "uuid"
+          },
+          "companyErpKey": {
+            "type": "string",
+            "description": "The ERP key for the company to which this payment belongs.",
+            "nullable": true
+          },
+          "companyExternalReference": {
+            "type": "string",
+            "description": "A additional reference that may be used in the ERP",
+            "nullable": true
+          },
+          "erpKey": {
+            "type": "string",
+            "description": "The unique ID of this record as it was known in its originating financial system.\r\n            \r\nIf this company record was imported from a financial system, it will have the value `ErpKey`\r\nset to the original primary key number of the record as it was known in the originating financial\r\nsystem.  If this record was not imported, this value will be `null`.\r\n            \r\nFor more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).",
+            "nullable": true
+          },
+          "paymentType": {
+            "type": "string",
+            "description": "The type of payment, AR Payment or AP Payment.\r\n            \r\nRecognized PaymentType values are:\r\n* `AR Payment` - A payment made by a Customer to the Company\r\n* `AP Payment` - A payment made by the Company to a Vendor",
+            "nullable": true
+          },
+          "tenderType": {
+            "type": "string",
+            "description": "Cash, check, credit card, wire transfer.\r\n            \r\nRecognized TenderType values are:\r\n* `Cash` - A cash payment or other direct transfer.\r\n* `Check` - A check payment.\r\n* `Credit Card` - A payment made via a credit card.\r\n* `Wire Transfer` - A payment made via wire transfer from another financial institution.\r\n* `Other` - A payment made via another method not listed above.",
+            "nullable": true
+          },
+          "memoText": {
+            "maxLength": 50,
+            "minLength": 0,
+            "type": "string",
+            "description": "Memo or reference text (ex. memo field on a check).",
+            "nullable": true
+          },
+          "paymentDate": {
+            "type": "string",
+            "description": "The date when this payment was received.",
+            "format": "date-time",
+            "nullable": true
+          },
+          "postDate": {
+            "type": "string",
+            "description": "The date when a payment was posted to a ledger.",
+            "format": "date-time",
+            "nullable": true
+          },
+          "paymentAmount": {
+            "type": "number",
+            "description": "Total amount of this payment in it's received currency.",
+            "format": "double"
+          },
+          "unappliedAmount": {
+            "type": "number",
+            "description": "Unapplied balance of this payment in it's received currency.  If this amount is nonzero, the field `IsOpen` will be true.",
+            "format": "double"
+          },
+          "currencyCode": {
+            "type": "string",
+            "description": "The ISO 4217 currency code for this payment.\r\n            \r\nFor a list of ISO 4217 currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies).",
+            "nullable": true
+          },
+          "referenceCode": {
+            "type": "string",
+            "description": "Reference code for the payment for the given Erp system.",
+            "nullable": true
+          },
+          "isVoided": {
+            "type": "boolean",
+            "description": "Is the payment voided?"
+          },
+          "inDispute": {
+            "type": "boolean",
+            "description": "Is the payment in dispute?"
+          },
+          "currencyRate": {
+            "type": "number",
+            "description": "The Currency Rate used to get from the account's base currency to the payment amount.",
+            "format": "double"
+          },
+          "baseCurrencyPaymentAmount": {
+            "type": "number",
+            "description": "Total amount of this payment in the group's base currency.",
+            "format": "double"
+          },
+          "baseCurrencyUnappliedAmount": {
+            "type": "number",
+            "description": "Unapplied balance of this payment in the group's base currency.  If this amount is nonzero, the field `IsOpen` will be true.",
+            "format": "double"
+          },
+          "bankAccountId": {
+            "type": "string",
+            "description": "The Bank account id for the company to which this payment belongs.",
+            "nullable": true
+          },
+          "groupKey": {
+            "type": "string",
+            "description": "The GroupKey this request belongs to.",
+            "format": "uuid"
+          },
+          "applications": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/InsertPaymentAppliedRequestModel"
+            },
+            "description": "All applications this payment is associated with.\r\nTo retrieve this collection, specify `Applications` in the \"Include\" parameter for your query.",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false,
+        "description": "A request to insert a new Payment"
+      },
+      "InsertPaymentRequestModelErpWriteSyncSubmitModel": {
+        "required": [
+          "appEnrollmentId",
+          "requests"
+        ],
+        "type": "object",
+        "properties": {
+          "appEnrollmentId": {
+            "minLength": 1,
+            "type": "string",
+            "description": "The connected App Enrollment id.",
+            "format": "uuid"
+          },
+          "requests": {
+            "minItems": 1,
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/InsertPaymentRequestModel"
+            },
+            "description": "An array of requests to write back."
+          }
+        },
+        "additionalProperties": false,
+        "description": "Lockstep.Shared.Models.Sync.ErpWriteSyncSubmitModel`1 represents a request to write back a collection\r\n            of requests to the connected AppEnrollment."
+      },
       "InstructedAmount": {
         "type": "object",
         "properties": {
@@ -28266,6 +28838,13 @@
       "MagicLinkModelFetchResult": {
         "type": "object",
         "properties": {
+          "records": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/MagicLinkModel"
+            },
+            "nullable": true
+          },
           "totalCount": {
             "type": "integer",
             "format": "int32",
@@ -28280,13 +28859,6 @@
             "type": "integer",
             "format": "int32",
             "nullable": true
-          },
-          "records": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/MagicLinkModel"
-            },
-            "nullable": true
           }
         },
         "additionalProperties": false
@@ -29416,6 +29988,46 @@
         "additionalProperties": false,
         "description": "A Payment represents money sent from one company to another.  A single payment may contain payments for\r\none or more invoices; it is also possible for payments to be made in advance of an invoice, for example,\r\nas a deposit.  The creator of the Payment is identified by the `CustomerId` field, and the recipient of\r\nthe Payment is identified by the `CompanyId` field.  Most Payments are uniquely identified both by a\r\nLockstep Platform ID number and a customer ERP \"key\" that was generated by the system that originated\r\nthe Payment.  Payments that have not been fully applied have a nonzero `UnappliedAmount` value, which\r\nrepresents a deposit that has been paid and not yet applied to an Invoice."
       },
+      "PaymentModelErpWriteResult": {
+        "type": "object",
+        "properties": {
+          "appEnrollmentId": {
+            "type": "string",
+            "description": "The id of the connected AppEnrollmentModel",
+            "format": "uuid"
+          },
+          "erpKey": {
+            "type": "string",
+            "description": "The ErpKey for the object written to the Erp if created",
+            "nullable": true
+          },
+          "groupKey": {
+            "type": "string",
+            "description": "The GroupKey uniquely identifies a single Lockstep Platform account.  All records for this\r\naccount will share the same GroupKey value.  GroupKey values cannot be changed once created.\r\n            \r\nFor more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).",
+            "format": "uuid"
+          },
+          "message": {
+            "type": "string",
+            "description": "An optional message to return with the result",
+            "nullable": true
+          },
+          "syncRequestId": {
+            "type": "string",
+            "description": "The id of the SyncRequestModel the requests were added to",
+            "format": "uuid"
+          },
+          "results": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/PaymentModel"
+            },
+            "description": "Results from the ERP write operation",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false,
+        "description": "Contains results of a write back request"
+      },
       "PaymentModelFetchResult": {
         "type": "object",
         "properties": {
@@ -31989,6 +32601,13 @@
       "TransactionModelTransactionSummaryTotalModelSummaryFetchResult": {
         "type": "object",
         "properties": {
+          "records": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/TransactionModel"
+            },
+            "nullable": true
+          },
           "totalCount": {
             "type": "integer",
             "format": "int32",
@@ -32004,13 +32623,6 @@
             "format": "int32",
             "nullable": true
           },
-          "records": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/TransactionModel"
-            },
-            "nullable": true
-          },
           "summary": {
             "allOf": [
               {
@@ -32309,13 +32921,6 @@
       "TranscriptionValidationRequestModelFetchResult": {
         "type": "object",
         "properties": {
-          "records": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/TranscriptionValidationRequestModel"
-            },
-            "nullable": true
-          },
           "totalCount": {
             "type": "integer",
             "format": "int32",
@@ -32330,6 +32935,13 @@
             "type": "integer",
             "format": "int32",
             "nullable": true
+          },
+          "records": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/TranscriptionValidationRequestModel"
+            },
+            "nullable": true
           }
         },
         "additionalProperties": false
@@ -32589,6 +33201,11 @@
             "description": "The default currency code used by this user entity.  This value can be overridden\r\nfor invoices in a different currency code.\r\n            \r\nFor a list of defined currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies) This will be validated by the /api/v1/definitions/currencies data set",
             "nullable": true
           },
+          "locale": {
+            "type": "string",
+            "description": "The IETF language tag for the user's preferred locale.",
+            "nullable": true
+          },
           "notes": {
             "type": "array",
             "items": {

data/lib/lockstep_rails/version.rb

@@ -1,3 +1,4 @@
 module LockstepRails
-  VERSION = '0.3.65'
+  VERSION = '0.3.67'
 end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lockstep_rails
 version: !ruby/object:Gem::Version
-  version: 0.3.65
+  version: 0.3.67
 platform: ruby
 authors:
 - Vivek AG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-15 00:00:00.000000000 Z
+date: 2023-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -54,6 +54,7 @@ files:
 - app/models/lockstep/contact.rb
 - app/models/lockstep/customer_summary.rb
 - app/models/lockstep/feature_flag.rb
+- app/models/lockstep/financial_institution_account.rb
 - app/models/lockstep/invoice.rb
 - app/models/lockstep/invoice_at_risk_summary.rb
 - app/models/lockstep/invoice_summary.rb
@@ -187,6 +188,8 @@ files:
 - app/platform_api/schema/financial_account_balance_history_sync.rb
 - app/platform_api/schema/financial_account_fetch_result.rb
 - app/platform_api/schema/financial_account_sync.rb
+- app/platform_api/schema/financial_institution_account.rb
+- app/platform_api/schema/financial_institution_account_fetch_result.rb
 - app/platform_api/schema/financial_report.rb
 - app/platform_api/schema/financial_report_cell.rb
 - app/platform_api/schema/financial_report_row.rb
@@ -194,6 +197,9 @@ files:
 - app/platform_api/schema/financial_year_setting_fetch_result.rb
 - app/platform_api/schema/financial_year_setting_sync.rb
 - app/platform_api/schema/group_account.rb
+- app/platform_api/schema/insert_payment_applied_request.rb
+- app/platform_api/schema/insert_payment_request.rb
+- app/platform_api/schema/insert_payment_request_erp_write_sync_submit.rb
 - app/platform_api/schema/instructed_amount.rb
 - app/platform_api/schema/invite.rb
 - app/platform_api/schema/invite_data.rb
@@ -243,6 +249,7 @@ files:
 - app/platform_api/schema/payment_detail.rb
 - app/platform_api/schema/payment_detail_fetch_result.rb
 - app/platform_api/schema/payment_detail_header.rb
+- app/platform_api/schema/payment_erp_write_result.rb
 - app/platform_api/schema/payment_fetch_result.rb
 - app/platform_api/schema/payment_instrument.rb
 - app/platform_api/schema/payment_response.rb