@robosystems/client 2.11.1 → 2.11.3
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 +8 -0
- package/artifacts/LedgerClient.js +23 -0
- package/artifacts/LedgerClient.ts +36 -0
- package/artifacts/graphql/generated/graphql.d.ts +31 -0
- package/artifacts/graphql/generated/graphql.js +48 -0
- package/artifacts/graphql/generated/graphql.ts +79 -0
- package/artifacts/graphql/queries/ledger/eventBlock.js +1 -0
- package/artifacts/graphql/queries/ledger/eventBlock.ts +1 -0
- package/artifacts/graphql/queries/ledger/eventBlocks.js +1 -0
- package/artifacts/graphql/queries/ledger/eventBlocks.ts +1 -0
- package/artifacts/graphql/queries/ledger/reconciliations.d.ts +4 -0
- package/artifacts/graphql/queries/ledger/reconciliations.js +33 -0
- package/artifacts/graphql/queries/ledger/reconciliations.ts +33 -0
- package/index.ts +1 -1
- package/package.json +1 -1
- package/sdk/index.d.ts +1 -1
- package/sdk/index.ts +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 +121 -8
- package/sdk/types.gen.ts +122 -8
- package/sdk.gen.d.ts +3 -3
- package/sdk.gen.js +3 -3
- package/sdk.gen.ts +3 -3
- package/types.gen.d.ts +121 -8
- package/types.gen.ts +122 -8
package/sdk/types.gen.ts
CHANGED
|
@@ -14708,7 +14708,7 @@ export type PreviewReconciliationsRequest = {
|
|
|
14708
14708
|
/**
|
|
14709
14709
|
* Method
|
|
14710
14710
|
*
|
|
14711
|
-
* Which check to preview. `source_ledger` compares every account with the synced accounting system's own trial balance. `schedule_register` compares each asset account a schedule carries a balance on with what its schedules say it holds. `statement` compares each account that has a statement
|
|
14711
|
+
* Which check to preview. `source_ledger` compares every account with the synced accounting system's own trial balance. `schedule_register` compares each asset account a schedule carries a balance on with what its schedules say it holds. `statement` compares each account that has a statement covering the period with that balance, adjusted on a bank-fed account by the lines the bank had not cleared.
|
|
14712
14712
|
*/
|
|
14713
14713
|
method?: 'source_ledger' | 'schedule_register' | 'statement';
|
|
14714
14714
|
/**
|
|
@@ -15123,13 +15123,14 @@ export type RebuildScheduleRequest = {
|
|
|
15123
15123
|
* ReconciliationComponent
|
|
15124
15124
|
*
|
|
15125
15125
|
* One part of an account's independent balance: what a single schedule
|
|
15126
|
-
* says the account carries,
|
|
15126
|
+
* says the account carries, a recorded statement balance, or a ledger line
|
|
15127
|
+
* outstanding at the statement's date.
|
|
15127
15128
|
*/
|
|
15128
15129
|
export type ReconciliationComponent = {
|
|
15129
15130
|
/**
|
|
15130
15131
|
* Name
|
|
15131
15132
|
*
|
|
15132
|
-
* The schedule's name,
|
|
15133
|
+
* The schedule's name, the statement and its date, or the outstanding line's description.
|
|
15133
15134
|
*/
|
|
15134
15135
|
name: string;
|
|
15135
15136
|
/**
|
|
@@ -15138,6 +15139,24 @@ export type ReconciliationComponent = {
|
|
|
15138
15139
|
* What this part says the account holds, debit-positive.
|
|
15139
15140
|
*/
|
|
15140
15141
|
amount: number;
|
|
15142
|
+
/**
|
|
15143
|
+
* Kind
|
|
15144
|
+
*
|
|
15145
|
+
* `schedule`, `statement`, or `outstanding`: a ledger line on a bank-fed account that did not come from the feed, dated on or before the statement, so the bank had not cleared it.
|
|
15146
|
+
*/
|
|
15147
|
+
kind?: string | null;
|
|
15148
|
+
/**
|
|
15149
|
+
* Posting Date
|
|
15150
|
+
*
|
|
15151
|
+
* An `outstanding` line's posting date.
|
|
15152
|
+
*/
|
|
15153
|
+
posting_date?: string | null;
|
|
15154
|
+
/**
|
|
15155
|
+
* Entry Id
|
|
15156
|
+
*
|
|
15157
|
+
* The journal entry an `outstanding` line belongs to.
|
|
15158
|
+
*/
|
|
15159
|
+
entry_id?: string | null;
|
|
15141
15160
|
/**
|
|
15142
15161
|
* Structure Id
|
|
15143
15162
|
*
|
|
@@ -15147,7 +15166,7 @@ export type ReconciliationComponent = {
|
|
|
15147
15166
|
/**
|
|
15148
15167
|
* Event Id
|
|
15149
15168
|
*
|
|
15150
|
-
* The recorded balance, for a `statement` part.
|
|
15169
|
+
* The recorded balance, for a `statement` part; the event behind an `outstanding` line, when it has one.
|
|
15151
15170
|
*/
|
|
15152
15171
|
event_id?: string | null;
|
|
15153
15172
|
/**
|
|
@@ -15253,6 +15272,12 @@ export type ReconciliationMechanics = {
|
|
|
15253
15272
|
* Whether the person who signs off must be someone other than the person who ran the comparison.
|
|
15254
15273
|
*/
|
|
15255
15274
|
separate_reviewer?: boolean;
|
|
15275
|
+
/**
|
|
15276
|
+
* Statement Cycle
|
|
15277
|
+
*
|
|
15278
|
+
* `statement` blocks only: how often the account's statement is issued; unset is monthly. A period is covered by the latest statement ending within the cycle that ends with it.
|
|
15279
|
+
*/
|
|
15280
|
+
statement_cycle?: 'monthly' | 'quarterly' | 'annual' | null;
|
|
15256
15281
|
};
|
|
15257
15282
|
|
|
15258
15283
|
/**
|
|
@@ -15281,6 +15306,12 @@ export type ReconciliationPolicyResponse = {
|
|
|
15281
15306
|
* Separate Reviewer
|
|
15282
15307
|
*/
|
|
15283
15308
|
separate_reviewer: boolean;
|
|
15309
|
+
/**
|
|
15310
|
+
* Statement Cycle
|
|
15311
|
+
*
|
|
15312
|
+
* `statement` blocks only: how often the statement is issued.
|
|
15313
|
+
*/
|
|
15314
|
+
statement_cycle?: 'monthly' | 'quarterly' | 'annual' | null;
|
|
15284
15315
|
};
|
|
15285
15316
|
|
|
15286
15317
|
/**
|
|
@@ -15363,6 +15394,69 @@ export type ReconciliationPreviewResponse = {
|
|
|
15363
15394
|
notes?: Array<string>;
|
|
15364
15395
|
};
|
|
15365
15396
|
|
|
15397
|
+
/**
|
|
15398
|
+
* ReconciliationRollForward
|
|
15399
|
+
*
|
|
15400
|
+
* A statement carried from its ending date to the period's last day on a
|
|
15401
|
+
* bank-fed account, where every line the feed brought is the bank's own.
|
|
15402
|
+
*/
|
|
15403
|
+
export type ReconciliationRollForward = {
|
|
15404
|
+
/**
|
|
15405
|
+
* Statement As Of
|
|
15406
|
+
*
|
|
15407
|
+
* The statement's ending date.
|
|
15408
|
+
*/
|
|
15409
|
+
statement_as_of: string;
|
|
15410
|
+
/**
|
|
15411
|
+
* Through
|
|
15412
|
+
*
|
|
15413
|
+
* The period's last day.
|
|
15414
|
+
*/
|
|
15415
|
+
through: string;
|
|
15416
|
+
/**
|
|
15417
|
+
* Bank Lines
|
|
15418
|
+
*
|
|
15419
|
+
* Booked feed lines dated after the statement, to the period end.
|
|
15420
|
+
*/
|
|
15421
|
+
bank_lines: number;
|
|
15422
|
+
/**
|
|
15423
|
+
* Bank Activity
|
|
15424
|
+
*
|
|
15425
|
+
* Their net effect on the account, debit-positive.
|
|
15426
|
+
*/
|
|
15427
|
+
bank_activity: number;
|
|
15428
|
+
/**
|
|
15429
|
+
* Bank Balance
|
|
15430
|
+
*
|
|
15431
|
+
* The statement balance carried to the period end by those lines: what the bank held then, debit-positive.
|
|
15432
|
+
*/
|
|
15433
|
+
bank_balance: number;
|
|
15434
|
+
/**
|
|
15435
|
+
* Ledger Balance
|
|
15436
|
+
*
|
|
15437
|
+
* The ledger's balance at the period end, as the close will leave it, debit-positive.
|
|
15438
|
+
*/
|
|
15439
|
+
ledger_balance: number;
|
|
15440
|
+
/**
|
|
15441
|
+
* Outstanding
|
|
15442
|
+
*
|
|
15443
|
+
* Ledger lines not from the feed and dated on or before the period end, net: the ledger minus the carried bank balance.
|
|
15444
|
+
*/
|
|
15445
|
+
outstanding: number;
|
|
15446
|
+
/**
|
|
15447
|
+
* Feed Balance
|
|
15448
|
+
*
|
|
15449
|
+
* A cross-check, never the figure reconciled: the bank feed's own balance from the first reading on or after the period end, less the booked feed lines between the period end and that reading. Null when the feed has no reading within ten days.
|
|
15450
|
+
*/
|
|
15451
|
+
feed_balance?: number | null;
|
|
15452
|
+
/**
|
|
15453
|
+
* Feed Balance Read On
|
|
15454
|
+
*
|
|
15455
|
+
* The day of the feed reading `feed_balance` starts from.
|
|
15456
|
+
*/
|
|
15457
|
+
feed_balance_read_on?: string | null;
|
|
15458
|
+
};
|
|
15459
|
+
|
|
15366
15460
|
/**
|
|
15367
15461
|
* ReconciliationRow
|
|
15368
15462
|
*
|
|
@@ -15410,7 +15504,7 @@ export type ReconciliationRow = {
|
|
|
15410
15504
|
/**
|
|
15411
15505
|
* Independent Balance
|
|
15412
15506
|
*
|
|
15413
|
-
* What the independent source says.
|
|
15507
|
+
* What the independent source says. For a `statement` on a bank-fed account, the statement balance adjusted by its outstanding lines.
|
|
15414
15508
|
*/
|
|
15415
15509
|
independent_balance: number;
|
|
15416
15510
|
/**
|
|
@@ -15434,9 +15528,13 @@ export type ReconciliationRow = {
|
|
|
15434
15528
|
/**
|
|
15435
15529
|
* Components
|
|
15436
15530
|
*
|
|
15437
|
-
* Account-scope methods only: what makes up the independent balance. One entry per schedule for `schedule_register`; the recorded statement for `statement
|
|
15531
|
+
* Account-scope methods only: what makes up the independent balance. One entry per schedule for `schedule_register`; the recorded statement for `statement`, then each outstanding line.
|
|
15438
15532
|
*/
|
|
15439
15533
|
components?: Array<ReconciliationComponent>;
|
|
15534
|
+
/**
|
|
15535
|
+
* `statement` on a bank-fed account whose statement ends before the period's last day: the statement carried to it by the feed's lines.
|
|
15536
|
+
*/
|
|
15537
|
+
roll_forward?: ReconciliationRollForward | null;
|
|
15440
15538
|
};
|
|
15441
15539
|
|
|
15442
15540
|
/**
|
|
@@ -15487,6 +15585,12 @@ export type ReconciliationSummary = {
|
|
|
15487
15585
|
* A difference up to this amount still counts as reconciled.
|
|
15488
15586
|
*/
|
|
15489
15587
|
materiality: number;
|
|
15588
|
+
/**
|
|
15589
|
+
* Statement Cycle
|
|
15590
|
+
*
|
|
15591
|
+
* `statement` blocks only: how often the account's statement is issued, `monthly`, `quarterly` or `annual`.
|
|
15592
|
+
*/
|
|
15593
|
+
statement_cycle?: string | null;
|
|
15490
15594
|
/**
|
|
15491
15595
|
* Period
|
|
15492
15596
|
*
|
|
@@ -15538,15 +15642,19 @@ export type ReconciliationSummary = {
|
|
|
15538
15642
|
/**
|
|
15539
15643
|
* Balance As Of
|
|
15540
15644
|
*
|
|
15541
|
-
* Account-scope only: the date the two balances are stated at. The period's last day, unless
|
|
15645
|
+
* Account-scope only: the date the two balances are stated at. The period's last day, unless the statement covering it ended earlier.
|
|
15542
15646
|
*/
|
|
15543
15647
|
balance_as_of?: string | null;
|
|
15544
15648
|
/**
|
|
15545
15649
|
* Components
|
|
15546
15650
|
*
|
|
15547
|
-
* Account-scope only: what makes up the independent balance. One entry per schedule for `schedule_register`; the recorded statement for `statement
|
|
15651
|
+
* Account-scope only: what makes up the independent balance. One entry per schedule for `schedule_register`; the recorded statement for `statement`, then each outstanding line.
|
|
15548
15652
|
*/
|
|
15549
15653
|
components?: Array<ReconciliationComponent>;
|
|
15654
|
+
/**
|
|
15655
|
+
* `statement` on a bank-fed account whose statement ends before the period's last day: the statement carried to it by the feed's lines.
|
|
15656
|
+
*/
|
|
15657
|
+
roll_forward?: ReconciliationRollForward | null;
|
|
15550
15658
|
/**
|
|
15551
15659
|
* Source
|
|
15552
15660
|
*
|
|
@@ -17877,6 +17985,12 @@ export type SetReconciliationPolicyRequest = {
|
|
|
17877
17985
|
* Whether the person who signs off must be someone other than the person who ran the comparison. It can only be turned on when the graph has at least two members who can write. Omit to keep.
|
|
17878
17986
|
*/
|
|
17879
17987
|
separate_reviewer?: boolean | null;
|
|
17988
|
+
/**
|
|
17989
|
+
* Statement Cycle
|
|
17990
|
+
*
|
|
17991
|
+
* `statement` blocks only: how often the account's statement is issued. A period is covered by the latest statement ending within the cycle that ends with it, so a quarterly statement covers the two months before the next one. Omit to keep.
|
|
17992
|
+
*/
|
|
17993
|
+
statement_cycle?: 'monthly' | 'quarterly' | 'annual' | null;
|
|
17880
17994
|
};
|
|
17881
17995
|
|
|
17882
17996
|
/**
|
package/sdk.gen.d.ts
CHANGED
|
@@ -1110,7 +1110,7 @@ export declare const previewReconciliations: <ThrowOnError extends boolean = fal
|
|
|
1110
1110
|
/**
|
|
1111
1111
|
* Refresh Reconciliations
|
|
1112
1112
|
*
|
|
1113
|
-
* Run every reconciliation that applies at a period end and record each result on its block. A ledger synced from QuickBooks is compared with QuickBooks' own trial balance, on one block for the whole ledger. Each asset account a schedule carries a balance on is compared with what its schedules say it holds, on a block of its own. Each account with a statement
|
|
1113
|
+
* Run every reconciliation that applies at a period end and record each result on its block. A ledger synced from QuickBooks is compared with QuickBooks' own trial balance, on one block for the whole ledger. Each asset account a schedule carries a balance on is compared with what its schedules say it holds, on a block of its own. Each account with a statement covering the period (record-statement-balance; the latest within its statement cycle) is compared with that balance. A block reconciles for the period when its difference is within its materiality. Running it again replaces the period's comparison, so the answer is always as of the last run. A block is created the first time its check applies, and from then on the period's close waits on it until set-reconciliation-policy releases it. The one exception is an account block whose first comparison does not tie: it is created without holding the close, so a difference found on first contact is reported and becomes a close requirement only when you turn it on. Returns every reconciliation's standing for the period. Use preview-reconciliations to see a comparison without recording it.
|
|
1114
1114
|
*
|
|
1115
1115
|
* **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.
|
|
1116
1116
|
*/
|
|
@@ -1118,7 +1118,7 @@ export declare const refreshReconciliations: <ThrowOnError extends boolean = fal
|
|
|
1118
1118
|
/**
|
|
1119
1119
|
* Record Statement Balance
|
|
1120
1120
|
*
|
|
1121
|
-
* Record the ending balance of a statement (a bank, card or loan statement) for one balance-sheet account, and reconcile the account to it. Give the balance as the statement shows it, as a positive number in the account's normal direction, with the statement's ending date. The ledger's balance at that date is set beside it, counting the drafts the close will post, and the result is recorded on the account's statement reconciliation for the period the statement ends in. Attach the statement as evidence by passing the `document_id` of its stored file (create-document-upload, then complete-document-upload); recording it again with another document lapses a sign-off. Writes no books. The first statement recorded for an account creates its reconciliation, which does not hold the close: turn `required_for_close` on with set-reconciliation-policy to make every period's close wait for a statement on that account. Recording the same account and date again replaces the earlier balance; when more than one statement ends in a period, the one with the latest date stands. Recording a balance that differs from one already signed off lapses that sign-off. A difference
|
|
1121
|
+
* Record the ending balance of a statement (a bank, card or loan statement) for one balance-sheet account, and reconcile the account to it. Give the balance as the statement shows it, as a positive number in the account's normal direction, with the statement's ending date. The ledger's balance at that date is set beside it, counting the drafts the close will post, and the result is recorded on the account's statement reconciliation for the period the statement ends in. On an account a bank feed keeps, ledger lines that did not come from the feed and are dated on or before the statement are listed as outstanding and adjust the statement balance, since the bank had not cleared them; a statement ending before the period's last day is carried to it by the feed's own lines (`roll_forward`). Attach the statement as evidence by passing the `document_id` of its stored file (create-document-upload, then complete-document-upload); recording it again with another document lapses a sign-off. Writes no books. The first statement recorded for an account creates its reconciliation, which does not hold the close: turn `required_for_close` on with set-reconciliation-policy to make every period's close wait for a statement on that account. Recording the same account and date again replaces the earlier balance; when more than one statement ends in a period, the one with the latest date stands. Recording a balance that differs from one already signed off lapses that sign-off. A difference left after the outstanding lines is activity one side has and the other does not yet, or an error on either. Returns the reconciliation's standing for the period.
|
|
1122
1122
|
*
|
|
1123
1123
|
* **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.
|
|
1124
1124
|
*/
|
|
@@ -1126,7 +1126,7 @@ export declare const recordStatementBalance: <ThrowOnError extends boolean = fal
|
|
|
1126
1126
|
/**
|
|
1127
1127
|
* Set Reconciliation Policy
|
|
1128
1128
|
*
|
|
1129
|
-
* Change how much the close cares about one reconciliation: whether the period's close waits on it (`required_for_close`); its `materiality`, the difference up to which it still counts as reconciled; whether the close also waits for a sign-off (`review_required`); and whether the reviewer must be someone other than the person who ran the comparison (`separate_reviewer`, which can only be turned on while the graph has at least two members who can write; if it later has one, turn it off or add a member). Omitted fields keep their value. The next refresh-reconciliations uses the new materiality; comparisons already recorded are not re-judged.
|
|
1129
|
+
* Change how much the close cares about one reconciliation: whether the period's close waits on it (`required_for_close`); its `materiality`, the difference up to which it still counts as reconciled; whether the close also waits for a sign-off (`review_required`); and whether the reviewer must be someone other than the person who ran the comparison (`separate_reviewer`, which can only be turned on while the graph has at least two members who can write; if it later has one, turn it off or add a member). For a statement reconciliation, `statement_cycle` says how often the statement is issued (monthly, quarterly or annual): a period is covered by the latest statement ending within the cycle that ends with it, so a quarterly statement still covers the months between statements. Omitted fields keep their value. The next refresh-reconciliations uses the new materiality; comparisons already recorded are not re-judged.
|
|
1130
1130
|
*
|
|
1131
1131
|
* **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.
|
|
1132
1132
|
*/
|
package/sdk.gen.js
CHANGED
|
@@ -2283,7 +2283,7 @@ exports.previewReconciliations = previewReconciliations;
|
|
|
2283
2283
|
/**
|
|
2284
2284
|
* Refresh Reconciliations
|
|
2285
2285
|
*
|
|
2286
|
-
* Run every reconciliation that applies at a period end and record each result on its block. A ledger synced from QuickBooks is compared with QuickBooks' own trial balance, on one block for the whole ledger. Each asset account a schedule carries a balance on is compared with what its schedules say it holds, on a block of its own. Each account with a statement
|
|
2286
|
+
* Run every reconciliation that applies at a period end and record each result on its block. A ledger synced from QuickBooks is compared with QuickBooks' own trial balance, on one block for the whole ledger. Each asset account a schedule carries a balance on is compared with what its schedules say it holds, on a block of its own. Each account with a statement covering the period (record-statement-balance; the latest within its statement cycle) is compared with that balance. A block reconciles for the period when its difference is within its materiality. Running it again replaces the period's comparison, so the answer is always as of the last run. A block is created the first time its check applies, and from then on the period's close waits on it until set-reconciliation-policy releases it. The one exception is an account block whose first comparison does not tie: it is created without holding the close, so a difference found on first contact is reported and becomes a close requirement only when you turn it on. Returns every reconciliation's standing for the period. Use preview-reconciliations to see a comparison without recording it.
|
|
2287
2287
|
*
|
|
2288
2288
|
* **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.
|
|
2289
2289
|
*/
|
|
@@ -2300,7 +2300,7 @@ exports.refreshReconciliations = refreshReconciliations;
|
|
|
2300
2300
|
/**
|
|
2301
2301
|
* Record Statement Balance
|
|
2302
2302
|
*
|
|
2303
|
-
* Record the ending balance of a statement (a bank, card or loan statement) for one balance-sheet account, and reconcile the account to it. Give the balance as the statement shows it, as a positive number in the account's normal direction, with the statement's ending date. The ledger's balance at that date is set beside it, counting the drafts the close will post, and the result is recorded on the account's statement reconciliation for the period the statement ends in. Attach the statement as evidence by passing the `document_id` of its stored file (create-document-upload, then complete-document-upload); recording it again with another document lapses a sign-off. Writes no books. The first statement recorded for an account creates its reconciliation, which does not hold the close: turn `required_for_close` on with set-reconciliation-policy to make every period's close wait for a statement on that account. Recording the same account and date again replaces the earlier balance; when more than one statement ends in a period, the one with the latest date stands. Recording a balance that differs from one already signed off lapses that sign-off. A difference
|
|
2303
|
+
* Record the ending balance of a statement (a bank, card or loan statement) for one balance-sheet account, and reconcile the account to it. Give the balance as the statement shows it, as a positive number in the account's normal direction, with the statement's ending date. The ledger's balance at that date is set beside it, counting the drafts the close will post, and the result is recorded on the account's statement reconciliation for the period the statement ends in. On an account a bank feed keeps, ledger lines that did not come from the feed and are dated on or before the statement are listed as outstanding and adjust the statement balance, since the bank had not cleared them; a statement ending before the period's last day is carried to it by the feed's own lines (`roll_forward`). Attach the statement as evidence by passing the `document_id` of its stored file (create-document-upload, then complete-document-upload); recording it again with another document lapses a sign-off. Writes no books. The first statement recorded for an account creates its reconciliation, which does not hold the close: turn `required_for_close` on with set-reconciliation-policy to make every period's close wait for a statement on that account. Recording the same account and date again replaces the earlier balance; when more than one statement ends in a period, the one with the latest date stands. Recording a balance that differs from one already signed off lapses that sign-off. A difference left after the outstanding lines is activity one side has and the other does not yet, or an error on either. Returns the reconciliation's standing for the period.
|
|
2304
2304
|
*
|
|
2305
2305
|
* **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.
|
|
2306
2306
|
*/
|
|
@@ -2317,7 +2317,7 @@ exports.recordStatementBalance = recordStatementBalance;
|
|
|
2317
2317
|
/**
|
|
2318
2318
|
* Set Reconciliation Policy
|
|
2319
2319
|
*
|
|
2320
|
-
* Change how much the close cares about one reconciliation: whether the period's close waits on it (`required_for_close`); its `materiality`, the difference up to which it still counts as reconciled; whether the close also waits for a sign-off (`review_required`); and whether the reviewer must be someone other than the person who ran the comparison (`separate_reviewer`, which can only be turned on while the graph has at least two members who can write; if it later has one, turn it off or add a member). Omitted fields keep their value. The next refresh-reconciliations uses the new materiality; comparisons already recorded are not re-judged.
|
|
2320
|
+
* Change how much the close cares about one reconciliation: whether the period's close waits on it (`required_for_close`); its `materiality`, the difference up to which it still counts as reconciled; whether the close also waits for a sign-off (`review_required`); and whether the reviewer must be someone other than the person who ran the comparison (`separate_reviewer`, which can only be turned on while the graph has at least two members who can write; if it later has one, turn it off or add a member). For a statement reconciliation, `statement_cycle` says how often the statement is issued (monthly, quarterly or annual): a period is covered by the latest statement ending within the cycle that ends with it, so a quarterly statement still covers the months between statements. Omitted fields keep their value. The next refresh-reconciliations uses the new materiality; comparisons already recorded are not re-judged.
|
|
2321
2321
|
*
|
|
2322
2322
|
* **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.
|
|
2323
2323
|
*/
|
package/sdk.gen.ts
CHANGED
|
@@ -2294,7 +2294,7 @@ export const previewReconciliations = <ThrowOnError extends boolean = false>(opt
|
|
|
2294
2294
|
/**
|
|
2295
2295
|
* Refresh Reconciliations
|
|
2296
2296
|
*
|
|
2297
|
-
* Run every reconciliation that applies at a period end and record each result on its block. A ledger synced from QuickBooks is compared with QuickBooks' own trial balance, on one block for the whole ledger. Each asset account a schedule carries a balance on is compared with what its schedules say it holds, on a block of its own. Each account with a statement
|
|
2297
|
+
* Run every reconciliation that applies at a period end and record each result on its block. A ledger synced from QuickBooks is compared with QuickBooks' own trial balance, on one block for the whole ledger. Each asset account a schedule carries a balance on is compared with what its schedules say it holds, on a block of its own. Each account with a statement covering the period (record-statement-balance; the latest within its statement cycle) is compared with that balance. A block reconciles for the period when its difference is within its materiality. Running it again replaces the period's comparison, so the answer is always as of the last run. A block is created the first time its check applies, and from then on the period's close waits on it until set-reconciliation-policy releases it. The one exception is an account block whose first comparison does not tie: it is created without holding the close, so a difference found on first contact is reported and becomes a close requirement only when you turn it on. Returns every reconciliation's standing for the period. Use preview-reconciliations to see a comparison without recording it.
|
|
2298
2298
|
*
|
|
2299
2299
|
* **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.
|
|
2300
2300
|
*/
|
|
@@ -2311,7 +2311,7 @@ export const refreshReconciliations = <ThrowOnError extends boolean = false>(opt
|
|
|
2311
2311
|
/**
|
|
2312
2312
|
* Record Statement Balance
|
|
2313
2313
|
*
|
|
2314
|
-
* Record the ending balance of a statement (a bank, card or loan statement) for one balance-sheet account, and reconcile the account to it. Give the balance as the statement shows it, as a positive number in the account's normal direction, with the statement's ending date. The ledger's balance at that date is set beside it, counting the drafts the close will post, and the result is recorded on the account's statement reconciliation for the period the statement ends in. Attach the statement as evidence by passing the `document_id` of its stored file (create-document-upload, then complete-document-upload); recording it again with another document lapses a sign-off. Writes no books. The first statement recorded for an account creates its reconciliation, which does not hold the close: turn `required_for_close` on with set-reconciliation-policy to make every period's close wait for a statement on that account. Recording the same account and date again replaces the earlier balance; when more than one statement ends in a period, the one with the latest date stands. Recording a balance that differs from one already signed off lapses that sign-off. A difference
|
|
2314
|
+
* Record the ending balance of a statement (a bank, card or loan statement) for one balance-sheet account, and reconcile the account to it. Give the balance as the statement shows it, as a positive number in the account's normal direction, with the statement's ending date. The ledger's balance at that date is set beside it, counting the drafts the close will post, and the result is recorded on the account's statement reconciliation for the period the statement ends in. On an account a bank feed keeps, ledger lines that did not come from the feed and are dated on or before the statement are listed as outstanding and adjust the statement balance, since the bank had not cleared them; a statement ending before the period's last day is carried to it by the feed's own lines (`roll_forward`). Attach the statement as evidence by passing the `document_id` of its stored file (create-document-upload, then complete-document-upload); recording it again with another document lapses a sign-off. Writes no books. The first statement recorded for an account creates its reconciliation, which does not hold the close: turn `required_for_close` on with set-reconciliation-policy to make every period's close wait for a statement on that account. Recording the same account and date again replaces the earlier balance; when more than one statement ends in a period, the one with the latest date stands. Recording a balance that differs from one already signed off lapses that sign-off. A difference left after the outstanding lines is activity one side has and the other does not yet, or an error on either. Returns the reconciliation's standing for the period.
|
|
2315
2315
|
*
|
|
2316
2316
|
* **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.
|
|
2317
2317
|
*/
|
|
@@ -2328,7 +2328,7 @@ export const recordStatementBalance = <ThrowOnError extends boolean = false>(opt
|
|
|
2328
2328
|
/**
|
|
2329
2329
|
* Set Reconciliation Policy
|
|
2330
2330
|
*
|
|
2331
|
-
* Change how much the close cares about one reconciliation: whether the period's close waits on it (`required_for_close`); its `materiality`, the difference up to which it still counts as reconciled; whether the close also waits for a sign-off (`review_required`); and whether the reviewer must be someone other than the person who ran the comparison (`separate_reviewer`, which can only be turned on while the graph has at least two members who can write; if it later has one, turn it off or add a member). Omitted fields keep their value. The next refresh-reconciliations uses the new materiality; comparisons already recorded are not re-judged.
|
|
2331
|
+
* Change how much the close cares about one reconciliation: whether the period's close waits on it (`required_for_close`); its `materiality`, the difference up to which it still counts as reconciled; whether the close also waits for a sign-off (`review_required`); and whether the reviewer must be someone other than the person who ran the comparison (`separate_reviewer`, which can only be turned on while the graph has at least two members who can write; if it later has one, turn it off or add a member). For a statement reconciliation, `statement_cycle` says how often the statement is issued (monthly, quarterly or annual): a period is covered by the latest statement ending within the cycle that ends with it, so a quarterly statement still covers the months between statements. Omitted fields keep their value. The next refresh-reconciliations uses the new materiality; comparisons already recorded are not re-judged.
|
|
2332
2332
|
*
|
|
2333
2333
|
* **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.
|
|
2334
2334
|
*/
|
package/types.gen.d.ts
CHANGED
|
@@ -14366,7 +14366,7 @@ export type PreviewReconciliationsRequest = {
|
|
|
14366
14366
|
/**
|
|
14367
14367
|
* Method
|
|
14368
14368
|
*
|
|
14369
|
-
* Which check to preview. `source_ledger` compares every account with the synced accounting system's own trial balance. `schedule_register` compares each asset account a schedule carries a balance on with what its schedules say it holds. `statement` compares each account that has a statement
|
|
14369
|
+
* Which check to preview. `source_ledger` compares every account with the synced accounting system's own trial balance. `schedule_register` compares each asset account a schedule carries a balance on with what its schedules say it holds. `statement` compares each account that has a statement covering the period with that balance, adjusted on a bank-fed account by the lines the bank had not cleared.
|
|
14370
14370
|
*/
|
|
14371
14371
|
method?: 'source_ledger' | 'schedule_register' | 'statement';
|
|
14372
14372
|
/**
|
|
@@ -14769,13 +14769,14 @@ export type RebuildScheduleRequest = {
|
|
|
14769
14769
|
* ReconciliationComponent
|
|
14770
14770
|
*
|
|
14771
14771
|
* One part of an account's independent balance: what a single schedule
|
|
14772
|
-
* says the account carries,
|
|
14772
|
+
* says the account carries, a recorded statement balance, or a ledger line
|
|
14773
|
+
* outstanding at the statement's date.
|
|
14773
14774
|
*/
|
|
14774
14775
|
export type ReconciliationComponent = {
|
|
14775
14776
|
/**
|
|
14776
14777
|
* Name
|
|
14777
14778
|
*
|
|
14778
|
-
* The schedule's name,
|
|
14779
|
+
* The schedule's name, the statement and its date, or the outstanding line's description.
|
|
14779
14780
|
*/
|
|
14780
14781
|
name: string;
|
|
14781
14782
|
/**
|
|
@@ -14784,6 +14785,24 @@ export type ReconciliationComponent = {
|
|
|
14784
14785
|
* What this part says the account holds, debit-positive.
|
|
14785
14786
|
*/
|
|
14786
14787
|
amount: number;
|
|
14788
|
+
/**
|
|
14789
|
+
* Kind
|
|
14790
|
+
*
|
|
14791
|
+
* `schedule`, `statement`, or `outstanding`: a ledger line on a bank-fed account that did not come from the feed, dated on or before the statement, so the bank had not cleared it.
|
|
14792
|
+
*/
|
|
14793
|
+
kind?: string | null;
|
|
14794
|
+
/**
|
|
14795
|
+
* Posting Date
|
|
14796
|
+
*
|
|
14797
|
+
* An `outstanding` line's posting date.
|
|
14798
|
+
*/
|
|
14799
|
+
posting_date?: string | null;
|
|
14800
|
+
/**
|
|
14801
|
+
* Entry Id
|
|
14802
|
+
*
|
|
14803
|
+
* The journal entry an `outstanding` line belongs to.
|
|
14804
|
+
*/
|
|
14805
|
+
entry_id?: string | null;
|
|
14787
14806
|
/**
|
|
14788
14807
|
* Structure Id
|
|
14789
14808
|
*
|
|
@@ -14793,7 +14812,7 @@ export type ReconciliationComponent = {
|
|
|
14793
14812
|
/**
|
|
14794
14813
|
* Event Id
|
|
14795
14814
|
*
|
|
14796
|
-
* The recorded balance, for a `statement` part.
|
|
14815
|
+
* The recorded balance, for a `statement` part; the event behind an `outstanding` line, when it has one.
|
|
14797
14816
|
*/
|
|
14798
14817
|
event_id?: string | null;
|
|
14799
14818
|
/**
|
|
@@ -14897,6 +14916,12 @@ export type ReconciliationMechanics = {
|
|
|
14897
14916
|
* Whether the person who signs off must be someone other than the person who ran the comparison.
|
|
14898
14917
|
*/
|
|
14899
14918
|
separate_reviewer?: boolean;
|
|
14919
|
+
/**
|
|
14920
|
+
* Statement Cycle
|
|
14921
|
+
*
|
|
14922
|
+
* `statement` blocks only: how often the account's statement is issued; unset is monthly. A period is covered by the latest statement ending within the cycle that ends with it.
|
|
14923
|
+
*/
|
|
14924
|
+
statement_cycle?: 'monthly' | 'quarterly' | 'annual' | null;
|
|
14900
14925
|
};
|
|
14901
14926
|
/**
|
|
14902
14927
|
* ReconciliationPolicyResponse
|
|
@@ -14924,6 +14949,12 @@ export type ReconciliationPolicyResponse = {
|
|
|
14924
14949
|
* Separate Reviewer
|
|
14925
14950
|
*/
|
|
14926
14951
|
separate_reviewer: boolean;
|
|
14952
|
+
/**
|
|
14953
|
+
* Statement Cycle
|
|
14954
|
+
*
|
|
14955
|
+
* `statement` blocks only: how often the statement is issued.
|
|
14956
|
+
*/
|
|
14957
|
+
statement_cycle?: 'monthly' | 'quarterly' | 'annual' | null;
|
|
14927
14958
|
};
|
|
14928
14959
|
/**
|
|
14929
14960
|
* ReconciliationPreviewResponse
|
|
@@ -15004,6 +15035,68 @@ export type ReconciliationPreviewResponse = {
|
|
|
15004
15035
|
*/
|
|
15005
15036
|
notes?: Array<string>;
|
|
15006
15037
|
};
|
|
15038
|
+
/**
|
|
15039
|
+
* ReconciliationRollForward
|
|
15040
|
+
*
|
|
15041
|
+
* A statement carried from its ending date to the period's last day on a
|
|
15042
|
+
* bank-fed account, where every line the feed brought is the bank's own.
|
|
15043
|
+
*/
|
|
15044
|
+
export type ReconciliationRollForward = {
|
|
15045
|
+
/**
|
|
15046
|
+
* Statement As Of
|
|
15047
|
+
*
|
|
15048
|
+
* The statement's ending date.
|
|
15049
|
+
*/
|
|
15050
|
+
statement_as_of: string;
|
|
15051
|
+
/**
|
|
15052
|
+
* Through
|
|
15053
|
+
*
|
|
15054
|
+
* The period's last day.
|
|
15055
|
+
*/
|
|
15056
|
+
through: string;
|
|
15057
|
+
/**
|
|
15058
|
+
* Bank Lines
|
|
15059
|
+
*
|
|
15060
|
+
* Booked feed lines dated after the statement, to the period end.
|
|
15061
|
+
*/
|
|
15062
|
+
bank_lines: number;
|
|
15063
|
+
/**
|
|
15064
|
+
* Bank Activity
|
|
15065
|
+
*
|
|
15066
|
+
* Their net effect on the account, debit-positive.
|
|
15067
|
+
*/
|
|
15068
|
+
bank_activity: number;
|
|
15069
|
+
/**
|
|
15070
|
+
* Bank Balance
|
|
15071
|
+
*
|
|
15072
|
+
* The statement balance carried to the period end by those lines: what the bank held then, debit-positive.
|
|
15073
|
+
*/
|
|
15074
|
+
bank_balance: number;
|
|
15075
|
+
/**
|
|
15076
|
+
* Ledger Balance
|
|
15077
|
+
*
|
|
15078
|
+
* The ledger's balance at the period end, as the close will leave it, debit-positive.
|
|
15079
|
+
*/
|
|
15080
|
+
ledger_balance: number;
|
|
15081
|
+
/**
|
|
15082
|
+
* Outstanding
|
|
15083
|
+
*
|
|
15084
|
+
* Ledger lines not from the feed and dated on or before the period end, net: the ledger minus the carried bank balance.
|
|
15085
|
+
*/
|
|
15086
|
+
outstanding: number;
|
|
15087
|
+
/**
|
|
15088
|
+
* Feed Balance
|
|
15089
|
+
*
|
|
15090
|
+
* A cross-check, never the figure reconciled: the bank feed's own balance from the first reading on or after the period end, less the booked feed lines between the period end and that reading. Null when the feed has no reading within ten days.
|
|
15091
|
+
*/
|
|
15092
|
+
feed_balance?: number | null;
|
|
15093
|
+
/**
|
|
15094
|
+
* Feed Balance Read On
|
|
15095
|
+
*
|
|
15096
|
+
* The day of the feed reading `feed_balance` starts from.
|
|
15097
|
+
*/
|
|
15098
|
+
feed_balance_read_on?: string | null;
|
|
15099
|
+
};
|
|
15007
15100
|
/**
|
|
15008
15101
|
* ReconciliationRow
|
|
15009
15102
|
*
|
|
@@ -15051,7 +15144,7 @@ export type ReconciliationRow = {
|
|
|
15051
15144
|
/**
|
|
15052
15145
|
* Independent Balance
|
|
15053
15146
|
*
|
|
15054
|
-
* What the independent source says.
|
|
15147
|
+
* What the independent source says. For a `statement` on a bank-fed account, the statement balance adjusted by its outstanding lines.
|
|
15055
15148
|
*/
|
|
15056
15149
|
independent_balance: number;
|
|
15057
15150
|
/**
|
|
@@ -15075,9 +15168,13 @@ export type ReconciliationRow = {
|
|
|
15075
15168
|
/**
|
|
15076
15169
|
* Components
|
|
15077
15170
|
*
|
|
15078
|
-
* Account-scope methods only: what makes up the independent balance. One entry per schedule for `schedule_register`; the recorded statement for `statement
|
|
15171
|
+
* Account-scope methods only: what makes up the independent balance. One entry per schedule for `schedule_register`; the recorded statement for `statement`, then each outstanding line.
|
|
15079
15172
|
*/
|
|
15080
15173
|
components?: Array<ReconciliationComponent>;
|
|
15174
|
+
/**
|
|
15175
|
+
* `statement` on a bank-fed account whose statement ends before the period's last day: the statement carried to it by the feed's lines.
|
|
15176
|
+
*/
|
|
15177
|
+
roll_forward?: ReconciliationRollForward | null;
|
|
15081
15178
|
};
|
|
15082
15179
|
/**
|
|
15083
15180
|
* ReconciliationSummary
|
|
@@ -15127,6 +15224,12 @@ export type ReconciliationSummary = {
|
|
|
15127
15224
|
* A difference up to this amount still counts as reconciled.
|
|
15128
15225
|
*/
|
|
15129
15226
|
materiality: number;
|
|
15227
|
+
/**
|
|
15228
|
+
* Statement Cycle
|
|
15229
|
+
*
|
|
15230
|
+
* `statement` blocks only: how often the account's statement is issued, `monthly`, `quarterly` or `annual`.
|
|
15231
|
+
*/
|
|
15232
|
+
statement_cycle?: string | null;
|
|
15130
15233
|
/**
|
|
15131
15234
|
* Period
|
|
15132
15235
|
*
|
|
@@ -15178,15 +15281,19 @@ export type ReconciliationSummary = {
|
|
|
15178
15281
|
/**
|
|
15179
15282
|
* Balance As Of
|
|
15180
15283
|
*
|
|
15181
|
-
* Account-scope only: the date the two balances are stated at. The period's last day, unless
|
|
15284
|
+
* Account-scope only: the date the two balances are stated at. The period's last day, unless the statement covering it ended earlier.
|
|
15182
15285
|
*/
|
|
15183
15286
|
balance_as_of?: string | null;
|
|
15184
15287
|
/**
|
|
15185
15288
|
* Components
|
|
15186
15289
|
*
|
|
15187
|
-
* Account-scope only: what makes up the independent balance. One entry per schedule for `schedule_register`; the recorded statement for `statement
|
|
15290
|
+
* Account-scope only: what makes up the independent balance. One entry per schedule for `schedule_register`; the recorded statement for `statement`, then each outstanding line.
|
|
15188
15291
|
*/
|
|
15189
15292
|
components?: Array<ReconciliationComponent>;
|
|
15293
|
+
/**
|
|
15294
|
+
* `statement` on a bank-fed account whose statement ends before the period's last day: the statement carried to it by the feed's lines.
|
|
15295
|
+
*/
|
|
15296
|
+
roll_forward?: ReconciliationRollForward | null;
|
|
15190
15297
|
/**
|
|
15191
15298
|
* Source
|
|
15192
15299
|
*
|
|
@@ -17462,6 +17569,12 @@ export type SetReconciliationPolicyRequest = {
|
|
|
17462
17569
|
* Whether the person who signs off must be someone other than the person who ran the comparison. It can only be turned on when the graph has at least two members who can write. Omit to keep.
|
|
17463
17570
|
*/
|
|
17464
17571
|
separate_reviewer?: boolean | null;
|
|
17572
|
+
/**
|
|
17573
|
+
* Statement Cycle
|
|
17574
|
+
*
|
|
17575
|
+
* `statement` blocks only: how often the account's statement is issued. A period is covered by the latest statement ending within the cycle that ends with it, so a quarterly statement covers the two months before the next one. Omit to keep.
|
|
17576
|
+
*/
|
|
17577
|
+
statement_cycle?: 'monthly' | 'quarterly' | 'annual' | null;
|
|
17465
17578
|
};
|
|
17466
17579
|
/**
|
|
17467
17580
|
* SetSelectedGraphRequest
|