POST api/reconciliation/items
Gets unreconciled ledger items eligible for reconciliation for a system bank account. The end date is inclusive. Incoming, outgoing and batch-payment items can be excluded, although incoming and outgoing items cannot both be excluded. Cash deposits, unsuspended funds, adjustments, reversals and lines without a positive adjusted total are not eligible.
Request Information
URI Parameters
None.
Body Parameters
The system bank account identifier, inclusive end date, and incoming, outgoing and batch-item exclusions.
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 not available.
application/json, text/json
{
"ExcludeInItems": true,
"ExcludeOutItems": true,
"ExcludeBatchItems": true,
"EndDate": "2026-08-05T00:19:02.2920468Z",
"OpeningBalance": 5.0,
"ClosingBalance": 6.0,
"ReconciliationId": 7,
"Id": 8
}
Response Information
Resource Description
Eligible items with adjusted and original amounts, adjustments, account context and payment references.
Collection of ReconciliationItemDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| DateTime |
The date time, expressed as a date and time. |
date |
None. |
| TransactionType |
The transaction type value. |
string |
None. |
| LedgerId |
The unique identifier of the related ledger resource. |
integer |
None. |
| Amount |
The amount value. |
decimal number |
None. |
| IsIn |
Indicates whether this item is in. |
boolean |
None. |
| PaymentMethod |
The payment method value. |
string |
None. |
| ClearedStatus |
The cleared status value. |
string |
None. |
| CreatedBy |
The created by value. |
integer |
None. |
| Description |
The description value. |
string |
None. |
| BatchPaymentId |
The unique identifier of the related batch payment resource. |
integer |
None. |
| Adjustments |
The collection of adjustments. |
Collection of AdjustmentItemDataContract |
None. |
| OriginalTotal |
The original total value. |
decimal number |
None. |
| FromTo |
The from to value. |
string |
None. |
| FromToGroupId |
The unique identifier of the related from to group resource. |
integer |
None. |
| From |
The from value. |
string |
None. |
| FromGroupId |
The unique identifier of the related from group resource. |
integer |
None. |
| To |
The to value. |
string |
None. |
| ToGroupId |
The unique identifier of the related to group resource. |
integer |
None. |
| CustomerBankAccount |
The customer bank account value. |
BankAccountDataContract |
None. |
| SystemBankAccount |
The system bank account value. |
None. |
Response Formats
application/json
Sample not available.
text/json
Sample not available.