Rule Logs

List all rule logs

Rule logs are created any time Synci attempts to apply a rule to a bank transaction. Each rule log references both the rule and the bank transaction, so you can use this endpoint to get all rule logs for a specific rule or bank transaction.

GET

/rule-logs

List all rule logs

curl --request GET \
  --url https://api.synci.io/api/v1/rule-logs \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "executed_at": "<string>",
      "field_name": "<string>",
      "id": "<string>",
      "message": "<string>",
      "new_value": "<string>",
      "previous_value": "<string>",
      "rule": {
        "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>",

Authorizations

Authorizationstringheaderrequired

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

Query Parameters

page[size]integerquerydefault:25

The number of results that will be returned per page.

page[number]integerquery

The page number to start the pagination from.

filter[rule_id]stringquery

Filter rule logs by the ID of the rule that was applied.

filter[transaction_id]stringquery

Filter rule logs by the ID of the transaction the rule was applied to.

filter[transaction_type]stringquery

Filter rule logs by the type of transaction the rule was applied to.

filter[transfer_link_id]stringquery

Filter rule logs by the ID of the transfer link the rule ran on.

filter[rule_action_id]stringquery

Filter rule logs by the ID of the rule action that was executed.

filter[field_name]stringquery

Filter rule logs by the name of the transaction field that was changed.

filter[success]booleanquery

Whether the rule action was successful.

Example: true

filter[undone_log_id]stringquery

Filter for undo entries by the ID of the original rule log they reverted.

filter[search]stringquery

Search for rule logs by commonly populated fields

sortenum<string>[]querydefault:["-id"]

includeenum<string>[]query

Response

Paginated set of RuleLogResource

dataobject[]required

Show child attributes

linksobjectrequired

Show child attributes

metaobjectrequired

Show child attributes

Still need help? Ask the team