JSON-RPC API

The JSON-RPC interface at /jsonrpc and /web/dataset/call_kw is the canonical BridgeERP RPC surface. It lets clients call any model method (create, write, search_read, custom action) directly, with full ORM semantics.

When to use JSON-RPC vs REST

Use REST for third-party integrations, public-facing apps, and partners who must not know your BridgeERP schema. Use JSON-RPC for internal BridgeERP-to-BridgeERP links, admin scripts, and anything where you want to call a custom model method without writing a REST wrapper.

Authentication

Two options: session cookie (web.session) or API key.

import xmlrpc.client
# JSON-RPC via xmlrpc helper, or use requests + JSON-RPC payload directly
import requests

base = 'https://microfinance.mybridgeerp.com'
db = 'microfinance.mybridgeerp.com'
login = 'integration@bridgeerp.com'
api_key = 'ak_8f72...'

# Authenticate
resp = requests.post(f'{base}/jsonrpc', json={
    'jsonrpc': '2.0',
    'method': 'call',
    'params': {
        'service': 'common',
        'method': 'authenticate',
        'args': [db, login, api_key, {}]
    }
}).json()
uid = resp['result']

Calling model methods

Once authenticated, call any model method by name. The pattern is execute_kw(db, uid, password, model, method, args, kwargs).

# Search and read members
resp = requests.post(f'{base}/jsonrpc', json={
    'jsonrpc': '2.0',
    'method': 'call',
    'params': {
        'service': 'object',
        'method': 'execute_kw',
        'args': [
            db, uid, api_key,
            'mfi.member', 'search_read',
            [[['state', '=', 'active']]],          # domain
            {'fields': ['name', 'phone', 'national_id'], 'limit': 50}
        ]
    }
}).json()
members = resp['result']

# Create a loan
loan_id = requests.post(f'{base}/jsonrpc', json={
    'jsonrpc': '2.0',
    'method': 'call',
    'params': {
        'service': 'object',
        'method': 'execute_kw',
        'args': [
            db, uid, api_key,
            'mfi.loan', 'create',
            [{
                'member_id': 4827,
                'product_id': 12,
                'principal': 5000000,
                'term_months': 12,
            }]
        ]
    }
}).json()['result']

# Call custom action
requests.post(f'{base}/jsonrpc', json={
    'jsonrpc': '2.0',
    'method': 'call',
    'params': {
        'service': 'object',
        'method': 'execute_kw',
        'args': [
            db, uid, api_key,
            'mfi.loan', 'action_approve',
            [[loan_id]]
        ]
    }
})

Most-called models

• mfi.member — members and KYC
• mfi.loan — loans
• mfi.loan.schedule — schedule lines
• mfi.loan.disbursement — disbursements
• mfi.loan.repayment — repayments
• mfi.savings.account — savings accounts
• mfi.savings.transaction — savings transactions
• mfi.aml.alert — AML alerts
• mfi.regulatory.return — regulatory returns
• account.move — accounting entries (for reconciliation)

Performance tips

• Always pass a fields list to search_read; never read every column
• Use create([list_of_dicts]) for bulk create — order of magnitude faster than N calls
• Use the with_context() pattern by passing context as kwarg to switch language, lang code, or skip computes
• For pagination prefer search with offset+limit and ordered by id, then read in batches

Worked scenarios

Reference

Common JSON-RPC error codes

Troubleshooting

See also

• Api
• Rest
• Sdks