Contact

Version: v2.0.0

Stored entity

Partition key pk, sort key sk • discriminator type = "CONTACT"

Overview

Contact Model

Field	Type	Required	Default	Description
`pk`	`str`	✅	—	—
`sk`	`str`	✅	—	—
`contact_id`	`str`	✅	—	—
`tenant_id`	`str`	✅	—	—
`contact_name`	`str`	✅	—	—
`contact_email`	`str`	❌	—	—
`contact_phone`	`str`	❌	—	—
`contact_status`	`str`	✅	—	—
`is_business_contact`	`bool`	❌	`False`	—
`is_capricorn_member`	`bool`	❌	`False`	—
`is_on_hold`	`bool`	❌	`False`	—
`on_hold_at`	`str`	❌	—	—
`is_hidden`	`bool`	✅	—	—
`type`	`str`	❌	`CONTACT`	—
`account_number`	`str`	❌	—	—
`payment_type`	`PaymentType` (`ACCOUNT`, `CASH`, `CAPRICORN`)	❌	—	PaymentType
`primary_people`	List[`PrimaryPerson`]	✅	—	—
`delivery_address`	`Address`	✅	—	Address model
`same_as_delivery_address`	`bool`	✅	—	—
`billing_address`	`Address`	✅	—	Address model
`note`	`str`	❌	—	—
`credit_limit`	`float`	❌	—	—
`block_new_invoice_if_credit_exceeded`	`bool`	❌	`False`	—
`line_item_tax_type`	`LineItemTaxType` (`EXCLUSIVE`, `INCLUSIVE`, `NO_TAX`)	❌	—	LineItemTaxType
`sales_account`	`SalesAccount`	❌	—	Account
`default_due_date`	`str`	❌	—	—
`contact_type`	`ContactType` (`CUSTOMER`, `SUPPLIER`, `BOTH`)	❌	—	ContactType
`created_at`	`str`	✅	—	—
`updated_at`	`str`	✅	—	—

Models embedded in the fields above — shown inline; they have no separate page.

PrimaryPerson — v2.0.0

Field	Type	Required	Default	Description
`primary_person_id`	`str`	✅	—	—
`primary_person_first_name`	`str`	❌	—	—
`primary_person_last_name`	`str`	❌	—	—
`primary_person_email`	`str`	❌	—	—
`position`	`Position` (`SALES`, `ACCOUNTS`, `MANAGER`)	❌	—	Position
`include_in_emails`	`bool`	❌	`False`	—

Change history

v2.0.0 · 2025-07-17 · Cian (shared account) · Added optional field position.; Field include_in_emails type changed: bool → Optional[bool] (breaking).; Field include_in_emails became optional.; Field include_in_emails default changed: None → False. (532bbaa1e)
v1.0.0 · 2025-06-26 · Cian (shared account) · Initial version. (5fb8ae8ad)

Address — v1.0.0

Field	Type	Required	Default	Description
`address_line_1`	`str`	❌	—	—
`address_line_2`	`str`	❌	—	—
`attention`	`str`	❌	—	—
`city`	`str`	❌	—	—
`country`	`str`	❌	—	—
`postal_code`	`str`	❌	—	—
`region`	`str`	❌	—	—

Change history

SalesAccount — v1.0.0

Field	Type	Required	Default	Description
`account_id`	`str`	✅	—	—
`account_name`	`str`	✅	—	—

Change history

No API or event interacts with this object directly.

v2.0.0 · 2025-07-17 · Cian (shared account) · 532bbaa1e

Added optional field block_new_invoice_if_credit_exceeded.
Added optional field contact_type.
Added optional field credit_limit.
Added optional field default_due_date.
Added optional field line_item_tax_type.
Added optional field note.
Added optional field on_hold_at.
Added optional field sales_account.
Added required field updated_at.
Field is_business_contact type changed: bool → Optional[bool] (breaking).
Field is_business_contact became optional.
Field is_business_contact default changed: None → False.
Field is_capricorn_member type changed: bool → Optional[bool] (breaking).
Field is_capricorn_member became optional.
Field is_capricorn_member default changed: None → False.
Field is_on_hold type changed: bool → Optional[bool] (breaking).
Field is_on_hold became optional.
Field is_on_hold default changed: None → False.
Field payment_type type changed: Optional[str] → Optional[PaymentType] (breaking).
Field payment_type enum value ACCOUNT added.
Field payment_type enum value CAPRICORN added.
Field payment_type enum value CASH added.
Field primary_people type changed: list[PrimaryPerson] → List[PrimaryPerson] (breaking).
Field type became optional.
Field type default changed: None → 'CONTACT'.

v1.0.0 · 2025-06-26 · Cian (shared account) · 5fb8ae8ad

work order create

Generated from dismantly-backend/Microservices/Invoice/dependencies/models.py. Do not edit by hand.