lockstep_rails 0.3.69 → 0.3.70
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +85 -53
- data/app/models/lockstep/invoice.rb +8 -3
- data/app/models/lockstep/workflow_status.rb +8 -0
- data/app/platform_api/schema/batch_sync.rb +2 -0
- data/app/platform_api/schema/company_magic_link_summary.rb +7 -3
- data/app/platform_api/schema/company_sync.rb +15 -0
- data/app/platform_api/schema/contact_sync.rb +10 -0
- data/app/platform_api/schema/invoice_line_sync.rb +10 -0
- data/app/platform_api/schema/invoice_sync.rb +15 -0
- data/app/platform_api/schema/journal_entry.rb +22 -17
- data/app/platform_api/schema/journal_entry_line.rb +27 -18
- data/app/platform_api/schema/journal_entry_line_fetch_result.rb +26 -0
- data/app/platform_api/schema/journal_entry_line_sync.rb +92 -0
- data/app/platform_api/schema/journal_entry_sync.rb +66 -0
- data/app/platform_api/schema/payment_applied_sync.rb +15 -0
- data/app/platform_api/schema/payment_sync.rb +10 -0
- data/app/platform_api/schema/workflow_status.rb +65 -0
- data/app/platform_api/schema/workflow_status_fetch_result.rb +26 -0
- data/app/platform_api/swagger.json +10449 -12939
- data/lib/lockstep_rails/version.rb +3 -2
- data/lib/tasks/update_api_schema.rake +5 -0
- metadata +8 -2
@@ -0,0 +1,26 @@
|
|
1
|
+
class Schema::JournalEntryLineFetchResult < Lockstep::ApiRecord
|
2
|
+
|
3
|
+
# ApiRecord will crash unless `id_ref` is defined
|
4
|
+
def self.id_ref
|
5
|
+
nil
|
6
|
+
end
|
7
|
+
|
8
|
+
|
9
|
+
# @type: integer
|
10
|
+
# @format: int32
|
11
|
+
field :total_count
|
12
|
+
|
13
|
+
|
14
|
+
# @type: integer
|
15
|
+
# @format: int32
|
16
|
+
field :page_size
|
17
|
+
|
18
|
+
|
19
|
+
# @type: integer
|
20
|
+
# @format: int32
|
21
|
+
field :page_number
|
22
|
+
|
23
|
+
|
24
|
+
has_many :records, {:class_name=>"Schema::JournalEntryLine", :included=>true}
|
25
|
+
|
26
|
+
end
|
@@ -0,0 +1,92 @@
|
|
1
|
+
class Schema::JournalEntryLineSync < Lockstep::ApiRecord
|
2
|
+
|
3
|
+
# ApiRecord will crash unless `id_ref` is defined
|
4
|
+
def self.id_ref
|
5
|
+
nil
|
6
|
+
end
|
7
|
+
|
8
|
+
# Indicates what action to take when an existing object has been found during the sync process.
|
9
|
+
field :on_match_action
|
10
|
+
|
11
|
+
# This is the primary key of the Journal Entry Line record. For this field, you should use whatever the Journal Entry Line's unique
|
12
|
+
# identifying number is in the originating system. Search for a unique, non-changing number within the
|
13
|
+
# originating financial system for this record.
|
14
|
+
#
|
15
|
+
# Example: If you store your Journal Entry Line records in a database, whatever the primary key for the Journal Entry Line table is
|
16
|
+
# in the database should be the "ErpKey".
|
17
|
+
#
|
18
|
+
# For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
|
19
|
+
# @type: string
|
20
|
+
field :erp_key
|
21
|
+
|
22
|
+
# The original primary key or unique ID of the journal entry to which this line belongs. This value should
|
23
|
+
# match the Journal Entry ErpKey field on the JournalEntrySyncModel.
|
24
|
+
# @type: string
|
25
|
+
field :journal_entry_erp_key
|
26
|
+
|
27
|
+
# An optional Financial Account with which this line is associated. This value should
|
28
|
+
# match the Financial Account ErpKey field on the FinancialAccountSyncModel.
|
29
|
+
# @type: string
|
30
|
+
field :financial_account_erp_key
|
31
|
+
|
32
|
+
# The unique code/identifier assigned to each account in the chart of accounts.
|
33
|
+
# @type: string
|
34
|
+
field :account_number
|
35
|
+
|
36
|
+
# The name of the account.
|
37
|
+
# @type: string
|
38
|
+
field :account_name
|
39
|
+
|
40
|
+
# Debit to account.
|
41
|
+
# @type: number
|
42
|
+
# @format: double
|
43
|
+
field :debit
|
44
|
+
|
45
|
+
# Credit to account.
|
46
|
+
# @type: number
|
47
|
+
# @format: double
|
48
|
+
field :credit
|
49
|
+
|
50
|
+
# The transaction currency in which the entry is recorded, especially useful for multi-currency environments.
|
51
|
+
# @type: string
|
52
|
+
field :currency_code
|
53
|
+
|
54
|
+
# The base currency debit amount for the account.
|
55
|
+
# @type: number
|
56
|
+
# @format: double
|
57
|
+
field :base_debit
|
58
|
+
|
59
|
+
# The base currency credit amount for the account.
|
60
|
+
# @type: number
|
61
|
+
# @format: double
|
62
|
+
field :base_credit
|
63
|
+
|
64
|
+
# The base currency in which the entry is recorded, especially useful for multi-currency environments.
|
65
|
+
# @type: string
|
66
|
+
field :base_currency_code
|
67
|
+
|
68
|
+
# The ERP’s identifier for the user who recorded the journal entry line.
|
69
|
+
# @type: string
|
70
|
+
field :source_created_user
|
71
|
+
|
72
|
+
# A memo related to this line.
|
73
|
+
# @type: string
|
74
|
+
field :memo
|
75
|
+
|
76
|
+
# If known, the date when this record was created according to the originating financial system
|
77
|
+
# in which this record is maintained. If the originating financial system does not maintain a
|
78
|
+
# created-date, leave this field null.
|
79
|
+
# @type: string
|
80
|
+
# @format: date-time
|
81
|
+
field :created, Types::Params::DateTime
|
82
|
+
|
83
|
+
# If known, the date when this record was most recently modified according to the originating
|
84
|
+
# financial system in which this record is maintained. If the originating financial system does
|
85
|
+
# not maintain a most-recently-modified-date, leave this field null.
|
86
|
+
# @type: string
|
87
|
+
# @format: date-time
|
88
|
+
field :modified, Types::Params::DateTime
|
89
|
+
|
90
|
+
|
91
|
+
|
92
|
+
end
|
@@ -0,0 +1,66 @@
|
|
1
|
+
class Schema::JournalEntrySync < Lockstep::ApiRecord
|
2
|
+
|
3
|
+
# ApiRecord will crash unless `id_ref` is defined
|
4
|
+
def self.id_ref
|
5
|
+
nil
|
6
|
+
end
|
7
|
+
|
8
|
+
# Indicates what action to take when an existing object has been found during the sync process.
|
9
|
+
field :on_match_action
|
10
|
+
|
11
|
+
# This is the primary key of the Journal Entry record. For this field, you should use whatever the Journal Entry's unique
|
12
|
+
# identifying number is in the originating system. Search for a unique, non-changing number within the
|
13
|
+
# originating financial system for this record.
|
14
|
+
#
|
15
|
+
# Example: If you store your Journal Entry records in a database, whatever the primary key for the Journal Entry table is
|
16
|
+
# in the database should be the "ErpKey".
|
17
|
+
#
|
18
|
+
# For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
|
19
|
+
# @type: string
|
20
|
+
field :erp_key
|
21
|
+
|
22
|
+
# The ERP’s identifier for this journal entry, usually has meaning to the user.
|
23
|
+
# May be the same value of the ERP Key.
|
24
|
+
# @type: string
|
25
|
+
field :journal_id
|
26
|
+
|
27
|
+
# Possible sources for a Journal Entry.
|
28
|
+
field :source
|
29
|
+
|
30
|
+
# Possible statuses for a Journal Entry.
|
31
|
+
field :status
|
32
|
+
|
33
|
+
# A brief description explaining the purpose of the journal entry.
|
34
|
+
# @type: string
|
35
|
+
field :description
|
36
|
+
|
37
|
+
# An additional comment related to the entry.
|
38
|
+
# @type: string
|
39
|
+
field :comment
|
40
|
+
|
41
|
+
# Any reference number or identifier associated with the entry, such as an invoice number or purchase order.
|
42
|
+
# @type: string
|
43
|
+
field :reference_number
|
44
|
+
|
45
|
+
# The raw posting date from the source.
|
46
|
+
# @type: string
|
47
|
+
# @format: date-time
|
48
|
+
field :source_posting_date, Types::Params::DateTime
|
49
|
+
|
50
|
+
# If known, the date when this record was created according to the originating financial system
|
51
|
+
# in which this record is maintained. If the originating financial system does not maintain a
|
52
|
+
# created-date, leave this field null.
|
53
|
+
# @type: string
|
54
|
+
# @format: date-time
|
55
|
+
field :created, Types::Params::DateTime
|
56
|
+
|
57
|
+
# If known, the date when this record was most recently modified according to the originating
|
58
|
+
# financial system in which this record is maintained. If the originating financial system does
|
59
|
+
# not maintain a most-recently-modified-date, leave this field null.
|
60
|
+
# @type: string
|
61
|
+
# @format: date-time
|
62
|
+
field :modified, Types::Params::DateTime
|
63
|
+
|
64
|
+
|
65
|
+
|
66
|
+
end
|
@@ -8,6 +8,11 @@ end
|
|
8
8
|
# Indicates what action to take when an existing object has been found during the sync process.
|
9
9
|
field :on_match_action
|
10
10
|
|
11
|
+
# The unique identifier of this object in the Sage Network platform.
|
12
|
+
# @type: string
|
13
|
+
# @format: uuid
|
14
|
+
field :network_id
|
15
|
+
|
11
16
|
# This is the primary key of the Payment Application record. For this field, you should use whatever this
|
12
17
|
# transaction's unique identifying number is in the originating system. Search for a unique, non-changing
|
13
18
|
# number within the originating financial system for this record.
|
@@ -30,6 +35,11 @@ end
|
|
30
35
|
# @type: string
|
31
36
|
field :invoice_erp_key
|
32
37
|
|
38
|
+
# The network id of the related Invoice.
|
39
|
+
# @type: string
|
40
|
+
# @format: uuid
|
41
|
+
field :invoice_network_id
|
42
|
+
|
33
43
|
# This field indicates which Payment was used to provide the funds for this payment application. In this
|
34
44
|
# field, identify the original primary key or unique ID of the Payment that was used for this payment
|
35
45
|
# application.
|
@@ -42,6 +52,11 @@ end
|
|
42
52
|
# @type: string
|
43
53
|
field :payment_erp_key
|
44
54
|
|
55
|
+
# The network id of the related Payment.
|
56
|
+
# @type: string
|
57
|
+
# @format: uuid
|
58
|
+
field :payment_network_id
|
59
|
+
|
45
60
|
# The entry number of this payment application. This is often a journal entry number, confirmation code,
|
46
61
|
# or other identifying field for this payment application.
|
47
62
|
# @type: integer
|
@@ -8,6 +8,11 @@ end
|
|
8
8
|
# Indicates what action to take when an existing object has been found during the sync process.
|
9
9
|
field :on_match_action
|
10
10
|
|
11
|
+
# The unique identifier of this object in the Sage Network platform.
|
12
|
+
# @type: string
|
13
|
+
# @format: uuid
|
14
|
+
field :network_id
|
15
|
+
|
11
16
|
# This is the primary key of the Payment record. For this field, you should use whatever the payment's unique
|
12
17
|
# identifying number is in the originating system. Search for a unique, non-changing number within the
|
13
18
|
# originating financial system for this record.
|
@@ -25,6 +30,11 @@ end
|
|
25
30
|
# @type: string
|
26
31
|
field :company_erp_key
|
27
32
|
|
33
|
+
# The network id of the related Company.
|
34
|
+
# @type: string
|
35
|
+
# @format: uuid
|
36
|
+
field :company_network_id
|
37
|
+
|
28
38
|
# The type of payment, AR Payment or AP Payment.
|
29
39
|
#
|
30
40
|
# Recognized PaymentType values are:
|
@@ -0,0 +1,65 @@
|
|
1
|
+
class Schema::WorkflowStatus < Lockstep::ApiRecord
|
2
|
+
# ApiRecord will crash unless `id_ref` is defined
|
3
|
+
def self.id_ref
|
4
|
+
nil
|
5
|
+
end
|
6
|
+
|
7
|
+
# The unique ID of this record, automatically assigned by Lockstep when this record is
|
8
|
+
# added to the Accounting Data Services platform.
|
9
|
+
# @type: string
|
10
|
+
# @format: uuid
|
11
|
+
field :id
|
12
|
+
|
13
|
+
# The name of the workflow status.
|
14
|
+
# @type: string
|
15
|
+
field :name
|
16
|
+
|
17
|
+
# The description explaining the use of the workflow status.
|
18
|
+
# @type: string
|
19
|
+
field :description
|
20
|
+
|
21
|
+
# The prior workflow status ID.
|
22
|
+
# @type: string
|
23
|
+
# @format: uuid
|
24
|
+
field :parent_workflow_status_id
|
25
|
+
|
26
|
+
# The category of the workflow status.
|
27
|
+
# @type: string
|
28
|
+
field :category
|
29
|
+
|
30
|
+
# The code of the workflow status.
|
31
|
+
# @type: string
|
32
|
+
field :code
|
33
|
+
|
34
|
+
# Indicates whether notes are required or not.
|
35
|
+
# @type: boolean
|
36
|
+
field :is_notes_required
|
37
|
+
|
38
|
+
# Indicates whether the status change should be reported to the ERP or not.
|
39
|
+
# @type: boolean
|
40
|
+
field :promote_to_erp
|
41
|
+
|
42
|
+
# The date that the workflow status was created.
|
43
|
+
# @type: string
|
44
|
+
# @format: date-time
|
45
|
+
field :created, Types::Params::DateTime
|
46
|
+
|
47
|
+
# The ID of the user who created the workflow status.
|
48
|
+
# @type: string
|
49
|
+
# @format: uuid
|
50
|
+
field :created_user_id
|
51
|
+
|
52
|
+
# The date that the workflow status was last modified.
|
53
|
+
# @type: string
|
54
|
+
# @format: date-time
|
55
|
+
field :modified, Types::Params::DateTime
|
56
|
+
|
57
|
+
# The ID of the user who last modified the workflow status.
|
58
|
+
# @type: string
|
59
|
+
# @format: uuid
|
60
|
+
field :modified_user_id
|
61
|
+
|
62
|
+
belongs_to :parent_workflow_status, { class_name: 'Lockstep::WorkflowStatus', primary_key: :id, foreign_key: 'parent_workflow_status_id' }
|
63
|
+
belongs_to :created_user, { class_name: 'Lockstep::User', primary_key: :user_id, foreign_key: 'created_user_id' }
|
64
|
+
belongs_to :modified_user, { class_name: 'Lockstep::User', primary_key: :user_id, foreign_key: 'modified_user_id' }
|
65
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
class Schema::WorkflowStatusFetchResult < Lockstep::ApiRecord
|
2
|
+
|
3
|
+
# ApiRecord will crash unless `id_ref` is defined
|
4
|
+
def self.id_ref
|
5
|
+
nil
|
6
|
+
end
|
7
|
+
|
8
|
+
|
9
|
+
# @type: integer
|
10
|
+
# @format: int32
|
11
|
+
field :total_count
|
12
|
+
|
13
|
+
|
14
|
+
# @type: integer
|
15
|
+
# @format: int32
|
16
|
+
field :page_size
|
17
|
+
|
18
|
+
|
19
|
+
# @type: integer
|
20
|
+
# @format: int32
|
21
|
+
field :page_number
|
22
|
+
|
23
|
+
|
24
|
+
has_many :records, {:class_name=>"Schema::WorkflowStatus", :included=>true}
|
25
|
+
|
26
|
+
end
|