GET
Open reconciliation workspace
Organization space Accounting module For: Accountant · Permission: bank_statements.retrieve Conditions
  • The accounting module must be active for the organization.
  • The caller must have been granted access to the book in the URL.
  • Only the organization’s own book is accepted; a company book or a client book is refused.
  • The book side (unmatched_journal_lines and the book balance) is returned only to callers with the permission journal_entries.retrieve; without it those parts are left out.
Part of Reconcile bank statements.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

bankStatement
string
required

Identifier of the book segment of the URL (the organization's book); see book.

bank_statement
string
required

Identifier of the bank statement to work on (27-character KSUID string).

Query Parameters

per_page
integer | null

Number of items per page.

Required range: 1 <= x <= 100
statement_cursor
string | null

Cursor of the page of unmatched statement lines. Pass the meta.next_cursor or meta.prev_cursor of unmatched_statement_lines; leave out for the first page.

journal_cursor
string | null

Cursor of the page of unmatched book lines. Pass the meta.next_cursor or meta.prev_cursor of unmatched_journal_lines; leave out for the first page.

Response

statement
object
required

The bank statement being reconciled.

unmatched_statement_lines
object
required

One page of the statement lines not yet matched, oldest first.

unmatched_journal_lines
object
required

One page of the unmatched book lines of the money account, up to the statement end date, oldest first. Present only for callers with the permission journal_entries.retrieve.

summary
object
required

Reconciliation figures of the statement, all integers in minor units.