VRPlatformVRPlatform
Bank rules

/bank-rules

List bank rules

Required scope: bank-rules:read

GET
/bank-rules

Authorization

apiKey
X-API-Key<token>

API key provided in dashboard

In: header

Query Parameters

search?string
status?string
Value in"active" | "inactive"
mode?string
Value in"suggest" | "autoCreateAndMatch"
transactionType?string
Value in"deposit" | "expense"
limit?integer
Default100
Range1 <= value <= 250
page?integer
Range1 <= value <= 9007199254740991
offset?integer
Range0 <= value <= 9007199254740991

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.vrplatform.app/bank-rules"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "status": "active",
      "priority": -9007199254740991,
      "transactionType": "deposit",
      "mode": "suggest",
      "matchMode": "all",
      "conditions": [
        {
          "type": "description",
          "operator": "contains",
          "value": "string"
        }
      ],
      "descriptionOverride": "string",
      "usePriorMonthEnd": true,
      "version": -9007199254740991,
      "vendorContact": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "firstName": "string",
        "uniqueRef": "string",
        "shortRef": "string",
        "email": "user@example.com",
        "type": "owner"
      },
      "accounts": [
        {
          "id": "string",
          "name": "string",
          "uniqueRef": "string",
          "status": "active"
        }
      ],
      "lines": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "sortOrder": 9007199254740991,
          "type": "flat",
          "amount": -9007199254740991,
          "assignment": "deposit_merchantFee",
          "party": "owners",
          "descriptionOverride": "string",
          "markup": {
            "amount": -9007199254740991,
            "taxBehavior": "excluded",
            "taxRate": {
              "id": "string",
              "name": "string",
              "basisPoints": 100000
            }
          },
          "account": {
            "id": "string",
            "name": "string",
            "uniqueRef": "string",
            "status": "active"
          },
          "listing": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "uniqueRef": "string",
            "shortRef": "string"
          },
          "contact": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "firstName": "string",
            "uniqueRef": "string",
            "shortRef": "string",
            "email": "user@example.com",
            "type": "owner"
          },
          "taxRate": {
            "id": "string",
            "name": "string",
            "basisPoints": 100000
          }
        }
      ],
      "operations": {
        "counts": {
          "total": 9007199254740991,
          "queued": 9007199254740991,
          "running": 9007199254740991,
          "completed": 9007199254740991,
          "failed": 9007199254740991
        },
        "items": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "type": "ach-verification",
            "status": "queued",
            "resource": {
              "type": "bank-rule",
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "role": "source",
              "url": "http://example.com"
            },
            "failure": {
              "code": "csvBlankHeader",
              "message": "CSV contains a blank header"
            },
            "initiator": {
              "type": "user",
              "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
            },
            "createdAt": "2024-01-15T12:30:00.000+00:00",
            "startedAt": "2024-01-15T12:30:00.000+00:00",
            "finishedAt": "2024-01-15T12:30:00.000+00:00"
          }
        ]
      }
    }
  ],
  "pagination": {
    "limit": 100,
    "page": 1,
    "total": 0,
    "totalPage": 0,
    "nextPage": 0
  }
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "MISDIRECTED_REQUEST",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": {
    "teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec",
    "dataRegion": "ap",
    "apiBaseUrl": "http://example.com"
  }
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}

/bank-rules/{id} GET

Previous Page

/bank-rules/{id}/run POST

Next Page