ENendclose

Create a reconciliation match

Changed on

Manually match a set of records. All records must be unreconciled in the specified reconciliation (a record matched in a different reconciliation is fine) and belong to its data streams.

post/reconciliation_matches

Request

  • Base URL
    https://api.endclose.com/v1
  • Auth
    API key in header X-API-KEY

Headers

Idempotency-Keystring

Optional. Send the same key when retrying a write you are not sure landed: the first response is returned again (with Idempotent-Replayed: true) instead of writing twice. A key used for a different request is refused with 422; one whose first request is still running gets 409. A refused or failed request does not use up its key. Keys are per environment and kept for 7 days.

Request body

reconciliation_idstring required
record_idsstring[] required

IDs of records to match together

create_adjustmentboolean

If true and the records do not balance, creates an adjustment record so the match nets to zero. With records on both sides the adjustment is a credit on the side with the lower total. With records on one side only it is an offsetting entry on the other side, mirroring the selection's amount and direction. The record lives on the reconciliation's own adjustments stream for that side (a data stream of type adjustments, bound to this reconciliation alone), not on one of its feeds.

adjustment_reasonstring

Description for the adjustment record

Response

Match created

idstring uuid
statusstring
group_keystring
reconciliation_idstring uuid
reconciliation_rule_idstring uuid
created_atstring date-time
record_countinteger

Total number of records in this match

Changes

  • 159f9ed3dbf4Revision changes
    • breaking

      the response's property type changed from integer to string, and format from no format to uuid for status

    • breaking

      the response's property type changed from integer to string, and format from no format to uuid for status

    • breaking

      the response's property type changed from integer to string, and format from no format to uuid for status

    • info

      added the new optional header request parameter Idempotency-Key