Rules

Get rule

GET

/rules/{ruleId}

Get rule

curl --request GET \
  --url https://api.synci.io/api/v1/rules/{ruleId} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "actions": [
      {
        "action_type": "<string>",
        "created_at": "<string>",
        "field_name": "memo",
        "id": "<string>",
        "order": "<string>",
        "rules": [
          {}
        ],
        "rules_count": "<string>",
        "updated_at": "<string>",
        "value": "{{ transaction.remittance_information.unstructured | remove: \"REF \" }}"
      }
    ],
    "actions_count": "<string>",
    "compatible_destinations": [
      "<string>"
    ],
    "conditions": [
      {
        "created_at": "<string>",
        "field_name": "currency",
        "id": "<string>",
        "operator": "EQUALS",
        "rules": [
          {}
        ],
        "rules_count": "<string>",
        "transaction_type": "BANK",
        "updated_at": "<string>",
        "value": "NOK"
      }
    ],
    "conditions_count": "<string>",
    "created_at": "<string>",
    "description": "<string>",
    "enabled": "<string>",
    "financial_accounts": [
      {
        "financial_account": {
          "account_category": "<string>",
          "account_number_masked": "<string>",
          "account_usage": "<string>",
          "balance": {
            "available": "<string>",
            "cleared": "<string>"
          },
          "balances_last_synced_at": "<string>",
          "bban": "<string>",
          "bic": "<string>",
          "cash_account_type": "<string>",
          "cash_balance": {
            "amount": "<string>",
            "currency": "<string>"
          },
          "config": {
            "enrichment": {
              "country": "<string>",
              "enabled": "<string>",
              "provider": "<string>"
            },
            "fields_for_duplicate_filtering": [
              "<string>"
            ],
            "fuzzy_counterparty_matching": "<string>",
            "fuzzy_counterparty_min_chars": "<string>",
            "map_fields": {
              "date": "<string>",
              "description": "<string>",
              "payee": "<string>"
            },
            "pending_settlement_matching": "<string>",
            "pending_settlement_max_days": "<string>",
            "sync_auto": "<string>",
            "sync_balances": "<string>",
            "sync_frequency_in_minutes": "<string>",
            "sync_pending_transactions": "<string>",

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

ruleIdintegerrequired

The rule ID

Response

RuleResource

dataobjectrequired

Show child attributes

Still need help? Ask the team