@robosystems/client 2.22.0 → 2.24.0

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.
Files changed (37) hide show
  1. package/artifacts/LedgerClient.d.ts +58 -3
  2. package/artifacts/LedgerClient.js +65 -1
  3. package/artifacts/LedgerClient.ts +125 -2
  4. package/artifacts/graphql/generated/graphql.d.ts +173 -0
  5. package/artifacts/graphql/generated/graphql.js +430 -2
  6. package/artifacts/graphql/generated/graphql.ts +583 -0
  7. package/artifacts/graphql/queries/ledger/accountRegister.d.ts +13 -0
  8. package/artifacts/graphql/queries/ledger/accountRegister.js +98 -0
  9. package/artifacts/graphql/queries/ledger/accountRegister.ts +96 -0
  10. package/artifacts/graphql/queries/ledger/dimensions.d.ts +7 -0
  11. package/artifacts/graphql/queries/ledger/dimensions.js +27 -0
  12. package/artifacts/graphql/queries/ledger/dimensions.ts +25 -0
  13. package/artifacts/graphql/queries/ledger/eventBlock.d.ts +3 -1
  14. package/artifacts/graphql/queries/ledger/eventBlock.js +24 -1
  15. package/artifacts/graphql/queries/ledger/eventBlock.ts +24 -1
  16. package/artifacts/graphql/queries/ledger/journalEntries.js +6 -0
  17. package/artifacts/graphql/queries/ledger/journalEntries.ts +6 -0
  18. package/artifacts/graphql/queries/ledger/transaction.js +6 -0
  19. package/artifacts/graphql/queries/ledger/transaction.ts +6 -0
  20. package/artifacts/graphql/queries/ledger/trialBalance.d.ts +4 -1
  21. package/artifacts/graphql/queries/ledger/trialBalance.js +19 -3
  22. package/artifacts/graphql/queries/ledger/trialBalance.ts +19 -3
  23. package/index.ts +2 -2
  24. package/package.json +1 -1
  25. package/sdk/index.d.ts +2 -2
  26. package/sdk/index.js +7 -5
  27. package/sdk/index.ts +2 -2
  28. package/sdk/sdk.gen.d.ts +19 -3
  29. package/sdk/sdk.gen.js +38 -4
  30. package/sdk/sdk.gen.ts +37 -3
  31. package/sdk/types.gen.d.ts +455 -4
  32. package/sdk/types.gen.ts +474 -4
  33. package/sdk.gen.d.ts +19 -3
  34. package/sdk.gen.js +38 -4
  35. package/sdk.gen.ts +37 -3
  36. package/types.gen.d.ts +455 -4
  37. package/types.gen.ts +474 -4
@@ -0,0 +1,13 @@
1
+ /**
2
+ * One entity's posted lines on one account, oldest first, each with the
3
+ * balance it leaves.
4
+ *
5
+ * The lines run from `openingBalance` to `closingBalance`, which is the trial
6
+ * balance's for the same window added to the opening. An income or expense
7
+ * account opens at the fiscal year's start (`openingFrom`). Each page carries
8
+ * its own `pageOpeningBalance`; pass `nextCursor` as `$after` for the next.
9
+ * `$includeDrafts` lists the window's drafts on the first page, outside every
10
+ * balance. A dimension pair or `$flowElementId` reads one slice, and says so
11
+ * in `sliced`.
12
+ */
13
+ export declare const GET_ACCOUNT_REGISTER: string;
@@ -0,0 +1,98 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.GET_ACCOUNT_REGISTER = void 0;
4
+ const graphql_request_1 = require("graphql-request");
5
+ /**
6
+ * One entity's posted lines on one account, oldest first, each with the
7
+ * balance it leaves.
8
+ *
9
+ * The lines run from `openingBalance` to `closingBalance`, which is the trial
10
+ * balance's for the same window added to the opening. An income or expense
11
+ * account opens at the fiscal year's start (`openingFrom`). Each page carries
12
+ * its own `pageOpeningBalance`; pass `nextCursor` as `$after` for the next.
13
+ * `$includeDrafts` lists the window's drafts on the first page, outside every
14
+ * balance. A dimension pair or `$flowElementId` reads one slice, and says so
15
+ * in `sliced`.
16
+ */
17
+ exports.GET_ACCOUNT_REGISTER = (0, graphql_request_1.gql) `
18
+ query GetLedgerAccountRegister(
19
+ $accountId: String!
20
+ $startDate: Date
21
+ $endDate: Date
22
+ $entityId: String
23
+ $dimensionType: String
24
+ $dimensionMemberId: String
25
+ $flowElementId: String
26
+ $includeDrafts: Boolean! = false
27
+ $after: String
28
+ $limit: Int
29
+ ) {
30
+ accountRegister(
31
+ accountId: $accountId
32
+ startDate: $startDate
33
+ endDate: $endDate
34
+ entityId: $entityId
35
+ dimensionType: $dimensionType
36
+ dimensionMemberId: $dimensionMemberId
37
+ flowElementId: $flowElementId
38
+ includeDrafts: $includeDrafts
39
+ after: $after
40
+ limit: $limit
41
+ ) {
42
+ account {
43
+ id
44
+ code
45
+ name
46
+ balanceType
47
+ trait
48
+ temporary
49
+ }
50
+ entityId
51
+ startDate
52
+ endDate
53
+ openingFrom
54
+ openingBalance
55
+ totalDebits
56
+ totalCredits
57
+ closingBalance
58
+ lineCount
59
+ pageOpeningBalance
60
+ nextCursor
61
+ sliced
62
+ draftsTruncated
63
+ lines {
64
+ ...RegisterLineFields
65
+ }
66
+ drafts {
67
+ ...RegisterLineFields
68
+ }
69
+ }
70
+ }
71
+
72
+ fragment RegisterLineFields on RegisterLine {
73
+ lineId
74
+ entryId
75
+ entryNumber
76
+ postingDate
77
+ entryType
78
+ provenance
79
+ status
80
+ memo
81
+ description
82
+ debit
83
+ credit
84
+ balance
85
+ triggeredByEventId
86
+ triggeredByEventType
87
+ reversalOf
88
+ reversedBy
89
+ agentId
90
+ agentName
91
+ flowElementId
92
+ dimensions {
93
+ id
94
+ dimensionType
95
+ name
96
+ }
97
+ }
98
+ `;
@@ -0,0 +1,96 @@
1
+ import { gql } from 'graphql-request'
2
+
3
+ /**
4
+ * One entity's posted lines on one account, oldest first, each with the
5
+ * balance it leaves.
6
+ *
7
+ * The lines run from `openingBalance` to `closingBalance`, which is the trial
8
+ * balance's for the same window added to the opening. An income or expense
9
+ * account opens at the fiscal year's start (`openingFrom`). Each page carries
10
+ * its own `pageOpeningBalance`; pass `nextCursor` as `$after` for the next.
11
+ * `$includeDrafts` lists the window's drafts on the first page, outside every
12
+ * balance. A dimension pair or `$flowElementId` reads one slice, and says so
13
+ * in `sliced`.
14
+ */
15
+ export const GET_ACCOUNT_REGISTER = gql`
16
+ query GetLedgerAccountRegister(
17
+ $accountId: String!
18
+ $startDate: Date
19
+ $endDate: Date
20
+ $entityId: String
21
+ $dimensionType: String
22
+ $dimensionMemberId: String
23
+ $flowElementId: String
24
+ $includeDrafts: Boolean! = false
25
+ $after: String
26
+ $limit: Int
27
+ ) {
28
+ accountRegister(
29
+ accountId: $accountId
30
+ startDate: $startDate
31
+ endDate: $endDate
32
+ entityId: $entityId
33
+ dimensionType: $dimensionType
34
+ dimensionMemberId: $dimensionMemberId
35
+ flowElementId: $flowElementId
36
+ includeDrafts: $includeDrafts
37
+ after: $after
38
+ limit: $limit
39
+ ) {
40
+ account {
41
+ id
42
+ code
43
+ name
44
+ balanceType
45
+ trait
46
+ temporary
47
+ }
48
+ entityId
49
+ startDate
50
+ endDate
51
+ openingFrom
52
+ openingBalance
53
+ totalDebits
54
+ totalCredits
55
+ closingBalance
56
+ lineCount
57
+ pageOpeningBalance
58
+ nextCursor
59
+ sliced
60
+ draftsTruncated
61
+ lines {
62
+ ...RegisterLineFields
63
+ }
64
+ drafts {
65
+ ...RegisterLineFields
66
+ }
67
+ }
68
+ }
69
+
70
+ fragment RegisterLineFields on RegisterLine {
71
+ lineId
72
+ entryId
73
+ entryNumber
74
+ postingDate
75
+ entryType
76
+ provenance
77
+ status
78
+ memo
79
+ description
80
+ debit
81
+ credit
82
+ balance
83
+ triggeredByEventId
84
+ triggeredByEventType
85
+ reversalOf
86
+ reversedBy
87
+ agentId
88
+ agentName
89
+ flowElementId
90
+ dimensions {
91
+ id
92
+ dimensionType
93
+ name
94
+ }
95
+ }
96
+ `
@@ -0,0 +1,7 @@
1
+ /**
2
+ * The graph's management dimension members — departments, classes,
3
+ * locations, projects — by axis then name, each with how many ledger lines
4
+ * carry it. `$dimensionType` narrows to one axis; `$includeInactive` adds
5
+ * retired members, which stay on the lines that carry them.
6
+ */
7
+ export declare const LIST_DIMENSIONS: string;
@@ -0,0 +1,27 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.LIST_DIMENSIONS = void 0;
4
+ const graphql_request_1 = require("graphql-request");
5
+ /**
6
+ * The graph's management dimension members — departments, classes,
7
+ * locations, projects — by axis then name, each with how many ledger lines
8
+ * carry it. `$dimensionType` narrows to one axis; `$includeInactive` adds
9
+ * retired members, which stay on the lines that carry them.
10
+ */
11
+ exports.LIST_DIMENSIONS = (0, graphql_request_1.gql) `
12
+ query ListLedgerDimensions($dimensionType: String, $includeInactive: Boolean! = false) {
13
+ dimensions(dimensionType: $dimensionType, includeInactive: $includeInactive) {
14
+ types
15
+ dimensions {
16
+ id
17
+ dimensionType
18
+ name
19
+ value
20
+ source
21
+ isActive
22
+ lineCount
23
+ createdAt
24
+ }
25
+ }
26
+ }
27
+ `;
@@ -0,0 +1,25 @@
1
+ import { gql } from 'graphql-request'
2
+
3
+ /**
4
+ * The graph's management dimension members — departments, classes,
5
+ * locations, projects — by axis then name, each with how many ledger lines
6
+ * carry it. `$dimensionType` narrows to one axis; `$includeInactive` adds
7
+ * retired members, which stay on the lines that carry them.
8
+ */
9
+ export const LIST_DIMENSIONS = gql`
10
+ query ListLedgerDimensions($dimensionType: String, $includeInactive: Boolean! = false) {
11
+ dimensions(dimensionType: $dimensionType, includeInactive: $includeInactive) {
12
+ types
13
+ dimensions {
14
+ id
15
+ dimensionType
16
+ name
17
+ value
18
+ source
19
+ isActive
20
+ lineCount
21
+ createdAt
22
+ }
23
+ }
24
+ }
25
+ `
@@ -3,6 +3,8 @@
3
3
  *
4
4
  * `metadata` is a JSON dict — for QB-sourced events it carries the
5
5
  * nested `entries[]` shape (memo + posting_date + line_items) that the
6
- * journal_entry_recorded handler consumes on approve.
6
+ * journal_entry_recorded handler consumes on approve. `triggeredEntries`
7
+ * is what the event's handler posted, oldest first — where
8
+ * `previewEventBlock` is what it would post.
7
9
  */
8
10
  export declare const GET_EVENT_BLOCK: string;
@@ -7,7 +7,9 @@ const graphql_request_1 = require("graphql-request");
7
7
  *
8
8
  * `metadata` is a JSON dict — for QB-sourced events it carries the
9
9
  * nested `entries[]` shape (memo + posting_date + line_items) that the
10
- * journal_entry_recorded handler consumes on approve.
10
+ * journal_entry_recorded handler consumes on approve. `triggeredEntries`
11
+ * is what the event's handler posted, oldest first — where
12
+ * `previewEventBlock` is what it would post.
11
13
  */
12
14
  exports.GET_EVENT_BLOCK = (0, graphql_request_1.gql) `
13
15
  query GetLedgerEventBlock($id: String!) {
@@ -37,6 +39,27 @@ exports.GET_EVENT_BLOCK = (0, graphql_request_1.gql) `
37
39
  documentId
38
40
  createdAt
39
41
  createdBy
42
+ triggeredEntries {
43
+ id
44
+ number
45
+ type
46
+ status
47
+ postingDate
48
+ memo
49
+ provenance
50
+ totalDebit
51
+ totalCredit
52
+ lineItems {
53
+ id
54
+ accountId
55
+ accountName
56
+ accountCode
57
+ debitAmount
58
+ creditAmount
59
+ description
60
+ lineOrder
61
+ }
62
+ }
40
63
  }
41
64
  }
42
65
  `;
@@ -5,7 +5,9 @@ import { gql } from 'graphql-request'
5
5
  *
6
6
  * `metadata` is a JSON dict — for QB-sourced events it carries the
7
7
  * nested `entries[]` shape (memo + posting_date + line_items) that the
8
- * journal_entry_recorded handler consumes on approve.
8
+ * journal_entry_recorded handler consumes on approve. `triggeredEntries`
9
+ * is what the event's handler posted, oldest first — where
10
+ * `previewEventBlock` is what it would post.
9
11
  */
10
12
  export const GET_EVENT_BLOCK = gql`
11
13
  query GetLedgerEventBlock($id: String!) {
@@ -35,6 +37,27 @@ export const GET_EVENT_BLOCK = gql`
35
37
  documentId
36
38
  createdAt
37
39
  createdBy
40
+ triggeredEntries {
41
+ id
42
+ number
43
+ type
44
+ status
45
+ postingDate
46
+ memo
47
+ provenance
48
+ totalDebit
49
+ totalCredit
50
+ lineItems {
51
+ id
52
+ accountId
53
+ accountName
54
+ accountCode
55
+ debitAmount
56
+ creditAmount
57
+ description
58
+ lineOrder
59
+ }
60
+ }
38
61
  }
39
62
  }
40
63
  `
@@ -50,6 +50,7 @@ exports.LIST_JOURNAL_ENTRIES = (0, graphql_request_1.gql) `
50
50
  sourceStructureId
51
51
  sourceStructureName
52
52
  triggeredByEventId
53
+ triggeredByEventType
53
54
  reversalOf
54
55
  postedAt
55
56
  totalDebit
@@ -65,6 +66,11 @@ exports.LIST_JOURNAL_ENTRIES = (0, graphql_request_1.gql) `
65
66
  description
66
67
  lineOrder
67
68
  flowQname
69
+ dimensions {
70
+ id
71
+ dimensionType
72
+ name
73
+ }
68
74
  }
69
75
  }
70
76
  pagination {
@@ -48,6 +48,7 @@ export const LIST_JOURNAL_ENTRIES = gql`
48
48
  sourceStructureId
49
49
  sourceStructureName
50
50
  triggeredByEventId
51
+ triggeredByEventType
51
52
  reversalOf
52
53
  postedAt
53
54
  totalDebit
@@ -63,6 +64,11 @@ export const LIST_JOURNAL_ENTRIES = gql`
63
64
  description
64
65
  lineOrder
65
66
  flowQname
67
+ dimensions {
68
+ id
69
+ dimensionType
70
+ name
71
+ }
66
72
  }
67
73
  }
68
74
  pagination {
@@ -42,6 +42,12 @@ exports.GET_TRANSACTION = (0, graphql_request_1.gql) `
42
42
  creditAmount
43
43
  description
44
44
  lineOrder
45
+ flowQname
46
+ dimensions {
47
+ id
48
+ dimensionType
49
+ name
50
+ }
45
51
  }
46
52
  }
47
53
  }
@@ -40,6 +40,12 @@ export const GET_TRANSACTION = gql`
40
40
  creditAmount
41
41
  description
42
42
  lineOrder
43
+ flowQname
44
+ dimensions {
45
+ id
46
+ dimensionType
47
+ name
48
+ }
43
49
  }
44
50
  }
45
51
  }
@@ -2,6 +2,9 @@
2
2
  * Trial balance for a period.
3
3
  *
4
4
  * Both dates are optional — omitting them returns a cumulative trial
5
- * balance from inception to now.
5
+ * balance from inception to now. `$dimensionType` with
6
+ * `$dimensionMemberId` sums one management dimension member's lines
7
+ * (`unallocated` for the untagged ones); such a balance need not foot, and
8
+ * says so in `sliced`.
6
9
  */
7
10
  export declare const GET_TRIAL_BALANCE: string;
@@ -6,13 +6,29 @@ const graphql_request_1 = require("graphql-request");
6
6
  * Trial balance for a period.
7
7
  *
8
8
  * Both dates are optional — omitting them returns a cumulative trial
9
- * balance from inception to now.
9
+ * balance from inception to now. `$dimensionType` with
10
+ * `$dimensionMemberId` sums one management dimension member's lines
11
+ * (`unallocated` for the untagged ones); such a balance need not foot, and
12
+ * says so in `sliced`.
10
13
  */
11
14
  exports.GET_TRIAL_BALANCE = (0, graphql_request_1.gql) `
12
- query GetLedgerTrialBalance($startDate: Date, $endDate: Date, $entityId: String) {
13
- trialBalance(startDate: $startDate, endDate: $endDate, entityId: $entityId) {
15
+ query GetLedgerTrialBalance(
16
+ $startDate: Date
17
+ $endDate: Date
18
+ $entityId: String
19
+ $dimensionType: String
20
+ $dimensionMemberId: String
21
+ ) {
22
+ trialBalance(
23
+ startDate: $startDate
24
+ endDate: $endDate
25
+ entityId: $entityId
26
+ dimensionType: $dimensionType
27
+ dimensionMemberId: $dimensionMemberId
28
+ ) {
14
29
  totalDebits
15
30
  totalCredits
31
+ sliced
16
32
  rows {
17
33
  accountId
18
34
  accountCode
@@ -4,13 +4,29 @@ import { gql } from 'graphql-request'
4
4
  * Trial balance for a period.
5
5
  *
6
6
  * Both dates are optional — omitting them returns a cumulative trial
7
- * balance from inception to now.
7
+ * balance from inception to now. `$dimensionType` with
8
+ * `$dimensionMemberId` sums one management dimension member's lines
9
+ * (`unallocated` for the untagged ones); such a balance need not foot, and
10
+ * says so in `sliced`.
8
11
  */
9
12
  export const GET_TRIAL_BALANCE = gql`
10
- query GetLedgerTrialBalance($startDate: Date, $endDate: Date, $entityId: String) {
11
- trialBalance(startDate: $startDate, endDate: $endDate, entityId: $entityId) {
13
+ query GetLedgerTrialBalance(
14
+ $startDate: Date
15
+ $endDate: Date
16
+ $entityId: String
17
+ $dimensionType: String
18
+ $dimensionMemberId: String
19
+ ) {
20
+ trialBalance(
21
+ startDate: $startDate
22
+ endDate: $endDate
23
+ entityId: $entityId
24
+ dimensionType: $dimensionType
25
+ dimensionMemberId: $dimensionMemberId
26
+ ) {
12
27
  totalDebits
13
28
  totalCredits
29
+ sliced
14
30
  rows {
15
31
  accountId
16
32
  accountCode