Create Tenant

POST/external/v1/tenants/create/

Create a company tenant for a user, linked to an accounting platform (manual, xero, quickbooks, or myob). Platform-specific fields are required depending on the chosen platform.

ApiDocsParametersTitle

ApiDocsParamField	ApiDocsParamType	ApiDocsParamRequired	ApiDocsParamDescription
user_id	integer	ApiDocsRequired	LynxLedger user id that owns the tenant.
platform	string	ApiDocsRequired	One of: manual, xero, quickbooks, myob.
cash_flow_method	string	ApiDocsRequired	direct or indirect.
company_name	string	ApiDocsOptional	Required for manual / myob platforms.
currency	string	ApiDocsOptional	3-letter ISO currency (manual / myob).

ApiDocsRequestLabel

curl -X POST https://<api-host>/external/v1/tenants/create/ \
  -H "X-API-Key: <encrypted_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "user_id": 42,
    "platform": "manual",
    "cash_flow_method": "indirect",
    "company_name": "Acme Corporation Pte Ltd",
    "currency": "SGD"
  }'

ApiDocsResponseLabel

{
  "status": "success",
  "status_code": 200,
  "data": {
    "tenant_domain_url": "acme-corp",
    "schema_name": "acme_corp",
    "platform": "manual"
  }
}