ContactPost

Version: v12.1.0

Supporting model

A request/response or nested model — not a stored DynamoDB entity.

Overview

ContactPost Model

Fields

Field	Type	Required	Default	Description
contact_name	str	✅	—	—
contact_email	str	❌	—	—
contact_phone	str	❌	—	—
is_business_contact	bool	❌	False	—
is_capricorn_member	bool	❌	False	—
is_on_hold	bool	❌	False	—
account_number	str	❌	—	—
is_hidden	bool	❌	False	—
payment_type	PaymentType (ACCOUNT, CASH, CAPRICORN)	❌	—	PaymentType
primary_people	List[PrimaryPerson]	✅	—	—
delivery_address	Address	✅	—	Address Model
same_as_delivery_address	bool	❌	False	—
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	Account	❌	—	Account
default_due_date	str	❌	—	—
contact_type	ContactType (CUSTOMER, SUPPLIER, BOTH)	❌	—	ContactType

Embedded models

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

PrimaryPerson — v8.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

• v8.0.0 · 2025-07-12 · 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. (d0f07daf2)
• v7.0.0 · 2025-07-08 · Cian (shared account) · Removed field position (breaking).; Field include_in_emails type changed: Optional[bool] → bool (breaking).; Field include_in_emails became required (breaking).; Field include_in_emails default changed: False → None. (ad0e24e1b)
• v6.0.0 · 2025-07-07 · Olaniyi Ajayi · Field position type changed: Optional[str] → Optional[Position] (breaking).; Field position enum value ACCOUNTS added.; Field position enum value MANAGER added.; Field position enum value SALES added. (485ac0313)
• v5.0.0 · 2025-07-07 · Olaniyi Ajayi · Field position type changed: Optional[Position] → Optional[str] (breaking).; Field position enum value ACCOUNTS removed (breaking).; Field position enum value MANAGER removed (breaking).; Field position enum value SALES removed (breaking). (3570a8d26)
• v4.0.0 · 2025-07-06 · Cian (shared account) · Field position type changed: Optional[str] → Optional[Position] (breaking).; Field position enum value ACCOUNTS added.; Field position enum value MANAGER added.; Field position enum value SALES added. (204ee02d7)
• v3.0.0 · 2025-07-05 · Olaniyi Ajayi · 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. (8910dd4d0)
• v2.0.0 · 2025-03-31 · Cian (shared account) · Field primary_person_id type changed: Optional[str] → str (breaking).; Field primary_person_id became required (breaking). (6d627b20f)
• v1.0.0 · 2025-03-16 · Cian (shared account) · Initial version. (0c2952ef4)

Address — v5.0.0

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

Change history

• v5.0.0 · 2025-07-16 · Cian (shared account) · Field country type changed: str → Optional[str] (breaking).; Field country became optional. (1abde6b0b)
• v4.0.0 · 2025-07-12 · Cian (shared account) · Field country type changed: Optional[str] → str (breaking).; Field country became required (breaking). (d0f07daf2)
• v3.0.0 · 2025-07-08 · Cian (shared account) · Field country type changed: str → Optional[str] (breaking).; Field country became optional. (ad0e24e1b)
• v2.0.0 · 2025-07-05 · Olaniyi Ajayi · Field country type changed: Optional[str] → str (breaking).; Field country became required (breaking). (8910dd4d0)
• v1.0.0 · 2025-03-16 · Cian (shared account) · Initial version. (0c2952ef4)

Account — v4.0.0

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

Change history

• v4.0.0 · 2025-07-07 · Olaniyi Ajayi · Removed field account_code (breaking).; Field account_id type changed: Optional[str] → str (breaking).; Field account_id became required (breaking).; Field account_name type changed: Optional[str] → str (breaking).; Field account_name became required (breaking). (485ac0313)
• v3.0.0 · 2025-07-07 · Olaniyi Ajayi · Added optional field account_code.; Field account_id type changed: str → Optional[str] (breaking).; Field account_id became optional.; Field account_name type changed: str → Optional[str] (breaking).; Field account_name became optional. (3570a8d26)
• v2.0.0 · 2025-07-06 · Cian (shared account) · Removed field account_code (breaking).; Field account_id type changed: Optional[str] → str (breaking).; Field account_id became required (breaking).; Field account_name type changed: Optional[str] → str (breaking).; Field account_name became required (breaking). (4ec8e08f5)
• v1.0.0 · 2025-07-05 · Olaniyi Ajayi · Initial version. (8910dd4d0)

APIs / Triggers

Trigger	Endpoint / Source	Detail	Handler
API	POST /newcontact/	—	src/contact_post.py

Change history

v12.1.0 · 2026-02-27 · Cian (shared account) · 90a6b50d2

init

• Added optional field is_hidden.

v12.0.0 · 2025-10-19 · Cian (shared account) · 4d42b898a

fx

• Removed field enable_work_order_notification (breaking).
• Removed field notification_channel (breaking).

v11.1.0 · 2025-10-15 · Olaniyi Ajayi · c67147264

fx

• Added optional field enable_work_order_notification.
• Added optional field notification_channel.

v11.0.0 · 2025-07-21 · Cian (shared account) · 1ed229dca

fx

• Field payment_type type changed: PaymentType → Optional[PaymentType] (breaking).
• Field payment_type became optional.

v10.0.0 · 2025-07-12 · Cian (shared account) · d0f07daf2

donefx

• 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 sales_account.
• 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] → PaymentType (breaking).
• Field payment_type became required (breaking).
• Field payment_type enum value ACCOUNT added.
• Field payment_type enum value CAPRICORN added.
• Field payment_type enum value CASH added.
• Field same_as_delivery_address type changed: bool → Optional[bool] (breaking).
• Field same_as_delivery_address became optional.
• Field same_as_delivery_address default changed: None → False.

v9.0.0 · 2025-07-08 · Cian (shared account) · ad0e24e1b

fxfx

• Removed field block_new_invoice_if_credit_exceeded (breaking).
• Removed field contact_type (breaking).
• Removed field credit_limit (breaking).
• Removed field default_due_date (breaking).
• Removed field line_item_tax_type (breaking).
• Removed field note (breaking).
• Removed field sales_account (breaking).
• Field is_business_contact type changed: Optional[bool] → bool (breaking).
• Field is_business_contact became required (breaking).
• Field is_business_contact default changed: False → None.
• Field is_capricorn_member type changed: Optional[bool] → bool (breaking).
• Field is_capricorn_member became required (breaking).
• Field is_capricorn_member default changed: False → None.
• Field is_on_hold type changed: Optional[bool] → bool (breaking).
• Field is_on_hold became required (breaking).
• Field is_on_hold default changed: False → None.
• Field payment_type type changed: PaymentType → Optional[str] (breaking).
• Field payment_type became optional.
• Field payment_type enum value ACCOUNT removed (breaking).
• Field payment_type enum value CAPRICORN removed (breaking).
• Field payment_type enum value CASH removed (breaking).
• Field same_as_delivery_address type changed: Optional[bool] → bool (breaking).
• Field same_as_delivery_address became required (breaking).
• Field same_as_delivery_address default changed: False → None.

v8.0.0 · 2025-07-07 · Olaniyi Ajayi · 485ac0313

migration script

• Removed field default_due_date_id (breaking).
• Field contact_type type changed: str → Optional[ContactType] (breaking).
• Field contact_type became optional.
• Field contact_type enum value BOTH added.
• Field contact_type enum value CUSTOMER added.
• Field contact_type enum value SUPPLIER added.
• Field line_item_tax_type type changed: Optional[str] → Optional[LineItemTaxType] (breaking).
• Field line_item_tax_type enum value EXCLUSIVE added.
• Field line_item_tax_type enum value INCLUSIVE added.
• Field line_item_tax_type enum value NO_TAX added.
• Field payment_type enum value Account removed (breaking).
• Field payment_type enum value Capricorn removed (breaking).
• Field payment_type enum value Cash removed (breaking).
• Field payment_type enum value ACCOUNT added.
• Field payment_type enum value CAPRICORN added.
• Field payment_type enum value CASH added.

v7.0.0 · 2025-07-07 · Olaniyi Ajayi · 3570a8d26

contact APIs

• Added optional field default_due_date_id.
• Field contact_type type changed: Optional[ContactType] → str (breaking).
• Field contact_type became required (breaking).
• Field contact_type enum value BOTH removed (breaking).
• Field contact_type enum value CUSTOMER removed (breaking).
• Field contact_type enum value SUPPLIER removed (breaking).
• Field line_item_tax_type type changed: Optional[LineItemTaxType] → Optional[str] (breaking).
• Field line_item_tax_type enum value EXCLUSIVE removed (breaking).
• Field line_item_tax_type enum value INCLUSIVE removed (breaking).
• Field line_item_tax_type enum value NO_TAX removed (breaking).
• Field payment_type enum value ACCOUNT removed (breaking).
• Field payment_type enum value CAPRICORN removed (breaking).
• Field payment_type enum value CASH removed (breaking).
• Field payment_type enum value Account added.
• Field payment_type enum value Capricorn added.
• Field payment_type enum value Cash added.

v6.0.0 · 2025-07-07 · Cian (shared account) · cd0b858e6

fx

• Field default_due_date type changed: Optional[DefaultDueDate] → Optional[str] (breaking).
• Field default_due_date enum value 20TH_OF_THE_FOLLOWING_MONTH removed (breaking).
• Field default_due_date enum value 20TH_OF_THIS_MONTH removed (breaking).
• Field default_due_date enum value CASH_ON_DELIVERY removed (breaking).

v5.0.0 · 2025-07-06 · Cian (shared account) · 204ee02d7

fx

• Field contact_type type changed: Optional[str] → Optional[ContactType] (breaking).
• Field contact_type enum value BOTH added.
• Field contact_type enum value CUSTOMER added.
• Field contact_type enum value SUPPLIER added.
• Field default_due_date type changed: Optional[str] → Optional[DefaultDueDate] (breaking).
• Field default_due_date enum value 20TH_OF_THE_FOLLOWING_MONTH added.
• Field default_due_date enum value 20TH_OF_THIS_MONTH added.
• Field default_due_date enum value CASH_ON_DELIVERY added.
• Field line_item_tax_type type changed: Optional[str] → Optional[LineItemTaxType] (breaking).
• Field line_item_tax_type enum value EXCLUSIVE added.
• Field line_item_tax_type enum value INCLUSIVE added.
• Field line_item_tax_type enum value NO_TAX added.

v4.0.0 · 2025-07-06 · Cian (shared account) · 3f283f85c

fx

• Field account_number type changed: PaymentType → Optional[str] (breaking).
• Field account_number became optional.
• Field account_number enum value ACCOUNT removed (breaking).
• Field account_number enum value CAPRICORN removed (breaking).
• Field account_number enum value CASH removed (breaking).
• Field contact_type type changed: str → Optional[str] (breaking).
• Field contact_type became optional.
• Field payment_type type changed: Optional[str] → PaymentType (breaking).
• Field payment_type became required (breaking).
• Field payment_type enum value ACCOUNT added.
• Field payment_type enum value CAPRICORN added.
• Field payment_type enum value CASH added.

v3.1.0 · 2025-07-06 · Cian (shared account) · 2c1a6f059

fx

• Added optional field block_new_invoice_if_credit_exceeded.

v3.0.0 · 2025-07-06 · Cian (shared account) · 4ec8e08f5

fx

• Removed field default_due_date_id (breaking).
• Field account_number type changed: PaymentTpe → PaymentType (breaking).
• Field account_number enum value account removed (breaking).
• Field account_number enum value capricorn removed (breaking).
• Field account_number enum value cash removed (breaking).
• Field account_number enum value ACCOUNT added.
• Field account_number enum value CAPRICORN added.
• Field account_number enum value CASH added.

v2.0.0 · 2025-07-05 · Olaniyi Ajayi · 8910dd4d0

init

• Added required field contact_type.
• Added optional field credit_limit.
• Added optional field default_due_date.
• Added optional field default_due_date_id.
• Added optional field line_item_tax_type.
• Added optional field note.
• Added optional field sales_account.
• Field account_number type changed: Optional[str] → PaymentTpe (breaking).
• Field account_number became required (breaking).
• Field account_number enum value account added.
• Field account_number enum value capricorn added.
• Field account_number enum value cash added.
• 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 same_as_delivery_address type changed: bool → Optional[bool] (breaking).
• Field same_as_delivery_address became optional.
• Field same_as_delivery_address default changed: None → False.

v1.0.0 · 2025-03-16 · Cian (shared account) · 0c2952ef4

init

• Initial version.

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