GET api/reconciliation/{id}

Gets a reconciliation by its reconciliation identifier. Processes this reconciliation API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The reconciliation identifier.

integer

Required

Body Parameters

None.

Response Information

Resource Description

The reconciliation, including its bank account, balances, state, selected item identifiers and uncleared item identifiers.

ReconciliationDataContract
NameDescriptionTypeAdditional 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-04T23:19:32.4409503Z",
  "EndDate": "2026-08-04T23:19:32.4409503Z",
  "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
}