Get reconciliation report

get

https://www.bankingcircleconnect.com/api/v1/reports/reconciliation-report

This endpoint returns a reconciliation report.This report contains relevant information of payments on all of your accounts at the given transaction date, or within a transaction date range. The report can be used to perform financial reconciliation of bookings during the day, or at end-of-day. There is a limitation of 50,000 payments per report for this endpoint. If you need a report for more than 50,000 payments on your account, a paginated endpoint is available.

Only data from current and previous year is available online. Contact Client Services to access older data.

Query Params

FromTransactionDate

date-time

required

Minimum transaction date

FromTransactionDate and ToTransactionDate form a date range

Criteria: Reconciliation.ReportDate must be equal or later

Format: ISO 8601 | YYYY-MM-DD

ToTransactionDate

date-time

required

Maximum transaction date

FromTransactionDate and ToTransactionDate form a date range

Criteria: Reconciliation.ReportDate must be equal or earlier

Format: ISO 8601 | YYYY-MM-DD

IncludeProperties

array of strings

deprecated

This Parameter has been deprecated. Please use PropertiesIncluded instead.

IncludeProperties

PropertiesIncluded

string

Properties of Reconciliation object to include in result

Please note: the use of IncludeProperties and PropertiesIncluded are mutual exclusive. - When both are used all IncludeProperties are ignored.

If PropertiesIncluded is set, PropertiesExcluded need not be set

If neither PropertiesIncluded nor PropertiesExcluded are specified, default value will be PropertiesIncluded =

	PIdChannelUser

	PTxnDate

	ReportDate

	CustomerId

	Account

	AccountCurrency

	DebitAmount

	CreditAmount

	ValueDate

	InstructedAmount

	InstructedAmountCurrency

	TransactionAmount

	TransactionAmountCurrency

	ExchangeRate

	DebtorBankCode

	DebtorAccount

	DebtorLine1

	DebtorLine2

	DebtorLine3

	DebtorLine4

	BeneficiaryBankCode

	BeneficiaryAccount

	BeneficiaryLine1

	BeneficiaryLine2

	BeneficiaryLine3

	BeneficiaryLine4

	PaymentReferenceNumber

	FileReferenceNumber

	UserReferenceNumber

	PaymentDetails1

	PaymentDetails2

	PaymentDetails3

	PaymentDetails4

	CreditDebitIndicator

	BankTrnsCodeDomain

	BankTrnsCodeFamily

Extra parameters that can be added to the array, but are not part of the default array

	PaymentId

	LastChangedTimestamp

	BankTrnsCodeSubFamily

	CreatedAt

	DebtorAgentBankCode

	UltimateDebtorLine1

	UltimateDebtorLine2

	UltimateDebtorLine3

	UltimateDebtorLine4

	UltimateDebtorAccount

	UltimateBeneficiaryAccount

	StatusReasonCode

	StatusReasonDescription

    AdditionalRemittanceInformation1

    AdditionalRemittanceInformation2

    AdditionalRemittanceInformation3

    AdditionalRemittanceInformation4

    AdditionalRemittanceInformation5

    InstructedChargeBearer

    ChargeBearer

    PaymentRail

    Return

    DirectDebitMandateId

    LatestStatusChangedTimestamp

    ProcessedTimestamp

    ClientOrderId

Format: comma (,) separated string

ExcludeProperties

array of strings

deprecated

This Parameter has been deprecated. Please use PropertiesExcluded instead.

ExcludeProperties

PropertiesExcluded

string

Properties of Reconciliation object to exclude from result

Please note: the use of ExcludeProperties and PropertiesExcluded are mutual exclusive. - When both are used all ExcludeProperties are ignored.

To get all available properties send an empty PropertiesExcluded list

If PropertiesExcluded is set, PropertiesIncluded need not be set

Format: comma (,) separated string

AccountId

string

Id of the account on which activities have been booked

Criteria: Exact match on the Id of the account.

It is possible to send comma separated list of GUIDs

Format: comma (,) separated string

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200OK

400Bad Request