POST
Auto-match bank statement
Organization space Accounting module For: Accountant · Permission: bank_statements.match 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 statement must still be open; a reconciled statement is refused.
What else happens
  • Creates one match per statement line that finds a counterpart, each linking one statement line to one book line; lines already matched are left alone.
  • A pair is formed only when the amount and the direction are identical and the dates are at most 5 days apart; book lines are read from 5 days before the statement start to 5 days after its end, oldest first on both sides.
  • Statement lines with no counterpart stay unmatched and no error is returned for them; an empty list is returned when nothing matches.
  • Book lines of a carry-forward restatement are never used. No journal entry is created.
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 auto-match (27-character KSUID string).

Query Parameters

response
enum<string>
default:none

Response mode. Default none; none answers 204 No Content.

Available options:
none,
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, bank_statement_id, created_by, created_by_type, created_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: statementLines, journalLines, journalLines.account.

Response

Resource (only with response=resource).

data
BankMatchResource · object[]
required

Items of this page.