TenantUpdateRequest
Version: v3.0.0
Supporting model
A request/response or nested model — not a stored DynamoDB entity.
Overview
Tenant Model
Fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
business_name | str | ✅ | — | — |
business_id | str | ✅ | — | — |
gst_number | str | ✅ | — | — |
business_admin_email | str | ✅ | — | — |
business_accounts_email | str | ✅ | — | — |
business_sales_email | str | ✅ | — | — |
business_phone_number | str | ✅ | — | — |
business_address | str | ✅ | — | — |
business_postal_code | str | ✅ | — | — |
country_code | str | ✅ | — | — |
branding_colour | str | ✅ | — | — |
autofill_capricorn_message | bool | ❌ | False | — |
dont_sync_cash_invoices_to_xero | bool | ❌ | True | — |
show_capricorn_lookup | bool | ❌ | False | — |
work_order_notifications | List[WorkOrderNotifications] (EMAIL, SMS) | ❌ | [] | — |
use_xero_invoices | bool | ❌ | False | — |
APIs / Triggers
| Trigger | Endpoint / Source | Detail | Handler |
|---|---|---|---|
| API | PUT /newtenant/ | — | src/tenant_put.py |
Change history
v3.0.0 · 2026-03-19 · Cian (shared account) · 0a1de5dd0
Add invoice defaults API and migrate tenant default fields
- Removed field
default_invoice_action(breaking). - Removed field
default_restocking_fee(breaking). - Removed field
line_item_tax_type(breaking). - Removed field
trigger_payment_after_add_invoice(breaking).
v2.1.0 · 2025-10-18 · Cian (shared account) · 5d54a9c10
fx
- Added optional field
use_xero_invoices. - Added optional field
work_order_notifications.
v2.0.0 · 2025-04-18 · Cian (shared account) · 46be395b4
revert
- Removed field
default_navigation_bar_closed(breaking).
v1.1.0 · 2025-04-18 · Cian (shared account) · 0ae7df4bb
nav bar
- Added optional field
default_navigation_bar_closed.
v1.0.0 · 2025-03-16 · Cian (shared account) · feca668a3
models
- Initial version.
Generated from
dismantly-backend/Microservices/Tenant/dependencies/models.py. Do not edit by hand.