Synci API
  1. Schemas
Synci API
  • BankAccounts
    • List all bank accounts
    • Get bank account
    • Update bank account
    • Delete bank account
    • Reset bank account config to defaults
    • List all balances
    • Get balance
    • Delete balance
  • BankConnections
    • List all bank connections
    • Create a new bank connection
    • Get bank connection
    • Delete bank connection
    • Disable bank connection
    • Reconfirm the consent of a bank connection
  • BankTransactions
    • List all bank transactions
    • Create a new bank transaction
    • Get bank transaction
    • Update bank transaction
    • Delete bank transaction
  • RuleActions
    • List all rule actions
    • Create a new rule action
    • Get rule action
    • Update rule action
    • Delete rule action
  • RuleConditions
    • List rule conditions
    • Create a new rule condition
    • Get rule condition
    • Update rule condition
    • Delete rule condition
  • RuleLogs
    • List all rule logs
    • Get rule log
    • Undo a rule action
  • Rules
    • Create a new rule
    • List all rules
    • Get rule
    • Update rule
    • Delete rule
    • Attach rule to bank account
    • Detach rule from bank account
    • Reorder rules for a bank account
    • Attach rule to transfer link
    • Detach rule from transfer link
    • Reorder rules for a transfer link
    • Attach rule to destination
    • Detach rule from destination
    • Reorder rules for a destination (e.g., YNAB budget account)
    • rules.attachToBank
    • rules.detachFromBank
  • Statistics
    • Get bank transaction statistics
    • Get key user statistics
    • Get transfer statistics
  • SupportedBanks
    • Get supported countries
    • List all supported banks
    • Get supported bank
  • TransferLinks
    • List all transfer links
    • Create a new transfer link
    • Get transfer link
    • Update transfer link
    • Delete transfer link
    • Retry transfers for all transfer links
    • Retry transfers for a specific transfer link
  • TransferLogs
    • List all transfer logs
    • Get transfer log
    • Undo a transfer
    • transfer-logs.undo-bulk
  • YnabBudgets
    • List all YNAB budgets
    • Get YNAB budget
    • Delete YNAB budget
    • Update YNAB connection
    • List all YNAB budget accounts
    • Get YNAB budget account
    • Delete YNAB budget account
    • List all YNAB budget payees
    • List all YNAB budget categories
    • List all YNAB budget transactions
  • YnabConnections
    • List all YNAB connections
    • Create new YNAB connection
    • Get YNAB connection
    • Delete YNAB connection
  • Schemas
    • Schemas
      • AttachRuleToDestinationRequest
      • BalanceTypeEnum
      • BankAccount
      • BankAccountResource
      • BankBalanceResource
      • BankConfigGeneratedDateEnum
      • BankConfigGeneratedTextEnum
      • BankConfigResource
      • BankConnectionResource
      • BankIntegratorEnum
      • BankResource
      • BankTransactionResource
      • BulkUndoTransferLogsRequest
      • CreateBankConnectionRequest
      • CreateBankTransactionRequest
      • CreateRuleRequest
      • CreateTransferLinkRequest
      • CreateYnabConnectionRequest
      • DestinationTypeEnum
      • GoCardlessRequisitionStatusEnum
      • HealthResource
      • HealthStatusEnum
      • ReauthorizeBankConnectionRequest
      • ReorderDestinationRulesRequest
      • RetryTransfersAllLinksRequest
      • RetryTransfersRequest
      • RuleActionResource
      • RuleActionTypeEnum
      • RuleConditionResource
      • RuleLogResource
      • RuleOperatorEnum
      • RuleResource
      • RuleTypeEnum
      • SourceTypeEnum
      • TransactionTypeEnum
      • TransferLink
      • TransferLinkResource
      • TransferLogResource
      • TransferLogStatusEnum
      • UpdateBankAccountRequest
      • UpdateBankTransactionRequest
      • UpdateRuleRequest
      • UpdateTransferLinkRequest
      • UpdateYnabBudgetRequest
      • YnabBudgetAccountResource
      • YnabBudgetAccountTypeEnum
      • YnabBudgetCategoryResource
      • YnabBudgetPayeeResource
      • YnabBudgetResource
      • YnabBudgetTransactionResource
      • YnabConnectionResource
    • Response
      • AuthenticationException
      • ValidationException
      • AuthorizationException
      • ModelNotFoundException
  1. Schemas

CreateRuleRequest(CreateRuleRequest)

{
    "name": "string",
    "description": "string",
    "enabled": true,
    "trigger_on_any_condition": true,
    "skip_other_rules_when_triggered": true,
    "type": "BANK",
    "conditions": [
        {
            "field_name": "string",
            "operator": "EQUALS",
            "value": "string"
        }
    ],
    "actions": [
        {
            "order": 0,
            "action_type": "SET_YNAB_FIELD",
            "field_name": "string",
            "value": "string"
        }
    ],
    "bank_accounts": [
        {
            "id": 0,
            "order": 0
        }
    ],
    "transfer_links": [
        {
            "id": 0,
            "order": 0
        }
    ],
    "destinations": [
        {
            "type": "YNAB",
            "id": 0,
            "order": 0
        }
    ],
    "banks": [
        {
            "id": 0,
            "order": 0
        }
    ]
}
Built with