lockstep_rails 0.3.47 → 0.3.49

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7db9d59fbe7aa12ec5ea2c3985a1e898e94327dc0645a90278b14d7612382cf1
4
- data.tar.gz: 47fc4750144c70cd99dd4cc765c38801f0e420e70af61d243a8d84b9ad67a67d
3
+ metadata.gz: 82705df2e97e69f440875d55efffae23cce649b7b87d3787a42c4947fd31b2f8
4
+ data.tar.gz: dc8248a2bdc68373ef1614419a9af594c36b3a98361e523b19e2bced5df78b96
5
5
  SHA512:
6
- metadata.gz: 45db88812fd762bcc175bce07bd8bcd89637940697f83321af415167467d842610512f8d434c2aac8b75386c0e63722e99f04fa19c3b86041bb47f35aa80fc35
7
- data.tar.gz: 33ae1ed95b0b7d869916b25dc2596ba889739e81a21d42113d2eb54cb184b23e6c1b6ea26e14129c796ca8ddf24a4aa693db52b7ff1ad123b9b6d7081ad4f89c
6
+ metadata.gz: fdd0cbd1821586a4b75c5ee35a492d768f0b94f72546ce853391ac4522e44d0256f5c7bd1d68b762ab7cbab74f3e708f92f629032b358ce7045b91b665903af0
7
+ data.tar.gz: fb0fdb58e7faa0bd0093eae93967e786f3accbe128ae2764a8db41266dc07364a5a5f18461fd82c8814a8a5f0f77af1a8202d8a6edfbc5fc4ff4663f1acd9b88
@@ -5,17 +5,17 @@ def self.id_ref
5
5
  nil
6
6
  end
7
7
 
8
- # The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
9
- # account will share the same GroupKey value. GroupKey values cannot be changed once created.
10
- #
8
+ # The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
9
+ # account will share the same GroupKey value. GroupKey values cannot be changed once created.
10
+ #
11
11
  # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
12
12
  # @type: string
13
13
  # @format: uuid
14
14
  field :group_key
15
15
 
16
- # The unique ID of this record, automatically assigned by Lockstep when this record is
17
- # added to the Lockstep platform.
18
- #
16
+ # The unique ID of this record, automatically assigned by Lockstep when this record is
17
+ # added to the Lockstep platform.
18
+ #
19
19
  # For the ID of this record in its originating financial system, see `ErpKey`.
20
20
  # @type: string
21
21
  # @format: uuid
@@ -31,23 +31,23 @@ end
31
31
  # @format: uuid
32
32
  field :customer_id
33
33
 
34
- # The unique ID of this record as it was known in its originating financial system.
35
- #
36
- # If this company record was imported from a financial system, it will have the value `ErpKey`
37
- # set to the original primary key number of the record as it was known in the originating financial
38
- # system. If this record was not imported, this value will be `null`.
39
- #
34
+ # The unique ID of this record as it was known in its originating financial system.
35
+ #
36
+ # If this company record was imported from a financial system, it will have the value `ErpKey`
37
+ # set to the original primary key number of the record as it was known in the originating financial
38
+ # system. If this record was not imported, this value will be `null`.
39
+ #
40
40
  # For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
41
41
  # @type: string
42
42
  field :erp_key
43
43
 
44
- # The "Purchase Order Code" is a code that is sometimes used by companies to refer to the original PO
45
- # that was sent that caused this invoice to be written. If a customer sends a purchase order to a vendor,
44
+ # The "Purchase Order Code" is a code that is sometimes used by companies to refer to the original PO
45
+ # that was sent that caused this invoice to be written. If a customer sends a purchase order to a vendor,
46
46
  # the vendor can then create an invoice and refer back to the originating purchase order using this field.
47
47
  # @type: string
48
48
  field :purchase_order_code
49
49
 
50
- # An additional reference code that is sometimes used to identify this invoice.
50
+ # An additional reference code that is sometimes used to identify this invoice.
51
51
  # The meaning of this field is specific to the ERP or accounting system used by the user.
52
52
  # @type: string
53
53
  field :reference_code
@@ -60,25 +60,25 @@ end
60
60
  # @type: string
61
61
  field :salesperson_name
62
62
 
63
- # A code identifying the type of this invoice.
64
- #
65
- # Recognized Invoice types are:
66
- # * `AR Invoice` - Represents an invoice sent by Company to the Customer
67
- # * `AP Invoice` - Represents an invoice sent by Vendor to the Company
68
- # * `AR Credit Memo` - Represents a credit memo generated by Company given to Customer
63
+ # A code identifying the type of this invoice.
64
+ #
65
+ # Recognized Invoice types are:
66
+ # * `AR Invoice` - Represents an invoice sent by Company to the Customer
67
+ # * `AP Invoice` - Represents an invoice sent by Vendor to the Company
68
+ # * `AR Credit Memo` - Represents a credit memo generated by Company given to Customer
69
69
  # * `AP Credit Memo` - Represents a credit memo generated by Vendor given to Company
70
70
  # @type: string
71
71
  field :invoice_type_code
72
72
 
73
- # A code identifying the status of this invoice.
74
- #
75
- # Recognized Invoice status codes are:
76
- # * `Open` - Represents an invoice that is considered open and needs more work to complete
73
+ # A code identifying the status of this invoice.
74
+ #
75
+ # Recognized Invoice status codes are:
76
+ # * `Open` - Represents an invoice that is considered open and needs more work to complete
77
77
  # * `Closed` - Represents an invoice that is considered closed and resolved
78
78
  # @type: string
79
79
  field :invoice_status_code
80
80
 
81
- # A code identifying the terms given to the purchaser. This field is imported directly from the originating
81
+ # A code identifying the terms given to the purchaser. This field is imported directly from the originating
82
82
  # financial system and does not follow a specified format.
83
83
  # @type: string
84
84
  field :terms_code
@@ -126,7 +126,7 @@ end
126
126
  # @format: date
127
127
  field :posted_date
128
128
 
129
- # The date when the invoice was closed and finalized after completion of all payments and delivery of all products and
129
+ # The date when the invoice was closed and finalized after completion of all payments and delivery of all products and
130
130
  # services.
131
131
  # @type: string
132
132
  # @format: date
@@ -177,9 +177,9 @@ end
177
177
  # @format: uuid
178
178
  field :modified_user_id
179
179
 
180
- # The AppEnrollmentId of the application that imported this record. For accounts
181
- # with more than one financial system connected, this field identifies the originating
182
- # financial system that produced this record. This value is null if this record
180
+ # The AppEnrollmentId of the application that imported this record. For accounts
181
+ # with more than one financial system connected, this field identifies the originating
182
+ # financial system that produced this record. This value is null if this record
183
183
  # was not loaded from an external ERP or financial system.
184
184
  # @type: string
185
185
  # @format: uuid
@@ -206,15 +206,35 @@ end
206
206
  # @format: double
207
207
  field :currency_rate
208
208
 
209
- # The Company associated to this invoice.
209
+ # The Currency Rate used to get from the account's base currency to the total amount.
210
+ # @type: number
211
+ # @format: double
212
+ field :base_currency_total_amount
213
+
214
+ # The sales tax amount in the group's base currency.
215
+ # @type: number
216
+ # @format: double
217
+ field :base_currency_sales_tax_amount
218
+
219
+ # The discount amount in the group's base currency.
220
+ # @type: number
221
+ # @format: double
222
+ field :base_currency_discount_amount
223
+
224
+ # The outstanding balance amount in the group's base currency.
225
+ # @type: number
226
+ # @format: double
227
+ field :base_currency_outstanding_balance_amount
228
+
229
+ # The Company associated to this invoice.
210
230
  # To retrieve this item, specify `Company` in the "Include" parameter for your query.
211
231
  field :company
212
232
 
213
- # The Customer associated to the invoice customer
233
+ # The Customer associated to the invoice customer
214
234
  # To retrieve this item, specify `Customer` in the "Include" parameter for your query.
215
235
  field :customer
216
236
 
217
- # The Contact associated to the invoice customer
237
+ # The Contact associated to the invoice customer
218
238
  # To retrieve this item, specify `Customer` in the "Include" parameter for your query.
219
239
  field :customer_primary_contact
220
240
 
@@ -83,6 +83,24 @@ end
83
83
  # @type: array
84
84
  field :payment_ids
85
85
 
86
+ # The group's currency code.
87
+ # @type: string
88
+ field :currency_code
89
+
90
+ # The base currency code of the group.
91
+ # @type: string
92
+ field :base_currency_code
93
+
94
+ # The total amount of the Invoice in the group's currency.
95
+ # @type: number
96
+ # @format: double
97
+ field :base_currency_invoice_amount
98
+
99
+ # The remaining balance value of this invoice in the group's currency.
100
+ # @type: number
101
+ # @format: double
102
+ field :base_currency_outstanding_balance
103
+
86
104
  belongs_to :customer, {:class_name=>"Lockstep::Connection", :primary_key=>:company_id, :foreign_key=>"customer_id"}
87
105
  belongs_to :connection, {:class_name=>"Lockstep::Connection", :primary_key=>:company_id, :foreign_key=>"customer_id"}
88
106
 
@@ -5,9 +5,9 @@ def self.id_ref
5
5
  nil
6
6
  end
7
7
 
8
- # The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
9
- # account will share the same GroupKey value. GroupKey values cannot be changed once created.
10
- #
8
+ # The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
9
+ # account will share the same GroupKey value. GroupKey values cannot be changed once created.
10
+ #
11
11
  # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
12
12
  # @type: string
13
13
  # @format: uuid
@@ -23,7 +23,7 @@ end
23
23
  # @format: uuid
24
24
  field :invoice_id
25
25
 
26
- # A reference code that is used to identify this invoice.
26
+ # A reference code that is used to identify this invoice.
27
27
  # The meaning of this field is specific to the ERP or accounting system used by the user.
28
28
  # @type: string
29
29
  field :invoice_number
@@ -33,7 +33,7 @@ end
33
33
  # @format: date
34
34
  field :invoice_date
35
35
 
36
- # The date when the invoice was closed and finalized after completion of all payments and delivery of all products and
36
+ # The date when the invoice was closed and finalized after completion of all payments and delivery of all products and
37
37
  # services.
38
38
  # @type: string
39
39
  # @format: date
@@ -81,7 +81,7 @@ end
81
81
  # @format: int32
82
82
  field :payment_count
83
83
 
84
- # Specific invoices have support for pdf retrieval from their respective erp. When this flag is true, an additional
84
+ # Specific invoices have support for pdf retrieval from their respective erp. When this flag is true, an additional
85
85
  # call to Invoices/{id}/pdf can be made to retrieve a pdf directly from the erp.
86
86
  # @type: boolean
87
87
  field :supports_erp_pdf_retrieval
@@ -94,6 +94,24 @@ end
94
94
  # @type: array
95
95
  field :payment_ids
96
96
 
97
+ # The group's currency code.
98
+ # @type: string
99
+ field :currency_code
100
+
101
+ # The group's base currency code.
102
+ # @type: string
103
+ field :base_currency_code
104
+
105
+ # The invoice amount in the group's base currency.
106
+ # @type: number
107
+ # @format: double
108
+ field :base_currency_invoice_amount
109
+
110
+ # The outstanding balance amount in the group's base currency.
111
+ # @type: number
112
+ # @format: double
113
+ field :base_currency_outstanding_balance_amount
114
+
97
115
  # The modified date of the invoice.
98
116
  # @type: string
99
117
  # @format: date-time
@@ -45,4 +45,8 @@ end
45
45
  # @type: string
46
46
  # @format: date-time
47
47
  field :dueDate, Types::Params::DateTime
48
+
49
+ # The base currency code of the group.
50
+ # @type: string
51
+ field :baseCurrencyCode
48
52
  end
@@ -5,17 +5,17 @@ def self.id_ref
5
5
  nil
6
6
  end
7
7
 
8
- # The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
9
- # account will share the same GroupKey value. GroupKey values cannot be changed once created.
10
- #
8
+ # The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
9
+ # account will share the same GroupKey value. GroupKey values cannot be changed once created.
10
+ #
11
11
  # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
12
12
  # @type: string
13
13
  # @format: uuid
14
14
  field :group_key
15
15
 
16
- # The unique ID of this record, automatically assigned by Lockstep when this record is
17
- # added to the Lockstep platform.
18
- #
16
+ # The unique ID of this record, automatically assigned by Lockstep when this record is
17
+ # added to the Lockstep platform.
18
+ #
19
19
  # For the ID of this record in its originating financial system, see `ErpKey`.
20
20
  # @type: string
21
21
  # @format: uuid
@@ -26,36 +26,36 @@ end
26
26
  # @format: uuid
27
27
  field :company_id
28
28
 
29
- # The unique ID of this record as it was known in its originating financial system.
30
- #
31
- # If this company record was imported from a financial system, it will have the value `ErpKey`
32
- # set to the original primary key number of the record as it was known in the originating financial
33
- # system. If this record was not imported, this value will be `null`.
34
- #
29
+ # The unique ID of this record as it was known in its originating financial system.
30
+ #
31
+ # If this company record was imported from a financial system, it will have the value `ErpKey`
32
+ # set to the original primary key number of the record as it was known in the originating financial
33
+ # system. If this record was not imported, this value will be `null`.
34
+ #
35
35
  # For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
36
36
  # @type: string
37
37
  field :erp_key
38
38
 
39
- # The type of payment, AR Payment or AP Payment.
40
- #
41
- # Recognized PaymentType values are:
42
- # * `AR Payment` - A payment made by a Customer to the Company
39
+ # The type of payment, AR Payment or AP Payment.
40
+ #
41
+ # Recognized PaymentType values are:
42
+ # * `AR Payment` - A payment made by a Customer to the Company
43
43
  # * `AP Payment` - A payment made by the Company to a Vendor
44
44
  # @type: string
45
45
  field :payment_type
46
46
 
47
- # Cash, check, credit card, wire transfer.
48
- #
49
- # Recognized TenderType values are:
50
- # * `Cash` - A cash payment or other direct transfer.
51
- # * `Check` - A check payment.
52
- # * `Credit Card` - A payment made via a credit card.
53
- # * `Wire Transfer` - A payment made via wire transfer from another financial institution.
47
+ # Cash, check, credit card, wire transfer.
48
+ #
49
+ # Recognized TenderType values are:
50
+ # * `Cash` - A cash payment or other direct transfer.
51
+ # * `Check` - A check payment.
52
+ # * `Credit Card` - A payment made via a credit card.
53
+ # * `Wire Transfer` - A payment made via wire transfer from another financial institution.
54
54
  # * `Other` - A payment made via another method not listed above.
55
55
  # @type: string
56
56
  field :tender_type
57
57
 
58
- # True if this payment includes some unassigned amount that has not yet been applied to an invoice. If this
58
+ # True if this payment includes some unassigned amount that has not yet been applied to an invoice. If this
59
59
  # value is true, the field `UnappliedAmount` will be nonzero.
60
60
  # @type: boolean
61
61
  field :is_open
@@ -64,15 +64,15 @@ end
64
64
  # @type: string
65
65
  field :memo_text
66
66
 
67
- # The date when this payment was received. This typically is the date when an accounting employee recorded
68
- # that they received notification that the payment had occurred, whether they were notified by email, postal
67
+ # The date when this payment was received. This typically is the date when an accounting employee recorded
68
+ # that they received notification that the payment had occurred, whether they were notified by email, postal
69
69
  # mail, or financial transaction notification.
70
70
  # @type: string
71
71
  # @format: date
72
72
  field :payment_date
73
73
 
74
- # The date when a payment was posted to a ledger. This date is often determined by a company's accounting
75
- # practices and may be different than the date when the payment was received. This date may be affected by
74
+ # The date when a payment was posted to a ledger. This date is often determined by a company's accounting
75
+ # practices and may be different than the date when the payment was received. This date may be affected by
76
76
  # issues such as temporary holds on funds transferred, bank holidays, or other actions.
77
77
  # @type: string
78
78
  # @format: date
@@ -88,8 +88,8 @@ end
88
88
  # @format: double
89
89
  field :unapplied_amount
90
90
 
91
- # The ISO 4217 currency code for this payment.
92
- #
91
+ # The ISO 4217 currency code for this payment.
92
+ #
93
93
  # For a list of ISO 4217 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
94
94
  # @type: string
95
95
  field :currency_code
@@ -118,9 +118,9 @@ end
118
118
  # @format: uuid
119
119
  field :modified_user_id
120
120
 
121
- # The AppEnrollmentId of the application that imported this record. For accounts
122
- # with more than one financial system connected, this field identifies the originating
123
- # financial system that produced this record. This value is null if this record
121
+ # The AppEnrollmentId of the application that imported this record. For accounts
122
+ # with more than one financial system connected, this field identifies the originating
123
+ # financial system that produced this record. This value is null if this record
124
124
  # was not loaded from an external ERP or financial system.
125
125
  # @type: string
126
126
  # @format: uuid
@@ -139,6 +139,17 @@ end
139
139
  # @format: double
140
140
  field :currency_rate
141
141
 
142
+ # Total amount of this payment in the group's base currency.
143
+ # @type: number
144
+ # @format: double
145
+ field :base_currency_payment_amount
146
+
147
+ # Unapplied balance of this payment in the group's base currency. If this amount is nonzero, the field IsOpen will be true.
148
+ # @type: number
149
+ # @format: double
150
+ field :base_currency_unapplied_amount
151
+
152
+
142
153
  belongs_to :company, {:class_name=>"Lockstep::Account", :primary_key=>:company_id, :foreign_key=>"company_id"}
143
154
  belongs_to :account, {:class_name=>"Lockstep::Account", :primary_key=>:company_id, :foreign_key=>"company_id"}
144
155
  belongs_to :created_user, {:class_name=>"Lockstep::User", :primary_key=>:user_id, :foreign_key=>"created_user_id"}
@@ -5,9 +5,9 @@ def self.id_ref
5
5
  nil
6
6
  end
7
7
 
8
- # The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
9
- # account will share the same GroupKey value. GroupKey values cannot be changed once created.
10
- #
8
+ # The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
9
+ # account will share the same GroupKey value. GroupKey values cannot be changed once created.
10
+ #
11
11
  # For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
12
12
  # @type: string
13
13
  # @format: uuid
@@ -49,7 +49,7 @@ end
49
49
  # @format: double
50
50
  field :unapplied_amount
51
51
 
52
- # True if this payment includes some unassigned amount that has not yet been applied to an invoice. If this
52
+ # True if this payment includes some unassigned amount that has not yet been applied to an invoice. If this
53
53
  # value is true, the field `UnappliedAmount` will be nonzero.
54
54
  # @type: boolean
55
55
  field :is_open
@@ -81,7 +81,7 @@ end
81
81
  # @type: string
82
82
  field :payment_company_name
83
83
 
84
- # Specific payments have support for pdf retrieval from their respective erp. When this flag is true, an additional
84
+ # Specific payments have support for pdf retrieval from their respective erp. When this flag is true, an additional
85
85
  # call to Payments/{id}/pdf can be made to retrieve a pdf directly from the erp.
86
86
  # @type: boolean
87
87
  field :supports_erp_pdf_retrieval
@@ -102,6 +102,24 @@ end
102
102
  # @type: array
103
103
  field :company_names
104
104
 
105
+ # The group's currency code.
106
+ # @type: string
107
+ field :currency_code
108
+
109
+ # The base currency code of the group.
110
+ # @type: string
111
+ field :base_currency_code
112
+
113
+ # The payment amount in the group's base currency.
114
+ # @type: number
115
+ # @format: double
116
+ field :base_currency_payment_amount
117
+
118
+ # The unapplied amount in the group's base currency.
119
+ # @type: number
120
+ # @format: double
121
+ field :base_currency_unapplied_amount
122
+
105
123
  # The modified date of the payment
106
124
  # @type: string
107
125
  # @format: date-time
@@ -1,3 +1,3 @@
1
1
  module LockstepRails
2
- VERSION = '0.3.47'
2
+ VERSION = '0.3.49'
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: lockstep_rails
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.47
4
+ version: 0.3.49
5
5
  platform: ruby
6
6
  authors:
7
7
  - Vivek AG
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-01-27 00:00:00.000000000 Z
11
+ date: 2023-02-24 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rails