Input schema (JSON)
{
"type": "object",
"$defs": {
"r0": {
"enum": [
"in",
"notIn"
],
"type": "string",
"description": "How the field is compared with value."
},
"r1": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d\\.\\d{3}(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Exact timestamp with three fractional digits and a known offset or Z; -00:00 is invalid."
},
"r2": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d\\.\\d{3}(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"r3": {
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?$",
"description": "Decimal fiat amount to compare against."
},
"r4": {
"type": "string",
"minLength": 1,
"description": "The value the field is compared against."
},
"r5": {
"enum": [
"fiatValue"
],
"type": "string",
"description": "Condition field."
},
"r6": {
"enum": [
"LINE"
],
"type": "string",
"description": "What the change applies to: a journal line or the transaction."
},
"r7": {
"enum": [
"transactionDate"
],
"type": "string",
"description": "Owning transaction timestamp."
},
"r8": {
"type": "string",
"maxLength": 8,
"minLength": 1,
"description": "Chart-of-accounts number, from list_journal_line_assignment_options (type: ledger_account)."
},
"r9": {
"type": "string",
"minLength": 1,
"description": "Counterparty name, from list_journal_line_assignment_options (type: counterparty)."
},
"r10": {
"enum": [
"equals",
"contains",
"notEquals",
"notContains"
],
"type": "string",
"description": "How the field is compared with value."
},
"r11": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1,
"description": "The value the field is compared against."
},
"r12": {
"enum": [
"equals",
"contains"
],
"type": "string",
"description": "How the field is compared with value."
},
"r13": {
"enum": [
1
],
"type": "number",
"description": "Structure version of this envelope. Always 1."
},
"r14": {
"enum": [
"equals"
],
"type": "string",
"description": "How the field is compared with value."
}
},
"required": [
"workspaceRef",
"portfolioRef",
"operation"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"description": "Human-readable rule name, shown in the rules list. Only for operation create, update; required for operation create."
},
"action": {
"type": "object",
"required": [
"formatVersion",
"actions"
],
"properties": {
"actions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"required": [
"type",
"target",
"counterpartyName"
],
"properties": {
"type": {
"enum": [
"SET_COUNTERPARTY"
],
"type": "string",
"description": "Which change this action makes."
},
"target": {
"$ref": "#/$defs/r6"
},
"counterpartyName": {
"$ref": "#/$defs/r9"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"target",
"accountNumber"
],
"properties": {
"type": {
"enum": [
"SET_LEDGER_ACCOUNT"
],
"type": "string",
"description": "Which change this action makes."
},
"target": {
"$ref": "#/$defs/r6"
},
"accountNumber": {
"$ref": "#/$defs/r8"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"type",
"target",
"responsibilityCenterAssignments"
],
"properties": {
"type": {
"enum": [
"SET_RESPONSIBILITY_CENTERS"
],
"type": "string",
"description": "Which change this action makes."
},
"target": {
"$ref": "#/$defs/r6"
},
"responsibilityCenterAssignments": {
"type": "array",
"items": {
"type": "object",
"required": [
"responsibilityCenterTypeKey",
"responsibilityCenterName"
],
"properties": {
"responsibilityCenterName": {
"type": "string",
"minLength": 1,
"description": "Responsibility center name, from list_journal_line_assignment_options (type: responsibility_center)."
},
"responsibilityCenterTypeKey": {
"type": "string",
"pattern": "^[a-z0-9]+(_[a-z0-9]+)*$",
"description": "Stable responsibility-center type key. It uses lowercase alphanumeric snake_case segments."
}
},
"additionalProperties": false
},
"minItems": 1
}
},
"additionalProperties": false
}
]
},
"minItems": 1,
"description": "What the rule changes when it matches. At most one action of each type."
},
"formatVersion": {
"$ref": "#/$defs/r13"
}
},
"description": "Only for operation create, update; required for operation create.",
"additionalProperties": false
},
"enabled": {
"anyOf": [
{
"type": "boolean",
"default": true,
"description": "Whether the rule evaluates. A disabled rule is kept but never fires."
},
{
"type": "boolean",
"description": "Whether the rule evaluates. A disabled rule is kept but never fires."
}
],
"description": "Whether the rule evaluates. A disabled rule is kept but never fires. Only for operation create, set_enabled; required for operation set_enabled."
},
"preview": {
"type": "boolean",
"description": "When true, evaluate the change and return its impact without saving it. Not for operation current."
},
"ruleRef": {
"type": "string",
"minLength": 1,
"description": "Saved rule handle, from list_accounting_rules. Only for operation update, set_enabled, delete; required for each."
},
"operation": {
"enum": [
"create",
"update",
"set_enabled",
"reorder",
"delete",
"current"
],
"type": "string",
"description": "create: Create a new rule, or preview creating one (preview: true). update: Change the name, conditions, or actions of an existing rule, or preview the change (preview: true). Provide at least one of name, conditions, action. set_enabled: Turn an existing rule on or off without changing it, or preview the change (preview: true). reorder: Set the evaluation order of every rule in the portfolio, or preview it (preview: true). delete: Remove one saved rule from active use, or preview removing it (preview: true). current: Preview the saved rules as they stand, changing nothing."
},
"conditions": {
"type": "object",
"required": [
"formatVersion",
"all"
],
"properties": {
"all": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"enum": [
"fromAddressLabel"
],
"type": "string",
"description": "Which part of the transaction this condition tests."
},
"value": {
"$ref": "#/$defs/r4"
},
"operator": {
"$ref": "#/$defs/r10"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"enum": [
"toAddressLabel"
],
"type": "string",
"description": "Which part of the transaction this condition tests."
},
"value": {
"$ref": "#/$defs/r4"
},
"operator": {
"$ref": "#/$defs/r10"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"enum": [
"fromAddress"
],
"type": "string",
"description": "Which part of the transaction this condition tests."
},
"value": {
"$ref": "#/$defs/r4"
},
"operator": {
"$ref": "#/$defs/r12"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"enum": [
"toAddress"
],
"type": "string",
"description": "Which part of the transaction this condition tests."
},
"value": {
"$ref": "#/$defs/r4"
},
"operator": {
"$ref": "#/$defs/r12"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"enum": [
"direction"
],
"type": "string",
"description": "Which part of the transaction this condition tests."
},
"value": {
"enum": [
"IN",
"OUT",
"GAS"
],
"type": "string",
"description": "The value the field is compared against."
},
"operator": {
"enum": [
"equals",
"notEquals"
],
"type": "string",
"description": "How the field is compared with value."
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"enum": [
"asset"
],
"type": "string",
"description": "Which part of the transaction this condition tests."
},
"value": {
"$ref": "#/$defs/r11"
},
"operator": {
"$ref": "#/$defs/r0"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"enum": [
"assetClass"
],
"type": "string",
"description": "Which part of the transaction this condition tests."
},
"value": {
"type": "array",
"items": {
"enum": [
"ERC20",
"FIAT",
"NATIVE",
"REBASE_LST",
"INTEREST_BEARING",
"VALUE_ACCRUING",
"LP_SHARE",
"DEBT",
"REFLECT",
"VOTE_ESCROWED",
"NFT"
],
"type": "string"
},
"minItems": 1,
"description": "The value the field is compared against."
},
"operator": {
"$ref": "#/$defs/r0"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"enum": [
"stablecoin"
],
"type": "string",
"description": "Which part of the transaction this condition tests."
},
"value": {
"type": "boolean",
"description": "The value the field is compared against."
},
"operator": {
"$ref": "#/$defs/r14"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"enum": [
"chain"
],
"type": "string",
"description": "Which part of the transaction this condition tests."
},
"value": {
"$ref": "#/$defs/r11"
},
"operator": {
"$ref": "#/$defs/r0"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"enum": [
"operationType"
],
"type": "string",
"description": "Which part of the transaction this condition tests."
},
"value": {
"type": "array",
"items": {
"enum": [
"DEPOSIT_FIAT",
"INCOME",
"REFUND",
"REBATE",
"WITHDRAWAL_FIAT",
"EXPENSE",
"BUY",
"SELL",
"EXCHANGE",
"SWAP",
"MOVE",
"INTERCOMPANY_SEND",
"INTERCOMPANY_RECEIVE",
"STAKE",
"UNSTAKE",
"PROTOCOL_DEPOSIT",
"PROTOCOL_WITHDRAW",
"VAULT_DEPOSIT",
"VAULT_WITHDRAW",
"LP_IN",
"LP_OUT",
"LOAN_BORROW",
"LOAN_REPAY",
"LOAN_LIQUIDATION",
"LEND_GIVE",
"LEND_WITHDRAW",
"ADJUSTMENT",
"UNCATEGORIZED",
"SPAM"
],
"type": "string"
},
"minItems": 1,
"description": "The value the field is compared against."
},
"operator": {
"$ref": "#/$defs/r0"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"enum": [
"accountSubType"
],
"type": "string",
"description": "Which part of the transaction this condition tests."
},
"value": {
"type": "array",
"items": {
"enum": [
"EXT",
"BNK",
"INC",
"EXP",
"LINT",
"LLIQ",
"LQLOSS",
"CLOSS",
"CBNK",
"CBAS",
"CRE",
"CGL",
"CEXP",
"CINC",
"TRADING_REVENUE",
"COGS",
"INVENTORY_VALUATION_ADJUSTMENT",
"INVENTORY_COGS_ADJUSTMENT",
"INVENTORY_WRITE_DOWN",
"INVENTORY_REMEASUREMENT_GAIN",
"INVENTORY_REMEASUREMENT_LOSS",
"CNP",
"UINC",
"UEXP",
"OFEXP",
"OFINC",
"ICINV",
"CAP",
"UNREALISED_FV_GAIN",
"UNREALISED_FV_LOSS",
"CFVA",
"OCI_REVALUATION",
"REVALUATION_SURPLUS"
],
"type": "string"
},
"minItems": 1,
"description": "The value the field is compared against."
},
"operator": {
"$ref": "#/$defs/r0"
}
},
"additionalProperties": false
},
{
"oneOf": [
{
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"$ref": "#/$defs/r5"
},
"value": {
"$ref": "#/$defs/r3"
},
"operator": {
"enum": [
"gt"
],
"type": "string",
"description": "Comparison operator."
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"$ref": "#/$defs/r5"
},
"value": {
"$ref": "#/$defs/r3"
},
"operator": {
"enum": [
"lt"
],
"type": "string",
"description": "Comparison operator."
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"$ref": "#/$defs/r5"
},
"value": {
"$ref": "#/$defs/r3"
},
"operator": {
"enum": [
"gte"
],
"type": "string",
"description": "Comparison operator."
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"$ref": "#/$defs/r5"
},
"value": {
"$ref": "#/$defs/r3"
},
"operator": {
"enum": [
"lte"
],
"type": "string",
"description": "Comparison operator."
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"$ref": "#/$defs/r5"
},
"value": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?$"
},
{
"type": "string",
"pattern": "^-?\\d+(\\.\\d+)?$"
}
]
},
"maxItems": 2,
"minItems": 2,
"description": "Inclusive [low, high] decimal-string range."
},
"operator": {
"enum": [
"between"
],
"type": "string",
"description": "Comparison operator."
}
},
"additionalProperties": false
}
]
},
{
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"enum": [
"entryType"
],
"type": "string",
"description": "Which part of the transaction this condition tests."
},
"value": {
"enum": [
"DR",
"CR"
],
"type": "string",
"description": "The value the field is compared against."
},
"operator": {
"$ref": "#/$defs/r14"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"enum": [
"accountType"
],
"type": "string",
"description": "Which part of the transaction this condition tests."
},
"value": {
"type": "array",
"items": {
"enum": [
"ASSET",
"LIABILITY",
"EQUITY",
"INCOME",
"EXPENSE"
],
"type": "string"
},
"minItems": 1,
"description": "The value the field is compared against."
},
"operator": {
"$ref": "#/$defs/r0"
}
},
"additionalProperties": false
},
{
"oneOf": [
{
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"$ref": "#/$defs/r7"
},
"value": {
"$ref": "#/$defs/r1"
},
"operator": {
"enum": [
"lt"
],
"type": "string",
"description": "Before (lt) or on or after (gte) the cutoff."
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"$ref": "#/$defs/r7"
},
"value": {
"$ref": "#/$defs/r1"
},
"operator": {
"enum": [
"gte"
],
"type": "string",
"description": "Before (lt) or on or after (gte) the cutoff."
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"$ref": "#/$defs/r7"
},
"value": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/$defs/r2"
},
{
"$ref": "#/$defs/r2"
}
]
},
"maxItems": 2,
"minItems": 2,
"description": "Inclusive [start, end] timestamps, earliest first; each has three fractional digits and a known offset or Z, never -00:00."
},
"operator": {
"enum": [
"between"
],
"type": "string",
"description": "Within the inclusive [start, end] range."
}
},
"additionalProperties": false
}
]
},
{
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"enum": [
"wallet"
],
"type": "string",
"description": "Which part of the transaction this condition tests."
},
"value": {
"type": "array",
"items": {
"type": "object",
"required": [
"chainId",
"address"
],
"properties": {
"address": {
"type": "string",
"minLength": 1,
"description": "Wallet address"
},
"chainId": {
"type": "string",
"minLength": 1,
"description": "Chain ID"
}
},
"additionalProperties": false
},
"minItems": 1,
"description": "The value the field is compared against."
},
"operator": {
"$ref": "#/$defs/r0"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"operator",
"field",
"value"
],
"properties": {
"field": {
"enum": [
"accountNumber"
],
"type": "string",
"description": "Which part of the transaction this condition tests."
},
"value": {
"type": "array",
"items": {
"$ref": "#/$defs/r8"
},
"minItems": 1,
"description": "The value the field is compared against."
},
"operator": {
"$ref": "#/$defs/r0"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"enum": [
"counterparty"
],
"type": "string",
"description": "Which part of the transaction this condition tests."
},
"value": {
"type": "array",
"items": {
"$ref": "#/$defs/r9"
},
"minItems": 1,
"description": "The value the field is compared against."
},
"operator": {
"$ref": "#/$defs/r0"
}
},
"additionalProperties": false
}
]
},
"minItems": 1,
"description": "Conditions that must all match for the rule to fire. At least one is required."
},
"formatVersion": {
"$ref": "#/$defs/r13"
}
},
"description": "Only for operation create, update; required for operation create.",
"additionalProperties": false
},
"maxAffected": {
"type": "integer",
"default": 10,
"maximum": 25,
"minimum": 1,
"description": "Preview only: how many affected transactions to sample, at most 25. affectedCount in the result equals this sample size; check candidateCount for the true total match count."
},
"portfolioRef": {
"type": "string",
"minLength": 1,
"description": "Portfolio name or slug inside that workspace. Call list_portfolios to resolve it."
},
"workspaceRef": {
"type": "string",
"minLength": 1,
"description": "Workspace name or slug. Call list_workspaces to resolve it."
},
"orderedRuleRefs": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"description": "Saved rule handle, from list_accounting_rules."
},
"minItems": 1,
"description": "Every rule handle in the portfolio, in the order they should evaluate. Rules apply in order, so earlier rules win. Only for operation reorder; required for each."
}
},
"additionalProperties": false
}