POST api/reconciliation/start

Starts or resumes a reconciliation for a system bank account. The previous closing balance must match the submitted opening balance. An existing unlocked, incomplete reconciliation is resumed; a locked reconciliation is rejected. The returned reconciliation is locked to the current user.

Request Information

URI Parameters

None.

Body Parameters

The bank account identifier, statement end date, and opening and closing balances.

GetAccountReconciliationDataContract

Name	Description	Type	Additional information
ExcludeInItems	Indicates whether exclude in items is true.	boolean	None.
ExcludeOutItems	Indicates whether exclude out items is true.	boolean	None.
ExcludeBatchItems	Indicates whether exclude batch items is true.	boolean	None.
EndDate	The end date, expressed as a date and time.	date	None.
OpeningBalance	The opening balance value.	decimal number	None.
ClosingBalance	The closing balance value.	decimal number	None.
ReconciliationId	The unique identifier of the related reconciliation resource.	integer	None.
Id	The unique identifier of this resource.	integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "ExcludeInItems": true,
  "ExcludeOutItems": true,
  "ExcludeBatchItems": true,
  "EndDate": "2026-08-04T22:23:23.9033929Z",
  "OpeningBalance": 5.0,
  "ClosingBalance": 6.0,
  "ReconciliationId": 7,
  "Id": 8
}

Response Information

Resource Description

The active reconciliation locked to the current user.

ReconciliationDataContract

Name	Description	Type	Additional information
StartDate	The start date, expressed as a date and time.	date	None.
EndDate	The end date, expressed as a date and time.	date	None.
OpeningBalance	The opening balance value.	decimal number	None.
ClosingBalance	The closing balance value.	decimal number	None.
BankAccountId	The unique identifier of the related bank account resource.	integer	None.
IsCompleted	Indicates whether this item is completed.	boolean	None.
IsLocked	Indicates whether this item is locked.	boolean	None.
CreatedBy	The created by value.	CreatedBySimpleDataContract	None.
ReconciliationItemIds	The unique identifiers of the related reconciliation item resources.	Collection of integer	None.
UnclearedItemIds	The unique identifiers of the related uncleared item resources.	Collection of integer	None.
SystemStatus	The system status classification.	SystemStatuses	None.
Id	The unique identifier of this resource.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "StartDate": "2026-08-04T22:23:23.9033929Z",
  "EndDate": "2026-08-04T22:23:23.9033929Z",
  "OpeningBalance": 3.0,
  "ClosingBalance": 4.0,
  "BankAccountId": 5,
  "IsCompleted": true,
  "IsLocked": true,
  "CreatedBy": {
    "Initials": "sample string 1",
    "Title": "sample string 2",
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "Id": 5
  },
  "ReconciliationItemIds": [
    1,
    2
  ],
  "UnclearedItemIds": [
    1,
    2
  ],
  "SystemStatus": 0,
  "Id": 8
}