Magidoc

Reconciliation
Object

Fields

#

_id

ID !
Non-null

workspaceId

ID !
Non-null

accountId

ID !
Non-null

glCompanyId

Whose books this statement is reconciled in. Null when the workspace has provisioned no GL companies.

bankFeedSource

statementStart

Non-null

statementEnd

Non-null

beginningBalance

Non-null

endingBalance

Non-null

status

Non-null

finalizedAt

finalizedBy

lockedLineIds

[ID !]

clearedLineCount

Cleared and total statement lines, over the same population getReconciliationSummary counts — every ReconciliationLine the statement holds. Projected by the list read alongside the two line views above, and null everywhere those are: matching stamps a bank line with the book line's journalLineId, so a matched line appears in both views and neither view's length (nor their sum) is the line count. The list used to count its book lines alone and read "0 of 0 book lines cleared" beside a detail page reading "Cleared lines 0 of 2" for the same statement.

totalLineCount

clearedBankLineCount

How many of the statement's lines are a bank line that has been cleared — a bank arrival the statement accounted for, rather than one still sitting on it.

The one fact a reconciliation's own claim rests on, which neither count above can answer and the bankLines array cannot either: finalizeReconciliation refuses only an unbalanced statement, so a statement can balance on cleared book lines alone while uncleared bank lines sit beside them (this read labels those lines "exception"). A register reading the array's length called such a statement reconciled on the strength of the very lines nobody had cleared.

Null exactly where the counts above are.

clearedBalance

Two of the three figures that make a statement a reconciliation, as the list read states them: the beginning balance plus everything cleared, and that balance less the statement's own ending balance. The endingBalance field above is the third, so a row can show cleared against statement and the difference between them without opening the statement — the register used to publish the statement's movement alone, and no row on it could say whether an account had reconciled.

Both null together, and only where they were not measured: a statement whose balances and cleared lines do not share one money unit has no figure to state — getReconciliationSummary refuses to add them — and the read that names every statement in the workspace must not fail over one. Null everywhere the line views and the counts above are, for the same reason: the mutations return the statement they wrote, not a measurement of it.

difference

createdAt

Non-null

modifiedAt

Non-null

createdBy

ID !
Non-null

modifiedBy

ID !
Non-null

Usages

#

References

#

  • Field getReconciliations from Query
  • Field createOpeningReconciliation from Mutation