MOmodern-treasury

Get Reconciliation Rule

Changed on

Get a single reconciliation rule.

get/reconciliation_rules/{id}

Request

  • Base URL
    https://app.moderntreasury.com/api
  • URL
    https://app.moderntreasury.com/api/reconciliation_rules/{id}
  • Auth
    HTTP basic

Path parameters

idstring required

The ID of the reconciliation rule to be retrieved

Query parameters

show_deletedboolean

Response

200

idstring
organization_idstring
live_modeboolean
namestring
descriptionstring
statusstring
priorityinteger
object_a_typestring
object_a_cardinalitystring
object_a_groupingstring[]
object_b_typestring
object_b_cardinalitystring
object_b_groupingunknown
use_net_reconciliationboolean
amount_variance_typestring
amount_variance_thresholdinteger
amount_variance_mark_as_reconciledboolean
versioninteger
lock_versioninteger
created_atstring
updated_atstring

Example response

{
  "id": "01936aca-5514-7c43-ad31-1f7c8a8dc708",
  "organization_id": "00000000-1111-2222-3333-445566778899",
  "live_mode": true,
  "name": "Reconciliation Rule name",
  "description": "Reconciliation Rule description",
  "status": "active",
  "object_a_type": "expected_payment",
  "object_a_cardinality": "many",
  "object_a_grouping": [
    "expected_payment.direction"
  ],
  "object_b_type": "transaction",
  "object_b_cardinality": "one",
  "use_net_reconciliation": true,
  "amount_variance_type": "percentage",
  "amount_variance_threshold": 3,
  "amount_variance_mark_as_reconciled": true,
  "filters": {
    "value": [
      {
        "value": [
          {
            "field": "transaction.as_of_date",
            "operator": "greater_than_or_equals",
            "value": "expected_payment.date_lower_bound"
          }
        ],
        "operator": "and"
      }
    ],
    "operator": "or"
  },
  "version": 1,
  "created_at": "2024-11-26T23:24:25.237Z",
  "updated_at": "2024-11-26T23:24:25.233Z"
}

Changes