PaymentModel

Version: v1.2.0

Stored entity

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

Overview

Payment model

Fields

Field	Type	Required	Default	Description
pk	str	✅	—	—
sk	str	✅	—	—
account	PaymentAccount	✅	—	Payment Account model
amount_paid	float	✅	—	—
created_at	str	✅	—	—
date_paid	str	✅	—	—
dont_sync_to_xero	bool	✅	—	—
invoice_id	str	✅	—	—
last_emailed_at	str	❌	—	—
payment_display_id	str	✅	—	—
payment_id	str	✅	—	—
tenant_id	str	✅	—	—
reference	str	❌	—	—
payment_type	str	❌	—	—
type	str	❌	PAYMENT	—
updated_at	str	✅	—	—

Embedded models

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

PaymentAccount — v5.0.0

Field	Type	Required	Default	Description
code	str	❌	—	—
name	str	✅	—	—
account_id	str	✅	—	—

Change history

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

APIs / Triggers

No API or event interacts with this object directly.

Change history

v1.2.0 · 2026-04-12 · Cian (shared account) · 86f7fd78b

Persist payment_type on invoice payments and paid settlements

• Added optional field payment_type.

v1.1.0 · 2025-04-09 · Cian (shared account) · 6c65e2d22

fx

• Field type became optional.
• Field type default changed: None → 'PAYMENT'.

v1.0.0 · 2025-03-15 · Olaniyi Ajayi · 338416124

fx

• Initial version.

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