InvoicePut

Version: v8.0.0

Supporting model

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

Overview

InvoicePut model

Fields

Field	Type	Required	Default	Description
invoice_id	str	✅	—	—
contact_name	str	❌	—	—
contact_id	str	✅	—	—
reference	str	❌	—	—
issue_date	str	❌	—	—
due_date	str	❌	—	—
sales_person	str	❌	—	—
sales_person_id	str	❌	—	—
sales_channel	str	❌	—	—
delivery_method	str	❌	—	—
delivery_details	str	❌	—	—
line_amount_tax_type	str	✅	—	—
work_order_id	str	❌	—	—
work_order_display_id	str	❌	—	—
quote_id	str	❌	—	—
quote_display_id	str	❌	—	—
parts_trader_number	str	❌	—	—
is_bulk_pricing	bool	✅	—	—
line_items	List[LineItem]	✅	—	—
brokered_to	BrokeredTo	❌	—	BrokeredTo model
dont_sync_to_xero	bool	❌	False	—
bulk_price	float	❌	—	—
note	str	❌	—	—
delivery_address	Address	❌	—	Address model
billing_address	Address	❌	—	Address model

Embedded models

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

LineItem — v2.1.0

Field	Type	Required	Default	Description
item_type	str	✅	—	—
item_name	str	✅	—	—
description	str	✅	—	—
unit_price	float	❌	—	—
tax_type	str	❌	—	—
quantity	int	❌	—	—
account	Account	❌	—	Account model
tag_id	str	❌	—	—
part_id	str	❌	—	—
is_restocked	bool	❌	False	—
discount	float	❌	—	—
tax_amount	float	❌	—	—
line_amount	float	❌	—	—
line_item_id	str	❌	—	—

Change history

• v2.1.0 · 2025-04-17 · Olaniyi Ajayi · Field line_item_id became optional.; Field line_item_id default changed: None → Field(default_factory=lambda : str(uuid4())). (6db62f7db)
• v2.0.0 · 2025-04-09 · Cian (shared account) · Field description type changed: Optional[str] → str (breaking).; Field description became required (breaking).; Field item_name type changed: Optional[str] → str (breaking).; Field item_name became required (breaking).; Field item_type type changed: Optional[str] → str (breaking).; Field item_type became required (breaking).; Field line_item_id type changed: Optional[str] → str (breaking).; Field line_item_id became required (breaking). (6c65e2d22)
• v1.0.0 · 2025-03-15 · Olaniyi Ajayi · Initial version. (338416124)

Account — v5.0.0

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

Change history

• v5.0.0 · 2025-05-26 · Cian (shared account) · Field account_code type changed: str → Optional[str] (breaking).; Field account_code became optional. (509648ddf)
• v4.0.0 · 2025-05-15 · Cian (shared account) · Field account_code type changed: Optional[str] → str (breaking).; Field account_code became required (breaking). (bdb212c0f)
• v3.0.0 · 2025-05-09 · Cian (shared account) · Field account_code type changed: str → Optional[str] (breaking).; Field account_code became optional. (3a7865c16)
• v2.0.0 · 2025-04-09 · Cian (shared account) · Field account_code type changed: Optional[str] → str (breaking).; Field account_code became required (breaking). (6c65e2d22)
• v1.0.0 · 2025-03-15 · Olaniyi Ajayi · Initial version. (338416124)

BrokeredTo — v1.0.0

Field	Type	Required	Default	Description
reference	str	❌	—	—
name	str	❌	—	—
address_line_1	str	❌	—	—
city	str	❌	—	—
region	str	❌	—	—
postal_code	str	❌	—	—
country	str	❌	—	—

Change history

• v1.0.0 · 2025-03-16 · Cian (shared account) · Initial version. (feca668a3)

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

• v1.0.0 · 2025-03-15 · Olaniyi Ajayi · Initial version. (338416124)

APIs / Triggers

No API or event interacts with this object directly.

Change history

v8.0.0 · 2026-04-02 · Cian (shared account) · 36cb79ec0

Remove payment_type fields from Invoice models and related classes

• Removed field invoice_payment_type (breaking).

v7.1.0 · 2026-03-19 · Cian (shared account) · 0a1de5dd0

Add invoice defaults API and migrate tenant default fields

• Added optional field invoice_payment_type.

v7.0.0 · 2025-07-30 · Cian (shared account) · 687639e18

fx

• Removed field is_approved (breaking).

v6.2.0 · 2025-07-29 · Cian (shared account) · 383059805

fx

• Added optional field quote_display_id.
• Added optional field quote_id.

v6.1.0 · 2025-07-28 · Cian (shared account) · 0eb204368

fx

• Added optional field billing_address.
• Added optional field bulk_price.
• Added optional field delivery_address.
• Added optional field note.

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

fx

• Removed field billing_address (breaking).
• Removed field bulk_price (breaking).
• Removed field cash_sale_email (breaking).
• Removed field cash_sale_name (breaking).
• Removed field cash_sale_phone (breaking).
• Removed field delivery_address (breaking).
• Removed field note (breaking).

v5.1.0 · 2025-07-28 · Cian (shared account) · 6290ff81b

fx

• Added optional field billing_address.

v5.0.0 · 2025-07-27 · Olaniyi Ajayi · 34f0c89db

credit note put updated

• Removed field billing_address (breaking).

v4.3.0 · 2025-07-27 · Cian (shared account) · eecb0225a

fx

• Added optional field billing_address.

v4.2.0 · 2025-07-25 · Olaniyi Ajayi · 5e7e7d403

fx

• Added optional field delivery_address.

v4.1.0 · 2025-07-25 · Olaniyi Ajayi · 13b90e91e

fx

• Added optional field cash_sale_email.
• Added optional field cash_sale_name.
• Added optional field cash_sale_phone.

v4.0.0 · 2025-07-25 · Olaniyi Ajayi · 2713a806c

fx

• Removed field delivery_address (breaking).

v3.0.0 · 2025-07-25 · Cian (shared account) · acbaa1ec4

fx

• Removed field notes (breaking).
• Added optional field delivery_address.
• Added optional field note.

v2.1.0 · 2025-07-25 · Olaniyi Ajayi · 903f2bbf8

rm note

• Added optional field bulk_price.
• Added optional field notes.

v2.0.0 · 2025-07-25 · Olaniyi Ajayi · 2789fcc2c

fx

• Removed field bulk_price (breaking).
• Removed field note (breaking).

v1.1.0 · 2025-07-25 · Cian (shared account) · 3ddba29c9

fx

• Added optional field bulk_price.
• Added optional field note.

v1.0.0 · 2025-03-18 · Olaniyi Ajayi · 3ded38209

updated

• Initial version.

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