Skip to content

Whitelisted API inventory

List HTTP-exposed Python functions for integration and security review. Internal helpers without @frappe.whitelist are omitted.

URL pattern: /api/method/leekimerp.api.<module>.<function_name> (Frappe standard; confirm CSRF/session rules for your version).


FunctionAuthMethodsInputs (summary)Returns / effects
get_all_usersSessionGETUser list
add_userGuestPOSTfull_name, username, email, password, gender, phoneCreates user flow
verify_emailGuestPOSTemail, codeVerification
login_newGuestPOSTusername, passwordLogin
reset_passwordGuestPOSTusername_or_emailReset flow
verify_reset_keyGuestGETemail, keyValidate reset key
new_passwordGuestPOSTemail, password, keySet password
new_password_sidSessionPOSTsid, old_password, passwordChange password
check_sessionSessionGETsidSession check
logoutSessionGETsidLogout
generate_secretSessionGETemailTOTP/secret step
get_secretSessionGETemailRetrieve secret
user_masterGuestGETMaster data payload
get_summarySessiondefaultuserSQL user lookup

FunctionAuthMethodsInputsEffects
get_all_usersSessionGETemail, username, active (optional)Filtered users

FunctionAuthNotes
get_app_webhook_secretGuest GETWebhook secret retrieval
xero_webhook_connectionGuest POSTXero webhook ingress
sync_contact_with_tenantSessionContact sync
create_contactSession POSTCreate Xero/ERP contact
update_sync_statusSession POSTSync flags
make_new_itemSessionItem creation helper
get_xero_invoicesSession GETList invoices
sync_xero_invoicesSession GETTrigger sync
get_total_amount_due_by_contactSessionAR amount
get_officersSessionOfficers for application

Non-whitelisted helpers perform OAuth, invoice mapping, and ERP writes — see source.


FunctionRole
create_payment_linkStripe Payment Link for invoice
get_payment_link_statusStatus polling
payment_completedCompletion callback handling
cancel_payment_linkCancel link

FunctionAuthRole
stripe_webhookGuestMain Stripe webhook
test_webhookGuestTesting only
debug_webhook_signatureGuestDebug
stripe_webhook_testGuestTest endpoint
test_payment_webhookSessionTest invoice webhook

FunctionRole
docusign_authAuth + envelope workflow
docusign_queue_sendQueue processor

FunctionMethodsRole
get_all_itemsGETList items
get_only_itemsGETSimplified list
get_query_itemsGETgroup, disabled
add_itemPOSTCreate item
update_itemPUTUpdate
delete_itemDELETEDelete
add_notePOSTNote on item

Most endpoints allow guest in current code — security review required before production exposure.


FunctionMethodsRole
entity_searchGETEntity search
ssic_searchGETSSIC search
ssic_exact_searchGETExact SSIC

FunctionMethodsRole
uploadPOSTFile upload
officer_upload_filesPOSTOfficer documents

FunctionRole
categoryFAQ categories
get_top_faqTop FAQs
get_category_faqFAQs by category

FunctionRole
create_new_support_ticketSession POST
add_message_in_ticketGuest/Session POST
get_ticketGuest GET

FunctionRole
get_printouts_dataSession; company_id optional

FunctionRole
generate_html_copyHTML for invoice copies

FunctionRole
bulk_uploadPOST guest — high risk; validate doctype_name + data server-side

FunctionRole
generate_stampGuest POST — QR/stamp generation

FunctionRole
log_timeSession POST
userSession GET
app_dataGuest GET
reset_passwordGuest POST
new_versionGuest POST
loginGuest POST

Regenerate this table after adding @frappe.whitelist:

Terminal window
rg '@frappe\.whitelist' leekimerp/leekimerp/api -n