API Reference

Full generated reference for every Soledgic API endpoint.

Base URLs

https://api.soledgic.com/v1
https://YOUR_PROJECT.supabase.co/functions/v1

Most endpoints use x-api-key. Billing, bootstrap, and webhook endpoints use JWT or signature-based auth as shown per endpoint below.

Complete Endpoint Index

Generated from supabase/functions/*/index.ts. Current total: 70 endpoints (60 public, 8 internal, 2 deprecated).

EndpointMethodsAuthStatusDetails
Ap Aging
/v1/ap-aging
GET
API keyPublicView details
Ar Aging
/v1/ar-aging
GET
API keyPublicView details
Balance Sheet
/v1/balance-sheet
GET
API keyPublicView details
Billing
/v1/billing
POST
Public/JWTPublicView details
Check Payout Eligibility
/v1/check-payout-eligibility
GETPOST
API keyPublicView details
Close Period
/v1/close-period
POST
API keyPublicView details
Configure Alerts
/v1/configure-alerts
POST
API keyPublicView details
Configure Risk Policy
/v1/configure-risk-policy
POST
API keyPublicView details
Connected Accounts
/v1/connected-accounts
POST
API keyPublicView details
Create Checkout
/v1/create-checkout
POST
API keyPublicView details
Create Creator
/v1/create-creator
POST
API keyPublicView details
Create Ledger
/v1/create-ledger
POST
Public/JWTPublicView details
Debug Expense
/v1/debug-expense
POST
API keyInternalView details
Debug Handler
/v1/debug-handler
POST
API keyInternalView details
Execute Payout
/v1/execute-payout
POST
API keyPublicView details
Export Report
/v1/export-report
POST
API keyPublicView details
Frozen Statements
/v1/frozen-statements
POST
API keyPublicView details
Generate Pdf
/v1/generate-pdf
POST
API keyPublicView details
Generate Report
/v1/generate-report
POST
API keyPublicView details
Generate Tax Summary
/v1/generate-tax-summary
POST
API keyPublicView details
Get Balance
/v1/get-balance
GET
API keyPublicView details
Get Balances
/v1/get-balances
GETPOST
API keyPublicView details
Get Runway
/v1/get-runway
GET
API keyPublicView details
Get Transactions
/v1/get-transactions
GET
API keyPublicView details
Health Check
/v1/health-check
POST
Public/JWTInternalView details
Import Bank Statement
/v1/import-bank-statement
POST
API keyPublicView details
Import Transactions
/v1/import-transactions
POST
API keyPublicView details
Invoices
/v1/invoices
GETPOST
API keyPublicView details
List Ledgers
/v1/list-ledgers
GET
Public/JWTPublicView details
Manage Bank Accounts
/v1/manage-bank-accounts
GETPOST
API keyPublicView details
Manage Budgets
/v1/manage-budgets
GETPOST
API keyPublicView details
Manage Contractors
/v1/manage-contractors
GETPOST
API keyPublicView details
Manage Recurring
/v1/manage-recurring
GETPOST
API keyPublicView details
Manage Splits
/v1/manage-splits
POST
API keyPublicView details
Pay Bill
/v1/pay-bill
POST
API keyPublicView details
Plaid
/v1/plaid
POST
API keyPublicView details
Preflight Authorization
/v1/preflight-authorization
POST
API keyPublicView details
Process Payout
/v1/process-payout
POST
API keyPublicView details
Process Webhooks
/v1/process-webhooks
POST
Custom/internalInternalView details
Profit Loss
/v1/profit-loss
GETPOST
API keyPublicView details
Project Intent
/v1/project-intent
POST
API keyPublicView details
Receive Payment
/v1/receive-payment
POST
API keyPublicView details
Reconcile
/v1/reconcile
POST
API keyPublicView details
Record Adjustment
/v1/record-adjustment
POST
API keyPublicView details
Record Bill
/v1/record-bill
POST
API keyPublicView details
Record Expense
/v1/record-expense
POST
API keyPublicView details
Record Income
/v1/record-income
POST
API keyPublicView details
Record Opening Balance
/v1/record-opening-balance
POST
API keyPublicView details
Record Refund
/v1/record-refund
POST
API keyPublicView details
Record Sale
/v1/record-sale
POST
API keyPublicView details
Record Transfer
/v1/record-transfer
POST
API keyPublicView details
Register Instrument
/v1/register-instrument
POST
API keyPublicView details
Release Funds
/v1/release-funds
POST
API keyPublicView details
Reverse Transaction
/v1/reverse-transaction
POST
API keyPublicView details
Risk Evaluation
/v1/risk-evaluation
POST
API keyPublicView details
Scheduled Payouts
/v1/scheduled-payouts
POST
API keyInternalView details
Security Alerts
/v1/security-alerts
POST
Public/JWTInternalView details
Send Breach Alert
/v1/send-breach-alert
POST
API keyInternalView details
Send Statements
/v1/send-statements
POST
API keyPublicView details
Stripe
/v1/stripe
POST
API keyPublicView details
Stripe Billing Webhook
/v1/stripe-billing-webhook
POST
Webhook signaturePublicView details
Stripe Connect Webhook
/v1/stripe-connect-webhook
POST
Webhook signaturePublicView details
Stripe Reconciliation
/v1/stripe-reconciliation
POST
API keyPublicView details
Stripe Webhook
/v1/stripe-webhook
POST
Webhook signatureDeprecatedView details
Submit Tax Info
/v1/submit-tax-info
POST
Public/JWTDeprecatedView details
Tax Documents
/v1/tax-documents
POST
API keyPublicView details
Test Cleanup
/v1/test-cleanup
POST
API keyInternalView details
Trial Balance
/v1/trial-balance
GETPOST
API keyPublicView details
Upload Receipt
/v1/upload-receipt
POST
API keyPublicView details
Webhooks
/v1/webhooks
POST
API keyPublicView details

Endpoint Details

Each entry includes inferred parameter schemas and a ready-to-run request example.

Ap Aging
/v1/ap-aging
GETAPI key

Accounts Payable Aging Report

Gateway path
https://api.soledgic.com/v1/ap-aging
Supabase function
/functions/v1/ap-aging
Source
supabase/functions/ap-aging/index.ts

Parameters

LocationNameTypeRequired
queryas_of_datestringNo

Example Request

curl -X GET "https://api.soledgic.com/v1/ap-aging?as_of_date=2026-01-01" \
  -H "x-api-key: sk_test_YOUR_API_KEY"
Ar Aging
/v1/ar-aging
GETAPI key

Accounts Receivable Aging Report

Gateway path
https://api.soledgic.com/v1/ar-aging
Supabase function
/functions/v1/ar-aging
Source
supabase/functions/ar-aging/index.ts

Parameters

LocationNameTypeRequired
queryas_of_datestringNo

Example Request

curl -X GET "https://api.soledgic.com/v1/ar-aging?as_of_date=2026-01-01" \
  -H "x-api-key: sk_test_YOUR_API_KEY"
Balance Sheet
/v1/balance-sheet
GETAPI key

Balance Sheet Report

Gateway path
https://api.soledgic.com/v1/balance-sheet
Supabase function
/functions/v1/balance-sheet
Source
supabase/functions/balance-sheet/index.ts

Parameters

LocationNameTypeRequired
queryas_of_datestringNo

Example Request

curl -X GET "https://api.soledgic.com/v1/balance-sheet?as_of_date=2026-01-01" \
  -H "x-api-key: sk_test_YOUR_API_KEY"
Billing
/v1/billing
POSTPublic/JWT

Billing Management API

Gateway path
https://api.soledgic.com/v1/billing
Supabase function
/functions/v1/billing
Source
supabase/functions/billing/index.ts

Parameters

LocationNameTypeRequired
bodyaction'get_subscription' | 'get_usage' | 'get_invoices' | 'get_payment_methods' |Yes
bodyorganization_idstringNo
bodyprice_idstringNo
bodyquantitynumberNo
bodyreturn_urlstringNo
bodycancel_urlstringNo
bodypayment_method_idstringNo
bodyusage_typestringNo
bodyusage_quantitynumberNo

Example Request

curl -X POST "https://api.soledgic.com/v1/billing" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "get_subscription",
  "organization_id": "organization_id_123",
  "price_id": "price_id_123",
  "quantity": 1000,
  "return_url": "value",
  "cancel_url": "value",
  "payment_method_id": "payment_method_id_123",
  "usage_type": "value"
}'
Check Payout Eligibility
/v1/check-payout-eligibility
GETPOSTAPI key

Check Payout Eligibility

Gateway path
https://api.soledgic.com/v1/check-payout-eligibility
Supabase function
/functions/v1/check-payout-eligibility
Source
supabase/functions/check-payout-eligibility/index.ts

Parameters

LocationNameTypeRequired
querycreator_idstringNo

Example Request

curl -X GET "https://api.soledgic.com/v1/check-payout-eligibility?creator_id=creator_id_123" \
  -H "x-api-key: sk_test_YOUR_API_KEY"
Close Period
/v1/close-period
POSTAPI key

Close Accounting Period

Gateway path
https://api.soledgic.com/v1/close-period
Supabase function
/functions/v1/close-period
Source
supabase/functions/close-period/index.ts

Parameters

LocationNameTypeRequired
bodyyearnumberYes
bodymonthnumberNo
bodyquarternumberNo
bodynotesstringNo

Example Request

curl -X POST "https://api.soledgic.com/v1/close-period" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "year": 1000,
  "month": 1000,
  "quarter": 1000,
  "notes": "value"
}'
Configure Alerts
/v1/configure-alerts
POSTAPI key

Configure Alerts

Gateway path
https://api.soledgic.com/v1/configure-alerts
Supabase function
/functions/v1/configure-alerts
Source
supabase/functions/configure-alerts/index.ts

Parameters

LocationNameTypeRequired
bodyaction'list' | 'create' | 'update' | 'delete' | 'test'Yes
bodyconfig_idstringNo
bodyalert_type'breach_risk' | 'projection_created' | 'instrument_invalidated'No
bodychannel'slack' | 'email' | 'webhook'No
bodyconfig{No
bodywebhook_urlstringNo
bodychannelstringNo
bodyrecipientsstring[]No
bodythresholds{No
bodycoverage_ratio_belownumberNo
bodyshortfall_abovenumberNo
bodyis_activebooleanNo

Example Request

curl -X POST "https://api.soledgic.com/v1/configure-alerts" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "list",
  "config_id": "config_id_123",
  "alert_type": "breach_risk",
  "channel": "value",
  "config": {},
  "webhook_url": "value",
  "recipients": [
    "item_1"
  ]
}'
Configure Risk Policy
/v1/configure-risk-policy
POSTAPI key

Configure Risk Policy

Gateway path
https://api.soledgic.com/v1/configure-risk-policy
Supabase function
/functions/v1/configure-risk-policy
Source
supabase/functions/configure-risk-policy/index.ts

Parameters

LocationNameTypeRequired
bodyaction'create' | 'list' | 'delete'Yes
bodypolicy_type'require_instrument' | 'budget_cap' | 'projection_guard'No
bodyconfigRecord<string, any>No
bodyseverity'hard' | 'soft'No
bodyprioritynumberNo
bodypolicy_idstringNo

Example Request

curl -X POST "https://api.soledgic.com/v1/configure-risk-policy" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "create",
  "policy_type": "require_instrument",
  "config": {},
  "severity": "hard",
  "priority": 1000,
  "policy_id": "policy_id_123"
}'
Connected Accounts
/v1/connected-accounts
POSTAPI key

Connected Accounts

Gateway path
https://api.soledgic.com/v1/connected-accounts
Supabase function
/functions/v1/connected-accounts
Source
supabase/functions/connected-accounts/index.ts

Parameters

LocationNameTypeRequired
bodyaction'create' | 'get' | 'list' | 'update_status' | 'create_onboarding_link' | 'cre...Yes
bodyentity_type'creator' | 'venture' | 'merchant'No
bodyentity_idstringNo
bodyemailstringNo
bodydisplay_namestringNo
bodycountrystringNo
bodyconnected_account_idstringNo
bodystripe_account_idstringNo
bodyentity_type_filterstringNo
bodystatus_filterstringNo
bodylimitnumberNo
bodyoffsetnumberNo
bodyreturn_urlstringNo
bodyrefresh_urlstringNo

Example Request

curl -X POST "https://api.soledgic.com/v1/connected-accounts" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "create",
  "entity_type": "creator",
  "entity_id": "entity_id_123",
  "email": "user@example.com",
  "display_name": "value",
  "country": "value",
  "connected_account_id": "connected_account_id_123",
  "stripe_account_id": "stripe_account_id_123"
}'
Create Checkout
/v1/create-checkout
POSTAPI key

Create Checkout

Gateway path
https://api.soledgic.com/v1/create-checkout
Supabase function
/functions/v1/create-checkout
Source
supabase/functions/create-checkout/index.ts

Parameters

LocationNameTypeRequired
bodyamountnumberYes
bodycreator_idstringYes
bodycurrencystringNo
bodyproduct_idstringNo
bodyproduct_namestringNo
bodycustomer_emailstringNo
bodycustomer_idstringNo
bodycapture_method'automatic' | 'manual'No
bodysetup_future_usage'off_session' | 'on_session'No
bodymetadataRecord<string, string>No

Example Request

curl -X POST "https://api.soledgic.com/v1/create-checkout" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 1000,
  "creator_id": "creator_id_123",
  "currency": "value",
  "product_id": "product_id_123",
  "product_name": "value",
  "customer_email": "user@example.com",
  "customer_id": "customer_id_123",
  "capture_method": "automatic"
}'
Create Creator
/v1/create-creator
POSTAPI key

Create Creator

Gateway path
https://api.soledgic.com/v1/create-creator
Supabase function
/functions/v1/create-creator
Source
supabase/functions/create-creator/index.ts

Parameters

LocationNameTypeRequired
bodycreator_idstringYes
bodydisplay_namestringNo
bodyemailstringNo
bodydefault_split_percentnumberNo
bodytax_info{No
bodytax_id_type'ssn' | 'ein' | 'itin'No
bodytax_id_last4stringNo
bodylegal_namestringNo
bodybusiness_type'individual' | 'sole_proprietor' | 'llc' | 'corporation' | 'partnership'No
bodyaddress{No
bodyline1stringNo
bodyline2stringNo
bodycitystringNo
bodystatestringNo
bodypostal_codestringNo
bodycountrystringNo
bodypayout_preferences{No
bodyschedule'manual' | 'weekly' | 'biweekly' | 'monthly'No
bodyminimum_amountnumberNo
bodymethod'stripe' | 'paypal' | 'bank_transfer'No
bodymetadataRecord<string, any>No

Example Request

curl -X POST "https://api.soledgic.com/v1/create-creator" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "creator_id": "creator_id_123",
  "display_name": "value",
  "email": "user@example.com",
  "default_split_percent": 20,
  "tax_info": {},
  "tax_id_type": "ssn",
  "tax_id_last4": "tax_id_last4_123",
  "legal_name": "value"
}'
Create Ledger
/v1/create-ledger
POSTPublic/JWT

Create Ledger

Gateway path
https://api.soledgic.com/v1/create-ledger
Supabase function
/functions/v1/create-ledger
Source
supabase/functions/create-ledger/index.ts

Parameters

LocationNameTypeRequired
bodybusiness_namestringYes
bodyowner_emailstringYes
bodyledger_mode'standard' | 'platform'No
bodysettings{No
bodydefault_tax_ratenumberNo
bodyfiscal_year_startstringNo
bodyreceipt_thresholdnumberNo
bodydefault_split_percentnumberNo
bodyplatform_fee_percentnumberNo
bodymin_payout_amountnumberNo
bodypayout_schedule'manual' | 'weekly' | 'monthly'No
bodytax_withholding_percentnumberNo
bodycurrencystringNo

Example Request

curl -X POST "https://api.soledgic.com/v1/create-ledger" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "business_name": "value",
  "owner_email": "user@example.com",
  "ledger_mode": "standard",
  "settings": {},
  "default_tax_rate": 1000,
  "fiscal_year_start": "value",
  "receipt_threshold": 1000,
  "default_split_percent": 20
}'
Debug Expense
/v1/debug-expense
POSTAPI keyInternal

Debug version of record-expense to capture actual errors

Gateway path
https://api.soledgic.com/v1/debug-expense
Supabase function
/functions/v1/debug-expense
Source
supabase/functions/debug-expense/index.ts

Parameters

No formal parameters were inferred for this endpoint from source declarations.

Example Request

curl -X POST "https://api.soledgic.com/v1/debug-expense" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "example": "value"
}'
Debug Handler
/v1/debug-handler
POSTAPI keyInternal

Debug version using createHandler to isolate the issue

Gateway path
https://api.soledgic.com/v1/debug-handler
Supabase function
/functions/v1/debug-handler
Source
supabase/functions/debug-handler/index.ts

Parameters

LocationNameTypeRequired
bodymessagestringNo

Example Request

curl -X POST "https://api.soledgic.com/v1/debug-handler" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "message": "value"
}'
Execute Payout
/v1/execute-payout
POSTAPI key

Soledgic Processor Adapter

Gateway path
https://api.soledgic.com/v1/execute-payout
Supabase function
/functions/v1/execute-payout
Source
supabase/functions/execute-payout/index.ts

Parameters

LocationNameTypeRequired
bodyaction'execute' | 'batch_execute' | 'get_status' | 'configure_rail' | 'list_rails' ...Yes
bodypayout_idstringNo
bodypayout_idsstring[]No
bodyrailPayoutRailNo
bodyrail_configRailConfigNo

Example Request

curl -X POST "https://api.soledgic.com/v1/execute-payout" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "execute",
  "payout_id": "payout_id_123",
  "payout_ids": [
    "item_1"
  ],
  "rail": "value",
  "rail_config": "value"
}'
Export Report
/v1/export-report
POSTAPI key

Export Report

Gateway path
https://api.soledgic.com/v1/export-report
Supabase function
/functions/v1/export-report
Source
supabase/functions/export-report/index.ts

Parameters

LocationNameTypeRequired
bodyreport_type'transaction_detail' | 'creator_earnings' | 'platform_revenue' |Yes
bodyformat'csv' | 'json'Yes
bodystart_datestringNo
bodyend_datestringNo
bodycreator_idstringNo

Example Request

curl -X POST "https://api.soledgic.com/v1/export-report" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "report_type": "transaction_detail",
  "format": "csv",
  "start_date": "2026-01-01",
  "end_date": "2026-01-01",
  "creator_id": "creator_id_123"
}'
Frozen Statements
/v1/frozen-statements
POSTAPI key

Frozen Statements

Gateway path
https://api.soledgic.com/v1/frozen-statements
Supabase function
/functions/v1/frozen-statements
Source
supabase/functions/frozen-statements/index.ts

Parameters

LocationNameTypeRequired
bodyactionActionYes
bodyperiod_idstringNo
bodystatement_typeStatementTypeNo

Example Request

curl -X POST "https://api.soledgic.com/v1/frozen-statements" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "value",
  "period_id": "period_id_123",
  "statement_type": "value"
}'
Generate Pdf
/v1/generate-pdf
POSTAPI key

Generate PDF Reports

Gateway path
https://api.soledgic.com/v1/generate-pdf
Supabase function
/functions/v1/generate-pdf
Source
supabase/functions/generate-pdf/index.ts

Parameters

LocationNameTypeRequired
bodyreport_typeReportTypeYes
bodyperiod_idstringNo
bodycreator_idstringNo
bodystart_datestringNo
bodyend_datestringNo
bodytax_yearnumberNo
bodyledger_idstringNo

Example Request

curl -X POST "https://api.soledgic.com/v1/generate-pdf" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "report_type": "value",
  "period_id": "period_id_123",
  "creator_id": "creator_id_123",
  "start_date": "2026-01-01",
  "end_date": "2026-01-01",
  "tax_year": 1000,
  "ledger_id": "ledger_id_123"
}'
Generate Report
/v1/generate-report
POSTAPI key

Generate Report

Gateway path
https://api.soledgic.com/v1/generate-report
Supabase function
/functions/v1/generate-report
Source
supabase/functions/generate-report/index.ts

Parameters

LocationNameTypeRequired
bodyreport_typeReportTypeYes
bodystart_datestringNo
bodyend_datestringNo
bodycreator_idstringNo
bodyformat'json' | 'csv'No

Example Request

curl -X POST "https://api.soledgic.com/v1/generate-report" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "report_type": "value",
  "start_date": "2026-01-01",
  "end_date": "2026-01-01",
  "creator_id": "creator_id_123",
  "format": "json"
}'
Generate Tax Summary
/v1/generate-tax-summary
POSTAPI key

Generate Tax Summary

Gateway path
https://api.soledgic.com/v1/generate-tax-summary
Supabase function
/functions/v1/generate-tax-summary
Source
supabase/functions/generate-tax-summary/index.ts

Parameters

LocationNameTypeRequired
bodytax_yearnumberYes
bodycreator_idstringNo

Example Request

curl -X POST "https://api.soledgic.com/v1/generate-tax-summary" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "tax_year": 1000,
  "creator_id": "creator_id_123"
}'
Get Balance
/v1/get-balance
GETAPI key

Get Balance

Gateway path
https://api.soledgic.com/v1/get-balance
Supabase function
/functions/v1/get-balance
Source
supabase/functions/get-balance/index.ts

Parameters

LocationNameTypeRequired
querycreator_idstringNo
queryinclude_platformstringNo

Example Request

curl -X GET "https://api.soledgic.com/v1/get-balance?creator_id=creator_id_123&include_platform=value" \
  -H "x-api-key: sk_test_YOUR_API_KEY"
Get Balances
/v1/get-balances
GETPOSTAPI key

Get Balances

Gateway path
https://api.soledgic.com/v1/get-balances
Supabase function
/functions/v1/get-balances
Source
supabase/functions/get-balances/index.ts

Parameters

LocationNameTypeRequired
bodyactionActionYes
bodyaccount_idstringNo
bodycreator_idstringNo
bodyas_of_datestringNo

Example Request

curl -X GET "https://api.soledgic.com/v1/get-balances" \
  -H "x-api-key: sk_test_YOUR_API_KEY"
Get Runway
/v1/get-runway
GETAPI key

Get Runway

Gateway path
https://api.soledgic.com/v1/get-runway
Supabase function
/functions/v1/get-runway
Source
supabase/functions/get-runway/index.ts

Parameters

No formal parameters were inferred for this endpoint from source declarations.

Example Request

curl -X GET "https://api.soledgic.com/v1/get-runway" \
  -H "x-api-key: sk_test_YOUR_API_KEY"
Get Transactions
/v1/get-transactions
GETAPI key

Get Transactions

Gateway path
https://api.soledgic.com/v1/get-transactions
Supabase function
/functions/v1/get-transactions
Source
supabase/functions/get-transactions/index.ts

Parameters

LocationNameTypeRequired
querycreator_idstringNo
querytypestringNo
querystatusstringNo
querystart_datestringNo
queryend_datestringNo
querypagestringNo
queryper_pagestringNo
queryinclude_entriesstringNo

Example Request

curl -X GET "https://api.soledgic.com/v1/get-transactions?creator_id=creator_id_123&type=value&status=value&start_date=2026-01-01" \
  -H "x-api-key: sk_test_YOUR_API_KEY"
Health Check
/v1/health-check
POSTPublic/JWTInternal

Health Check

Gateway path
https://api.soledgic.com/v1/health-check
Supabase function
/functions/v1/health-check
Source
supabase/functions/health-check/index.ts

Parameters

LocationNameTypeRequired
bodyaction'run' | 'status' | 'history' | 'run_all'Yes
bodyledger_idstringNo

Example Request

curl -X POST "https://api.soledgic.com/v1/health-check" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "run",
  "ledger_id": "ledger_id_123"
}'
Import Bank Statement
/v1/import-bank-statement
POSTAPI key

Import Bank Statement

Gateway path
https://api.soledgic.com/v1/import-bank-statement
Supabase function
/functions/v1/import-bank-statement
Source
supabase/functions/import-bank-statement/index.ts

Parameters

LocationNameTypeRequired
bodybank_account_idstringYes
bodylinesBankStatementLine[]Yes
bodyauto_matchbooleanNo

Example Request

curl -X POST "https://api.soledgic.com/v1/import-bank-statement" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "bank_account_id": "bank_account_id_123",
  "lines": [
    "item_1"
  ],
  "auto_match": true
}'
Import Transactions
/v1/import-transactions
POSTAPI key

Import Transactions

Gateway path
https://api.soledgic.com/v1/import-transactions
Supabase function
/functions/v1/import-transactions
Source
supabase/functions/import-transactions/index.ts

Parameters

LocationNameTypeRequired
bodyaction'parse_preview' | 'import' | 'get_templates' | 'save_template'Yes
bodyformat'csv' | 'ofx' | 'qfx' | 'auto'No
bodydatastringNo
bodymappingColumnMappingNo
bodytemplate_idstringNo
bodytemplateImportTemplateNo
bodytransactionsParsedTransaction[]No
bodyaccount_namestringNo

Example Request

curl -X POST "https://api.soledgic.com/v1/import-transactions" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "parse_preview",
  "format": "csv",
  "data": "value",
  "mapping": "value",
  "template_id": "template_id_123",
  "template": "value",
  "transactions": [
    "item_1"
  ],
  "account_name": "value"
}'
Invoices
/v1/invoices
GETPOSTAPI key

Invoice Management

Gateway path
https://api.soledgic.com/v1/invoices
Supabase function
/functions/v1/invoices
Source
supabase/functions/invoices/index.ts

Parameters

LocationNameTypeRequired
querystatusstringNo
querycustomer_idstringNo
querylimitstringNo
queryoffsetstringNo
bodycustomer_namestringYes
bodycustomer_emailstringNo
bodycustomer_idstringNo
bodycustomer_address{No
bodyline1stringNo
bodyline2stringNo
bodycitystringNo
bodystatestringNo
bodypostal_codestringNo
bodycountrystringNo
bodyline_itemsInvoiceLineItem[]Yes
bodydue_datestringNo
bodynotesstringNo
bodytermsstringNo
bodyreference_idstringNo
bodymetadataRecord<string, any>No

Example Request

curl -X GET "https://api.soledgic.com/v1/invoices?status=value&customer_id=customer_id_123&limit=value&offset=value" \
  -H "x-api-key: sk_test_YOUR_API_KEY"
List Ledgers
/v1/list-ledgers
GETPublic/JWT

List Ledgers

Gateway path
https://api.soledgic.com/v1/list-ledgers
Supabase function
/functions/v1/list-ledgers
Source
supabase/functions/list-ledgers/index.ts

Parameters

No formal parameters were inferred for this endpoint from source declarations.

Example Request

curl -X GET "https://api.soledgic.com/v1/list-ledgers" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"
Manage Bank Accounts
/v1/manage-bank-accounts
GETPOSTAPI key

Manage Bank Accounts

Gateway path
https://api.soledgic.com/v1/manage-bank-accounts
Supabase function
/functions/v1/manage-bank-accounts
Source
supabase/functions/manage-bank-accounts/index.ts

Parameters

LocationNameTypeRequired
bodybank_namestringYes
bodyaccount_namestringYes
bodyaccount_type'checking' | 'savings' | 'credit_card' | 'paypal' | 'other'Yes
bodyaccount_last_fourstringNo

Example Request

curl -X GET "https://api.soledgic.com/v1/manage-bank-accounts" \
  -H "x-api-key: sk_test_YOUR_API_KEY"
Manage Budgets
/v1/manage-budgets
GETPOSTAPI key

Manage Budgets

Gateway path
https://api.soledgic.com/v1/manage-budgets
Supabase function
/functions/v1/manage-budgets
Source
supabase/functions/manage-budgets/index.ts

Parameters

LocationNameTypeRequired
bodynamestringYes
bodycategory_codestringNo
bodybudget_amountnumberYes
bodybudget_period'weekly' | 'monthly' | 'quarterly' | 'annual'Yes
bodyalert_at_percentagenumberNo

Example Request

curl -X GET "https://api.soledgic.com/v1/manage-budgets" \
  -H "x-api-key: sk_test_YOUR_API_KEY"
Manage Contractors
/v1/manage-contractors
GETPOSTAPI key

Manage Contractors

Gateway path
https://api.soledgic.com/v1/manage-contractors
Supabase function
/functions/v1/manage-contractors
Source
supabase/functions/manage-contractors/index.ts

Parameters

LocationNameTypeRequired
bodycontractor_idstringYes
bodyamountnumberYes
bodypayment_datestringYes
bodypayment_methodstringNo
bodypayment_referencestringNo
bodydescriptionstringNo

Example Request

curl -X GET "https://api.soledgic.com/v1/manage-contractors" \
  -H "x-api-key: sk_test_YOUR_API_KEY"
Manage Recurring
/v1/manage-recurring
GETPOSTAPI key

Manage Recurring Expenses

Gateway path
https://api.soledgic.com/v1/manage-recurring
Supabase function
/functions/v1/manage-recurring
Source
supabase/functions/manage-recurring/index.ts

Parameters

LocationNameTypeRequired
querydaysstringNo
bodynamestringYes
bodymerchant_namestringYes
bodycategory_codestringYes
bodyamountnumberYes
bodyrecurrence_interval'weekly' | 'monthly' | 'quarterly' | 'annual'Yes
bodyrecurrence_daynumberNo
bodystart_datestringYes
bodyend_datestringNo
bodybusiness_purposestringYes
bodyis_variable_amountbooleanNo

Example Request

curl -X GET "https://api.soledgic.com/v1/manage-recurring?days=value" \
  -H "x-api-key: sk_test_YOUR_API_KEY"
Manage Splits
/v1/manage-splits
POSTAPI key

Manage Splits

Gateway path
https://api.soledgic.com/v1/manage-splits
Supabase function
/functions/v1/manage-splits
Source
supabase/functions/manage-splits/index.ts

Parameters

LocationNameTypeRequired
bodyactionActionYes
bodycreator_idstringNo
bodycreator_percentnumberNo
bodyproduct_idstringNo

Example Request

curl -X POST "https://api.soledgic.com/v1/manage-splits" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "value",
  "creator_id": "creator_id_123",
  "creator_percent": 20,
  "product_id": "product_id_123"
}'
Pay Bill
/v1/pay-bill
POSTAPI key

Records payment of a bill (reduces A/P, reduces Cash)

Gateway path
https://api.soledgic.com/v1/pay-bill
Supabase function
/functions/v1/pay-bill
Source
supabase/functions/pay-bill/index.ts

Parameters

LocationNameTypeRequired
bodybill_transaction_idstringNo
bodyamountnumberYes
bodyvendor_namestringNo
bodyreference_idstringNo
bodypayment_methodstringNo
bodypayment_datestringNo
bodymetadataRecord<string, any>No

Example Request

curl -X POST "https://api.soledgic.com/v1/pay-bill" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 1000,
  "bill_transaction_id": "bill_transaction_id_123",
  "vendor_name": "value",
  "reference_id": "reference_id_123",
  "payment_method": "value",
  "payment_date": "2026-01-01",
  "metadata": {}
}'
Plaid
/v1/plaid
POSTAPI key

Plaid Integration

Gateway path
https://api.soledgic.com/v1/plaid
Supabase function
/functions/v1/plaid
Source
supabase/functions/plaid/index.ts

Parameters

LocationNameTypeRequired
bodyaction'create_link_token' | 'exchange_token' | 'list_connections' | 'sync' | 'disco...Yes
bodyconnection_idstringNo
bodypublic_tokenstringNo
bodyplaid_transaction_idstringNo
bodyledger_transaction_idstringNo
bodyrule{No
bodynamestringYes
bodyconditionsRecord<string, any>Yes
bodyactionstringYes
bodyaction_configRecord<string, any>No
bodyrule_idstringNo

Example Request

curl -X POST "https://api.soledgic.com/v1/plaid" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "value",
  "name": "value",
  "conditions": {},
  "connection_id": "connection_id_123",
  "public_token": "value",
  "plaid_transaction_id": "plaid_transaction_id_123",
  "ledger_transaction_id": "ledger_transaction_id_123"
}'
Preflight Authorization
/v1/preflight-authorization
POSTAPI key

Preflight Authorization

Gateway path
https://api.soledgic.com/v1/preflight-authorization
Supabase function
/functions/v1/preflight-authorization
Source
supabase/functions/preflight-authorization/index.ts

Parameters

LocationNameTypeRequired
bodyidempotency_keystringYes
bodyamountnumberYes
bodycurrencystringNo
bodycounterparty_namestringNo
bodyauthorizing_instrument_idstringNo
bodyexpected_datestringNo
bodycategorystringNo

Example Request

curl -X POST "https://api.soledgic.com/v1/preflight-authorization" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "idempotency_key": "idempotency_key_123",
  "amount": 1000,
  "currency": "value",
  "counterparty_name": "value",
  "authorizing_instrument_id": "authorizing_instrument_id_123",
  "expected_date": "2026-01-01",
  "category": "value"
}'
Process Payout
/v1/process-payout
POSTAPI key

Process Payout

Gateway path
https://api.soledgic.com/v1/process-payout
Supabase function
/functions/v1/process-payout
Source
supabase/functions/process-payout/index.ts

Parameters

LocationNameTypeRequired
bodycreator_idstringYes
bodyamountnumberYes
bodyreference_idstringYes
bodyreference_typestringNo
bodydescriptionstringNo
bodypayout_methodstringNo
bodyfeesnumberNo
bodyfees_paid_by'platform' | 'creator'No
bodymetadataRecord<string, any>No

Example Request

curl -X POST "https://api.soledgic.com/v1/process-payout" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "creator_id": "creator_id_123",
  "amount": 1000,
  "reference_id": "reference_id_123",
  "reference_type": "value",
  "description": "value",
  "payout_method": "value",
  "fees": 1000,
  "fees_paid_by": "platform"
}'
Process Webhooks
/v1/process-webhooks
POSTCustom/internalInternal

Process Webhooks

Gateway path
https://api.soledgic.com/v1/process-webhooks
Supabase function
/functions/v1/process-webhooks
Source
supabase/functions/process-webhooks/index.ts

Parameters

No formal parameters were inferred for this endpoint from source declarations.

Example Request

curl -X POST "https://api.soledgic.com/v1/process-webhooks" \
  -H "Content-Type: application/json" \
  -d '{
  "example": "value"
}'
Profit Loss
/v1/profit-loss
GETPOSTAPI key

Profit & Loss Report

Gateway path
https://api.soledgic.com/v1/profit-loss
Supabase function
/functions/v1/profit-loss
Source
supabase/functions/profit-loss/index.ts

Parameters

LocationNameTypeRequired
queryyearstringNo
querymonthstringNo
queryquarterstringNo
querybreakdownstringNo
querystart_datestringNo
queryend_datestringNo

Example Request

curl -X GET "https://api.soledgic.com/v1/profit-loss?year=value&month=value&quarter=value&breakdown=value" \
  -H "x-api-key: sk_test_YOUR_API_KEY"
Project Intent
/v1/project-intent
POSTAPI key

Project Intent

Gateway path
https://api.soledgic.com/v1/project-intent
Supabase function
/functions/v1/project-intent
Source
supabase/functions/project-intent/index.ts

Parameters

LocationNameTypeRequired
bodyauthorizing_instrument_idstringYes
bodyuntil_datestringYes
bodyhorizon_countnumberNo

Example Request

curl -X POST "https://api.soledgic.com/v1/project-intent" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "authorizing_instrument_id": "authorizing_instrument_id_123",
  "until_date": "2026-01-01",
  "horizon_count": 1000
}'
Receive Payment
/v1/receive-payment
POSTAPI key

Receive Payment

Gateway path
https://api.soledgic.com/v1/receive-payment
Supabase function
/functions/v1/receive-payment
Source
supabase/functions/receive-payment/index.ts

Parameters

LocationNameTypeRequired
bodyinvoice_transaction_idstringNo
bodyamountnumberYes
bodycustomer_namestringNo
bodycustomer_idstringNo
bodyreference_idstringNo
bodypayment_methodstringNo
bodypayment_datestringNo
bodymetadataRecord<string, any>No

Example Request

curl -X POST "https://api.soledgic.com/v1/receive-payment" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 1000,
  "invoice_transaction_id": "invoice_transaction_id_123",
  "customer_name": "value",
  "customer_id": "customer_id_123",
  "reference_id": "reference_id_123",
  "payment_method": "value",
  "payment_date": "2026-01-01",
  "metadata": {}
}'
Reconcile
/v1/reconcile
POSTAPI key

Reconciliation

Gateway path
https://api.soledgic.com/v1/reconcile
Supabase function
/functions/v1/reconcile
Source
supabase/functions/reconcile/index.ts

Parameters

LocationNameTypeRequired
bodyactionActionYes
bodytransaction_idstringNo
bodybank_transaction_idstringNo
bodyperiod_idstringNo
bodyas_of_datestringNo

Example Request

curl -X POST "https://api.soledgic.com/v1/reconcile" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "value",
  "transaction_id": "transaction_id_123",
  "bank_transaction_id": "bank_transaction_id_123",
  "period_id": "period_id_123",
  "as_of_date": "2026-01-01"
}'
Record Adjustment
/v1/record-adjustment
POSTAPI key

Record Adjustment Journal

Gateway path
https://api.soledgic.com/v1/record-adjustment
Supabase function
/functions/v1/record-adjustment
Source
supabase/functions/record-adjustment/index.ts

Parameters

LocationNameTypeRequired
bodyadjustment_typestringYes
bodyadjustment_datestringNo
bodyentriesAdjustmentEntry[]Yes
bodyreasonstringYes
bodyoriginal_transaction_idstringNo
bodysupporting_documentationstringNo
bodyprepared_bystringYes

Example Request

curl -X POST "https://api.soledgic.com/v1/record-adjustment" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "adjustment_type": "value",
  "entries": [
    "item_1"
  ],
  "reason": "value",
  "prepared_by": "value",
  "adjustment_date": "2026-01-01",
  "original_transaction_id": "original_transaction_id_123",
  "supporting_documentation": "value"
}'
Record Bill
/v1/record-bill
POSTAPI key

Record Bill

Gateway path
https://api.soledgic.com/v1/record-bill
Supabase function
/functions/v1/record-bill
Source
supabase/functions/record-bill/index.ts

Parameters

LocationNameTypeRequired
bodyamountnumberYes
bodydescriptionstringYes
bodyvendor_namestringYes
bodyvendor_idstringNo
bodyreference_idstringNo
bodydue_datestringNo
bodyexpense_categorystringNo
bodypaidbooleanNo
bodymetadataRecord<string, any>No
bodyauthorizing_instrument_idstringNo
bodyrisk_evaluation_idstringNo

Example Request

curl -X POST "https://api.soledgic.com/v1/record-bill" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 1000,
  "description": "value",
  "vendor_name": "value",
  "vendor_id": "vendor_id_123",
  "reference_id": "reference_id_123",
  "due_date": "2026-01-01",
  "expense_category": "value",
  "paid": true
}'
Record Expense
/v1/record-expense
POSTAPI key

Record Expense

Gateway path
https://api.soledgic.com/v1/record-expense
Supabase function
/functions/v1/record-expense
Source
supabase/functions/record-expense/index.ts

Parameters

LocationNameTypeRequired
bodyreference_idstringYes
bodyamountnumberYes
bodydescriptionstringYes
bodycategorystringNo
bodyvendor_idstringNo
bodyvendor_namestringNo
bodypaid_from'cash' | 'credit_card' | stringNo
bodyreceipt_urlstringNo
bodytax_deductiblebooleanNo
bodymetadataRecord<string, any>No
bodyauthorizing_instrument_idstringNo
bodyrisk_evaluation_idstringNo

Example Request

curl -X POST "https://api.soledgic.com/v1/record-expense" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "reference_id": "reference_id_123",
  "amount": 1000,
  "description": "value",
  "category": "value",
  "vendor_id": "vendor_id_123",
  "vendor_name": "value",
  "paid_from": "cash",
  "receipt_url": "value"
}'
Record Income
/v1/record-income
POSTAPI key

Record Income

Gateway path
https://api.soledgic.com/v1/record-income
Supabase function
/functions/v1/record-income
Source
supabase/functions/record-income/index.ts

Parameters

LocationNameTypeRequired
bodyreference_idstringYes
bodyamountnumberYes
bodydescriptionstringYes
bodycategorystringNo
bodycustomer_idstringNo
bodycustomer_namestringNo
bodyreceived_to'cash' | stringNo
bodyinvoice_idstringNo
bodymetadataRecord<string, any>No

Example Request

curl -X POST "https://api.soledgic.com/v1/record-income" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "reference_id": "reference_id_123",
  "amount": 1000,
  "description": "value",
  "category": "value",
  "customer_id": "customer_id_123",
  "customer_name": "value",
  "received_to": "cash",
  "invoice_id": "invoice_id_123"
}'
Record Opening Balance
/v1/record-opening-balance
POSTAPI key

Record Opening Balances

Gateway path
https://api.soledgic.com/v1/record-opening-balance
Supabase function
/functions/v1/record-opening-balance
Source
supabase/functions/record-opening-balance/index.ts

Parameters

LocationNameTypeRequired
bodyas_of_datestringYes
bodysource'manual' | 'imported' | 'migrated' | 'year_start'Yes
bodysource_descriptionstringNo
bodybalancesOpeningBalanceEntry[]Yes

Example Request

curl -X POST "https://api.soledgic.com/v1/record-opening-balance" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "as_of_date": "2026-01-01",
  "source": "manual",
  "balances": [
    "item_1"
  ],
  "source_description": "value"
}'
Record Refund
/v1/record-refund
POSTAPI key

Record Refund

Gateway path
https://api.soledgic.com/v1/record-refund
Supabase function
/functions/v1/record-refund
Source
supabase/functions/record-refund/index.ts

Parameters

LocationNameTypeRequired
bodyoriginal_sale_referencestringYes
bodyamountnumberNo
bodyreasonstringYes
bodyrefund_from'both' | 'platform_only' | 'creator_only'No
bodyexternal_refund_idstringNo
bodytrigger_stripe_refundbooleanNo
bodymetadataRecord<string, any>No

Example Request

curl -X POST "https://api.soledgic.com/v1/record-refund" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "original_sale_reference": "value",
  "reason": "value",
  "amount": 1000,
  "refund_from": "both",
  "external_refund_id": "external_refund_id_123",
  "trigger_stripe_refund": true,
  "metadata": {}
}'
Record Sale
/v1/record-sale
POSTAPI key

Record Sale

Gateway path
https://api.soledgic.com/v1/record-sale
Supabase function
/functions/v1/record-sale
Source
supabase/functions/record-sale/index.ts

Parameters

LocationNameTypeRequired
bodyreference_idstringYes
bodycreator_idstringYes
bodyamountnumberYes
bodyprocessing_feenumberNo
bodyprocessing_fee_paid_by'platform' | 'creator' | 'split'No
bodyproduct_idstringNo
bodyproduct_namestringNo
bodycreator_percentnumberNo
bodyskip_withholdingbooleanNo
bodymetadataRecord<string, any>No

Example Request

curl -X POST "https://api.soledgic.com/v1/record-sale" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "reference_id": "reference_id_123",
  "creator_id": "creator_id_123",
  "amount": 1000,
  "processing_fee": 1000,
  "processing_fee_paid_by": "platform",
  "product_id": "product_id_123",
  "product_name": "value",
  "creator_percent": 20
}'
Record Transfer
/v1/record-transfer
POSTAPI key

Record Internal Transfer

Gateway path
https://api.soledgic.com/v1/record-transfer
Supabase function
/functions/v1/record-transfer
Source
supabase/functions/record-transfer/index.ts

Parameters

LocationNameTypeRequired
bodyfrom_account_typestringYes
bodyto_account_typestringYes
bodyamountnumberYes
bodytransfer_type'tax_reserve' | 'payout_reserve' | 'owner_draw' |Yes
bodydescriptionstringNo
bodyreference_idstringNo

Example Request

curl -X POST "https://api.soledgic.com/v1/record-transfer" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "from_account_type": "value",
  "to_account_type": "value",
  "amount": 1000,
  "transfer_type": "tax_reserve",
  "description": "value",
  "reference_id": "reference_id_123"
}'
Register Instrument
/v1/register-instrument
POSTAPI key

Register Authorizing Instrument

Gateway path
https://api.soledgic.com/v1/register-instrument
Supabase function
/functions/v1/register-instrument
Source
supabase/functions/register-instrument/index.ts

Parameters

LocationNameTypeRequired
bodyexternal_refstringYes
bodyextracted_termsExtractedTermsYes

Example Request

curl -X POST "https://api.soledgic.com/v1/register-instrument" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "external_ref": "value",
  "extracted_terms": "value"
}'
Release Funds
/v1/release-funds
POSTAPI key

Release Funds

Gateway path
https://api.soledgic.com/v1/release-funds
Supabase function
/functions/v1/release-funds
Source
supabase/functions/release-funds/index.ts

Parameters

LocationNameTypeRequired
bodyaction'release' | 'batch_release' | 'void' | 'get_held' | 'get_summary' | 'auto_rel...Yes
bodyentry_idstringNo
bodyentry_idsstring[]No
bodyvoid_reasonstringNo
bodyventure_idstringNo
bodycreator_idstringNo
bodyready_onlybooleanNo
bodylimitnumberNo
bodyoffsetnumberNo

Example Request

curl -X POST "https://api.soledgic.com/v1/release-funds" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "release",
  "entry_id": "entry_id_123",
  "entry_ids": [
    "item_1"
  ],
  "void_reason": "void_reason_123",
  "venture_id": "venture_id_123",
  "creator_id": "creator_id_123",
  "ready_only": true,
  "limit": 1000
}'
Reverse Transaction
/v1/reverse-transaction
POSTAPI key

Reverse Transaction

Gateway path
https://api.soledgic.com/v1/reverse-transaction
Supabase function
/functions/v1/reverse-transaction
Source
supabase/functions/reverse-transaction/index.ts

Parameters

LocationNameTypeRequired
bodytransaction_idstringYes
bodyreasonstringYes
bodypartial_amountnumberNo
bodymetadataRecord<string, any>No

Example Request

curl -X POST "https://api.soledgic.com/v1/reverse-transaction" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "transaction_id": "transaction_id_123",
  "reason": "value",
  "partial_amount": 1000,
  "metadata": {}
}'
Risk Evaluation
/v1/risk-evaluation
POSTAPI key

Risk Evaluation

Gateway path
https://api.soledgic.com/v1/risk-evaluation
Supabase function
/functions/v1/risk-evaluation
Source
supabase/functions/risk-evaluation/index.ts

Parameters

LocationNameTypeRequired
bodyidempotency_keystringYes
bodyamountnumberYes
bodycurrencystringNo
bodycounterparty_namestringNo
bodyauthorizing_instrument_idstringNo
bodyexpected_datestringNo
bodycategorystringNo

Example Request

curl -X POST "https://api.soledgic.com/v1/risk-evaluation" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "idempotency_key": "idempotency_key_123",
  "amount": 1000,
  "currency": "value",
  "counterparty_name": "value",
  "authorizing_instrument_id": "authorizing_instrument_id_123",
  "expected_date": "2026-01-01",
  "category": "value"
}'
Scheduled Payouts
/v1/scheduled-payouts
POSTAPI keyInternal

Scheduled Payouts

Gateway path
https://api.soledgic.com/v1/scheduled-payouts
Supabase function
/functions/v1/scheduled-payouts
Source
supabase/functions/scheduled-payouts/index.ts

Parameters

No formal parameters were inferred for this endpoint from source declarations.

Example Request

curl -X POST "https://api.soledgic.com/v1/scheduled-payouts" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "example": "value"
}'
Security Alerts
/v1/security-alerts
POSTPublic/JWTInternal

Security Alerts

Gateway path
https://api.soledgic.com/v1/security-alerts
Supabase function
/functions/v1/security-alerts
Source
supabase/functions/security-alerts/index.ts

Parameters

No formal parameters were inferred for this endpoint from source declarations.

Example Request

curl -X POST "https://api.soledgic.com/v1/security-alerts" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "example": "value"
}'
Send Breach Alert
/v1/send-breach-alert
POSTAPI keyInternal

Send Breach Alert

Gateway path
https://api.soledgic.com/v1/send-breach-alert
Supabase function
/functions/v1/send-breach-alert
Source
supabase/functions/send-breach-alert/index.ts

Parameters

LocationNameTypeRequired
bodycash_balancenumberYes
bodypending_totalnumberYes
bodyshortfallnumberYes
bodycoverage_rationumberYes
bodytriggered_by'project_intent' | 'get_runway' | 'manual'Yes
bodyinstrument_idstringNo
bodyexternal_refstringNo
bodyprojections_creatednumberNo
bodychannel'slack' | 'email' | 'webhook'No

Example Request

curl -X POST "https://api.soledgic.com/v1/send-breach-alert" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "cash_balance": 1000,
  "pending_total": 1000,
  "shortfall": 1000,
  "coverage_ratio": 1000,
  "triggered_by": "project_intent",
  "instrument_id": "instrument_id_123",
  "external_ref": "value",
  "projections_created": 1000
}'
Send Statements
/v1/send-statements
POSTAPI key

Soledgic Auto-Email Service

Gateway path
https://api.soledgic.com/v1/send-statements
Supabase function
/functions/v1/send-statements
Source
supabase/functions/send-statements/index.ts

Parameters

LocationNameTypeRequired
bodyaction'send_monthly_statements' | 'send_single_statement' | 'preview' | 'get_queue'...Yes
bodyledger_idstringNo
bodycreator_idstringNo
bodyyearnumberNo
bodymonthnumberNo
bodyemail_configEmailConfigNo

Example Request

curl -X POST "https://api.soledgic.com/v1/send-statements" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "send_monthly_statements",
  "ledger_id": "ledger_id_123",
  "creator_id": "creator_id_123",
  "year": 1000,
  "month": 1000,
  "email_config": "user@example.com"
}'
Stripe
/v1/stripe
POSTAPI key

Stripe Management

Gateway path
https://api.soledgic.com/v1/stripe
Supabase function
/functions/v1/stripe
Source
supabase/functions/stripe/index.ts

Parameters

LocationNameTypeRequired
bodyaction'list_transactions' | 'list_events' | 'match' | 'unmatch' | 'exclude' |Yes
bodystripe_transaction_idstringNo
bodyledger_transaction_idstringNo
bodyevent_idstringNo
bodybank_transaction_idstringNo

Example Request

curl -X POST "https://api.soledgic.com/v1/stripe" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "list_transactions",
  "stripe_transaction_id": "stripe_transaction_id_123",
  "ledger_transaction_id": "ledger_transaction_id_123",
  "event_id": "event_id_123",
  "bank_transaction_id": "bank_transaction_id_123"
}'
Stripe Billing Webhook
/v1/stripe-billing-webhook
POSTWebhook signature

Stripe Billing Webhook

Gateway path
https://api.soledgic.com/v1/stripe-billing-webhook
Supabase function
/functions/v1/stripe-billing-webhook
Source
supabase/functions/stripe-billing-webhook/index.ts

Parameters

No formal parameters were inferred for this endpoint from source declarations.

Example Request

curl -X POST "https://api.soledgic.com/v1/stripe-billing-webhook" \
  -H "x-webhook-signature: YOUR_SIGNATURE" \
  -H "Content-Type: application/json" \
  -d '{
  "example": "value"
}'
Stripe Connect Webhook
/v1/stripe-connect-webhook
POSTWebhook signature

Stripe Connect Webhook

Gateway path
https://api.soledgic.com/v1/stripe-connect-webhook
Supabase function
/functions/v1/stripe-connect-webhook
Source
supabase/functions/stripe-connect-webhook/index.ts

Parameters

No formal parameters were inferred for this endpoint from source declarations.

Example Request

curl -X POST "https://api.soledgic.com/v1/stripe-connect-webhook" \
  -H "x-webhook-signature: YOUR_SIGNATURE" \
  -H "Content-Type: application/json" \
  -d '{
  "example": "value"
}'
Stripe Reconciliation
/v1/stripe-reconciliation
POSTAPI key

Stripe Reconciliation

Gateway path
https://api.soledgic.com/v1/stripe-reconciliation
Supabase function
/functions/v1/stripe-reconciliation
Source
supabase/functions/stripe-reconciliation/index.ts

Parameters

LocationNameTypeRequired
bodyaction'sync_balance_transactions' | 'auto_match' | 'check_drift' | 'run_daily'Yes
bodyledger_idstringNo
bodysincestringNo
bodylimitnumberNo

Example Request

curl -X POST "https://api.soledgic.com/v1/stripe-reconciliation" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "sync_balance_transactions",
  "ledger_id": "ledger_id_123",
  "since": "value",
  "limit": 1000
}'
Stripe Webhook
/v1/stripe-webhook
POSTWebhook signatureDeprecated

Stripe Webhook

Gateway path
https://api.soledgic.com/v1/stripe-webhook
Supabase function
/functions/v1/stripe-webhook
Source
supabase/functions/stripe-webhook/index.ts

Parameters

No formal parameters were inferred for this endpoint from source declarations.

Example Request

curl -X POST "https://api.soledgic.com/v1/stripe-webhook" \
  -H "x-webhook-signature: YOUR_SIGNATURE" \
  -H "Content-Type: application/json" \
  -d '{
  "example": "value"
}'
Submit Tax Info
/v1/submit-tax-info
POSTPublic/JWTDeprecated

Submit Tax Info

Gateway path
https://api.soledgic.com/v1/submit-tax-info
Supabase function
/functions/v1/submit-tax-info
Source
supabase/functions/submit-tax-info/index.ts

Parameters

No formal parameters were inferred for this endpoint from source declarations.

Example Request

curl -X POST "https://api.soledgic.com/v1/submit-tax-info" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "example": "value"
}'
Tax Documents
/v1/tax-documents
POSTAPI key

Tax Documents

Gateway path
https://api.soledgic.com/v1/tax-documents
Supabase function
/functions/v1/tax-documents
Source
supabase/functions/tax-documents/index.ts

Parameters

LocationNameTypeRequired
bodyaction'calculate' | 'generate_all' | 'list' | 'get' | 'export' | 'mark_filed'Yes
bodytax_yearnumberNo
bodycreator_idstringNo
bodydocument_idstringNo
bodyformat'csv' | 'json'No

Example Request

curl -X POST "https://api.soledgic.com/v1/tax-documents" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "calculate",
  "tax_year": 1000,
  "creator_id": "creator_id_123",
  "document_id": "document_id_123",
  "format": "csv"
}'
Test Cleanup
/v1/test-cleanup
POSTAPI keyInternal

Test Data Cleanup

Gateway path
https://api.soledgic.com/v1/test-cleanup
Supabase function
/functions/v1/test-cleanup
Source
supabase/functions/test-cleanup/index.ts

Parameters

No formal parameters were inferred for this endpoint from source declarations.

Example Request

curl -X POST "https://api.soledgic.com/v1/test-cleanup" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "example": "value"
}'
Trial Balance
/v1/trial-balance
GETPOSTAPI key

Trial Balance

Gateway path
https://api.soledgic.com/v1/trial-balance
Supabase function
/functions/v1/trial-balance
Source
supabase/functions/trial-balance/index.ts

Parameters

LocationNameTypeRequired
querysnapshotstringNo
queryas_ofstringNo

Example Request

curl -X GET "https://api.soledgic.com/v1/trial-balance?snapshot=value&as_of=value" \
  -H "x-api-key: sk_test_YOUR_API_KEY"
Upload Receipt
/v1/upload-receipt
POSTAPI key

Upload Receipt

Gateway path
https://api.soledgic.com/v1/upload-receipt
Supabase function
/functions/v1/upload-receipt
Source
supabase/functions/upload-receipt/index.ts

Parameters

LocationNameTypeRequired
bodyfile_urlstringYes
bodyfile_namestringNo
bodyfile_sizenumberNo
bodymime_typestringNo
bodymerchant_namestringNo
bodytransaction_datestringNo
bodytotal_amountnumberNo
bodytransaction_idstringNo

Example Request

curl -X POST "https://api.soledgic.com/v1/upload-receipt" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "file_url": "value",
  "file_name": "value",
  "file_size": 1000,
  "mime_type": "value",
  "merchant_name": "value",
  "transaction_date": "2026-01-01",
  "total_amount": 1000,
  "transaction_id": "transaction_id_123"
}'
Webhooks
/v1/webhooks
POSTAPI key

Webhooks Management

Gateway path
https://api.soledgic.com/v1/webhooks
Supabase function
/functions/v1/webhooks
Source
supabase/functions/webhooks/index.ts

Parameters

LocationNameTypeRequired
bodyaction'list' | 'create' | 'update' | 'delete' | 'test' | 'deliveries' | 'retry' | '...Yes
bodyendpoint_idstringNo
bodydelivery_idstringNo
bodyurlstringNo
bodydescriptionstringNo
bodyeventsstring[]No
bodyis_activebooleanNo

Example Request

curl -X POST "https://api.soledgic.com/v1/webhooks" \
  -H "x-api-key: sk_test_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "list",
  "endpoint_id": "endpoint_id_123",
  "delivery_id": "delivery_id_123",
  "url": "value",
  "description": "value",
  "events": [
    "item_1"
  ],
  "is_active": true
}'

Error Responses

All endpoints return a consistent error envelope.

{
  "success": false,
  "error": "Error message here",
  "request_id": "req_xxx"
}
CodeMeaning
400Validation or malformed request
401Missing or invalid authentication
403Forbidden or account inactive
404Resource not found
409State conflict (duplicate or invalid transition)
413Payload too large
429Rate limit exceeded
500Internal server error