Create a reconciliation match

Books the previewed match through the app's own bank seam: a bill payment, a VAT payable settlement, or a dividend payment (an instalment of a declared dividend, or the one payment of an interim, which posts its SDC and GeSY withholding at the bank date). Send the preview's confirmation_token, the same Idempotency-Key and If-Match; if the bank line or the candidate changed since the preview the answer is 412. Never categorize a dividend to an account: match it here so the declaration, withholding and statutory vouchers are recorded. A dividend match is undone in Cybooks, not through reconciliationMatch.unmatch. A difference books the bill in full with the gap as a fee or adjustment row on the named account; bank_transaction_ids books every line as a part payment of the bill in one transaction (all or none); fx_confirm settles the bill in full from a line in another currency, the exchange difference going to exchange gain or loss. Each line gets its own match (settlement.match_ids), reversible with reconciliationMatch.unmatch. The period lock, the payment gate and the zero-VAT gate apply as in the app. The posted journal is checked: it balances and equals the preview, or nothing is booked (journal_mismatch, journal_unbalanced). With candidates the whole allocation is ONE booking through the app's multi-document payment (one payment journal per document, all or nothing); the response's allocation names each document's booking and the journal as posted, candidate is null, meta.candidate_versions has each document's version, and reconciliationMatch.unmatch on the match id reopens every document together. Refuses with the preview's codes, period_locked, 412 when anything changed since the preview, and 409 confirmation_already_claimed. Requires the reconciliation:action OAuth scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

Confirmed values used to create a reconciliation match, including the confirmation token returned by reconciliationMatch.create.preview.

string
enum
Allowed:
string
length ≤ 64
string
enum
Allowed:
string
string
required
length ≤ 8192
candidates
array of objects
length between 1 and 25

Or documents in the line's currency, amounts above zero, netting to it unless difference is sent: money in, invoice/vendor_credit add, bill/credit_note subtract; money out reversed. Mixing kinds: new Reconcile only.

candidates
bank_transaction_ids
array of strings
length between 1 and 10

Bills only: every line paying the bill (its transfer and fee), this one too, adding up to it unless difference is sent.

bank_transaction_ids
difference
object

Settle in full, the gap (at most the smaller of 25 and 2 % of the open amount) to an account.

fx_confirm
object

Bills only, a line in another currency with no provider target: echo the preview's bill amount and currency.

Headers
string
required
length ≤ 191

Required unique key whose request hash and terminal response are stored durably for 24 hours.

string

Required. ETag from the latest representation; a stale value returns 412 precondition_failed. Send this header, not the standard If-Match: some HTTP intermediaries evaluate a standard If-Match themselves and can answer 412 even though the change was applied. Never send both; both with different ETags returns 400 conflicting_precondition_headers.

string
deprecated

Accepted with the same value and meaning as Cybooks-If-Match, but do not send it: an intermediary can answer 412 to it after the change was applied. Send Cybooks-If-Match instead.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*