@robosystems/client 2.20.0 → 2.20.2
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.
- package/artifacts/LedgerClient.d.ts +3 -1
- package/artifacts/LedgerClient.js +3 -1
- package/artifacts/LedgerClient.ts +3 -1
- package/artifacts/graphql/generated/graphql.d.ts +24 -0
- package/artifacts/graphql/generated/graphql.js +38 -0
- package/artifacts/graphql/generated/graphql.ts +62 -0
- package/artifacts/graphql/queries/ledger/agent.d.ts +4 -3
- package/artifacts/graphql/queries/ledger/agent.js +16 -3
- package/artifacts/graphql/queries/ledger/agent.ts +16 -3
- package/artifacts/graphql/queries/ledger/agents.js +12 -0
- package/artifacts/graphql/queries/ledger/agents.ts +12 -0
- package/package.json +1 -1
- package/sdk/sdk.gen.d.ts +3 -3
- package/sdk/sdk.gen.js +3 -3
- package/sdk/sdk.gen.ts +3 -3
- package/sdk/types.gen.d.ts +37 -15
- package/sdk/types.gen.ts +37 -15
- package/sdk.gen.d.ts +3 -3
- package/sdk.gen.js +3 -3
- package/sdk.gen.ts +3 -3
- package/types.gen.d.ts +37 -15
- package/types.gen.ts +37 -15
|
@@ -1020,7 +1020,9 @@ export declare class LedgerClient {
|
|
|
1020
1020
|
* metadata object; all other fields replace. `classification_element_id`
|
|
1021
1021
|
* sets the account its bank lines are suggested (an empty string clears
|
|
1022
1022
|
* it) and `classification_mode: 'always_ask'` stops suggesting one; its
|
|
1023
|
-
* open lines are re-suggested at once.
|
|
1023
|
+
* open lines are re-suggested at once. Each entity keeps its own default:
|
|
1024
|
+
* `classification_entity_id` names the one these are for, omitted the group
|
|
1025
|
+
* parent.
|
|
1024
1026
|
*/
|
|
1025
1027
|
updateAgent(graphId: string, body: UpdateAgentRequest): Promise<LedgerAgentResponse>;
|
|
1026
1028
|
/**
|
|
@@ -1088,7 +1088,9 @@ class LedgerClient {
|
|
|
1088
1088
|
* metadata object; all other fields replace. `classification_element_id`
|
|
1089
1089
|
* sets the account its bank lines are suggested (an empty string clears
|
|
1090
1090
|
* it) and `classification_mode: 'always_ask'` stops suggesting one; its
|
|
1091
|
-
* open lines are re-suggested at once.
|
|
1091
|
+
* open lines are re-suggested at once. Each entity keeps its own default:
|
|
1092
|
+
* `classification_entity_id` names the one these are for, omitted the group
|
|
1093
|
+
* parent.
|
|
1092
1094
|
*/
|
|
1093
1095
|
async updateAgent(graphId, body) {
|
|
1094
1096
|
const envelope = await this.callOperation('Update agent', (o) => (0, sdk_gen_1.updateAgent)({ ...o, path: { graph_id: graphId }, body }));
|
|
@@ -2699,7 +2699,9 @@ export class LedgerClient {
|
|
|
2699
2699
|
* metadata object; all other fields replace. `classification_element_id`
|
|
2700
2700
|
* sets the account its bank lines are suggested (an empty string clears
|
|
2701
2701
|
* it) and `classification_mode: 'always_ask'` stops suggesting one; its
|
|
2702
|
-
* open lines are re-suggested at once.
|
|
2702
|
+
* open lines are re-suggested at once. Each entity keeps its own default:
|
|
2703
|
+
* `classification_entity_id` names the one these are for, omitted the group
|
|
2704
|
+
* parent.
|
|
2703
2705
|
*/
|
|
2704
2706
|
async updateAgent(graphId: string, body: UpdateAgentRequest): Promise<LedgerAgentResponse> {
|
|
2705
2707
|
const envelope = await this.callOperation('Update agent', (o) =>
|
|
@@ -362,6 +362,7 @@ export type GetLedgerAgentQuery = {
|
|
|
362
362
|
updatedAt: string | null;
|
|
363
363
|
createdBy: string | null;
|
|
364
364
|
classification: {
|
|
365
|
+
entityId: string;
|
|
365
366
|
elementId: string;
|
|
366
367
|
accountName: string | null;
|
|
367
368
|
mode: string;
|
|
@@ -371,6 +372,17 @@ export type GetLedgerAgentQuery = {
|
|
|
371
372
|
setAt: string | null;
|
|
372
373
|
learnedFrom: string | null;
|
|
373
374
|
} | null;
|
|
375
|
+
classifications: Array<{
|
|
376
|
+
entityId: string;
|
|
377
|
+
elementId: string;
|
|
378
|
+
accountName: string | null;
|
|
379
|
+
mode: string;
|
|
380
|
+
confirmations: number;
|
|
381
|
+
overrides: number;
|
|
382
|
+
setBy: string | null;
|
|
383
|
+
setAt: string | null;
|
|
384
|
+
learnedFrom: string | null;
|
|
385
|
+
}>;
|
|
374
386
|
} | null;
|
|
375
387
|
};
|
|
376
388
|
export type ListLedgerAgentsQueryVariables = Exact<{
|
|
@@ -401,6 +413,7 @@ export type ListLedgerAgentsQuery = {
|
|
|
401
413
|
updatedAt: string | null;
|
|
402
414
|
createdBy: string | null;
|
|
403
415
|
classification: {
|
|
416
|
+
entityId: string;
|
|
404
417
|
elementId: string;
|
|
405
418
|
accountName: string | null;
|
|
406
419
|
mode: string;
|
|
@@ -410,6 +423,17 @@ export type ListLedgerAgentsQuery = {
|
|
|
410
423
|
setAt: string | null;
|
|
411
424
|
learnedFrom: string | null;
|
|
412
425
|
} | null;
|
|
426
|
+
classifications: Array<{
|
|
427
|
+
entityId: string;
|
|
428
|
+
elementId: string;
|
|
429
|
+
accountName: string | null;
|
|
430
|
+
mode: string;
|
|
431
|
+
confirmations: number;
|
|
432
|
+
overrides: number;
|
|
433
|
+
setBy: string | null;
|
|
434
|
+
setAt: string | null;
|
|
435
|
+
learnedFrom: string | null;
|
|
436
|
+
}>;
|
|
413
437
|
}>;
|
|
414
438
|
};
|
|
415
439
|
export type ListLedgerBankAccountsQueryVariables = Exact<{
|
|
@@ -1030,6 +1030,25 @@ exports.GetLedgerAgentDocument = {
|
|
|
1030
1030
|
selectionSet: {
|
|
1031
1031
|
kind: 'SelectionSet',
|
|
1032
1032
|
selections: [
|
|
1033
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'entityId' } },
|
|
1034
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'elementId' } },
|
|
1035
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'accountName' } },
|
|
1036
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'mode' } },
|
|
1037
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'confirmations' } },
|
|
1038
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'overrides' } },
|
|
1039
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'setBy' } },
|
|
1040
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'setAt' } },
|
|
1041
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'learnedFrom' } },
|
|
1042
|
+
],
|
|
1043
|
+
},
|
|
1044
|
+
},
|
|
1045
|
+
{
|
|
1046
|
+
kind: 'Field',
|
|
1047
|
+
name: { kind: 'Name', value: 'classifications' },
|
|
1048
|
+
selectionSet: {
|
|
1049
|
+
kind: 'SelectionSet',
|
|
1050
|
+
selections: [
|
|
1051
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'entityId' } },
|
|
1033
1052
|
{ kind: 'Field', name: { kind: 'Name', value: 'elementId' } },
|
|
1034
1053
|
{ kind: 'Field', name: { kind: 'Name', value: 'accountName' } },
|
|
1035
1054
|
{ kind: 'Field', name: { kind: 'Name', value: 'mode' } },
|
|
@@ -1152,6 +1171,25 @@ exports.ListLedgerAgentsDocument = {
|
|
|
1152
1171
|
selectionSet: {
|
|
1153
1172
|
kind: 'SelectionSet',
|
|
1154
1173
|
selections: [
|
|
1174
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'entityId' } },
|
|
1175
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'elementId' } },
|
|
1176
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'accountName' } },
|
|
1177
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'mode' } },
|
|
1178
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'confirmations' } },
|
|
1179
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'overrides' } },
|
|
1180
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'setBy' } },
|
|
1181
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'setAt' } },
|
|
1182
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'learnedFrom' } },
|
|
1183
|
+
],
|
|
1184
|
+
},
|
|
1185
|
+
},
|
|
1186
|
+
{
|
|
1187
|
+
kind: 'Field',
|
|
1188
|
+
name: { kind: 'Name', value: 'classifications' },
|
|
1189
|
+
selectionSet: {
|
|
1190
|
+
kind: 'SelectionSet',
|
|
1191
|
+
selections: [
|
|
1192
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'entityId' } },
|
|
1155
1193
|
{ kind: 'Field', name: { kind: 'Name', value: 'elementId' } },
|
|
1156
1194
|
{ kind: 'Field', name: { kind: 'Name', value: 'accountName' } },
|
|
1157
1195
|
{ kind: 'Field', name: { kind: 'Name', value: 'mode' } },
|
|
@@ -352,6 +352,7 @@ export type GetLedgerAgentQuery = {
|
|
|
352
352
|
updatedAt: string | null
|
|
353
353
|
createdBy: string | null
|
|
354
354
|
classification: {
|
|
355
|
+
entityId: string
|
|
355
356
|
elementId: string
|
|
356
357
|
accountName: string | null
|
|
357
358
|
mode: string
|
|
@@ -361,6 +362,17 @@ export type GetLedgerAgentQuery = {
|
|
|
361
362
|
setAt: string | null
|
|
362
363
|
learnedFrom: string | null
|
|
363
364
|
} | null
|
|
365
|
+
classifications: Array<{
|
|
366
|
+
entityId: string
|
|
367
|
+
elementId: string
|
|
368
|
+
accountName: string | null
|
|
369
|
+
mode: string
|
|
370
|
+
confirmations: number
|
|
371
|
+
overrides: number
|
|
372
|
+
setBy: string | null
|
|
373
|
+
setAt: string | null
|
|
374
|
+
learnedFrom: string | null
|
|
375
|
+
}>
|
|
364
376
|
} | null
|
|
365
377
|
}
|
|
366
378
|
|
|
@@ -393,6 +405,7 @@ export type ListLedgerAgentsQuery = {
|
|
|
393
405
|
updatedAt: string | null
|
|
394
406
|
createdBy: string | null
|
|
395
407
|
classification: {
|
|
408
|
+
entityId: string
|
|
396
409
|
elementId: string
|
|
397
410
|
accountName: string | null
|
|
398
411
|
mode: string
|
|
@@ -402,6 +415,17 @@ export type ListLedgerAgentsQuery = {
|
|
|
402
415
|
setAt: string | null
|
|
403
416
|
learnedFrom: string | null
|
|
404
417
|
} | null
|
|
418
|
+
classifications: Array<{
|
|
419
|
+
entityId: string
|
|
420
|
+
elementId: string
|
|
421
|
+
accountName: string | null
|
|
422
|
+
mode: string
|
|
423
|
+
confirmations: number
|
|
424
|
+
overrides: number
|
|
425
|
+
setBy: string | null
|
|
426
|
+
setAt: string | null
|
|
427
|
+
learnedFrom: string | null
|
|
428
|
+
}>
|
|
405
429
|
}>
|
|
406
430
|
}
|
|
407
431
|
|
|
@@ -3332,6 +3356,25 @@ export const GetLedgerAgentDocument = {
|
|
|
3332
3356
|
selectionSet: {
|
|
3333
3357
|
kind: 'SelectionSet',
|
|
3334
3358
|
selections: [
|
|
3359
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'entityId' } },
|
|
3360
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'elementId' } },
|
|
3361
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'accountName' } },
|
|
3362
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'mode' } },
|
|
3363
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'confirmations' } },
|
|
3364
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'overrides' } },
|
|
3365
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'setBy' } },
|
|
3366
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'setAt' } },
|
|
3367
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'learnedFrom' } },
|
|
3368
|
+
],
|
|
3369
|
+
},
|
|
3370
|
+
},
|
|
3371
|
+
{
|
|
3372
|
+
kind: 'Field',
|
|
3373
|
+
name: { kind: 'Name', value: 'classifications' },
|
|
3374
|
+
selectionSet: {
|
|
3375
|
+
kind: 'SelectionSet',
|
|
3376
|
+
selections: [
|
|
3377
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'entityId' } },
|
|
3335
3378
|
{ kind: 'Field', name: { kind: 'Name', value: 'elementId' } },
|
|
3336
3379
|
{ kind: 'Field', name: { kind: 'Name', value: 'accountName' } },
|
|
3337
3380
|
{ kind: 'Field', name: { kind: 'Name', value: 'mode' } },
|
|
@@ -3454,6 +3497,25 @@ export const ListLedgerAgentsDocument = {
|
|
|
3454
3497
|
selectionSet: {
|
|
3455
3498
|
kind: 'SelectionSet',
|
|
3456
3499
|
selections: [
|
|
3500
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'entityId' } },
|
|
3501
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'elementId' } },
|
|
3502
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'accountName' } },
|
|
3503
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'mode' } },
|
|
3504
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'confirmations' } },
|
|
3505
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'overrides' } },
|
|
3506
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'setBy' } },
|
|
3507
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'setAt' } },
|
|
3508
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'learnedFrom' } },
|
|
3509
|
+
],
|
|
3510
|
+
},
|
|
3511
|
+
},
|
|
3512
|
+
{
|
|
3513
|
+
kind: 'Field',
|
|
3514
|
+
name: { kind: 'Name', value: 'classifications' },
|
|
3515
|
+
selectionSet: {
|
|
3516
|
+
kind: 'SelectionSet',
|
|
3517
|
+
selections: [
|
|
3518
|
+
{ kind: 'Field', name: { kind: 'Name', value: 'entityId' } },
|
|
3457
3519
|
{ kind: 'Field', name: { kind: 'Name', value: 'elementId' } },
|
|
3458
3520
|
{ kind: 'Field', name: { kind: 'Name', value: 'accountName' } },
|
|
3459
3521
|
{ kind: 'Field', name: { kind: 'Name', value: 'mode' } },
|
|
@@ -2,8 +2,9 @@
|
|
|
2
2
|
* Get a single agent by id (the agents detail view).
|
|
3
3
|
*
|
|
4
4
|
* `address` is a JSON dict — typically QB-shaped with `Line1`/`City`/
|
|
5
|
-
* `CountrySubDivisionCode`/`PostalCode` keys. `
|
|
6
|
-
* account
|
|
7
|
-
* with `updateAgent`;
|
|
5
|
+
* `CountrySubDivisionCode`/`PostalCode` keys. `classifications` holds the
|
|
6
|
+
* account each entity's bank lines are suggested, learned from committed lines
|
|
7
|
+
* or set with `updateAgent`; `classification` is the group parent's, null
|
|
8
|
+
* until it has one.
|
|
8
9
|
*/
|
|
9
10
|
export declare const GET_AGENT: string;
|
|
@@ -6,9 +6,10 @@ const graphql_request_1 = require("graphql-request");
|
|
|
6
6
|
* Get a single agent by id (the agents detail view).
|
|
7
7
|
*
|
|
8
8
|
* `address` is a JSON dict — typically QB-shaped with `Line1`/`City`/
|
|
9
|
-
* `CountrySubDivisionCode`/`PostalCode` keys. `
|
|
10
|
-
* account
|
|
11
|
-
* with `updateAgent`;
|
|
9
|
+
* `CountrySubDivisionCode`/`PostalCode` keys. `classifications` holds the
|
|
10
|
+
* account each entity's bank lines are suggested, learned from committed lines
|
|
11
|
+
* or set with `updateAgent`; `classification` is the group parent's, null
|
|
12
|
+
* until it has one.
|
|
12
13
|
*/
|
|
13
14
|
exports.GET_AGENT = (0, graphql_request_1.gql) `
|
|
14
15
|
query GetLedgerAgent($id: String!) {
|
|
@@ -29,6 +30,18 @@ exports.GET_AGENT = (0, graphql_request_1.gql) `
|
|
|
29
30
|
isActive
|
|
30
31
|
is1099Recipient
|
|
31
32
|
classification {
|
|
33
|
+
entityId
|
|
34
|
+
elementId
|
|
35
|
+
accountName
|
|
36
|
+
mode
|
|
37
|
+
confirmations
|
|
38
|
+
overrides
|
|
39
|
+
setBy
|
|
40
|
+
setAt
|
|
41
|
+
learnedFrom
|
|
42
|
+
}
|
|
43
|
+
classifications {
|
|
44
|
+
entityId
|
|
32
45
|
elementId
|
|
33
46
|
accountName
|
|
34
47
|
mode
|
|
@@ -4,9 +4,10 @@ import { gql } from 'graphql-request'
|
|
|
4
4
|
* Get a single agent by id (the agents detail view).
|
|
5
5
|
*
|
|
6
6
|
* `address` is a JSON dict — typically QB-shaped with `Line1`/`City`/
|
|
7
|
-
* `CountrySubDivisionCode`/`PostalCode` keys. `
|
|
8
|
-
* account
|
|
9
|
-
* with `updateAgent`;
|
|
7
|
+
* `CountrySubDivisionCode`/`PostalCode` keys. `classifications` holds the
|
|
8
|
+
* account each entity's bank lines are suggested, learned from committed lines
|
|
9
|
+
* or set with `updateAgent`; `classification` is the group parent's, null
|
|
10
|
+
* until it has one.
|
|
10
11
|
*/
|
|
11
12
|
export const GET_AGENT = gql`
|
|
12
13
|
query GetLedgerAgent($id: String!) {
|
|
@@ -27,6 +28,18 @@ export const GET_AGENT = gql`
|
|
|
27
28
|
isActive
|
|
28
29
|
is1099Recipient
|
|
29
30
|
classification {
|
|
31
|
+
entityId
|
|
32
|
+
elementId
|
|
33
|
+
accountName
|
|
34
|
+
mode
|
|
35
|
+
confirmations
|
|
36
|
+
overrides
|
|
37
|
+
setBy
|
|
38
|
+
setAt
|
|
39
|
+
learnedFrom
|
|
40
|
+
}
|
|
41
|
+
classifications {
|
|
42
|
+
entityId
|
|
30
43
|
elementId
|
|
31
44
|
accountName
|
|
32
45
|
mode
|
|
@@ -41,6 +41,18 @@ exports.LIST_AGENTS = (0, graphql_request_1.gql) `
|
|
|
41
41
|
isActive
|
|
42
42
|
is1099Recipient
|
|
43
43
|
classification {
|
|
44
|
+
entityId
|
|
45
|
+
elementId
|
|
46
|
+
accountName
|
|
47
|
+
mode
|
|
48
|
+
confirmations
|
|
49
|
+
overrides
|
|
50
|
+
setBy
|
|
51
|
+
setAt
|
|
52
|
+
learnedFrom
|
|
53
|
+
}
|
|
54
|
+
classifications {
|
|
55
|
+
entityId
|
|
44
56
|
elementId
|
|
45
57
|
accountName
|
|
46
58
|
mode
|
|
@@ -39,6 +39,18 @@ export const LIST_AGENTS = gql`
|
|
|
39
39
|
isActive
|
|
40
40
|
is1099Recipient
|
|
41
41
|
classification {
|
|
42
|
+
entityId
|
|
43
|
+
elementId
|
|
44
|
+
accountName
|
|
45
|
+
mode
|
|
46
|
+
confirmations
|
|
47
|
+
overrides
|
|
48
|
+
setBy
|
|
49
|
+
setAt
|
|
50
|
+
learnedFrom
|
|
51
|
+
}
|
|
52
|
+
classifications {
|
|
53
|
+
entityId
|
|
42
54
|
elementId
|
|
43
55
|
accountName
|
|
44
56
|
mode
|
package/package.json
CHANGED
package/sdk/sdk.gen.d.ts
CHANGED
|
@@ -926,7 +926,7 @@ export declare const deleteTaxonomyBlock: <ThrowOnError extends boolean = false>
|
|
|
926
926
|
/**
|
|
927
927
|
* Link Entity to Taxonomy
|
|
928
928
|
*
|
|
929
|
-
* Link
|
|
929
|
+
* Link an entity to a taxonomy. Idempotent — returns the existing linkage if it already exists. CoA blocks auto-link at create time; use this to switch an entity's primary chart of accounts. Only the `chart_of_accounts` basis changes behavior: a `reporting`, `mapping` or `schedule` link records the association and nothing reads it. Statements render from the entity's reporting style (change-reporting-style), and custom statement rows come from a reporting extension of that style.
|
|
930
930
|
*
|
|
931
931
|
* **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
|
|
932
932
|
*/
|
|
@@ -1030,7 +1030,7 @@ export declare const createAgent: <ThrowOnError extends boolean = false>(options
|
|
|
1030
1030
|
/**
|
|
1031
1031
|
* Update Agent
|
|
1032
1032
|
*
|
|
1033
|
-
* Patch counterparty fields. Only supplied fields are updated. Set is_active=false to deactivate (agents are never deleted — they are reference data referenced by events and transactions). `classification_element_id` sets the account this counterparty's bank lines are suggested (an empty string clears it), and `classification_mode='always_ask'` stops suggesting one for a counterparty whose lines go to different accounts; its still-open lines are re-suggested at once. A default is also learned as lines are committed, so set one by hand only to correct it.
|
|
1033
|
+
* Patch counterparty fields. Only supplied fields are updated. Set is_active=false to deactivate (agents are never deleted — they are reference data referenced by events and transactions). `classification_element_id` sets the account this counterparty's bank lines are suggested (an empty string clears it), and `classification_mode='always_ask'` stops suggesting one for a counterparty whose lines go to different accounts; its still-open lines are re-suggested at once. Each entity of a group keeps its own default, on its own chart: `classification_entity_id` names the one these fields are for, omitted the group parent. A default is also learned as lines are committed, so set one by hand only to correct it.
|
|
1034
1034
|
*
|
|
1035
1035
|
* **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
|
|
1036
1036
|
*/
|
|
@@ -1038,7 +1038,7 @@ export declare const updateAgent: <ThrowOnError extends boolean = false>(options
|
|
|
1038
1038
|
/**
|
|
1039
1039
|
* Learn Classification Defaults
|
|
1040
1040
|
*
|
|
1041
|
-
* Seed each counterparty's default account from the bank lines already committed to the books: the account most of
|
|
1041
|
+
* Seed each counterparty's default account from the bank lines already committed to the books, one for each entity whose lines it has: the account most of those lines went to becomes the default, with the lines that agreed counted as confirmations. A default already there is kept. Its still-open lines are then suggested from the default. Run it once on books that were classified before defaults were learned; after that, every commit teaches the default by itself. `dry_run` reports what would be learned without writing it.
|
|
1042
1042
|
*
|
|
1043
1043
|
* **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
|
|
1044
1044
|
*/
|
package/sdk/sdk.gen.js
CHANGED
|
@@ -1892,7 +1892,7 @@ exports.deleteTaxonomyBlock = deleteTaxonomyBlock;
|
|
|
1892
1892
|
/**
|
|
1893
1893
|
* Link Entity to Taxonomy
|
|
1894
1894
|
*
|
|
1895
|
-
* Link
|
|
1895
|
+
* Link an entity to a taxonomy. Idempotent — returns the existing linkage if it already exists. CoA blocks auto-link at create time; use this to switch an entity's primary chart of accounts. Only the `chart_of_accounts` basis changes behavior: a `reporting`, `mapping` or `schedule` link records the association and nothing reads it. Statements render from the entity's reporting style (change-reporting-style), and custom statement rows come from a reporting extension of that style.
|
|
1896
1896
|
*
|
|
1897
1897
|
* **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
|
|
1898
1898
|
*/
|
|
@@ -2113,7 +2113,7 @@ exports.createAgent = createAgent;
|
|
|
2113
2113
|
/**
|
|
2114
2114
|
* Update Agent
|
|
2115
2115
|
*
|
|
2116
|
-
* Patch counterparty fields. Only supplied fields are updated. Set is_active=false to deactivate (agents are never deleted — they are reference data referenced by events and transactions). `classification_element_id` sets the account this counterparty's bank lines are suggested (an empty string clears it), and `classification_mode='always_ask'` stops suggesting one for a counterparty whose lines go to different accounts; its still-open lines are re-suggested at once. A default is also learned as lines are committed, so set one by hand only to correct it.
|
|
2116
|
+
* Patch counterparty fields. Only supplied fields are updated. Set is_active=false to deactivate (agents are never deleted — they are reference data referenced by events and transactions). `classification_element_id` sets the account this counterparty's bank lines are suggested (an empty string clears it), and `classification_mode='always_ask'` stops suggesting one for a counterparty whose lines go to different accounts; its still-open lines are re-suggested at once. Each entity of a group keeps its own default, on its own chart: `classification_entity_id` names the one these fields are for, omitted the group parent. A default is also learned as lines are committed, so set one by hand only to correct it.
|
|
2117
2117
|
*
|
|
2118
2118
|
* **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
|
|
2119
2119
|
*/
|
|
@@ -2130,7 +2130,7 @@ exports.updateAgent = updateAgent;
|
|
|
2130
2130
|
/**
|
|
2131
2131
|
* Learn Classification Defaults
|
|
2132
2132
|
*
|
|
2133
|
-
* Seed each counterparty's default account from the bank lines already committed to the books: the account most of
|
|
2133
|
+
* Seed each counterparty's default account from the bank lines already committed to the books, one for each entity whose lines it has: the account most of those lines went to becomes the default, with the lines that agreed counted as confirmations. A default already there is kept. Its still-open lines are then suggested from the default. Run it once on books that were classified before defaults were learned; after that, every commit teaches the default by itself. `dry_run` reports what would be learned without writing it.
|
|
2134
2134
|
*
|
|
2135
2135
|
* **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
|
|
2136
2136
|
*/
|
package/sdk/sdk.gen.ts
CHANGED
|
@@ -1903,7 +1903,7 @@ export const deleteTaxonomyBlock = <ThrowOnError extends boolean = false>(option
|
|
|
1903
1903
|
/**
|
|
1904
1904
|
* Link Entity to Taxonomy
|
|
1905
1905
|
*
|
|
1906
|
-
* Link
|
|
1906
|
+
* Link an entity to a taxonomy. Idempotent — returns the existing linkage if it already exists. CoA blocks auto-link at create time; use this to switch an entity's primary chart of accounts. Only the `chart_of_accounts` basis changes behavior: a `reporting`, `mapping` or `schedule` link records the association and nothing reads it. Statements render from the entity's reporting style (change-reporting-style), and custom statement rows come from a reporting extension of that style.
|
|
1907
1907
|
*
|
|
1908
1908
|
* **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
|
|
1909
1909
|
*/
|
|
@@ -2124,7 +2124,7 @@ export const createAgent = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
2124
2124
|
/**
|
|
2125
2125
|
* Update Agent
|
|
2126
2126
|
*
|
|
2127
|
-
* Patch counterparty fields. Only supplied fields are updated. Set is_active=false to deactivate (agents are never deleted — they are reference data referenced by events and transactions). `classification_element_id` sets the account this counterparty's bank lines are suggested (an empty string clears it), and `classification_mode='always_ask'` stops suggesting one for a counterparty whose lines go to different accounts; its still-open lines are re-suggested at once. A default is also learned as lines are committed, so set one by hand only to correct it.
|
|
2127
|
+
* Patch counterparty fields. Only supplied fields are updated. Set is_active=false to deactivate (agents are never deleted — they are reference data referenced by events and transactions). `classification_element_id` sets the account this counterparty's bank lines are suggested (an empty string clears it), and `classification_mode='always_ask'` stops suggesting one for a counterparty whose lines go to different accounts; its still-open lines are re-suggested at once. Each entity of a group keeps its own default, on its own chart: `classification_entity_id` names the one these fields are for, omitted the group parent. A default is also learned as lines are committed, so set one by hand only to correct it.
|
|
2128
2128
|
*
|
|
2129
2129
|
* **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
|
|
2130
2130
|
*/
|
|
@@ -2141,7 +2141,7 @@ export const updateAgent = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
2141
2141
|
/**
|
|
2142
2142
|
* Learn Classification Defaults
|
|
2143
2143
|
*
|
|
2144
|
-
* Seed each counterparty's default account from the bank lines already committed to the books: the account most of
|
|
2144
|
+
* Seed each counterparty's default account from the bank lines already committed to the books, one for each entity whose lines it has: the account most of those lines went to becomes the default, with the lines that agreed counted as confirmations. A default already there is kept. Its still-open lines are then suggested from the default. Run it once on books that were classified before defaults were learned; after that, every commit teaches the default by itself. `dry_run` reports what would be learned without writing it.
|
|
2145
2145
|
*
|
|
2146
2146
|
* **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
|
|
2147
2147
|
*/
|
package/sdk/types.gen.d.ts
CHANGED
|
@@ -96,7 +96,7 @@ export type AcceptSuggestionLine = {
|
|
|
96
96
|
/**
|
|
97
97
|
* Reason
|
|
98
98
|
*
|
|
99
|
-
* Why a skipped line was not taken: `not_open` (already classified, posted or retracted), `no_suggestion` (nothing to take, or a name that matches no account), `source_changed` (the feed changed it after capture), `closed_period`, `locked` (another process holds it; retry), or `refused` (the handler would not post the choice).
|
|
99
|
+
* Why a skipped line was not taken: `not_open` (already classified, posted or retracted), `no_suggestion` (nothing to take, or a name that matches no account), `source_changed` (the feed changed it after capture), `suggestion_changed` (a line taken earlier in the batch moved the counterparty's default, so this one's suggestion is not the one selected; review it again), `closed_period`, `locked` (another process holds it; retry), or `refused` (the handler would not post the choice).
|
|
100
100
|
*/
|
|
101
101
|
reason?: string | null;
|
|
102
102
|
/**
|
|
@@ -298,10 +298,16 @@ export type AddPublishListMembersOperation = {
|
|
|
298
298
|
/**
|
|
299
299
|
* AgentClassification
|
|
300
300
|
*
|
|
301
|
-
* A counterparty's default account
|
|
302
|
-
* hand.
|
|
301
|
+
* A counterparty's default account for one entity's lines, learned from
|
|
302
|
+
* committed lines or set by hand.
|
|
303
303
|
*/
|
|
304
304
|
export type AgentClassification = {
|
|
305
|
+
/**
|
|
306
|
+
* Entity Id
|
|
307
|
+
*
|
|
308
|
+
* The entity whose lines it is for.
|
|
309
|
+
*/
|
|
310
|
+
entity_id: string;
|
|
305
311
|
/**
|
|
306
312
|
* Element Id
|
|
307
313
|
*
|
|
@@ -9261,13 +9267,13 @@ export type LearnClassificationDefaultsResponse = {
|
|
|
9261
9267
|
/**
|
|
9262
9268
|
* Agents Learned
|
|
9263
9269
|
*
|
|
9264
|
-
*
|
|
9270
|
+
* Defaults learned from committed lines, one per counterparty and entity.
|
|
9265
9271
|
*/
|
|
9266
9272
|
agents_learned: number;
|
|
9267
9273
|
/**
|
|
9268
9274
|
* Agents Kept
|
|
9269
9275
|
*
|
|
9270
|
-
*
|
|
9276
|
+
* Counterparty and entity pairs that already had a default, left as they were.
|
|
9271
9277
|
*/
|
|
9272
9278
|
agents_kept: number;
|
|
9273
9279
|
/**
|
|
@@ -9354,9 +9360,15 @@ export type LedgerAgentResponse = {
|
|
|
9354
9360
|
*/
|
|
9355
9361
|
is_1099_recipient: boolean;
|
|
9356
9362
|
/**
|
|
9357
|
-
* The default account
|
|
9363
|
+
* The default account the group parent's bank lines are suggested.
|
|
9358
9364
|
*/
|
|
9359
9365
|
classification?: AgentClassification | null;
|
|
9366
|
+
/**
|
|
9367
|
+
* Classifications
|
|
9368
|
+
*
|
|
9369
|
+
* The default account for each entity's bank lines, one per entity.
|
|
9370
|
+
*/
|
|
9371
|
+
classifications?: Array<AgentClassification>;
|
|
9360
9372
|
/**
|
|
9361
9373
|
* Created At
|
|
9362
9374
|
*/
|
|
@@ -10014,14 +10026,12 @@ export type LinkBankAccountResponse = {
|
|
|
10014
10026
|
*
|
|
10015
10027
|
* Link an entity to a taxonomy (creates the ENTITY_HAS_TAXONOMY edge).
|
|
10016
10028
|
*
|
|
10017
|
-
*
|
|
10018
|
-
*
|
|
10019
|
-
* the
|
|
10020
|
-
*
|
|
10021
|
-
*
|
|
10022
|
-
*
|
|
10023
|
-
* CoA, link a reporting extension, or attach a custom ontology
|
|
10024
|
-
* explicitly.
|
|
10029
|
+
* A `chart_of_accounts` link tells the platform which chart the entity
|
|
10030
|
+
* keeps its books in; CoA blocks auto-link at create time, so use this to
|
|
10031
|
+
* switch the primary one. The other bases record the association and
|
|
10032
|
+
* nothing reads them: statements render from the entity's reporting style,
|
|
10033
|
+
* whatever taxonomy is linked. Idempotent — re-linking returns the
|
|
10034
|
+
* existing edge unchanged.
|
|
10025
10035
|
*/
|
|
10026
10036
|
export type LinkEntityTaxonomyRequest = {
|
|
10027
10037
|
/**
|
|
@@ -10039,7 +10049,7 @@ export type LinkEntityTaxonomyRequest = {
|
|
|
10039
10049
|
/**
|
|
10040
10050
|
* Basis
|
|
10041
10051
|
*
|
|
10042
|
-
* Linkage role: `chart_of_accounts` (the entity's CoA), `reporting` (reporting standard
|
|
10052
|
+
* Linkage role: `chart_of_accounts` (the entity's CoA), `reporting` (a reporting standard), `mapping` (CoA→reporting rollup), `schedule` (schedule structure). Only `chart_of_accounts` is read; the others are recorded and do not change how statements render.
|
|
10043
10053
|
*/
|
|
10044
10054
|
basis?: 'reporting' | 'chart_of_accounts' | 'mapping' | 'schedule';
|
|
10045
10055
|
/**
|
|
@@ -15460,6 +15470,12 @@ export type PreviewConsolidationEntriesResponse = {
|
|
|
15460
15470
|
* True when the consolidation entity has closed the month: its entries are as posted, and nothing is recomputed.
|
|
15461
15471
|
*/
|
|
15462
15472
|
closed?: boolean;
|
|
15473
|
+
/**
|
|
15474
|
+
* Incomplete
|
|
15475
|
+
*
|
|
15476
|
+
* True when the engine left an entry out — a member's books it cannot read, an account the consolidation entity lacks; `notes` says which. The group close waits on it whatever the residuals.
|
|
15477
|
+
*/
|
|
15478
|
+
incomplete?: boolean;
|
|
15463
15479
|
/**
|
|
15464
15480
|
* Drafted Entry Ids
|
|
15465
15481
|
*
|
|
@@ -20568,6 +20584,12 @@ export type UpdateAgentRequest = {
|
|
|
20568
20584
|
* `suggest` offers the default on each line; `always_ask` offers none, for a counterparty whose lines go to different accounts. Omit to keep.
|
|
20569
20585
|
*/
|
|
20570
20586
|
classification_mode?: 'suggest' | 'always_ask' | null;
|
|
20587
|
+
/**
|
|
20588
|
+
* Classification Entity Id
|
|
20589
|
+
*
|
|
20590
|
+
* The entity whose bank lines the default above is for. Each entity keeps its own default, on its own chart. Omit for the group parent.
|
|
20591
|
+
*/
|
|
20592
|
+
classification_entity_id?: string | null;
|
|
20571
20593
|
/**
|
|
20572
20594
|
* Metadata Patch
|
|
20573
20595
|
*
|
package/sdk/types.gen.ts
CHANGED
|
@@ -101,7 +101,7 @@ export type AcceptSuggestionLine = {
|
|
|
101
101
|
/**
|
|
102
102
|
* Reason
|
|
103
103
|
*
|
|
104
|
-
* Why a skipped line was not taken: `not_open` (already classified, posted or retracted), `no_suggestion` (nothing to take, or a name that matches no account), `source_changed` (the feed changed it after capture), `closed_period`, `locked` (another process holds it; retry), or `refused` (the handler would not post the choice).
|
|
104
|
+
* Why a skipped line was not taken: `not_open` (already classified, posted or retracted), `no_suggestion` (nothing to take, or a name that matches no account), `source_changed` (the feed changed it after capture), `suggestion_changed` (a line taken earlier in the batch moved the counterparty's default, so this one's suggestion is not the one selected; review it again), `closed_period`, `locked` (another process holds it; retry), or `refused` (the handler would not post the choice).
|
|
105
105
|
*/
|
|
106
106
|
reason?: string | null;
|
|
107
107
|
/**
|
|
@@ -309,10 +309,16 @@ export type AddPublishListMembersOperation = {
|
|
|
309
309
|
/**
|
|
310
310
|
* AgentClassification
|
|
311
311
|
*
|
|
312
|
-
* A counterparty's default account
|
|
313
|
-
* hand.
|
|
312
|
+
* A counterparty's default account for one entity's lines, learned from
|
|
313
|
+
* committed lines or set by hand.
|
|
314
314
|
*/
|
|
315
315
|
export type AgentClassification = {
|
|
316
|
+
/**
|
|
317
|
+
* Entity Id
|
|
318
|
+
*
|
|
319
|
+
* The entity whose lines it is for.
|
|
320
|
+
*/
|
|
321
|
+
entity_id: string;
|
|
316
322
|
/**
|
|
317
323
|
* Element Id
|
|
318
324
|
*
|
|
@@ -9477,13 +9483,13 @@ export type LearnClassificationDefaultsResponse = {
|
|
|
9477
9483
|
/**
|
|
9478
9484
|
* Agents Learned
|
|
9479
9485
|
*
|
|
9480
|
-
*
|
|
9486
|
+
* Defaults learned from committed lines, one per counterparty and entity.
|
|
9481
9487
|
*/
|
|
9482
9488
|
agents_learned: number;
|
|
9483
9489
|
/**
|
|
9484
9490
|
* Agents Kept
|
|
9485
9491
|
*
|
|
9486
|
-
*
|
|
9492
|
+
* Counterparty and entity pairs that already had a default, left as they were.
|
|
9487
9493
|
*/
|
|
9488
9494
|
agents_kept: number;
|
|
9489
9495
|
/**
|
|
@@ -9571,9 +9577,15 @@ export type LedgerAgentResponse = {
|
|
|
9571
9577
|
*/
|
|
9572
9578
|
is_1099_recipient: boolean;
|
|
9573
9579
|
/**
|
|
9574
|
-
* The default account
|
|
9580
|
+
* The default account the group parent's bank lines are suggested.
|
|
9575
9581
|
*/
|
|
9576
9582
|
classification?: AgentClassification | null;
|
|
9583
|
+
/**
|
|
9584
|
+
* Classifications
|
|
9585
|
+
*
|
|
9586
|
+
* The default account for each entity's bank lines, one per entity.
|
|
9587
|
+
*/
|
|
9588
|
+
classifications?: Array<AgentClassification>;
|
|
9577
9589
|
/**
|
|
9578
9590
|
* Created At
|
|
9579
9591
|
*/
|
|
@@ -10242,14 +10254,12 @@ export type LinkBankAccountResponse = {
|
|
|
10242
10254
|
*
|
|
10243
10255
|
* Link an entity to a taxonomy (creates the ENTITY_HAS_TAXONOMY edge).
|
|
10244
10256
|
*
|
|
10245
|
-
*
|
|
10246
|
-
*
|
|
10247
|
-
* the
|
|
10248
|
-
*
|
|
10249
|
-
*
|
|
10250
|
-
*
|
|
10251
|
-
* CoA, link a reporting extension, or attach a custom ontology
|
|
10252
|
-
* explicitly.
|
|
10257
|
+
* A `chart_of_accounts` link tells the platform which chart the entity
|
|
10258
|
+
* keeps its books in; CoA blocks auto-link at create time, so use this to
|
|
10259
|
+
* switch the primary one. The other bases record the association and
|
|
10260
|
+
* nothing reads them: statements render from the entity's reporting style,
|
|
10261
|
+
* whatever taxonomy is linked. Idempotent — re-linking returns the
|
|
10262
|
+
* existing edge unchanged.
|
|
10253
10263
|
*/
|
|
10254
10264
|
export type LinkEntityTaxonomyRequest = {
|
|
10255
10265
|
/**
|
|
@@ -10267,7 +10277,7 @@ export type LinkEntityTaxonomyRequest = {
|
|
|
10267
10277
|
/**
|
|
10268
10278
|
* Basis
|
|
10269
10279
|
*
|
|
10270
|
-
* Linkage role: `chart_of_accounts` (the entity's CoA), `reporting` (reporting standard
|
|
10280
|
+
* Linkage role: `chart_of_accounts` (the entity's CoA), `reporting` (a reporting standard), `mapping` (CoA→reporting rollup), `schedule` (schedule structure). Only `chart_of_accounts` is read; the others are recorded and do not change how statements render.
|
|
10271
10281
|
*/
|
|
10272
10282
|
basis?: 'reporting' | 'chart_of_accounts' | 'mapping' | 'schedule';
|
|
10273
10283
|
/**
|
|
@@ -15823,6 +15833,12 @@ export type PreviewConsolidationEntriesResponse = {
|
|
|
15823
15833
|
* True when the consolidation entity has closed the month: its entries are as posted, and nothing is recomputed.
|
|
15824
15834
|
*/
|
|
15825
15835
|
closed?: boolean;
|
|
15836
|
+
/**
|
|
15837
|
+
* Incomplete
|
|
15838
|
+
*
|
|
15839
|
+
* True when the engine left an entry out — a member's books it cannot read, an account the consolidation entity lacks; `notes` says which. The group close waits on it whatever the residuals.
|
|
15840
|
+
*/
|
|
15841
|
+
incomplete?: boolean;
|
|
15826
15842
|
/**
|
|
15827
15843
|
* Drafted Entry Ids
|
|
15828
15844
|
*
|
|
@@ -21059,6 +21075,12 @@ export type UpdateAgentRequest = {
|
|
|
21059
21075
|
* `suggest` offers the default on each line; `always_ask` offers none, for a counterparty whose lines go to different accounts. Omit to keep.
|
|
21060
21076
|
*/
|
|
21061
21077
|
classification_mode?: 'suggest' | 'always_ask' | null;
|
|
21078
|
+
/**
|
|
21079
|
+
* Classification Entity Id
|
|
21080
|
+
*
|
|
21081
|
+
* The entity whose bank lines the default above is for. Each entity keeps its own default, on its own chart. Omit for the group parent.
|
|
21082
|
+
*/
|
|
21083
|
+
classification_entity_id?: string | null;
|
|
21062
21084
|
/**
|
|
21063
21085
|
* Metadata Patch
|
|
21064
21086
|
*
|
package/sdk.gen.d.ts
CHANGED
|
@@ -926,7 +926,7 @@ export declare const deleteTaxonomyBlock: <ThrowOnError extends boolean = false>
|
|
|
926
926
|
/**
|
|
927
927
|
* Link Entity to Taxonomy
|
|
928
928
|
*
|
|
929
|
-
* Link
|
|
929
|
+
* Link an entity to a taxonomy. Idempotent — returns the existing linkage if it already exists. CoA blocks auto-link at create time; use this to switch an entity's primary chart of accounts. Only the `chart_of_accounts` basis changes behavior: a `reporting`, `mapping` or `schedule` link records the association and nothing reads it. Statements render from the entity's reporting style (change-reporting-style), and custom statement rows come from a reporting extension of that style.
|
|
930
930
|
*
|
|
931
931
|
* **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
|
|
932
932
|
*/
|
|
@@ -1030,7 +1030,7 @@ export declare const createAgent: <ThrowOnError extends boolean = false>(options
|
|
|
1030
1030
|
/**
|
|
1031
1031
|
* Update Agent
|
|
1032
1032
|
*
|
|
1033
|
-
* Patch counterparty fields. Only supplied fields are updated. Set is_active=false to deactivate (agents are never deleted — they are reference data referenced by events and transactions). `classification_element_id` sets the account this counterparty's bank lines are suggested (an empty string clears it), and `classification_mode='always_ask'` stops suggesting one for a counterparty whose lines go to different accounts; its still-open lines are re-suggested at once. A default is also learned as lines are committed, so set one by hand only to correct it.
|
|
1033
|
+
* Patch counterparty fields. Only supplied fields are updated. Set is_active=false to deactivate (agents are never deleted — they are reference data referenced by events and transactions). `classification_element_id` sets the account this counterparty's bank lines are suggested (an empty string clears it), and `classification_mode='always_ask'` stops suggesting one for a counterparty whose lines go to different accounts; its still-open lines are re-suggested at once. Each entity of a group keeps its own default, on its own chart: `classification_entity_id` names the one these fields are for, omitted the group parent. A default is also learned as lines are committed, so set one by hand only to correct it.
|
|
1034
1034
|
*
|
|
1035
1035
|
* **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
|
|
1036
1036
|
*/
|
|
@@ -1038,7 +1038,7 @@ export declare const updateAgent: <ThrowOnError extends boolean = false>(options
|
|
|
1038
1038
|
/**
|
|
1039
1039
|
* Learn Classification Defaults
|
|
1040
1040
|
*
|
|
1041
|
-
* Seed each counterparty's default account from the bank lines already committed to the books: the account most of
|
|
1041
|
+
* Seed each counterparty's default account from the bank lines already committed to the books, one for each entity whose lines it has: the account most of those lines went to becomes the default, with the lines that agreed counted as confirmations. A default already there is kept. Its still-open lines are then suggested from the default. Run it once on books that were classified before defaults were learned; after that, every commit teaches the default by itself. `dry_run` reports what would be learned without writing it.
|
|
1042
1042
|
*
|
|
1043
1043
|
* **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
|
|
1044
1044
|
*/
|
package/sdk.gen.js
CHANGED
|
@@ -1892,7 +1892,7 @@ exports.deleteTaxonomyBlock = deleteTaxonomyBlock;
|
|
|
1892
1892
|
/**
|
|
1893
1893
|
* Link Entity to Taxonomy
|
|
1894
1894
|
*
|
|
1895
|
-
* Link
|
|
1895
|
+
* Link an entity to a taxonomy. Idempotent — returns the existing linkage if it already exists. CoA blocks auto-link at create time; use this to switch an entity's primary chart of accounts. Only the `chart_of_accounts` basis changes behavior: a `reporting`, `mapping` or `schedule` link records the association and nothing reads it. Statements render from the entity's reporting style (change-reporting-style), and custom statement rows come from a reporting extension of that style.
|
|
1896
1896
|
*
|
|
1897
1897
|
* **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
|
|
1898
1898
|
*/
|
|
@@ -2113,7 +2113,7 @@ exports.createAgent = createAgent;
|
|
|
2113
2113
|
/**
|
|
2114
2114
|
* Update Agent
|
|
2115
2115
|
*
|
|
2116
|
-
* Patch counterparty fields. Only supplied fields are updated. Set is_active=false to deactivate (agents are never deleted — they are reference data referenced by events and transactions). `classification_element_id` sets the account this counterparty's bank lines are suggested (an empty string clears it), and `classification_mode='always_ask'` stops suggesting one for a counterparty whose lines go to different accounts; its still-open lines are re-suggested at once. A default is also learned as lines are committed, so set one by hand only to correct it.
|
|
2116
|
+
* Patch counterparty fields. Only supplied fields are updated. Set is_active=false to deactivate (agents are never deleted — they are reference data referenced by events and transactions). `classification_element_id` sets the account this counterparty's bank lines are suggested (an empty string clears it), and `classification_mode='always_ask'` stops suggesting one for a counterparty whose lines go to different accounts; its still-open lines are re-suggested at once. Each entity of a group keeps its own default, on its own chart: `classification_entity_id` names the one these fields are for, omitted the group parent. A default is also learned as lines are committed, so set one by hand only to correct it.
|
|
2117
2117
|
*
|
|
2118
2118
|
* **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
|
|
2119
2119
|
*/
|
|
@@ -2130,7 +2130,7 @@ exports.updateAgent = updateAgent;
|
|
|
2130
2130
|
/**
|
|
2131
2131
|
* Learn Classification Defaults
|
|
2132
2132
|
*
|
|
2133
|
-
* Seed each counterparty's default account from the bank lines already committed to the books: the account most of
|
|
2133
|
+
* Seed each counterparty's default account from the bank lines already committed to the books, one for each entity whose lines it has: the account most of those lines went to becomes the default, with the lines that agreed counted as confirmations. A default already there is kept. Its still-open lines are then suggested from the default. Run it once on books that were classified before defaults were learned; after that, every commit teaches the default by itself. `dry_run` reports what would be learned without writing it.
|
|
2134
2134
|
*
|
|
2135
2135
|
* **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
|
|
2136
2136
|
*/
|
package/sdk.gen.ts
CHANGED
|
@@ -1903,7 +1903,7 @@ export const deleteTaxonomyBlock = <ThrowOnError extends boolean = false>(option
|
|
|
1903
1903
|
/**
|
|
1904
1904
|
* Link Entity to Taxonomy
|
|
1905
1905
|
*
|
|
1906
|
-
* Link
|
|
1906
|
+
* Link an entity to a taxonomy. Idempotent — returns the existing linkage if it already exists. CoA blocks auto-link at create time; use this to switch an entity's primary chart of accounts. Only the `chart_of_accounts` basis changes behavior: a `reporting`, `mapping` or `schedule` link records the association and nothing reads it. Statements render from the entity's reporting style (change-reporting-style), and custom statement rows come from a reporting extension of that style.
|
|
1907
1907
|
*
|
|
1908
1908
|
* **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
|
|
1909
1909
|
*/
|
|
@@ -2124,7 +2124,7 @@ export const createAgent = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
2124
2124
|
/**
|
|
2125
2125
|
* Update Agent
|
|
2126
2126
|
*
|
|
2127
|
-
* Patch counterparty fields. Only supplied fields are updated. Set is_active=false to deactivate (agents are never deleted — they are reference data referenced by events and transactions). `classification_element_id` sets the account this counterparty's bank lines are suggested (an empty string clears it), and `classification_mode='always_ask'` stops suggesting one for a counterparty whose lines go to different accounts; its still-open lines are re-suggested at once. A default is also learned as lines are committed, so set one by hand only to correct it.
|
|
2127
|
+
* Patch counterparty fields. Only supplied fields are updated. Set is_active=false to deactivate (agents are never deleted — they are reference data referenced by events and transactions). `classification_element_id` sets the account this counterparty's bank lines are suggested (an empty string clears it), and `classification_mode='always_ask'` stops suggesting one for a counterparty whose lines go to different accounts; its still-open lines are re-suggested at once. Each entity of a group keeps its own default, on its own chart: `classification_entity_id` names the one these fields are for, omitted the group parent. A default is also learned as lines are committed, so set one by hand only to correct it.
|
|
2128
2128
|
*
|
|
2129
2129
|
* **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
|
|
2130
2130
|
*/
|
|
@@ -2141,7 +2141,7 @@ export const updateAgent = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
2141
2141
|
/**
|
|
2142
2142
|
* Learn Classification Defaults
|
|
2143
2143
|
*
|
|
2144
|
-
* Seed each counterparty's default account from the bank lines already committed to the books: the account most of
|
|
2144
|
+
* Seed each counterparty's default account from the bank lines already committed to the books, one for each entity whose lines it has: the account most of those lines went to becomes the default, with the lines that agreed counted as confirmations. A default already there is kept. Its still-open lines are then suggested from the default. Run it once on books that were classified before defaults were learned; after that, every commit teaches the default by itself. `dry_run` reports what would be learned without writing it.
|
|
2145
2145
|
*
|
|
2146
2146
|
* **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
|
|
2147
2147
|
*/
|
package/types.gen.d.ts
CHANGED
|
@@ -96,7 +96,7 @@ export type AcceptSuggestionLine = {
|
|
|
96
96
|
/**
|
|
97
97
|
* Reason
|
|
98
98
|
*
|
|
99
|
-
* Why a skipped line was not taken: `not_open` (already classified, posted or retracted), `no_suggestion` (nothing to take, or a name that matches no account), `source_changed` (the feed changed it after capture), `closed_period`, `locked` (another process holds it; retry), or `refused` (the handler would not post the choice).
|
|
99
|
+
* Why a skipped line was not taken: `not_open` (already classified, posted or retracted), `no_suggestion` (nothing to take, or a name that matches no account), `source_changed` (the feed changed it after capture), `suggestion_changed` (a line taken earlier in the batch moved the counterparty's default, so this one's suggestion is not the one selected; review it again), `closed_period`, `locked` (another process holds it; retry), or `refused` (the handler would not post the choice).
|
|
100
100
|
*/
|
|
101
101
|
reason?: string | null;
|
|
102
102
|
/**
|
|
@@ -298,10 +298,16 @@ export type AddPublishListMembersOperation = {
|
|
|
298
298
|
/**
|
|
299
299
|
* AgentClassification
|
|
300
300
|
*
|
|
301
|
-
* A counterparty's default account
|
|
302
|
-
* hand.
|
|
301
|
+
* A counterparty's default account for one entity's lines, learned from
|
|
302
|
+
* committed lines or set by hand.
|
|
303
303
|
*/
|
|
304
304
|
export type AgentClassification = {
|
|
305
|
+
/**
|
|
306
|
+
* Entity Id
|
|
307
|
+
*
|
|
308
|
+
* The entity whose lines it is for.
|
|
309
|
+
*/
|
|
310
|
+
entity_id: string;
|
|
305
311
|
/**
|
|
306
312
|
* Element Id
|
|
307
313
|
*
|
|
@@ -9261,13 +9267,13 @@ export type LearnClassificationDefaultsResponse = {
|
|
|
9261
9267
|
/**
|
|
9262
9268
|
* Agents Learned
|
|
9263
9269
|
*
|
|
9264
|
-
*
|
|
9270
|
+
* Defaults learned from committed lines, one per counterparty and entity.
|
|
9265
9271
|
*/
|
|
9266
9272
|
agents_learned: number;
|
|
9267
9273
|
/**
|
|
9268
9274
|
* Agents Kept
|
|
9269
9275
|
*
|
|
9270
|
-
*
|
|
9276
|
+
* Counterparty and entity pairs that already had a default, left as they were.
|
|
9271
9277
|
*/
|
|
9272
9278
|
agents_kept: number;
|
|
9273
9279
|
/**
|
|
@@ -9354,9 +9360,15 @@ export type LedgerAgentResponse = {
|
|
|
9354
9360
|
*/
|
|
9355
9361
|
is_1099_recipient: boolean;
|
|
9356
9362
|
/**
|
|
9357
|
-
* The default account
|
|
9363
|
+
* The default account the group parent's bank lines are suggested.
|
|
9358
9364
|
*/
|
|
9359
9365
|
classification?: AgentClassification | null;
|
|
9366
|
+
/**
|
|
9367
|
+
* Classifications
|
|
9368
|
+
*
|
|
9369
|
+
* The default account for each entity's bank lines, one per entity.
|
|
9370
|
+
*/
|
|
9371
|
+
classifications?: Array<AgentClassification>;
|
|
9360
9372
|
/**
|
|
9361
9373
|
* Created At
|
|
9362
9374
|
*/
|
|
@@ -10014,14 +10026,12 @@ export type LinkBankAccountResponse = {
|
|
|
10014
10026
|
*
|
|
10015
10027
|
* Link an entity to a taxonomy (creates the ENTITY_HAS_TAXONOMY edge).
|
|
10016
10028
|
*
|
|
10017
|
-
*
|
|
10018
|
-
*
|
|
10019
|
-
* the
|
|
10020
|
-
*
|
|
10021
|
-
*
|
|
10022
|
-
*
|
|
10023
|
-
* CoA, link a reporting extension, or attach a custom ontology
|
|
10024
|
-
* explicitly.
|
|
10029
|
+
* A `chart_of_accounts` link tells the platform which chart the entity
|
|
10030
|
+
* keeps its books in; CoA blocks auto-link at create time, so use this to
|
|
10031
|
+
* switch the primary one. The other bases record the association and
|
|
10032
|
+
* nothing reads them: statements render from the entity's reporting style,
|
|
10033
|
+
* whatever taxonomy is linked. Idempotent — re-linking returns the
|
|
10034
|
+
* existing edge unchanged.
|
|
10025
10035
|
*/
|
|
10026
10036
|
export type LinkEntityTaxonomyRequest = {
|
|
10027
10037
|
/**
|
|
@@ -10039,7 +10049,7 @@ export type LinkEntityTaxonomyRequest = {
|
|
|
10039
10049
|
/**
|
|
10040
10050
|
* Basis
|
|
10041
10051
|
*
|
|
10042
|
-
* Linkage role: `chart_of_accounts` (the entity's CoA), `reporting` (reporting standard
|
|
10052
|
+
* Linkage role: `chart_of_accounts` (the entity's CoA), `reporting` (a reporting standard), `mapping` (CoA→reporting rollup), `schedule` (schedule structure). Only `chart_of_accounts` is read; the others are recorded and do not change how statements render.
|
|
10043
10053
|
*/
|
|
10044
10054
|
basis?: 'reporting' | 'chart_of_accounts' | 'mapping' | 'schedule';
|
|
10045
10055
|
/**
|
|
@@ -15460,6 +15470,12 @@ export type PreviewConsolidationEntriesResponse = {
|
|
|
15460
15470
|
* True when the consolidation entity has closed the month: its entries are as posted, and nothing is recomputed.
|
|
15461
15471
|
*/
|
|
15462
15472
|
closed?: boolean;
|
|
15473
|
+
/**
|
|
15474
|
+
* Incomplete
|
|
15475
|
+
*
|
|
15476
|
+
* True when the engine left an entry out — a member's books it cannot read, an account the consolidation entity lacks; `notes` says which. The group close waits on it whatever the residuals.
|
|
15477
|
+
*/
|
|
15478
|
+
incomplete?: boolean;
|
|
15463
15479
|
/**
|
|
15464
15480
|
* Drafted Entry Ids
|
|
15465
15481
|
*
|
|
@@ -20568,6 +20584,12 @@ export type UpdateAgentRequest = {
|
|
|
20568
20584
|
* `suggest` offers the default on each line; `always_ask` offers none, for a counterparty whose lines go to different accounts. Omit to keep.
|
|
20569
20585
|
*/
|
|
20570
20586
|
classification_mode?: 'suggest' | 'always_ask' | null;
|
|
20587
|
+
/**
|
|
20588
|
+
* Classification Entity Id
|
|
20589
|
+
*
|
|
20590
|
+
* The entity whose bank lines the default above is for. Each entity keeps its own default, on its own chart. Omit for the group parent.
|
|
20591
|
+
*/
|
|
20592
|
+
classification_entity_id?: string | null;
|
|
20571
20593
|
/**
|
|
20572
20594
|
* Metadata Patch
|
|
20573
20595
|
*
|
package/types.gen.ts
CHANGED
|
@@ -101,7 +101,7 @@ export type AcceptSuggestionLine = {
|
|
|
101
101
|
/**
|
|
102
102
|
* Reason
|
|
103
103
|
*
|
|
104
|
-
* Why a skipped line was not taken: `not_open` (already classified, posted or retracted), `no_suggestion` (nothing to take, or a name that matches no account), `source_changed` (the feed changed it after capture), `closed_period`, `locked` (another process holds it; retry), or `refused` (the handler would not post the choice).
|
|
104
|
+
* Why a skipped line was not taken: `not_open` (already classified, posted or retracted), `no_suggestion` (nothing to take, or a name that matches no account), `source_changed` (the feed changed it after capture), `suggestion_changed` (a line taken earlier in the batch moved the counterparty's default, so this one's suggestion is not the one selected; review it again), `closed_period`, `locked` (another process holds it; retry), or `refused` (the handler would not post the choice).
|
|
105
105
|
*/
|
|
106
106
|
reason?: string | null;
|
|
107
107
|
/**
|
|
@@ -309,10 +309,16 @@ export type AddPublishListMembersOperation = {
|
|
|
309
309
|
/**
|
|
310
310
|
* AgentClassification
|
|
311
311
|
*
|
|
312
|
-
* A counterparty's default account
|
|
313
|
-
* hand.
|
|
312
|
+
* A counterparty's default account for one entity's lines, learned from
|
|
313
|
+
* committed lines or set by hand.
|
|
314
314
|
*/
|
|
315
315
|
export type AgentClassification = {
|
|
316
|
+
/**
|
|
317
|
+
* Entity Id
|
|
318
|
+
*
|
|
319
|
+
* The entity whose lines it is for.
|
|
320
|
+
*/
|
|
321
|
+
entity_id: string;
|
|
316
322
|
/**
|
|
317
323
|
* Element Id
|
|
318
324
|
*
|
|
@@ -9477,13 +9483,13 @@ export type LearnClassificationDefaultsResponse = {
|
|
|
9477
9483
|
/**
|
|
9478
9484
|
* Agents Learned
|
|
9479
9485
|
*
|
|
9480
|
-
*
|
|
9486
|
+
* Defaults learned from committed lines, one per counterparty and entity.
|
|
9481
9487
|
*/
|
|
9482
9488
|
agents_learned: number;
|
|
9483
9489
|
/**
|
|
9484
9490
|
* Agents Kept
|
|
9485
9491
|
*
|
|
9486
|
-
*
|
|
9492
|
+
* Counterparty and entity pairs that already had a default, left as they were.
|
|
9487
9493
|
*/
|
|
9488
9494
|
agents_kept: number;
|
|
9489
9495
|
/**
|
|
@@ -9571,9 +9577,15 @@ export type LedgerAgentResponse = {
|
|
|
9571
9577
|
*/
|
|
9572
9578
|
is_1099_recipient: boolean;
|
|
9573
9579
|
/**
|
|
9574
|
-
* The default account
|
|
9580
|
+
* The default account the group parent's bank lines are suggested.
|
|
9575
9581
|
*/
|
|
9576
9582
|
classification?: AgentClassification | null;
|
|
9583
|
+
/**
|
|
9584
|
+
* Classifications
|
|
9585
|
+
*
|
|
9586
|
+
* The default account for each entity's bank lines, one per entity.
|
|
9587
|
+
*/
|
|
9588
|
+
classifications?: Array<AgentClassification>;
|
|
9577
9589
|
/**
|
|
9578
9590
|
* Created At
|
|
9579
9591
|
*/
|
|
@@ -10242,14 +10254,12 @@ export type LinkBankAccountResponse = {
|
|
|
10242
10254
|
*
|
|
10243
10255
|
* Link an entity to a taxonomy (creates the ENTITY_HAS_TAXONOMY edge).
|
|
10244
10256
|
*
|
|
10245
|
-
*
|
|
10246
|
-
*
|
|
10247
|
-
* the
|
|
10248
|
-
*
|
|
10249
|
-
*
|
|
10250
|
-
*
|
|
10251
|
-
* CoA, link a reporting extension, or attach a custom ontology
|
|
10252
|
-
* explicitly.
|
|
10257
|
+
* A `chart_of_accounts` link tells the platform which chart the entity
|
|
10258
|
+
* keeps its books in; CoA blocks auto-link at create time, so use this to
|
|
10259
|
+
* switch the primary one. The other bases record the association and
|
|
10260
|
+
* nothing reads them: statements render from the entity's reporting style,
|
|
10261
|
+
* whatever taxonomy is linked. Idempotent — re-linking returns the
|
|
10262
|
+
* existing edge unchanged.
|
|
10253
10263
|
*/
|
|
10254
10264
|
export type LinkEntityTaxonomyRequest = {
|
|
10255
10265
|
/**
|
|
@@ -10267,7 +10277,7 @@ export type LinkEntityTaxonomyRequest = {
|
|
|
10267
10277
|
/**
|
|
10268
10278
|
* Basis
|
|
10269
10279
|
*
|
|
10270
|
-
* Linkage role: `chart_of_accounts` (the entity's CoA), `reporting` (reporting standard
|
|
10280
|
+
* Linkage role: `chart_of_accounts` (the entity's CoA), `reporting` (a reporting standard), `mapping` (CoA→reporting rollup), `schedule` (schedule structure). Only `chart_of_accounts` is read; the others are recorded and do not change how statements render.
|
|
10271
10281
|
*/
|
|
10272
10282
|
basis?: 'reporting' | 'chart_of_accounts' | 'mapping' | 'schedule';
|
|
10273
10283
|
/**
|
|
@@ -15823,6 +15833,12 @@ export type PreviewConsolidationEntriesResponse = {
|
|
|
15823
15833
|
* True when the consolidation entity has closed the month: its entries are as posted, and nothing is recomputed.
|
|
15824
15834
|
*/
|
|
15825
15835
|
closed?: boolean;
|
|
15836
|
+
/**
|
|
15837
|
+
* Incomplete
|
|
15838
|
+
*
|
|
15839
|
+
* True when the engine left an entry out — a member's books it cannot read, an account the consolidation entity lacks; `notes` says which. The group close waits on it whatever the residuals.
|
|
15840
|
+
*/
|
|
15841
|
+
incomplete?: boolean;
|
|
15826
15842
|
/**
|
|
15827
15843
|
* Drafted Entry Ids
|
|
15828
15844
|
*
|
|
@@ -21059,6 +21075,12 @@ export type UpdateAgentRequest = {
|
|
|
21059
21075
|
* `suggest` offers the default on each line; `always_ask` offers none, for a counterparty whose lines go to different accounts. Omit to keep.
|
|
21060
21076
|
*/
|
|
21061
21077
|
classification_mode?: 'suggest' | 'always_ask' | null;
|
|
21078
|
+
/**
|
|
21079
|
+
* Classification Entity Id
|
|
21080
|
+
*
|
|
21081
|
+
* The entity whose bank lines the default above is for. Each entity keeps its own default, on its own chart. Omit for the group parent.
|
|
21082
|
+
*/
|
|
21083
|
+
classification_entity_id?: string | null;
|
|
21062
21084
|
/**
|
|
21063
21085
|
* Metadata Patch
|
|
21064
21086
|
*
|